@nlozgachev/pipekit 0.1.6
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 +182 -0
- package/esm/mod.js +3 -0
- package/esm/package.json +3 -0
- package/esm/src/Composition/compose.js +3 -0
- package/esm/src/Composition/curry.js +42 -0
- package/esm/src/Composition/flip.js +20 -0
- package/esm/src/Composition/flow.js +8 -0
- package/esm/src/Composition/fn.js +85 -0
- package/esm/src/Composition/index.js +10 -0
- package/esm/src/Composition/memoize.js +66 -0
- package/esm/src/Composition/not.js +25 -0
- package/esm/src/Composition/pipe.js +3 -0
- package/esm/src/Composition/tap.js +33 -0
- package/esm/src/Composition/uncurry.js +32 -0
- package/esm/src/Core/Arr.js +461 -0
- package/esm/src/Core/InternalTypes.js +1 -0
- package/esm/src/Core/Option.js +195 -0
- package/esm/src/Core/Rec.js +167 -0
- package/esm/src/Core/RemoteData.js +210 -0
- package/esm/src/Core/Result.js +173 -0
- package/esm/src/Core/Task.js +108 -0
- package/esm/src/Core/TaskResult.js +63 -0
- package/esm/src/Core/Validation.js +215 -0
- package/esm/src/Core/index.js +8 -0
- package/esm/src/Types/NonEmptyList.js +14 -0
- package/esm/src/Types/index.js +1 -0
- package/package.json +60 -0
- package/script/mod.js +19 -0
- package/script/package.json +3 -0
- package/script/src/Composition/compose.js +6 -0
- package/script/src/Composition/curry.js +48 -0
- package/script/src/Composition/flip.js +24 -0
- package/script/src/Composition/flow.js +11 -0
- package/script/src/Composition/fn.js +98 -0
- package/script/src/Composition/index.js +26 -0
- package/script/src/Composition/memoize.js +71 -0
- package/script/src/Composition/not.js +29 -0
- package/script/src/Composition/pipe.js +6 -0
- package/script/src/Composition/tap.js +37 -0
- package/script/src/Composition/uncurry.js +38 -0
- package/script/src/Core/Arr.js +464 -0
- package/script/src/Core/InternalTypes.js +2 -0
- package/script/src/Core/Option.js +198 -0
- package/script/src/Core/Rec.js +170 -0
- package/script/src/Core/RemoteData.js +213 -0
- package/script/src/Core/Result.js +176 -0
- package/script/src/Core/Task.js +111 -0
- package/script/src/Core/TaskResult.js +66 -0
- package/script/src/Core/Validation.js +218 -0
- package/script/src/Core/index.js +24 -0
- package/script/src/Types/NonEmptyList.js +18 -0
- package/script/src/Types/index.js +17 -0
- package/types/mod.d.ts +4 -0
- package/types/mod.d.ts.map +1 -0
- package/types/src/Composition/compose.d.ts +33 -0
- package/types/src/Composition/compose.d.ts.map +1 -0
- package/types/src/Composition/curry.d.ts +43 -0
- package/types/src/Composition/curry.d.ts.map +1 -0
- package/types/src/Composition/flip.d.ts +21 -0
- package/types/src/Composition/flip.d.ts.map +1 -0
- package/types/src/Composition/flow.d.ts +56 -0
- package/types/src/Composition/flow.d.ts.map +1 -0
- package/types/src/Composition/fn.d.ts +76 -0
- package/types/src/Composition/fn.d.ts.map +1 -0
- package/types/src/Composition/index.d.ts +11 -0
- package/types/src/Composition/index.d.ts.map +1 -0
- package/types/src/Composition/memoize.d.ts +46 -0
- package/types/src/Composition/memoize.d.ts.map +1 -0
- package/types/src/Composition/not.d.ts +26 -0
- package/types/src/Composition/not.d.ts.map +1 -0
- package/types/src/Composition/pipe.d.ts +56 -0
- package/types/src/Composition/pipe.d.ts.map +1 -0
- package/types/src/Composition/tap.d.ts +31 -0
- package/types/src/Composition/tap.d.ts.map +1 -0
- package/types/src/Composition/uncurry.d.ts +54 -0
- package/types/src/Composition/uncurry.d.ts.map +1 -0
- package/types/src/Core/Arr.d.ts +355 -0
- package/types/src/Core/Arr.d.ts.map +1 -0
- package/types/src/Core/InternalTypes.d.ts +14 -0
- package/types/src/Core/InternalTypes.d.ts.map +1 -0
- package/types/src/Core/Option.d.ts +214 -0
- package/types/src/Core/Option.d.ts.map +1 -0
- package/types/src/Core/Rec.d.ts +121 -0
- package/types/src/Core/Rec.d.ts.map +1 -0
- package/types/src/Core/RemoteData.d.ts +196 -0
- package/types/src/Core/RemoteData.d.ts.map +1 -0
- package/types/src/Core/Result.d.ts +185 -0
- package/types/src/Core/Result.d.ts.map +1 -0
- package/types/src/Core/Task.d.ts +125 -0
- package/types/src/Core/Task.d.ts.map +1 -0
- package/types/src/Core/TaskResult.d.ts +78 -0
- package/types/src/Core/TaskResult.d.ts.map +1 -0
- package/types/src/Core/Validation.d.ts +217 -0
- package/types/src/Core/Validation.d.ts.map +1 -0
- package/types/src/Core/index.d.ts +9 -0
- package/types/src/Core/index.d.ts.map +1 -0
- package/types/src/Types/NonEmptyList.d.ts +29 -0
- package/types/src/Types/NonEmptyList.d.ts.map +1 -0
- package/types/src/Types/index.d.ts +2 -0
- package/types/src/Types/index.d.ts.map +1 -0
|
@@ -0,0 +1,121 @@
|
|
|
1
|
+
import { Option } from "./Option.js";
|
|
2
|
+
/**
|
|
3
|
+
* Functional record/object utilities that compose well with pipe.
|
|
4
|
+
* All functions are data-last and curried where applicable.
|
|
5
|
+
*
|
|
6
|
+
* @example
|
|
7
|
+
* ```ts
|
|
8
|
+
* pipe(
|
|
9
|
+
* { a: 1, b: 2, c: 3 },
|
|
10
|
+
* Rec.filter(n => n > 1),
|
|
11
|
+
* Rec.map(n => n * 10)
|
|
12
|
+
* ); // { b: 20, c: 30 }
|
|
13
|
+
* ```
|
|
14
|
+
*/
|
|
15
|
+
export declare namespace Rec {
|
|
16
|
+
/**
|
|
17
|
+
* Transforms each value in a record.
|
|
18
|
+
*
|
|
19
|
+
* @example
|
|
20
|
+
* ```ts
|
|
21
|
+
* pipe({ a: 1, b: 2 }, Rec.map(n => n * 2)); // { a: 2, b: 4 }
|
|
22
|
+
* ```
|
|
23
|
+
*/
|
|
24
|
+
const map: <A, B>(f: (a: A) => B) => (data: Readonly<Record<string, A>>) => Readonly<Record<string, B>>;
|
|
25
|
+
/**
|
|
26
|
+
* Transforms each value in a record, also receiving the key.
|
|
27
|
+
*
|
|
28
|
+
* @example
|
|
29
|
+
* ```ts
|
|
30
|
+
* pipe({ a: 1, b: 2 }, Rec.mapWithKey((k, v) => `${k}:${v}`));
|
|
31
|
+
* // { a: "a:1", b: "b:2" }
|
|
32
|
+
* ```
|
|
33
|
+
*/
|
|
34
|
+
const mapWithKey: <A, B>(f: (key: string, a: A) => B) => (data: Readonly<Record<string, A>>) => Readonly<Record<string, B>>;
|
|
35
|
+
/**
|
|
36
|
+
* Filters values in a record by a predicate.
|
|
37
|
+
*
|
|
38
|
+
* @example
|
|
39
|
+
* ```ts
|
|
40
|
+
* pipe({ a: 1, b: 2, c: 3 }, Rec.filter(n => n > 1)); // { b: 2, c: 3 }
|
|
41
|
+
* ```
|
|
42
|
+
*/
|
|
43
|
+
const filter: <A>(predicate: (a: A) => boolean) => (data: Readonly<Record<string, A>>) => Readonly<Record<string, A>>;
|
|
44
|
+
/**
|
|
45
|
+
* Filters values in a record by a predicate that also receives the key.
|
|
46
|
+
*
|
|
47
|
+
* @example
|
|
48
|
+
* ```ts
|
|
49
|
+
* pipe({ a: 1, b: 2 }, Rec.filterWithKey((k, v) => k !== "a" && v > 0));
|
|
50
|
+
* // { b: 2 }
|
|
51
|
+
* ```
|
|
52
|
+
*/
|
|
53
|
+
const filterWithKey: <A>(predicate: (key: string, a: A) => boolean) => (data: Readonly<Record<string, A>>) => Readonly<Record<string, A>>;
|
|
54
|
+
/**
|
|
55
|
+
* Looks up a value by key, returning Option.
|
|
56
|
+
*
|
|
57
|
+
* @example
|
|
58
|
+
* ```ts
|
|
59
|
+
* pipe({ a: 1, b: 2 }, Rec.lookup("a")); // Some(1)
|
|
60
|
+
* pipe({ a: 1, b: 2 }, Rec.lookup("c")); // None
|
|
61
|
+
* ```
|
|
62
|
+
*/
|
|
63
|
+
const lookup: (key: string) => <A>(data: Readonly<Record<string, A>>) => Option<A>;
|
|
64
|
+
/**
|
|
65
|
+
* Returns all keys of a record.
|
|
66
|
+
*/
|
|
67
|
+
const keys: <A>(data: Readonly<Record<string, A>>) => readonly string[];
|
|
68
|
+
/**
|
|
69
|
+
* Returns all values of a record.
|
|
70
|
+
*/
|
|
71
|
+
const values: <A>(data: Readonly<Record<string, A>>) => readonly A[];
|
|
72
|
+
/**
|
|
73
|
+
* Returns all key-value pairs of a record.
|
|
74
|
+
*/
|
|
75
|
+
const entries: <A>(data: Readonly<Record<string, A>>) => readonly (readonly [string, A])[];
|
|
76
|
+
/**
|
|
77
|
+
* Creates a record from key-value pairs.
|
|
78
|
+
*
|
|
79
|
+
* @example
|
|
80
|
+
* ```ts
|
|
81
|
+
* Rec.fromEntries([["a", 1], ["b", 2]]); // { a: 1, b: 2 }
|
|
82
|
+
* ```
|
|
83
|
+
*/
|
|
84
|
+
const fromEntries: <A>(data: readonly (readonly [string, A])[]) => Readonly<Record<string, A>>;
|
|
85
|
+
/**
|
|
86
|
+
* Picks specific keys from a record.
|
|
87
|
+
*
|
|
88
|
+
* @example
|
|
89
|
+
* ```ts
|
|
90
|
+
* pipe({ a: 1, b: 2, c: 3 }, Rec.pick("a", "c")); // { a: 1, c: 3 }
|
|
91
|
+
* ```
|
|
92
|
+
*/
|
|
93
|
+
const pick: <K extends string>(...pickedKeys: K[]) => <A extends Record<K, unknown>>(data: A) => Pick<A, K>;
|
|
94
|
+
/**
|
|
95
|
+
* Omits specific keys from a record.
|
|
96
|
+
*
|
|
97
|
+
* @example
|
|
98
|
+
* ```ts
|
|
99
|
+
* pipe({ a: 1, b: 2, c: 3 }, Rec.omit("b")); // { a: 1, c: 3 }
|
|
100
|
+
* ```
|
|
101
|
+
*/
|
|
102
|
+
const omit: <K extends string>(...omittedKeys: K[]) => <A extends Record<K, unknown>>(data: A) => Omit<A, K>;
|
|
103
|
+
/**
|
|
104
|
+
* Merges two records. Values from the second record take precedence.
|
|
105
|
+
*
|
|
106
|
+
* @example
|
|
107
|
+
* ```ts
|
|
108
|
+
* pipe({ a: 1, b: 2 }, Rec.merge({ b: 3, c: 4 })); // { a: 1, b: 3, c: 4 }
|
|
109
|
+
* ```
|
|
110
|
+
*/
|
|
111
|
+
const merge: <A>(other: Readonly<Record<string, A>>) => (data: Readonly<Record<string, A>>) => Readonly<Record<string, A>>;
|
|
112
|
+
/**
|
|
113
|
+
* Returns true if the record has no keys.
|
|
114
|
+
*/
|
|
115
|
+
const isEmpty: <A>(data: Readonly<Record<string, A>>) => boolean;
|
|
116
|
+
/**
|
|
117
|
+
* Returns the number of keys in a record.
|
|
118
|
+
*/
|
|
119
|
+
const size: <A>(data: Readonly<Record<string, A>>) => number;
|
|
120
|
+
}
|
|
121
|
+
//# sourceMappingURL=Rec.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"Rec.d.ts","sourceRoot":"","sources":["../../../src/src/Core/Rec.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AAErC;;;;;;;;;;;;GAYG;AACH,yBAAiB,GAAG,CAAC;IACnB;;;;;;;OAOG;IACI,MAAM,GAAG,GACb,CAAC,EAAE,CAAC,EAAE,GAAG,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,MAAM,MAAM,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,KAAG,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC,CAAC,CAMxF,CAAC;IAEJ;;;;;;;;OAQG;IACI,MAAM,UAAU,GACpB,CAAC,EAAE,CAAC,EAAE,GAAG,CAAC,GAAG,EAAE,MAAM,EAAE,CAAC,EAAE,CAAC,KAAK,CAAC,MACjC,MAAM,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,KAAG,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC,CAAC,CAM9D,CAAC;IAEJ;;;;;;;OAOG;IACI,MAAM,MAAM,GAChB,CAAC,EAAE,WAAW,CAAC,CAAC,EAAE,CAAC,KAAK,OAAO,MAC/B,MAAM,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,KAAG,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC,CAAC,CAM9D,CAAC;IAEJ;;;;;;;;OAQG;IACI,MAAM,aAAa,GACvB,CAAC,EAAE,WAAW,CAAC,GAAG,EAAE,MAAM,EAAE,CAAC,EAAE,CAAC,KAAK,OAAO,MAC5C,MAAM,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,KAAG,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC,CAAC,CAM9D,CAAC;IAEJ;;;;;;;;OAQG;IACI,MAAM,MAAM,GAAI,KAAK,MAAM,MAAM,CAAC,EAAE,MAAM,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,KAAG,MAAM,CAAC,CAAC,CACO,CAAC;IAE/F;;OAEG;IACI,MAAM,IAAI,GAAI,CAAC,EAAE,MAAM,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,KAAG,SAAS,MAAM,EACxD,CAAC;IAEpB;;OAEG;IACI,MAAM,MAAM,GAAI,CAAC,EAAE,MAAM,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,KAAG,SAAS,CAAC,EAAyB,CAAC;IAElG;;OAEG;IACI,MAAM,OAAO,GAAI,CAAC,EACvB,MAAM,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,KAChC,SAAS,CAAC,SAAS,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,EAA0B,CAAC;IAE7D;;;;;;;OAOG;IACI,MAAM,WAAW,GAAI,CAAC,EAC3B,MAAM,SAAS,CAAC,SAAS,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,EAAE,KACtC,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC,CAAC,CAA6B,CAAC;IAE3D;;;;;;;OAOG;IACI,MAAM,IAAI,GAAI,CAAC,SAAS,MAAM,EAAE,GAAG,YAAY,CAAC,EAAE,MACxD,CAAC,SAAS,MAAM,CAAC,CAAC,EAAE,OAAO,CAAC,EAC3B,MAAM,CAAC,KACN,IAAI,CAAC,CAAC,EAAE,CAAC,CAQX,CAAC;IAEF;;;;;;;OAOG;IACI,MAAM,IAAI,GACd,CAAC,SAAS,MAAM,EAAE,GAAG,aAAa,CAAC,EAAE,MACrC,CAAC,SAAS,MAAM,CAAC,CAAC,EAAE,OAAO,CAAC,EAAE,MAAM,CAAC,KAAG,IAAI,CAAC,CAAC,EAAE,CAAC,CASjD,CAAC;IAEJ;;;;;;;OAOG;IACI,MAAM,KAAK,GACf,CAAC,EAAE,OAAO,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,MACrC,MAAM,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,KAAG,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC,CAAC,CAG7D,CAAC;IAEL;;OAEG;IACI,MAAM,OAAO,GAAI,CAAC,EAAE,MAAM,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,KAAG,OAC/B,CAAC;IAEjC;;OAEG;IACI,MAAM,IAAI,GAAI,CAAC,EAAE,MAAM,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,KAAG,MAAkC,CAAC;CAChG"}
|
|
@@ -0,0 +1,196 @@
|
|
|
1
|
+
import { WithError, WithKind, WithValue } from "./InternalTypes.js";
|
|
2
|
+
/**
|
|
3
|
+
* RemoteData represents the state of an async data fetch.
|
|
4
|
+
* It has four states: NotAsked, Loading, Failure, and Success.
|
|
5
|
+
*
|
|
6
|
+
* Use RemoteData to model data fetching states explicitly,
|
|
7
|
+
* replacing the common `{ data: T | null; loading: boolean; error: Error | null }` pattern.
|
|
8
|
+
*
|
|
9
|
+
* @example
|
|
10
|
+
* ```ts
|
|
11
|
+
* const renderUser = pipe(
|
|
12
|
+
* userData,
|
|
13
|
+
* RemoteData.match({
|
|
14
|
+
* notAsked: () => "Click to load",
|
|
15
|
+
* loading: () => "Loading...",
|
|
16
|
+
* failure: e => `Error: ${e.message}`,
|
|
17
|
+
* success: user => `Hello, ${user.name}!`
|
|
18
|
+
* })
|
|
19
|
+
* );
|
|
20
|
+
* ```
|
|
21
|
+
*/
|
|
22
|
+
export type RemoteData<E, A> = NotAsked | Loading | Failure<E> | Success<A>;
|
|
23
|
+
export type NotAsked = WithKind<"NotAsked">;
|
|
24
|
+
export type Loading = WithKind<"Loading">;
|
|
25
|
+
export type Failure<E> = WithKind<"Failure"> & WithError<E>;
|
|
26
|
+
export type Success<A> = WithKind<"Success"> & WithValue<A>;
|
|
27
|
+
export declare namespace RemoteData {
|
|
28
|
+
/**
|
|
29
|
+
* Creates a NotAsked RemoteData.
|
|
30
|
+
*/
|
|
31
|
+
const notAsked: <E, A>() => RemoteData<E, A>;
|
|
32
|
+
/**
|
|
33
|
+
* Creates a Loading RemoteData.
|
|
34
|
+
*/
|
|
35
|
+
const loading: <E, A>() => RemoteData<E, A>;
|
|
36
|
+
/**
|
|
37
|
+
* Creates a Failure RemoteData with the given error.
|
|
38
|
+
*/
|
|
39
|
+
const failure: <E, A>(error: E) => RemoteData<E, A>;
|
|
40
|
+
/**
|
|
41
|
+
* Creates a Success RemoteData with the given value.
|
|
42
|
+
*/
|
|
43
|
+
const success: <E, A>(value: A) => RemoteData<E, A>;
|
|
44
|
+
/**
|
|
45
|
+
* Wraps a value in a Success RemoteData. Alias for `success`.
|
|
46
|
+
*/
|
|
47
|
+
const of: <E, A>(value: A) => RemoteData<E, A>;
|
|
48
|
+
/**
|
|
49
|
+
* Type guard that checks if a RemoteData is NotAsked.
|
|
50
|
+
*/
|
|
51
|
+
const isNotAsked: <E, A>(data: RemoteData<E, A>) => data is NotAsked;
|
|
52
|
+
/**
|
|
53
|
+
* Type guard that checks if a RemoteData is Loading.
|
|
54
|
+
*/
|
|
55
|
+
const isLoading: <E, A>(data: RemoteData<E, A>) => data is Loading;
|
|
56
|
+
/**
|
|
57
|
+
* Type guard that checks if a RemoteData is Failure.
|
|
58
|
+
*/
|
|
59
|
+
const isFailure: <E, A>(data: RemoteData<E, A>) => data is Failure<E>;
|
|
60
|
+
/**
|
|
61
|
+
* Type guard that checks if a RemoteData is Success.
|
|
62
|
+
*/
|
|
63
|
+
const isSuccess: <E, A>(data: RemoteData<E, A>) => data is Success<A>;
|
|
64
|
+
/**
|
|
65
|
+
* Transforms the success value inside a RemoteData.
|
|
66
|
+
*
|
|
67
|
+
* @example
|
|
68
|
+
* ```ts
|
|
69
|
+
* pipe(RemoteData.of(5), RemoteData.map(n => n * 2)); // Success(10)
|
|
70
|
+
* pipe(RemoteData.loading(), RemoteData.map(n => n * 2)); // Loading
|
|
71
|
+
* ```
|
|
72
|
+
*/
|
|
73
|
+
const map: <A, B>(f: (a: A) => B) => <E>(data: RemoteData<E, A>) => RemoteData<E, B>;
|
|
74
|
+
/**
|
|
75
|
+
* Transforms the error value inside a RemoteData.
|
|
76
|
+
*
|
|
77
|
+
* @example
|
|
78
|
+
* ```ts
|
|
79
|
+
* pipe(RemoteData.failure("oops"), RemoteData.mapError(e => e.toUpperCase())); // Failure("OOPS")
|
|
80
|
+
* ```
|
|
81
|
+
*/
|
|
82
|
+
const mapError: <E, F>(f: (e: E) => F) => <A>(data: RemoteData<E, A>) => RemoteData<F, A>;
|
|
83
|
+
/**
|
|
84
|
+
* Chains RemoteData computations. If the input is Success, passes the value to f.
|
|
85
|
+
* Otherwise, propagates the current state.
|
|
86
|
+
*
|
|
87
|
+
* @example
|
|
88
|
+
* ```ts
|
|
89
|
+
* pipe(
|
|
90
|
+
* RemoteData.of(5),
|
|
91
|
+
* RemoteData.chain(n => n > 0 ? RemoteData.of(n) : RemoteData.failure("negative"))
|
|
92
|
+
* );
|
|
93
|
+
* ```
|
|
94
|
+
*/
|
|
95
|
+
const chain: <E, A, B>(f: (a: A) => RemoteData<E, B>) => (data: RemoteData<E, A>) => RemoteData<E, B>;
|
|
96
|
+
/**
|
|
97
|
+
* Applies a function wrapped in a RemoteData to a value wrapped in a RemoteData.
|
|
98
|
+
*
|
|
99
|
+
* @example
|
|
100
|
+
* ```ts
|
|
101
|
+
* const add = (a: number) => (b: number) => a + b;
|
|
102
|
+
* pipe(
|
|
103
|
+
* RemoteData.of(add),
|
|
104
|
+
* RemoteData.ap(RemoteData.of(5)),
|
|
105
|
+
* RemoteData.ap(RemoteData.of(3))
|
|
106
|
+
* ); // Success(8)
|
|
107
|
+
* ```
|
|
108
|
+
*/
|
|
109
|
+
const ap: <E, A>(arg: RemoteData<E, A>) => <B>(data: RemoteData<E, (a: A) => B>) => RemoteData<E, B>;
|
|
110
|
+
/**
|
|
111
|
+
* Extracts the value from a RemoteData by providing handlers for all four cases.
|
|
112
|
+
*
|
|
113
|
+
* @example
|
|
114
|
+
* ```ts
|
|
115
|
+
* pipe(
|
|
116
|
+
* userData,
|
|
117
|
+
* RemoteData.fold(
|
|
118
|
+
* () => "Not asked",
|
|
119
|
+
* () => "Loading...",
|
|
120
|
+
* e => `Error: ${e}`,
|
|
121
|
+
* value => `Got: ${value}`
|
|
122
|
+
* )
|
|
123
|
+
* );
|
|
124
|
+
* ```
|
|
125
|
+
*/
|
|
126
|
+
const fold: <E, A, B>(onNotAsked: () => B, onLoading: () => B, onFailure: (e: E) => B, onSuccess: (a: A) => B) => (data: RemoteData<E, A>) => B;
|
|
127
|
+
/**
|
|
128
|
+
* Pattern matches on a RemoteData, returning the result of the matching case.
|
|
129
|
+
*
|
|
130
|
+
* @example
|
|
131
|
+
* ```ts
|
|
132
|
+
* pipe(
|
|
133
|
+
* userData,
|
|
134
|
+
* RemoteData.match({
|
|
135
|
+
* notAsked: () => "Click to load",
|
|
136
|
+
* loading: () => "Loading...",
|
|
137
|
+
* failure: e => `Error: ${e}`,
|
|
138
|
+
* success: user => `Hello, ${user.name}!`
|
|
139
|
+
* })
|
|
140
|
+
* );
|
|
141
|
+
* ```
|
|
142
|
+
*/
|
|
143
|
+
const match: <E, A, B>(cases: {
|
|
144
|
+
notAsked: () => B;
|
|
145
|
+
loading: () => B;
|
|
146
|
+
failure: (e: E) => B;
|
|
147
|
+
success: (a: A) => B;
|
|
148
|
+
}) => (data: RemoteData<E, A>) => B;
|
|
149
|
+
/**
|
|
150
|
+
* Returns the success value or a default value if the RemoteData is not Success.
|
|
151
|
+
*
|
|
152
|
+
* @example
|
|
153
|
+
* ```ts
|
|
154
|
+
* pipe(RemoteData.of(5), RemoteData.getOrElse(0)); // 5
|
|
155
|
+
* pipe(RemoteData.loading(), RemoteData.getOrElse(0)); // 0
|
|
156
|
+
* ```
|
|
157
|
+
*/
|
|
158
|
+
const getOrElse: <E, A>(defaultValue: A) => (data: RemoteData<E, A>) => A;
|
|
159
|
+
/**
|
|
160
|
+
* Executes a side effect on the success value without changing the RemoteData.
|
|
161
|
+
*
|
|
162
|
+
* @example
|
|
163
|
+
* ```ts
|
|
164
|
+
* pipe(
|
|
165
|
+
* RemoteData.of(5),
|
|
166
|
+
* RemoteData.tap(n => console.log("Value:", n)),
|
|
167
|
+
* RemoteData.map(n => n * 2)
|
|
168
|
+
* );
|
|
169
|
+
* ```
|
|
170
|
+
*/
|
|
171
|
+
const tap: <E, A>(f: (a: A) => void) => (data: RemoteData<E, A>) => RemoteData<E, A>;
|
|
172
|
+
/**
|
|
173
|
+
* Recovers from a Failure state by providing a fallback RemoteData.
|
|
174
|
+
*/
|
|
175
|
+
const recover: <E, A>(fallback: (e: E) => RemoteData<E, A>) => (data: RemoteData<E, A>) => RemoteData<E, A>;
|
|
176
|
+
/**
|
|
177
|
+
* Converts a RemoteData to an Option.
|
|
178
|
+
* Success becomes Some, all other states become None.
|
|
179
|
+
*/
|
|
180
|
+
const toOption: <E, A>(data: RemoteData<E, A>) => import("./Option.ts").Option<A>;
|
|
181
|
+
/**
|
|
182
|
+
* Converts a RemoteData to a Result.
|
|
183
|
+
* Success becomes Ok, Failure becomes Err.
|
|
184
|
+
* NotAsked and Loading become Err with the provided fallback error.
|
|
185
|
+
*
|
|
186
|
+
* @example
|
|
187
|
+
* ```ts
|
|
188
|
+
* pipe(
|
|
189
|
+
* RemoteData.of(42),
|
|
190
|
+
* RemoteData.toResult(() => "not loaded")
|
|
191
|
+
* ); // Ok(42)
|
|
192
|
+
* ```
|
|
193
|
+
*/
|
|
194
|
+
const toResult: <E>(onNotReady: () => E) => <A>(data: RemoteData<E, A>) => import("./Result.ts").Result<E, A>;
|
|
195
|
+
}
|
|
196
|
+
//# sourceMappingURL=RemoteData.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"RemoteData.d.ts","sourceRoot":"","sources":["../../../src/src/Core/RemoteData.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,QAAQ,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAC;AAEpE;;;;;;;;;;;;;;;;;;;GAmBG;AACH,MAAM,MAAM,UAAU,CAAC,CAAC,EAAE,CAAC,IAAI,QAAQ,GAAG,OAAO,GAAG,OAAO,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC;AAE5E,MAAM,MAAM,QAAQ,GAAG,QAAQ,CAAC,UAAU,CAAC,CAAC;AAC5C,MAAM,MAAM,OAAO,GAAG,QAAQ,CAAC,SAAS,CAAC,CAAC;AAC1C,MAAM,MAAM,OAAO,CAAC,CAAC,IAAI,QAAQ,CAAC,SAAS,CAAC,GAAG,SAAS,CAAC,CAAC,CAAC,CAAC;AAC5D,MAAM,MAAM,OAAO,CAAC,CAAC,IAAI,QAAQ,CAAC,SAAS,CAAC,GAAG,SAAS,CAAC,CAAC,CAAC,CAAC;AAE5D,yBAAiB,UAAU,CAAC;IAC1B;;OAEG;IACI,MAAM,QAAQ,GAAI,CAAC,EAAE,CAAC,OAAK,UAAU,CAAC,CAAC,EAAE,CAAC,CAA2B,CAAC;IAE7E;;OAEG;IACI,MAAM,OAAO,GAAI,CAAC,EAAE,CAAC,OAAK,UAAU,CAAC,CAAC,EAAE,CAAC,CAA0B,CAAC;IAE3E;;OAEG;IACI,MAAM,OAAO,GAAI,CAAC,EAAE,CAAC,EAAE,OAAO,CAAC,KAAG,UAAU,CAAC,CAAC,EAAE,CAAC,CAGtD,CAAC;IAEH;;OAEG;IACI,MAAM,OAAO,GAAI,CAAC,EAAE,CAAC,EAAE,OAAO,CAAC,KAAG,UAAU,CAAC,CAAC,EAAE,CAAC,CAGtD,CAAC;IAEH;;OAEG;IACI,MAAM,EAAE,GARS,CAAC,EAAE,CAAC,SAAS,CAAC,KAAG,UAAU,CAAC,CAAC,EAAE,CAAC,CAQ/B,CAAC;IAE1B;;OAEG;IACI,MAAM,UAAU,GAAI,CAAC,EAAE,CAAC,EAAE,MAAM,UAAU,CAAC,CAAC,EAAE,CAAC,CAAC,KAAG,IAAI,IAAI,QACxC,CAAC;IAE3B;;OAEG;IACI,MAAM,SAAS,GAAI,CAAC,EAAE,CAAC,EAAE,MAAM,UAAU,CAAC,CAAC,EAAE,CAAC,CAAC,KAAG,IAAI,IAAI,OACxC,CAAC;IAE1B;;OAEG;IACI,MAAM,SAAS,GAAI,CAAC,EAAE,CAAC,EAAE,MAAM,UAAU,CAAC,CAAC,EAAE,CAAC,CAAC,KAAG,IAAI,IAAI,OAAO,CAAC,CAAC,CACjD,CAAC;IAE1B;;OAEG;IACI,MAAM,SAAS,GAAI,CAAC,EAAE,CAAC,EAAE,MAAM,UAAU,CAAC,CAAC,EAAE,CAAC,CAAC,KAAG,IAAI,IAAI,OAAO,CAAC,CAAC,CACjD,CAAC;IAE1B;;;;;;;;OAQG;IACI,MAAM,GAAG,GAAI,CAAC,EAAE,CAAC,EAAE,GAAG,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,MAAM,CAAC,EAAE,MAAM,UAAU,CAAC,CAAC,EAAE,CAAC,CAAC,KAAG,UAAU,CAAC,CAAC,EAAE,CAAC,CAClB,CAAC;IAExE;;;;;;;OAOG;IACI,MAAM,QAAQ,GAAI,CAAC,EAAE,CAAC,EAAE,GAAG,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,MAAM,CAAC,EAAE,MAAM,UAAU,CAAC,CAAC,EAAE,CAAC,CAAC,KAAG,UAAU,CAAC,CAAC,EAAE,CAAC,CACvB,CAAC;IAExE;;;;;;;;;;;OAWG;IACI,MAAM,KAAK,GACf,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,GAAG,CAAC,CAAC,EAAE,CAAC,KAAK,UAAU,CAAC,CAAC,EAAE,CAAC,CAAC,MAAM,MAAM,UAAU,CAAC,CAAC,EAAE,CAAC,CAAC,KAAG,UAAU,CAAC,CAAC,EAAE,CAAC,CACvB,CAAC;IAEjE;;;;;;;;;;;;OAYG;IACI,MAAM,EAAE,GACZ,CAAC,EAAE,CAAC,EAAE,KAAK,UAAU,CAAC,CAAC,EAAE,CAAC,CAAC,MAAM,CAAC,EAAE,MAAM,UAAU,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC,KAAG,UAAU,CAAC,CAAC,EAAE,CAAC,CAQtF,CAAC;IAEJ;;;;;;;;;;;;;;;OAeG;IACI,MAAM,IAAI,GAAI,CAAC,EAAE,CAAC,EAAE,CAAC,EAC1B,YAAY,MAAM,CAAC,EACnB,WAAW,MAAM,CAAC,EAClB,WAAW,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,EACtB,WAAW,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,MAEvB,MAAM,UAAU,CAAC,CAAC,EAAE,CAAC,CAAC,KAAG,CAWzB,CAAC;IAEF;;;;;;;;;;;;;;;OAeG;IACI,MAAM,KAAK,GAAI,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,OAAO;QACpC,QAAQ,EAAE,MAAM,CAAC,CAAC;QAClB,OAAO,EAAE,MAAM,CAAC,CAAC;QACjB,OAAO,EAAE,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC;QACrB,OAAO,EAAE,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC;KACtB,MACA,MAAM,UAAU,CAAC,CAAC,EAAE,CAAC,CAAC,KAAG,CAWzB,CAAC;IAEF;;;;;;;;OAQG;IACI,MAAM,SAAS,GAAI,CAAC,EAAE,CAAC,EAAE,cAAc,CAAC,MAAM,MAAM,UAAU,CAAC,CAAC,EAAE,CAAC,CAAC,KAAG,CACjC,CAAC;IAE9C;;;;;;;;;;;OAWG;IACI,MAAM,GAAG,GAAI,CAAC,EAAE,CAAC,EAAE,GAAG,CAAC,CAAC,EAAE,CAAC,KAAK,IAAI,MAAM,MAAM,UAAU,CAAC,CAAC,EAAE,CAAC,CAAC,KAAG,UAAU,CAAC,CAAC,EAAE,CAAC,CAGxF,CAAC;IAEF;;OAEG;IACI,MAAM,OAAO,GACjB,CAAC,EAAE,CAAC,EAAE,UAAU,CAAC,CAAC,EAAE,CAAC,KAAK,UAAU,CAAC,CAAC,EAAE,CAAC,CAAC,MAAM,MAAM,UAAU,CAAC,CAAC,EAAE,CAAC,CAAC,KAAG,UAAU,CAAC,CAAC,EAAE,CAAC,CAC1C,CAAC;IAElD;;;OAGG;IACI,MAAM,QAAQ,GAAI,CAAC,EAAE,CAAC,EAC3B,MAAM,UAAU,CAAC,CAAC,EAAE,CAAC,CAAC,KACrB,OAAO,aAAa,EAAE,MAAM,CAAC,CAAC,CACyC,CAAC;IAE3E;;;;;;;;;;;;OAYG;IACI,MAAM,QAAQ,GAClB,CAAC,EAAE,YAAY,MAAM,CAAC,MAAM,CAAC,EAAE,MAAM,UAAU,CAAC,CAAC,EAAE,CAAC,CAAC,KAAG,OAAO,aAAa,EAAE,MAAM,CAAC,CAAC,EAAE,CAAC,CAGf,CAAC;CAC/E"}
|
|
@@ -0,0 +1,185 @@
|
|
|
1
|
+
import { WithError, WithKind, WithValue } from "./InternalTypes.js";
|
|
2
|
+
/**
|
|
3
|
+
* Result represents a value that can be one of two types: a success (Ok) or a failure (Err).
|
|
4
|
+
* Use Result when an operation can fail with a meaningful error value.
|
|
5
|
+
*
|
|
6
|
+
* @example
|
|
7
|
+
* ```ts
|
|
8
|
+
* const divide = (a: number, b: number): Result<string, number> =>
|
|
9
|
+
* b === 0 ? Result.toErr("Division by zero") : Result.toOk(a / b);
|
|
10
|
+
*
|
|
11
|
+
* pipe(
|
|
12
|
+
* divide(10, 2),
|
|
13
|
+
* Result.map(n => n * 2),
|
|
14
|
+
* Result.getOrElse(0)
|
|
15
|
+
* ); // 10
|
|
16
|
+
* ```
|
|
17
|
+
*/
|
|
18
|
+
export type Result<E, A> = Ok<A> | Err<E>;
|
|
19
|
+
export type Ok<A> = WithKind<"Ok"> & WithValue<A>;
|
|
20
|
+
export type Err<E> = WithKind<"Error"> & WithError<E>;
|
|
21
|
+
export declare namespace Result {
|
|
22
|
+
/**
|
|
23
|
+
* Wraps a value in a successful Result (Ok).
|
|
24
|
+
*
|
|
25
|
+
* @example
|
|
26
|
+
* ```ts
|
|
27
|
+
* Result.of(42); // Ok(42)
|
|
28
|
+
* ```
|
|
29
|
+
*/
|
|
30
|
+
const of: <E, A>(value: A) => Result<E, A>;
|
|
31
|
+
/**
|
|
32
|
+
* Creates a failed Result with the given error.
|
|
33
|
+
*/
|
|
34
|
+
const toErr: <E>(error: E) => Err<E>;
|
|
35
|
+
/**
|
|
36
|
+
* Creates a successful Result with the given value.
|
|
37
|
+
*/
|
|
38
|
+
const toOk: <A>(value: A) => Ok<A>;
|
|
39
|
+
/**
|
|
40
|
+
* Type guard that checks if an Result is Ok.
|
|
41
|
+
*/
|
|
42
|
+
const isOk: <E, A>(data: Result<E, A>) => data is Ok<A>;
|
|
43
|
+
/**
|
|
44
|
+
* Type guard that checks if an Result is Err.
|
|
45
|
+
*/
|
|
46
|
+
const isErr: <E, A>(data: Result<E, A>) => data is Err<E>;
|
|
47
|
+
/**
|
|
48
|
+
* Creates an Result from a function that may throw.
|
|
49
|
+
* Catches any errors and transforms them using the onError function.
|
|
50
|
+
*
|
|
51
|
+
* @example
|
|
52
|
+
* ```ts
|
|
53
|
+
* const parseJson = (s: string): Result<string, unknown> =>
|
|
54
|
+
* Result.tryCatch(
|
|
55
|
+
* () => JSON.parse(s),
|
|
56
|
+
* (e) => `Parse error: ${e}`
|
|
57
|
+
* );
|
|
58
|
+
* ```
|
|
59
|
+
*/
|
|
60
|
+
const tryCatch: <E, A>(f: () => A, onError: (e: unknown) => E) => Result<E, A>;
|
|
61
|
+
/**
|
|
62
|
+
* Transforms the success value inside an Result.
|
|
63
|
+
*
|
|
64
|
+
* @example
|
|
65
|
+
* ```ts
|
|
66
|
+
* pipe(Result.of(5), Result.map(n => n * 2)); // Ok(10)
|
|
67
|
+
* pipe(Result.toErr("error"), Result.map(n => n * 2)); // Err("error")
|
|
68
|
+
* ```
|
|
69
|
+
*/
|
|
70
|
+
const map: <E, A, B>(f: (a: A) => B) => (data: Result<E, A>) => Result<E, B>;
|
|
71
|
+
/**
|
|
72
|
+
* Transforms the error value inside an Result.
|
|
73
|
+
*
|
|
74
|
+
* @example
|
|
75
|
+
* ```ts
|
|
76
|
+
* pipe(Result.toErr("oops"), Result.mapError(e => e.toUpperCase())); // Err("OOPS")
|
|
77
|
+
* ```
|
|
78
|
+
*/
|
|
79
|
+
const mapError: <E, F, A>(f: (e: E) => F) => (data: Result<E, A>) => Result<F, A>;
|
|
80
|
+
/**
|
|
81
|
+
* Chains Result computations. If the first is Ok, passes the value to f.
|
|
82
|
+
* If the first is Err, propagates the error.
|
|
83
|
+
*
|
|
84
|
+
* @example
|
|
85
|
+
* ```ts
|
|
86
|
+
* const validatePositive = (n: number): Result<string, number> =>
|
|
87
|
+
* n > 0 ? Result.of(n) : Result.toErr("Must be positive");
|
|
88
|
+
*
|
|
89
|
+
* pipe(Result.of(5), Result.chain(validatePositive)); // Ok(5)
|
|
90
|
+
* pipe(Result.of(-1), Result.chain(validatePositive)); // Err("Must be positive")
|
|
91
|
+
* ```
|
|
92
|
+
*/
|
|
93
|
+
const chain: <E, A, B>(f: (a: A) => Result<E, B>) => (data: Result<E, A>) => Result<E, B>;
|
|
94
|
+
/**
|
|
95
|
+
* Extracts the value from an Result by providing handlers for both cases.
|
|
96
|
+
*
|
|
97
|
+
* @example
|
|
98
|
+
* ```ts
|
|
99
|
+
* pipe(
|
|
100
|
+
* Result.of(5),
|
|
101
|
+
* Result.fold(
|
|
102
|
+
* e => `Error: ${e}`,
|
|
103
|
+
* n => `Value: ${n}`
|
|
104
|
+
* )
|
|
105
|
+
* ); // "Value: 5"
|
|
106
|
+
* ```
|
|
107
|
+
*/
|
|
108
|
+
const fold: <E, A, B>(onErr: (e: E) => B, onOk: (a: A) => B) => (data: Result<E, A>) => B;
|
|
109
|
+
/**
|
|
110
|
+
* Pattern matches on a Result, returning the result of the matching case.
|
|
111
|
+
*
|
|
112
|
+
* @example
|
|
113
|
+
* ```ts
|
|
114
|
+
* pipe(
|
|
115
|
+
* result,
|
|
116
|
+
* Result.match({
|
|
117
|
+
* ok: value => `Got ${value}`,
|
|
118
|
+
* err: error => `Failed: ${error}`
|
|
119
|
+
* })
|
|
120
|
+
* );
|
|
121
|
+
* ```
|
|
122
|
+
*/
|
|
123
|
+
const match: <E, A, B>(cases: {
|
|
124
|
+
ok: (a: A) => B;
|
|
125
|
+
err: (e: E) => B;
|
|
126
|
+
}) => (data: Result<E, A>) => B;
|
|
127
|
+
/**
|
|
128
|
+
* Returns the success value or a default value if the Result is an error.
|
|
129
|
+
*
|
|
130
|
+
* @example
|
|
131
|
+
* ```ts
|
|
132
|
+
* pipe(Result.of(5), Result.getOrElse(0)); // 5
|
|
133
|
+
* pipe(Result.toErr("error"), Result.getOrElse(0)); // 0
|
|
134
|
+
* ```
|
|
135
|
+
*/
|
|
136
|
+
const getOrElse: <E, A>(defaultValue: A) => (data: Result<E, A>) => A;
|
|
137
|
+
/**
|
|
138
|
+
* Executes a side effect on the success value without changing the Result.
|
|
139
|
+
* Useful for logging or debugging.
|
|
140
|
+
*
|
|
141
|
+
* @example
|
|
142
|
+
* ```ts
|
|
143
|
+
* pipe(
|
|
144
|
+
* Result.of(5),
|
|
145
|
+
* Result.tap(n => console.log("Value:", n)),
|
|
146
|
+
* Result.map(n => n * 2)
|
|
147
|
+
* );
|
|
148
|
+
* ```
|
|
149
|
+
*/
|
|
150
|
+
const tap: <E, A>(f: (a: A) => void) => (data: Result<E, A>) => Result<E, A>;
|
|
151
|
+
/**
|
|
152
|
+
* Recovers from an error by providing a fallback Result.
|
|
153
|
+
*/
|
|
154
|
+
const recover: <E, A>(fallback: () => Result<E, A>) => (data: Result<E, A>) => Result<E, A>;
|
|
155
|
+
/**
|
|
156
|
+
* Recovers from an error unless it matches the blocked error.
|
|
157
|
+
*/
|
|
158
|
+
const recoverUnless: <E, A>(blockedErr: E, fallback: () => Result<E, A>) => (data: Result<E, A>) => Result<E, A>;
|
|
159
|
+
/**
|
|
160
|
+
* Converts a Result to an Option.
|
|
161
|
+
* Ok becomes Some, Err becomes None (the error is discarded).
|
|
162
|
+
*
|
|
163
|
+
* @example
|
|
164
|
+
* ```ts
|
|
165
|
+
* Result.toOption(Result.toOk(42)); // Some(42)
|
|
166
|
+
* Result.toOption(Result.toErr("oops")); // None
|
|
167
|
+
* ```
|
|
168
|
+
*/
|
|
169
|
+
const toOption: <E, A>(data: Result<E, A>) => import("./Option.ts").Option<A>;
|
|
170
|
+
/**
|
|
171
|
+
* Applies a function wrapped in an Result to a value wrapped in an Result.
|
|
172
|
+
*
|
|
173
|
+
* @example
|
|
174
|
+
* ```ts
|
|
175
|
+
* const add = (a: number) => (b: number) => a + b;
|
|
176
|
+
* pipe(
|
|
177
|
+
* Result.of(add),
|
|
178
|
+
* Result.ap(Result.of(5)),
|
|
179
|
+
* Result.ap(Result.of(3))
|
|
180
|
+
* ); // Ok(8)
|
|
181
|
+
* ```
|
|
182
|
+
*/
|
|
183
|
+
const ap: <E, A>(arg: Result<E, A>) => <B>(data: Result<E, (a: A) => B>) => Result<E, B>;
|
|
184
|
+
}
|
|
185
|
+
//# sourceMappingURL=Result.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"Result.d.ts","sourceRoot":"","sources":["../../../src/src/Core/Result.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,QAAQ,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAC;AAEpE;;;;;;;;;;;;;;;GAeG;AACH,MAAM,MAAM,MAAM,CAAC,CAAC,EAAE,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,GAAG,GAAG,CAAC,CAAC,CAAC,CAAC;AAE1C,MAAM,MAAM,EAAE,CAAC,CAAC,IAAI,QAAQ,CAAC,IAAI,CAAC,GAAG,SAAS,CAAC,CAAC,CAAC,CAAC;AAClD,MAAM,MAAM,GAAG,CAAC,CAAC,IAAI,QAAQ,CAAC,OAAO,CAAC,GAAG,SAAS,CAAC,CAAC,CAAC,CAAC;AAEtD,yBAAiB,MAAM,CAAC;IACtB;;;;;;;OAOG;IACI,MAAM,EAAE,GAAI,CAAC,EAAE,CAAC,EAAE,OAAO,CAAC,KAAG,MAAM,CAAC,CAAC,EAAE,CAAC,CAAgB,CAAC;IAEhE;;OAEG;IACI,MAAM,KAAK,GAAI,CAAC,EAAE,OAAO,CAAC,KAAG,GAAG,CAAC,CAAC,CAA+B,CAAC;IAEzE;;OAEG;IACI,MAAM,IAAI,GAAI,CAAC,EAAE,OAAO,CAAC,KAAG,EAAE,CAAC,CAAC,CAA4B,CAAC;IAEpE;;OAEG;IACI,MAAM,IAAI,GAAI,CAAC,EAAE,CAAC,EAAE,MAAM,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,KAAG,IAAI,IAAI,EAAE,CAAC,CAAC,CAAuB,CAAC;IAEpF;;OAEG;IACI,MAAM,KAAK,GAAI,CAAC,EAAE,CAAC,EAAE,MAAM,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,KAAG,IAAI,IAAI,GAAG,CAAC,CAAC,CAA0B,CAAC;IAEzF;;;;;;;;;;;;OAYG;IACI,MAAM,QAAQ,GAAI,CAAC,EAAE,CAAC,EAC3B,GAAG,MAAM,CAAC,EACV,SAAS,CAAC,CAAC,EAAE,OAAO,KAAK,CAAC,KACzB,MAAM,CAAC,CAAC,EAAE,CAAC,CAMb,CAAC;IAEF;;;;;;;;OAQG;IACI,MAAM,GAAG,GAAI,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,GAAG,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,MAAM,MAAM,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,KAAG,MAAM,CAAC,CAAC,EAAE,CAAC,CACxC,CAAC;IAE1C;;;;;;;OAOG;IACI,MAAM,QAAQ,GAAI,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,GAAG,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,MAAM,MAAM,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,KAAG,MAAM,CAAC,CAAC,EAAE,CAAC,CAC3C,CAAC;IAE5C;;;;;;;;;;;;OAYG;IACI,MAAM,KAAK,GAAI,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,GAAG,CAAC,CAAC,EAAE,CAAC,KAAK,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,MAAM,MAAM,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,KAAG,MAAM,CAAC,CAAC,EAAE,CAAC,CAC3D,CAAC;IAEpC;;;;;;;;;;;;;OAaG;IACI,MAAM,IAAI,GAAI,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,OAAO,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,EAAE,MAAM,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,MAAM,MAAM,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,KAAG,CAC3C,CAAC;IAEpD;;;;;;;;;;;;;OAaG;IACI,MAAM,KAAK,GACf,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,OAAO;QAAE,EAAE,EAAE,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC;QAAC,GAAG,EAAE,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,CAAA;KAAE,MAAM,MAAM,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,KAAG,CACtB,CAAC;IAE9D;;;;;;;;OAQG;IACI,MAAM,SAAS,GAAI,CAAC,EAAE,CAAC,EAAE,cAAc,CAAC,MAAM,MAAM,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,KAAG,CAClC,CAAC;IAEzC;;;;;;;;;;;;OAYG;IACI,MAAM,GAAG,GAAI,CAAC,EAAE,CAAC,EAAE,GAAG,CAAC,CAAC,EAAE,CAAC,KAAK,IAAI,MAAM,MAAM,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,KAAG,MAAM,CAAC,CAAC,EAAE,CAAC,CAGhF,CAAC;IAEF;;OAEG;IACI,MAAM,OAAO,GACjB,CAAC,EAAE,CAAC,EAAE,UAAU,MAAM,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,MAAM,MAAM,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,KAAG,MAAM,CAAC,CAAC,EAAE,CAAC,CACzC,CAAC;IAEnC;;OAEG;IACI,MAAM,aAAa,GACvB,CAAC,EAAE,CAAC,EAAE,YAAY,CAAC,EAAE,UAAU,MAAM,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,MAAM,MAAM,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,KAAG,MAAM,CAAC,CAAC,EAAE,CAAC,CAC1B,CAAC;IAEjE;;;;;;;;;OASG;IACI,MAAM,QAAQ,GAAI,CAAC,EAAE,CAAC,EAC3B,MAAM,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,KACjB,OAAO,aAAa,EAAE,MAAM,CAAC,CAAC,CACoC,CAAC;IAEtE;;;;;;;;;;;;OAYG;IACI,MAAM,EAAE,GAAI,CAAC,EAAE,CAAC,EAAE,KAAK,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,MAAM,CAAC,EAAE,MAAM,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC,KAAG,MAAM,CAAC,CAAC,EAAE,CAAC,CACC,CAAC;CAChG"}
|
|
@@ -0,0 +1,125 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Task represents a lazy asynchronous computation.
|
|
3
|
+
* Unlike Promise, a Task doesn't execute until you call it.
|
|
4
|
+
* This makes Tasks composable and referentially transparent.
|
|
5
|
+
*
|
|
6
|
+
* @example
|
|
7
|
+
* ```ts
|
|
8
|
+
* const fetchData: Task<Data> = () => fetch('/api/data').then(r => r.json());
|
|
9
|
+
*
|
|
10
|
+
* // Nothing happens yet - the task is just defined
|
|
11
|
+
* const processedData = pipe(
|
|
12
|
+
* fetchData,
|
|
13
|
+
* Task.map(data => transform(data))
|
|
14
|
+
* );
|
|
15
|
+
*
|
|
16
|
+
* // Now execute the task
|
|
17
|
+
* processedData().then(result => console.log(result));
|
|
18
|
+
* ```
|
|
19
|
+
*/
|
|
20
|
+
export type Task<A> = () => Promise<A>;
|
|
21
|
+
export declare namespace Task {
|
|
22
|
+
/**
|
|
23
|
+
* Wraps a value in a Task that immediately resolves to that value.
|
|
24
|
+
*
|
|
25
|
+
* @example
|
|
26
|
+
* ```ts
|
|
27
|
+
* const task = Task.of(42);
|
|
28
|
+
* task().then(console.log); // 42
|
|
29
|
+
* ```
|
|
30
|
+
*/
|
|
31
|
+
const of: <A>(value: A) => Task<A>;
|
|
32
|
+
/**
|
|
33
|
+
* Creates a Task that will reject with the given error.
|
|
34
|
+
*/
|
|
35
|
+
const fail: <A>(error: unknown) => Task<A>;
|
|
36
|
+
/**
|
|
37
|
+
* Creates a Task from a function that returns a Promise.
|
|
38
|
+
* Alias for directly creating a Task.
|
|
39
|
+
*
|
|
40
|
+
* @example
|
|
41
|
+
* ```ts
|
|
42
|
+
* const fetchUser = Task.from(() => fetch('/user').then(r => r.json()));
|
|
43
|
+
* ```
|
|
44
|
+
*/
|
|
45
|
+
const from: <A>(f: () => Promise<A>) => Task<A>;
|
|
46
|
+
/**
|
|
47
|
+
* Transforms the value inside a Task.
|
|
48
|
+
*
|
|
49
|
+
* @example
|
|
50
|
+
* ```ts
|
|
51
|
+
* pipe(
|
|
52
|
+
* Task.of(5),
|
|
53
|
+
* Task.map(n => n * 2)
|
|
54
|
+
* )(); // Promise<10>
|
|
55
|
+
* ```
|
|
56
|
+
*/
|
|
57
|
+
const map: <A, B>(f: (a: A) => B) => (data: Task<A>) => Task<B>;
|
|
58
|
+
/**
|
|
59
|
+
* Chains Task computations. If the first succeeds, passes the value to f.
|
|
60
|
+
*
|
|
61
|
+
* @example
|
|
62
|
+
* ```ts
|
|
63
|
+
* const fetchUser = (id: string): Task<User> => () => fetch(`/users/${id}`).then(r => r.json());
|
|
64
|
+
* const fetchPosts = (user: User): Task<Post[]> => () => fetch(`/posts?userId=${user.id}`).then(r => r.json());
|
|
65
|
+
*
|
|
66
|
+
* pipe(
|
|
67
|
+
* fetchUser("123"),
|
|
68
|
+
* Task.chain(fetchPosts)
|
|
69
|
+
* )(); // Promise<Post[]>
|
|
70
|
+
* ```
|
|
71
|
+
*/
|
|
72
|
+
const chain: <A, B>(f: (a: A) => Task<B>) => (data: Task<A>) => Task<B>;
|
|
73
|
+
/**
|
|
74
|
+
* Applies a function wrapped in a Task to a value wrapped in a Task.
|
|
75
|
+
* Both Tasks run in parallel.
|
|
76
|
+
*
|
|
77
|
+
* @example
|
|
78
|
+
* ```ts
|
|
79
|
+
* const add = (a: number) => (b: number) => a + b;
|
|
80
|
+
* pipe(
|
|
81
|
+
* Task.of(add),
|
|
82
|
+
* Task.ap(Task.of(5)),
|
|
83
|
+
* Task.ap(Task.of(3))
|
|
84
|
+
* )(); // Promise<8>
|
|
85
|
+
* ```
|
|
86
|
+
*/
|
|
87
|
+
const ap: <A>(arg: Task<A>) => <B>(data: Task<(a: A) => B>) => Task<B>;
|
|
88
|
+
/**
|
|
89
|
+
* Executes a side effect on the value without changing the Task.
|
|
90
|
+
* Useful for logging or debugging.
|
|
91
|
+
*
|
|
92
|
+
* @example
|
|
93
|
+
* ```ts
|
|
94
|
+
* pipe(
|
|
95
|
+
* fetchData,
|
|
96
|
+
* Task.tap(data => console.log("Fetched:", data)),
|
|
97
|
+
* Task.map(transform)
|
|
98
|
+
* );
|
|
99
|
+
* ```
|
|
100
|
+
*/
|
|
101
|
+
const tap: <A>(f: (a: A) => void) => (data: Task<A>) => Task<A>;
|
|
102
|
+
/**
|
|
103
|
+
* Runs multiple Tasks in parallel and collects their results.
|
|
104
|
+
*
|
|
105
|
+
* @example
|
|
106
|
+
* ```ts
|
|
107
|
+
* Task.all([fetchUser, fetchPosts, fetchComments])();
|
|
108
|
+
* // Promise<[User, Post[], Comment[]]>
|
|
109
|
+
* ```
|
|
110
|
+
*/
|
|
111
|
+
const all: <T extends readonly Task<unknown>[]>(tasks: T) => Task<{ [K in keyof T]: T[K] extends Task<infer A> ? A : never; }>;
|
|
112
|
+
/**
|
|
113
|
+
* Delays the execution of a Task by the specified milliseconds.
|
|
114
|
+
*
|
|
115
|
+
* @example
|
|
116
|
+
* ```ts
|
|
117
|
+
* pipe(
|
|
118
|
+
* Task.of(42),
|
|
119
|
+
* Task.delay(1000)
|
|
120
|
+
* )(); // Resolves after 1 second
|
|
121
|
+
* ```
|
|
122
|
+
*/
|
|
123
|
+
const delay: (ms: number) => <A>(data: Task<A>) => Task<A>;
|
|
124
|
+
}
|
|
125
|
+
//# sourceMappingURL=Task.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"Task.d.ts","sourceRoot":"","sources":["../../../src/src/Core/Task.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAM,MAAM,IAAI,CAAC,CAAC,IAAI,MAAM,OAAO,CAAC,CAAC,CAAC,CAAC;AAEvC,yBAAiB,IAAI,CAAC;IACpB;;;;;;;;OAQG;IACI,MAAM,EAAE,GAAI,CAAC,EAAE,OAAO,CAAC,KAAG,IAAI,CAAC,CAAC,CAAiC,CAAC;IAEzE;;OAEG;IACI,MAAM,IAAI,GAAI,CAAC,EAAE,OAAO,OAAO,KAAG,IAAI,CAAC,CAAC,CAAgC,CAAC;IAEhF;;;;;;;;OAQG;IACI,MAAM,IAAI,GAAI,CAAC,EAAE,GAAG,MAAM,OAAO,CAAC,CAAC,CAAC,KAAG,IAAI,CAAC,CAAC,CAAM,CAAC;IAE3D;;;;;;;;;;OAUG;IACI,MAAM,GAAG,GAAI,CAAC,EAAE,CAAC,EAAE,GAAG,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,MAAM,MAAM,IAAI,CAAC,CAAC,CAAC,KAAG,IAAI,CAAC,CAAC,CAAyB,CAAC;IAE9F;;;;;;;;;;;;;OAaG;IACI,MAAM,KAAK,GAAI,CAAC,EAAE,CAAC,EAAE,GAAG,CAAC,CAAC,EAAE,CAAC,KAAK,IAAI,CAAC,CAAC,CAAC,MAAM,MAAM,IAAI,CAAC,CAAC,CAAC,KAAG,IAAI,CAAC,CAAC,CAChD,CAAC;IAE7B;;;;;;;;;;;;;OAaG;IACI,MAAM,EAAE,GAAI,CAAC,EAAE,KAAK,IAAI,CAAC,CAAC,CAAC,MAAM,CAAC,EAAE,MAAM,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC,KAAG,IAAI,CAAC,CAAC,CACtB,CAAC;IAEtD;;;;;;;;;;;;OAYG;IACI,MAAM,GAAG,GAAI,CAAC,EAAE,GAAG,CAAC,CAAC,EAAE,CAAC,KAAK,IAAI,MAAM,MAAM,IAAI,CAAC,CAAC,CAAC,KAAG,IAAI,CAAC,CAAC,CAIhE,CAAC;IAEL;;;;;;;;OAQG;IACI,MAAM,GAAG,GAAI,CAAC,SAAS,SAAS,IAAI,CAAC,OAAO,CAAC,EAAE,EACpD,OAAO,CAAC,KACP,IAAI,CAAC,GAAG,CAAC,IAAI,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,SAAS,IAAI,CAAC,MAAM,CAAC,CAAC,GAAG,CAAC,GAAG,KAAK,GAAE,CAI/D,CAAC;IAEJ;;;;;;;;;;OAUG;IACI,MAAM,KAAK,GAAI,IAAI,MAAM,MAAM,CAAC,EAAE,MAAM,IAAI,CAAC,CAAC,CAAC,KAAG,IAAI,CAAC,CAAC,CACuB,CAAC;CACxF"}
|