@j2blasco/ts-result 0.1.2 → 0.1.4
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/dist/index.cjs +10 -0
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +4 -2
- package/dist/index.d.ts +4 -2
- package/dist/index.js +8 -0
- package/dist/index.js.map +1 -1
- package/package.json +3 -3
package/dist/index.cjs
CHANGED
|
@@ -22,6 +22,8 @@ var index_exports = {};
|
|
|
22
22
|
__export(index_exports, {
|
|
23
23
|
andThen: () => andThen,
|
|
24
24
|
andThenAsync: () => andThenAsync,
|
|
25
|
+
catchError: () => catchError,
|
|
26
|
+
catchErrorAsync: () => catchErrorAsync,
|
|
25
27
|
errorUnkown: () => errorUnkown,
|
|
26
28
|
errorWithCode: () => errorWithCode,
|
|
27
29
|
makeSafePromise: () => makeSafePromise,
|
|
@@ -124,10 +126,18 @@ function andThen(callback) {
|
|
|
124
126
|
function andThenAsync(callback) {
|
|
125
127
|
return (result) => result.andThenAsync(callback);
|
|
126
128
|
}
|
|
129
|
+
function catchError(callback) {
|
|
130
|
+
return (result) => result.catchError(callback);
|
|
131
|
+
}
|
|
132
|
+
function catchErrorAsync(callback) {
|
|
133
|
+
return (result) => result.catchErrorAsync(callback);
|
|
134
|
+
}
|
|
127
135
|
// Annotate the CommonJS export names for ESM import in node:
|
|
128
136
|
0 && (module.exports = {
|
|
129
137
|
andThen,
|
|
130
138
|
andThenAsync,
|
|
139
|
+
catchError,
|
|
140
|
+
catchErrorAsync,
|
|
131
141
|
errorUnkown,
|
|
132
142
|
errorWithCode,
|
|
133
143
|
makeSafePromise,
|
package/dist/index.cjs.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../src/index.ts","../src/result.ts","../src/result-functions.ts"],"sourcesContent":["export * from './result';\r\nexport * from './result-functions';","export interface Result<TSuccess1, TError1> {\r\n andThen<TResult extends Result<any, any>>(\r\n f: (value: TSuccess1) => TResult,\r\n ): Result<SuccessType<TResult>, TError1 | ErrorType<TResult>>;\r\n andThenAsync<TResult extends Result<any, any>>(\r\n f: (value: TSuccess1) => Promise<TResult>,\r\n ): Promise<Result<SuccessType<TResult>, TError1 | ErrorType<TResult>>>;\r\n catchError<TResult extends Result<any, any>>(\r\n f: (error: TError1) => TResult,\r\n ): Result<TSuccess1 | SuccessType<TResult>, ErrorType<TResult>>;\r\n catchErrorAsync<TResult extends Result<any, any>>(\r\n f: (error: TError1) => Promise<TResult>,\r\n ): Promise<Result<TSuccess1 | SuccessType<TResult>, ErrorType<TResult>>>;\r\n unwrapOrThrow(errorCallback?: (e: TError1) => void): TSuccess1;\r\n}\r\n\r\nexport function unwrapSuccessResult<T>(result: Result<T, never>): T {\r\n if (result instanceof ResultSuccessImp) {\r\n return result['value'];\r\n }\r\n throw new Error('Unreachable code. Result is an error');\r\n}\r\n\r\nexport type ErrorWithCode<TCode, TData = object> = { code: TCode; data: TData };\r\nexport function errorWithCode<TCode, TData>(\r\n code: TCode,\r\n data: TData,\r\n): ErrorWithCode<TCode, TData> {\r\n return {\r\n code,\r\n data,\r\n };\r\n}\r\n\r\nexport type ErrorUnknown = {\r\n code: 'unknown';\r\n data: { message: string };\r\n};\r\nexport function errorUnkown(message: string): ErrorUnknown {\r\n return {\r\n code: 'unknown',\r\n data: { message },\r\n };\r\n}\r\n\r\nexport type SuccessType<T> = T extends Result<infer S, any> ? S : never;\r\nexport type ErrorType<T> = T extends Result<any, infer E> ? E : never;\r\n\r\nexport type SuccessVoid = never;\r\n\r\nexport function resultSuccessVoid(): Result<SuccessVoid, never> {\r\n return new ResultSuccessImp<SuccessVoid>(undefined as never);\r\n}\r\n\r\nexport function resultSuccess<TSuccess1>(\r\n value: TSuccess1,\r\n): Result<TSuccess1, never> {\r\n return new ResultSuccessImp<TSuccess1>(value);\r\n}\r\n\r\ntype EnforceLiteral<T> = string extends T ? never : T;\r\n\r\nexport class resultError {\r\n public static unknown(message: string): Result<never, ErrorUnknown> {\r\n return new ResultErrorImp<ErrorUnknown>(errorUnkown(message));\r\n }\r\n public static withCode<TCode, TData = object>(\r\n code: EnforceLiteral<TCode>,\r\n data: TData = {} as TData,\r\n ): Result<never, ErrorWithCode<TCode, TData>> {\r\n return new ResultErrorImp<ErrorWithCode<TCode, TData>>(\r\n errorWithCode(code, data),\r\n );\r\n }\r\n public static fromError<\r\n
|
|
1
|
+
{"version":3,"sources":["../src/index.ts","../src/result.ts","../src/result-functions.ts"],"sourcesContent":["export * from './result';\r\nexport * from './result-functions';","export interface Result<TSuccess1, TError1> {\r\n andThen<TResult extends Result<any, any>>(\r\n f: (value: TSuccess1) => TResult,\r\n ): Result<SuccessType<TResult>, TError1 | ErrorType<TResult>>;\r\n andThenAsync<TResult extends Result<any, any>>(\r\n f: (value: TSuccess1) => Promise<TResult>,\r\n ): Promise<Result<SuccessType<TResult>, TError1 | ErrorType<TResult>>>;\r\n catchError<TResult extends Result<any, any>>(\r\n f: (error: TError1) => TResult,\r\n ): Result<TSuccess1 | SuccessType<TResult>, ErrorType<TResult>>;\r\n catchErrorAsync<TResult extends Result<any, any>>(\r\n f: (error: TError1) => Promise<TResult>,\r\n ): Promise<Result<TSuccess1 | SuccessType<TResult>, ErrorType<TResult>>>;\r\n unwrapOrThrow(errorCallback?: (e: TError1) => void): TSuccess1;\r\n}\r\n\r\nexport function unwrapSuccessResult<T>(result: Result<T, never>): T {\r\n if (result instanceof ResultSuccessImp) {\r\n return result['value'];\r\n }\r\n throw new Error('Unreachable code. Result is an error');\r\n}\r\n\r\nexport type ErrorWithCode<TCode, TData = object> = { code: TCode; data: TData };\r\nexport function errorWithCode<TCode, TData>(\r\n code: TCode,\r\n data: TData,\r\n): ErrorWithCode<TCode, TData> {\r\n return {\r\n code,\r\n data,\r\n };\r\n}\r\n\r\nexport type ErrorUnknown = {\r\n code: 'unknown';\r\n data: { message: string };\r\n};\r\nexport function errorUnkown(message: string): ErrorUnknown {\r\n return {\r\n code: 'unknown',\r\n data: { message },\r\n };\r\n}\r\n\r\nexport type SuccessType<T> = T extends Result<infer S, any> ? S : never;\r\nexport type ErrorType<T> = T extends Result<any, infer E> ? E : never;\r\n\r\nexport type SuccessVoid = never;\r\n\r\nexport function resultSuccessVoid(): Result<SuccessVoid, never> {\r\n return new ResultSuccessImp<SuccessVoid>(undefined as never);\r\n}\r\n\r\nexport function resultSuccess<TSuccess1>(\r\n value: TSuccess1,\r\n): Result<TSuccess1, never> {\r\n return new ResultSuccessImp<TSuccess1>(value);\r\n}\r\n\r\ntype EnforceLiteral<T> = string extends T ? never : T;\r\n\r\nexport class resultError {\r\n public static unknown(message: string): Result<never, ErrorUnknown> {\r\n return new ResultErrorImp<ErrorUnknown>(errorUnkown(message));\r\n }\r\n public static withCode<TCode, TData = object>(\r\n code: EnforceLiteral<TCode>,\r\n data: TData = {} as TData,\r\n ): Result<never, ErrorWithCode<TCode, TData>> {\r\n return new ResultErrorImp<ErrorWithCode<TCode, TData>>(\r\n errorWithCode(code, data),\r\n );\r\n }\r\n public static fromError<\r\n TError1 extends ErrorWithCode<any, object>,\r\n >(error: TError1): Result<never, TError1> {\r\n return new ResultErrorImp<TError1>(error);\r\n }\r\n}\r\n\r\nclass ResultSuccessImp<TSuccess1> implements Result<TSuccess1, never> {\r\n constructor(private value: TSuccess1) {}\r\n\r\n public andThen<TSuccess2, TError2>(\r\n f: (value: TSuccess1) => Result<TSuccess2, TError2>,\r\n ): Result<TSuccess2, TError2> {\r\n return f(this.value);\r\n }\r\n\r\n public async andThenAsync<TSuccess2, TError2>(\r\n f: (value: TSuccess1) => Promise<Result<TSuccess2, TError2>>,\r\n ): Promise<Result<TSuccess2, TError2>> {\r\n return await f(this.value);\r\n }\r\n\r\n public catchError<TSuccess2, TError2>(\r\n _f: (error: never) => Result<TSuccess2, TError2>,\r\n ): Result<TSuccess1 | TSuccess2, TError2> {\r\n return this;\r\n }\r\n\r\n public async catchErrorAsync<TSuccess2, TError2>(\r\n _f: (error: never) => Promise<Result<TSuccess2, TError2>>,\r\n ): Promise<Result<TSuccess1 | TSuccess2, TError2>> {\r\n return this;\r\n }\r\n\r\n public unwrapOrThrow(_errorCallback?: (e: never) => void): TSuccess1 {\r\n return this.value;\r\n }\r\n}\r\n\r\nclass ResultErrorImp<TError1> implements Result<never, TError1> {\r\n constructor(private error: TError1) {}\r\n\r\n public andThen<TSuccess2, TError2>(\r\n _f: (value: never) => Result<TSuccess2, TError2>,\r\n ): Result<TSuccess2, TError1 | TError2> {\r\n return this;\r\n }\r\n\r\n public async andThenAsync<TSuccess2, TError2>(\r\n _f: (value: never) => Promise<Result<TSuccess2, TError2>>,\r\n ): Promise<Result<TSuccess2, TError1 | TError2>> {\r\n return this;\r\n }\r\n\r\n public catchError<TSuccess2, TError2>(\r\n f: (error: TError1) => Result<TSuccess2, TError2>,\r\n ): Result<TSuccess2, TError2> {\r\n return f(this.error);\r\n }\r\n\r\n public async catchErrorAsync<TSuccess2, TError2>(\r\n f: (error: TError1) => Promise<Result<TSuccess2, TError2>>,\r\n ): Promise<Result<TSuccess2, TError2>> {\r\n return await f(this.error);\r\n }\r\n\r\n public unwrapOrThrow(errorCallback?: (e: TError1) => void): never {\r\n if (errorCallback !== undefined) {\r\n errorCallback(this.error);\r\n }\r\n throw this.error;\r\n }\r\n}\r\n\r\nexport type UnwrapErrorFromResult<T> =\r\n T extends Result<any, infer U> ? U : never;\r\n\r\nexport function makeSafePromise<T>(\r\n promise: Promise<T>,\r\n): Promise<Result<T, ErrorUnknown>> {\r\n return promise\r\n .then((value) => resultSuccess(value))\r\n .catch((error) => resultError.unknown(error.message));\r\n}","import { ErrorType, Result, SuccessType } from \"./result\";\r\n\r\nexport function andThen<TSuccess, TError, TResult extends Result<any, any>>(\r\n callback: (value: TSuccess) => TResult\r\n): (\r\n result: Result<TSuccess, TError>\r\n) => Result<SuccessType<TResult>, TError | ErrorType<TResult>> {\r\n return (result) => result.andThen(callback);\r\n}\r\n\r\nexport function andThenAsync<\r\n TSuccess,\r\n TError,\r\n TResult extends Result<any, any>\r\n>(\r\n callback: (value: TSuccess) => Promise<TResult>\r\n): (\r\n result: Result<TSuccess, TError>\r\n) => Promise<Result<SuccessType<TResult>, TError | ErrorType<TResult>>> {\r\n return (result) => result.andThenAsync(callback);\r\n}\r\n\r\nexport function catchError<TSuccess, TError, TResult extends Result<any, any>>(\r\n callback: (error: TError) => TResult\r\n): (\r\n result: Result<TSuccess, TError>\r\n) => Result<TSuccess | SuccessType<TResult>, ErrorType<TResult>> {\r\n return (result) => result.catchError(callback);\r\n}\r\n\r\nexport function catchErrorAsync<\r\n TSuccess,\r\n TError,\r\n TResult extends Result<any, any>\r\n>(\r\n callback: (error: TError) => Promise<TResult>\r\n): (\r\n result: Result<TSuccess, TError>\r\n) => Promise<Result<TSuccess | SuccessType<TResult>, ErrorType<TResult>>> {\r\n return (result) => result.catchErrorAsync(callback);\r\n}\r\n"],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;;;ACgBO,SAAS,oBAAuB,QAA6B;AAClE,MAAI,kBAAkB,kBAAkB;AACtC,WAAO,OAAO,OAAO;AAAA,EACvB;AACA,QAAM,IAAI,MAAM,sCAAsC;AACxD;AAGO,SAAS,cACd,MACA,MAC6B;AAC7B,SAAO;AAAA,IACL;AAAA,IACA;AAAA,EACF;AACF;AAMO,SAAS,YAAY,SAA+B;AACzD,SAAO;AAAA,IACL,MAAM;AAAA,IACN,MAAM,EAAE,QAAQ;AAAA,EAClB;AACF;AAOO,SAAS,oBAAgD;AAC9D,SAAO,IAAI,iBAA8B,MAAkB;AAC7D;AAEO,SAAS,cACd,OAC0B;AAC1B,SAAO,IAAI,iBAA4B,KAAK;AAC9C;AAIO,IAAM,cAAN,MAAkB;AAAA,EACvB,OAAc,QAAQ,SAA8C;AAClE,WAAO,IAAI,eAA6B,YAAY,OAAO,CAAC;AAAA,EAC9D;AAAA,EACA,OAAc,SACZ,MACA,OAAc,CAAC,GAC6B;AAC5C,WAAO,IAAI;AAAA,MACT,cAAc,MAAM,IAAI;AAAA,IAC1B;AAAA,EACF;AAAA,EACA,OAAc,UAEZ,OAAwC;AACxC,WAAO,IAAI,eAAwB,KAAK;AAAA,EAC1C;AACF;AAEA,IAAM,mBAAN,MAAsE;AAAA,EACpE,YAAoB,OAAkB;AAAlB;AAAA,EAAmB;AAAA,EAEhC,QACL,GAC4B;AAC5B,WAAO,EAAE,KAAK,KAAK;AAAA,EACrB;AAAA,EAEA,MAAa,aACX,GACqC;AACrC,WAAO,MAAM,EAAE,KAAK,KAAK;AAAA,EAC3B;AAAA,EAEO,WACL,IACwC;AACxC,WAAO;AAAA,EACT;AAAA,EAEA,MAAa,gBACX,IACiD;AACjD,WAAO;AAAA,EACT;AAAA,EAEO,cAAc,gBAAgD;AACnE,WAAO,KAAK;AAAA,EACd;AACF;AAEA,IAAM,iBAAN,MAAgE;AAAA,EAC9D,YAAoB,OAAgB;AAAhB;AAAA,EAAiB;AAAA,EAE9B,QACL,IACsC;AACtC,WAAO;AAAA,EACT;AAAA,EAEA,MAAa,aACX,IAC+C;AAC/C,WAAO;AAAA,EACT;AAAA,EAEO,WACL,GAC4B;AAC5B,WAAO,EAAE,KAAK,KAAK;AAAA,EACrB;AAAA,EAEA,MAAa,gBACX,GACqC;AACrC,WAAO,MAAM,EAAE,KAAK,KAAK;AAAA,EAC3B;AAAA,EAEO,cAAc,eAA6C;AAChE,QAAI,kBAAkB,QAAW;AAC/B,oBAAc,KAAK,KAAK;AAAA,IAC1B;AACA,UAAM,KAAK;AAAA,EACb;AACF;AAKO,SAAS,gBACd,SACkC;AAClC,SAAO,QACJ,KAAK,CAAC,UAAU,cAAc,KAAK,CAAC,EACpC,MAAM,CAAC,UAAU,YAAY,QAAQ,MAAM,OAAO,CAAC;AACxD;;;AC3JO,SAAS,QACd,UAG6D;AAC7D,SAAO,CAAC,WAAW,OAAO,QAAQ,QAAQ;AAC5C;AAEO,SAAS,aAKd,UAGsE;AACtE,SAAO,CAAC,WAAW,OAAO,aAAa,QAAQ;AACjD;AAEO,SAAS,WACd,UAG+D;AAC/D,SAAO,CAAC,WAAW,OAAO,WAAW,QAAQ;AAC/C;AAEO,SAAS,gBAKd,UAGwE;AACxE,SAAO,CAAC,WAAW,OAAO,gBAAgB,QAAQ;AACpD;","names":[]}
|
package/dist/index.d.cts
CHANGED
|
@@ -27,12 +27,14 @@ type EnforceLiteral<T> = string extends T ? never : T;
|
|
|
27
27
|
declare class resultError {
|
|
28
28
|
static unknown(message: string): Result<never, ErrorUnknown>;
|
|
29
29
|
static withCode<TCode, TData = object>(code: EnforceLiteral<TCode>, data?: TData): Result<never, ErrorWithCode<TCode, TData>>;
|
|
30
|
-
static fromError<
|
|
30
|
+
static fromError<TError1 extends ErrorWithCode<any, object>>(error: TError1): Result<never, TError1>;
|
|
31
31
|
}
|
|
32
32
|
type UnwrapErrorFromResult<T> = T extends Result<any, infer U> ? U : never;
|
|
33
33
|
declare function makeSafePromise<T>(promise: Promise<T>): Promise<Result<T, ErrorUnknown>>;
|
|
34
34
|
|
|
35
35
|
declare function andThen<TSuccess, TError, TResult extends Result<any, any>>(callback: (value: TSuccess) => TResult): (result: Result<TSuccess, TError>) => Result<SuccessType<TResult>, TError | ErrorType<TResult>>;
|
|
36
36
|
declare function andThenAsync<TSuccess, TError, TResult extends Result<any, any>>(callback: (value: TSuccess) => Promise<TResult>): (result: Result<TSuccess, TError>) => Promise<Result<SuccessType<TResult>, TError | ErrorType<TResult>>>;
|
|
37
|
+
declare function catchError<TSuccess, TError, TResult extends Result<any, any>>(callback: (error: TError) => TResult): (result: Result<TSuccess, TError>) => Result<TSuccess | SuccessType<TResult>, ErrorType<TResult>>;
|
|
38
|
+
declare function catchErrorAsync<TSuccess, TError, TResult extends Result<any, any>>(callback: (error: TError) => Promise<TResult>): (result: Result<TSuccess, TError>) => Promise<Result<TSuccess | SuccessType<TResult>, ErrorType<TResult>>>;
|
|
37
39
|
|
|
38
|
-
export { type ErrorType, type ErrorUnknown, type ErrorWithCode, type Result, type SuccessType, type SuccessVoid, type UnwrapErrorFromResult, andThen, andThenAsync, errorUnkown, errorWithCode, makeSafePromise, resultError, resultSuccess, resultSuccessVoid, unwrapSuccessResult };
|
|
40
|
+
export { type ErrorType, type ErrorUnknown, type ErrorWithCode, type Result, type SuccessType, type SuccessVoid, type UnwrapErrorFromResult, andThen, andThenAsync, catchError, catchErrorAsync, errorUnkown, errorWithCode, makeSafePromise, resultError, resultSuccess, resultSuccessVoid, unwrapSuccessResult };
|
package/dist/index.d.ts
CHANGED
|
@@ -27,12 +27,14 @@ type EnforceLiteral<T> = string extends T ? never : T;
|
|
|
27
27
|
declare class resultError {
|
|
28
28
|
static unknown(message: string): Result<never, ErrorUnknown>;
|
|
29
29
|
static withCode<TCode, TData = object>(code: EnforceLiteral<TCode>, data?: TData): Result<never, ErrorWithCode<TCode, TData>>;
|
|
30
|
-
static fromError<
|
|
30
|
+
static fromError<TError1 extends ErrorWithCode<any, object>>(error: TError1): Result<never, TError1>;
|
|
31
31
|
}
|
|
32
32
|
type UnwrapErrorFromResult<T> = T extends Result<any, infer U> ? U : never;
|
|
33
33
|
declare function makeSafePromise<T>(promise: Promise<T>): Promise<Result<T, ErrorUnknown>>;
|
|
34
34
|
|
|
35
35
|
declare function andThen<TSuccess, TError, TResult extends Result<any, any>>(callback: (value: TSuccess) => TResult): (result: Result<TSuccess, TError>) => Result<SuccessType<TResult>, TError | ErrorType<TResult>>;
|
|
36
36
|
declare function andThenAsync<TSuccess, TError, TResult extends Result<any, any>>(callback: (value: TSuccess) => Promise<TResult>): (result: Result<TSuccess, TError>) => Promise<Result<SuccessType<TResult>, TError | ErrorType<TResult>>>;
|
|
37
|
+
declare function catchError<TSuccess, TError, TResult extends Result<any, any>>(callback: (error: TError) => TResult): (result: Result<TSuccess, TError>) => Result<TSuccess | SuccessType<TResult>, ErrorType<TResult>>;
|
|
38
|
+
declare function catchErrorAsync<TSuccess, TError, TResult extends Result<any, any>>(callback: (error: TError) => Promise<TResult>): (result: Result<TSuccess, TError>) => Promise<Result<TSuccess | SuccessType<TResult>, ErrorType<TResult>>>;
|
|
37
39
|
|
|
38
|
-
export { type ErrorType, type ErrorUnknown, type ErrorWithCode, type Result, type SuccessType, type SuccessVoid, type UnwrapErrorFromResult, andThen, andThenAsync, errorUnkown, errorWithCode, makeSafePromise, resultError, resultSuccess, resultSuccessVoid, unwrapSuccessResult };
|
|
40
|
+
export { type ErrorType, type ErrorUnknown, type ErrorWithCode, type Result, type SuccessType, type SuccessVoid, type UnwrapErrorFromResult, andThen, andThenAsync, catchError, catchErrorAsync, errorUnkown, errorWithCode, makeSafePromise, resultError, resultSuccess, resultSuccessVoid, unwrapSuccessResult };
|
package/dist/index.js
CHANGED
|
@@ -90,9 +90,17 @@ function andThen(callback) {
|
|
|
90
90
|
function andThenAsync(callback) {
|
|
91
91
|
return (result) => result.andThenAsync(callback);
|
|
92
92
|
}
|
|
93
|
+
function catchError(callback) {
|
|
94
|
+
return (result) => result.catchError(callback);
|
|
95
|
+
}
|
|
96
|
+
function catchErrorAsync(callback) {
|
|
97
|
+
return (result) => result.catchErrorAsync(callback);
|
|
98
|
+
}
|
|
93
99
|
export {
|
|
94
100
|
andThen,
|
|
95
101
|
andThenAsync,
|
|
102
|
+
catchError,
|
|
103
|
+
catchErrorAsync,
|
|
96
104
|
errorUnkown,
|
|
97
105
|
errorWithCode,
|
|
98
106
|
makeSafePromise,
|
package/dist/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../src/result.ts","../src/result-functions.ts"],"sourcesContent":["export interface Result<TSuccess1, TError1> {\r\n andThen<TResult extends Result<any, any>>(\r\n f: (value: TSuccess1) => TResult,\r\n ): Result<SuccessType<TResult>, TError1 | ErrorType<TResult>>;\r\n andThenAsync<TResult extends Result<any, any>>(\r\n f: (value: TSuccess1) => Promise<TResult>,\r\n ): Promise<Result<SuccessType<TResult>, TError1 | ErrorType<TResult>>>;\r\n catchError<TResult extends Result<any, any>>(\r\n f: (error: TError1) => TResult,\r\n ): Result<TSuccess1 | SuccessType<TResult>, ErrorType<TResult>>;\r\n catchErrorAsync<TResult extends Result<any, any>>(\r\n f: (error: TError1) => Promise<TResult>,\r\n ): Promise<Result<TSuccess1 | SuccessType<TResult>, ErrorType<TResult>>>;\r\n unwrapOrThrow(errorCallback?: (e: TError1) => void): TSuccess1;\r\n}\r\n\r\nexport function unwrapSuccessResult<T>(result: Result<T, never>): T {\r\n if (result instanceof ResultSuccessImp) {\r\n return result['value'];\r\n }\r\n throw new Error('Unreachable code. Result is an error');\r\n}\r\n\r\nexport type ErrorWithCode<TCode, TData = object> = { code: TCode; data: TData };\r\nexport function errorWithCode<TCode, TData>(\r\n code: TCode,\r\n data: TData,\r\n): ErrorWithCode<TCode, TData> {\r\n return {\r\n code,\r\n data,\r\n };\r\n}\r\n\r\nexport type ErrorUnknown = {\r\n code: 'unknown';\r\n data: { message: string };\r\n};\r\nexport function errorUnkown(message: string): ErrorUnknown {\r\n return {\r\n code: 'unknown',\r\n data: { message },\r\n };\r\n}\r\n\r\nexport type SuccessType<T> = T extends Result<infer S, any> ? S : never;\r\nexport type ErrorType<T> = T extends Result<any, infer E> ? E : never;\r\n\r\nexport type SuccessVoid = never;\r\n\r\nexport function resultSuccessVoid(): Result<SuccessVoid, never> {\r\n return new ResultSuccessImp<SuccessVoid>(undefined as never);\r\n}\r\n\r\nexport function resultSuccess<TSuccess1>(\r\n value: TSuccess1,\r\n): Result<TSuccess1, never> {\r\n return new ResultSuccessImp<TSuccess1>(value);\r\n}\r\n\r\ntype EnforceLiteral<T> = string extends T ? never : T;\r\n\r\nexport class resultError {\r\n public static unknown(message: string): Result<never, ErrorUnknown> {\r\n return new ResultErrorImp<ErrorUnknown>(errorUnkown(message));\r\n }\r\n public static withCode<TCode, TData = object>(\r\n code: EnforceLiteral<TCode>,\r\n data: TData = {} as TData,\r\n ): Result<never, ErrorWithCode<TCode, TData>> {\r\n return new ResultErrorImp<ErrorWithCode<TCode, TData>>(\r\n errorWithCode(code, data),\r\n );\r\n }\r\n public static fromError<\r\n
|
|
1
|
+
{"version":3,"sources":["../src/result.ts","../src/result-functions.ts"],"sourcesContent":["export interface Result<TSuccess1, TError1> {\r\n andThen<TResult extends Result<any, any>>(\r\n f: (value: TSuccess1) => TResult,\r\n ): Result<SuccessType<TResult>, TError1 | ErrorType<TResult>>;\r\n andThenAsync<TResult extends Result<any, any>>(\r\n f: (value: TSuccess1) => Promise<TResult>,\r\n ): Promise<Result<SuccessType<TResult>, TError1 | ErrorType<TResult>>>;\r\n catchError<TResult extends Result<any, any>>(\r\n f: (error: TError1) => TResult,\r\n ): Result<TSuccess1 | SuccessType<TResult>, ErrorType<TResult>>;\r\n catchErrorAsync<TResult extends Result<any, any>>(\r\n f: (error: TError1) => Promise<TResult>,\r\n ): Promise<Result<TSuccess1 | SuccessType<TResult>, ErrorType<TResult>>>;\r\n unwrapOrThrow(errorCallback?: (e: TError1) => void): TSuccess1;\r\n}\r\n\r\nexport function unwrapSuccessResult<T>(result: Result<T, never>): T {\r\n if (result instanceof ResultSuccessImp) {\r\n return result['value'];\r\n }\r\n throw new Error('Unreachable code. Result is an error');\r\n}\r\n\r\nexport type ErrorWithCode<TCode, TData = object> = { code: TCode; data: TData };\r\nexport function errorWithCode<TCode, TData>(\r\n code: TCode,\r\n data: TData,\r\n): ErrorWithCode<TCode, TData> {\r\n return {\r\n code,\r\n data,\r\n };\r\n}\r\n\r\nexport type ErrorUnknown = {\r\n code: 'unknown';\r\n data: { message: string };\r\n};\r\nexport function errorUnkown(message: string): ErrorUnknown {\r\n return {\r\n code: 'unknown',\r\n data: { message },\r\n };\r\n}\r\n\r\nexport type SuccessType<T> = T extends Result<infer S, any> ? S : never;\r\nexport type ErrorType<T> = T extends Result<any, infer E> ? E : never;\r\n\r\nexport type SuccessVoid = never;\r\n\r\nexport function resultSuccessVoid(): Result<SuccessVoid, never> {\r\n return new ResultSuccessImp<SuccessVoid>(undefined as never);\r\n}\r\n\r\nexport function resultSuccess<TSuccess1>(\r\n value: TSuccess1,\r\n): Result<TSuccess1, never> {\r\n return new ResultSuccessImp<TSuccess1>(value);\r\n}\r\n\r\ntype EnforceLiteral<T> = string extends T ? never : T;\r\n\r\nexport class resultError {\r\n public static unknown(message: string): Result<never, ErrorUnknown> {\r\n return new ResultErrorImp<ErrorUnknown>(errorUnkown(message));\r\n }\r\n public static withCode<TCode, TData = object>(\r\n code: EnforceLiteral<TCode>,\r\n data: TData = {} as TData,\r\n ): Result<never, ErrorWithCode<TCode, TData>> {\r\n return new ResultErrorImp<ErrorWithCode<TCode, TData>>(\r\n errorWithCode(code, data),\r\n );\r\n }\r\n public static fromError<\r\n TError1 extends ErrorWithCode<any, object>,\r\n >(error: TError1): Result<never, TError1> {\r\n return new ResultErrorImp<TError1>(error);\r\n }\r\n}\r\n\r\nclass ResultSuccessImp<TSuccess1> implements Result<TSuccess1, never> {\r\n constructor(private value: TSuccess1) {}\r\n\r\n public andThen<TSuccess2, TError2>(\r\n f: (value: TSuccess1) => Result<TSuccess2, TError2>,\r\n ): Result<TSuccess2, TError2> {\r\n return f(this.value);\r\n }\r\n\r\n public async andThenAsync<TSuccess2, TError2>(\r\n f: (value: TSuccess1) => Promise<Result<TSuccess2, TError2>>,\r\n ): Promise<Result<TSuccess2, TError2>> {\r\n return await f(this.value);\r\n }\r\n\r\n public catchError<TSuccess2, TError2>(\r\n _f: (error: never) => Result<TSuccess2, TError2>,\r\n ): Result<TSuccess1 | TSuccess2, TError2> {\r\n return this;\r\n }\r\n\r\n public async catchErrorAsync<TSuccess2, TError2>(\r\n _f: (error: never) => Promise<Result<TSuccess2, TError2>>,\r\n ): Promise<Result<TSuccess1 | TSuccess2, TError2>> {\r\n return this;\r\n }\r\n\r\n public unwrapOrThrow(_errorCallback?: (e: never) => void): TSuccess1 {\r\n return this.value;\r\n }\r\n}\r\n\r\nclass ResultErrorImp<TError1> implements Result<never, TError1> {\r\n constructor(private error: TError1) {}\r\n\r\n public andThen<TSuccess2, TError2>(\r\n _f: (value: never) => Result<TSuccess2, TError2>,\r\n ): Result<TSuccess2, TError1 | TError2> {\r\n return this;\r\n }\r\n\r\n public async andThenAsync<TSuccess2, TError2>(\r\n _f: (value: never) => Promise<Result<TSuccess2, TError2>>,\r\n ): Promise<Result<TSuccess2, TError1 | TError2>> {\r\n return this;\r\n }\r\n\r\n public catchError<TSuccess2, TError2>(\r\n f: (error: TError1) => Result<TSuccess2, TError2>,\r\n ): Result<TSuccess2, TError2> {\r\n return f(this.error);\r\n }\r\n\r\n public async catchErrorAsync<TSuccess2, TError2>(\r\n f: (error: TError1) => Promise<Result<TSuccess2, TError2>>,\r\n ): Promise<Result<TSuccess2, TError2>> {\r\n return await f(this.error);\r\n }\r\n\r\n public unwrapOrThrow(errorCallback?: (e: TError1) => void): never {\r\n if (errorCallback !== undefined) {\r\n errorCallback(this.error);\r\n }\r\n throw this.error;\r\n }\r\n}\r\n\r\nexport type UnwrapErrorFromResult<T> =\r\n T extends Result<any, infer U> ? U : never;\r\n\r\nexport function makeSafePromise<T>(\r\n promise: Promise<T>,\r\n): Promise<Result<T, ErrorUnknown>> {\r\n return promise\r\n .then((value) => resultSuccess(value))\r\n .catch((error) => resultError.unknown(error.message));\r\n}","import { ErrorType, Result, SuccessType } from \"./result\";\r\n\r\nexport function andThen<TSuccess, TError, TResult extends Result<any, any>>(\r\n callback: (value: TSuccess) => TResult\r\n): (\r\n result: Result<TSuccess, TError>\r\n) => Result<SuccessType<TResult>, TError | ErrorType<TResult>> {\r\n return (result) => result.andThen(callback);\r\n}\r\n\r\nexport function andThenAsync<\r\n TSuccess,\r\n TError,\r\n TResult extends Result<any, any>\r\n>(\r\n callback: (value: TSuccess) => Promise<TResult>\r\n): (\r\n result: Result<TSuccess, TError>\r\n) => Promise<Result<SuccessType<TResult>, TError | ErrorType<TResult>>> {\r\n return (result) => result.andThenAsync(callback);\r\n}\r\n\r\nexport function catchError<TSuccess, TError, TResult extends Result<any, any>>(\r\n callback: (error: TError) => TResult\r\n): (\r\n result: Result<TSuccess, TError>\r\n) => Result<TSuccess | SuccessType<TResult>, ErrorType<TResult>> {\r\n return (result) => result.catchError(callback);\r\n}\r\n\r\nexport function catchErrorAsync<\r\n TSuccess,\r\n TError,\r\n TResult extends Result<any, any>\r\n>(\r\n callback: (error: TError) => Promise<TResult>\r\n): (\r\n result: Result<TSuccess, TError>\r\n) => Promise<Result<TSuccess | SuccessType<TResult>, ErrorType<TResult>>> {\r\n return (result) => result.catchErrorAsync(callback);\r\n}\r\n"],"mappings":";AAgBO,SAAS,oBAAuB,QAA6B;AAClE,MAAI,kBAAkB,kBAAkB;AACtC,WAAO,OAAO,OAAO;AAAA,EACvB;AACA,QAAM,IAAI,MAAM,sCAAsC;AACxD;AAGO,SAAS,cACd,MACA,MAC6B;AAC7B,SAAO;AAAA,IACL;AAAA,IACA;AAAA,EACF;AACF;AAMO,SAAS,YAAY,SAA+B;AACzD,SAAO;AAAA,IACL,MAAM;AAAA,IACN,MAAM,EAAE,QAAQ;AAAA,EAClB;AACF;AAOO,SAAS,oBAAgD;AAC9D,SAAO,IAAI,iBAA8B,MAAkB;AAC7D;AAEO,SAAS,cACd,OAC0B;AAC1B,SAAO,IAAI,iBAA4B,KAAK;AAC9C;AAIO,IAAM,cAAN,MAAkB;AAAA,EACvB,OAAc,QAAQ,SAA8C;AAClE,WAAO,IAAI,eAA6B,YAAY,OAAO,CAAC;AAAA,EAC9D;AAAA,EACA,OAAc,SACZ,MACA,OAAc,CAAC,GAC6B;AAC5C,WAAO,IAAI;AAAA,MACT,cAAc,MAAM,IAAI;AAAA,IAC1B;AAAA,EACF;AAAA,EACA,OAAc,UAEZ,OAAwC;AACxC,WAAO,IAAI,eAAwB,KAAK;AAAA,EAC1C;AACF;AAEA,IAAM,mBAAN,MAAsE;AAAA,EACpE,YAAoB,OAAkB;AAAlB;AAAA,EAAmB;AAAA,EAEhC,QACL,GAC4B;AAC5B,WAAO,EAAE,KAAK,KAAK;AAAA,EACrB;AAAA,EAEA,MAAa,aACX,GACqC;AACrC,WAAO,MAAM,EAAE,KAAK,KAAK;AAAA,EAC3B;AAAA,EAEO,WACL,IACwC;AACxC,WAAO;AAAA,EACT;AAAA,EAEA,MAAa,gBACX,IACiD;AACjD,WAAO;AAAA,EACT;AAAA,EAEO,cAAc,gBAAgD;AACnE,WAAO,KAAK;AAAA,EACd;AACF;AAEA,IAAM,iBAAN,MAAgE;AAAA,EAC9D,YAAoB,OAAgB;AAAhB;AAAA,EAAiB;AAAA,EAE9B,QACL,IACsC;AACtC,WAAO;AAAA,EACT;AAAA,EAEA,MAAa,aACX,IAC+C;AAC/C,WAAO;AAAA,EACT;AAAA,EAEO,WACL,GAC4B;AAC5B,WAAO,EAAE,KAAK,KAAK;AAAA,EACrB;AAAA,EAEA,MAAa,gBACX,GACqC;AACrC,WAAO,MAAM,EAAE,KAAK,KAAK;AAAA,EAC3B;AAAA,EAEO,cAAc,eAA6C;AAChE,QAAI,kBAAkB,QAAW;AAC/B,oBAAc,KAAK,KAAK;AAAA,IAC1B;AACA,UAAM,KAAK;AAAA,EACb;AACF;AAKO,SAAS,gBACd,SACkC;AAClC,SAAO,QACJ,KAAK,CAAC,UAAU,cAAc,KAAK,CAAC,EACpC,MAAM,CAAC,UAAU,YAAY,QAAQ,MAAM,OAAO,CAAC;AACxD;;;AC3JO,SAAS,QACd,UAG6D;AAC7D,SAAO,CAAC,WAAW,OAAO,QAAQ,QAAQ;AAC5C;AAEO,SAAS,aAKd,UAGsE;AACtE,SAAO,CAAC,WAAW,OAAO,aAAa,QAAQ;AACjD;AAEO,SAAS,WACd,UAG+D;AAC/D,SAAO,CAAC,WAAW,OAAO,WAAW,QAAQ;AAC/C;AAEO,SAAS,gBAKd,UAGwE;AACxE,SAAO,CAAC,WAAW,OAAO,gBAAgB,QAAQ;AACpD;","names":[]}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@j2blasco/ts-result",
|
|
3
|
-
"version": "0.1.
|
|
3
|
+
"version": "0.1.4",
|
|
4
4
|
"description": "Result Monad for TypeScript",
|
|
5
5
|
"author": "j2blasco",
|
|
6
6
|
"license": "MIT",
|
|
@@ -33,14 +33,14 @@
|
|
|
33
33
|
"LICENSE"
|
|
34
34
|
],
|
|
35
35
|
"scripts": {
|
|
36
|
-
"build": "npm run clean && tsup
|
|
36
|
+
"build": "npm run clean && tsup",
|
|
37
37
|
"clean": "shx rm -rf dist",
|
|
38
38
|
"prepublishOnly": "npm run build",
|
|
39
39
|
"test": "jest"
|
|
40
40
|
},
|
|
41
41
|
"type": "module",
|
|
42
42
|
"devDependencies": {
|
|
43
|
-
"@j2blasco/ts-pipe": "^0.0.
|
|
43
|
+
"@j2blasco/ts-pipe": "^0.0.8",
|
|
44
44
|
"@types/jest": "^29.5.14",
|
|
45
45
|
"jest": "^29.7.0",
|
|
46
46
|
"shx": "^0.4.0",
|