neverpanic 0.0.4 → 1.0.0-beta.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -19,20 +19,23 @@ Create a safe function from an unsafe one:
19
19
 
20
20
  ```ts
21
21
  const getUser = n.safeFn(
22
- async (id: string) => {
23
- const res = await fetch(`https://example.com/users/${id}`);
24
- if (!res.ok) return { success: false, error: "FAILED_TO_FETCH" };
25
-
26
- return { success: true, data: await res.json() };
27
- },
28
- (err) => "FAILED_TO_GET_USER",
22
+ async (id: string) => {
23
+ const res = await fetch(
24
+ `https://example.com/users/${id}`,
25
+ );
26
+ if (!res.ok)
27
+ return { success: false, error: "FAILED_TO_FETCH" };
28
+
29
+ return { success: true, data: await res.json() };
30
+ },
31
+ (err) => "FAILED_TO_GET_USER",
29
32
  );
30
33
 
31
34
  const getUserResult = await getUser("some-user-id");
32
35
  if (!getUserResult.success) {
33
- console.error(getUserResult.error);
36
+ console.error(getUserResult.error);
34
37
  } else {
35
- console.log(getUserResult.data);
38
+ console.log(getUserResult.data);
36
39
  }
37
40
  ```
38
41
 
@@ -43,12 +46,12 @@ Runs the provided callback function, catching any thrown errors and returning a
43
46
 
44
47
  ```ts
45
48
  const user = await n.fromUnsafe(
46
- () => db.findUser("some-user-id"),
47
- (err) => "FAILED_T0_FIND_USER",
49
+ () => db.findUser("some-user-id"),
50
+ (err) => "FAILED_T0_FIND_USER",
48
51
  );
49
52
  if (!user.success) {
50
- console.error(user.error);
53
+ console.error(user.error);
51
54
  } else {
52
- console.log(user.data);
55
+ console.log(user.data);
53
56
  }
54
57
  ```
package/dist/index.d.ts CHANGED
@@ -50,5 +50,10 @@ declare function fromUnsafe<T, E = null, R = T extends Promise<unknown> ? Promis
50
50
  export declare const n: {
51
51
  safeFn: typeof safeFn;
52
52
  fromUnsafe: typeof fromUnsafe;
53
+ resultsToResult: <T extends Result[], D extends Extract<T[number], {
54
+ success: true;
55
+ }>, E extends Extract<T[number], {
56
+ success: false;
57
+ }>>(results: T) => Result<D[], E[]>;
53
58
  };
54
59
  export {};
package/dist/index.js CHANGED
@@ -67,11 +67,42 @@ function fromUnsafe(cb, eh) {
67
67
  try {
68
68
  const result = cb();
69
69
  if (result instanceof Promise)
70
- return result.then(createSuccessResult).catch(createErrorResult);
70
+ return result
71
+ .then(createSuccessResult)
72
+ .catch(createErrorResult);
71
73
  return createSuccessResult(result);
72
74
  }
73
75
  catch (e) {
74
76
  return createErrorResult(e);
75
77
  }
76
78
  }
77
- export const n = { safeFn, fromUnsafe };
79
+ /**
80
+ * Convert a list of results into a single result.
81
+ *
82
+ * @param results - A list of Results.
83
+ * @returns A single result containing the data / errors of the input results.
84
+ *
85
+ * @example
86
+ * const findUserResults = userIds.map((userId) =>
87
+ * n.fromUnsafe(
88
+ * () => db.findUser(userId),
89
+ * () => "FAILED_TO_FIND_USER" as const,
90
+ * ),
91
+ * );
92
+ *
93
+ * const result = n.resultsToResult(findUserResults)
94
+ */
95
+ const resultsToResult = (results) => {
96
+ const errors = results.filter((result) => !result.success);
97
+ if (errors.length)
98
+ return {
99
+ success: false,
100
+ error: errors,
101
+ };
102
+ const successes = results.filter((result) => result.success);
103
+ return {
104
+ success: true,
105
+ data: successes,
106
+ };
107
+ };
108
+ export const n = { safeFn, fromUnsafe, resultsToResult };
package/package.json CHANGED
@@ -1,21 +1,26 @@
1
1
  {
2
2
  "name": "neverpanic",
3
- "module": "index.ts",
4
- "version": "0.0.4",
5
- "type": "module",
3
+ "version": "1.0.0-beta.1",
6
4
  "repository": {
7
5
  "url": "https://github.com/bgrcs/neverpanic"
8
6
  },
9
- "scripts": {
10
- "build": "tsc",
11
- "test": "bun test"
12
- },
13
- "files": ["dist"],
7
+ "files": [
8
+ "dist"
9
+ ],
10
+ "type": "module",
11
+ "module": "index.ts",
14
12
  "exports": {
15
13
  ".": "./dist/index.js"
16
14
  },
15
+ "scripts": {
16
+ "build": "tsc",
17
+ "test": "bun test",
18
+ "fmt": "oxfmt --check",
19
+ "fmt:fix": "oxfmt --write"
20
+ },
17
21
  "devDependencies": {
18
- "@types/bun": "latest"
22
+ "@types/bun": "latest",
23
+ "oxfmt": "0.32.0"
19
24
  },
20
25
  "peerDependencies": {
21
26
  "typescript": "5"