Module: "result"
Index
Classes
Interfaces
Type aliases
Variables
Functions
Type aliases
Result
Ƭ Result: OkResult‹TResult› | ErrorResult‹TError›
Defined in packages/sdk/base/src/result.ts:10
Variables
Const JSONParseErrorType
• JSONParseErrorType: "JsonParseError" = "JsonParseError"
Defined in packages/sdk/base/src/result.ts:77
Functions
Const Err
▸ Err<TError>(error: TError): ErrorResult‹TError›
Defined in packages/sdk/base/src/result.ts:16
Type parameters:
▪ TError: Error
Parameters:
| Name | Type |
|---|---|
error |
TError |
Returns: ErrorResult‹TError›
Const Ok
▸ Ok<TResult>(result: TResult): OkResult‹TResult›
Defined in packages/sdk/base/src/result.ts:12
Type parameters:
▪ TResult
Parameters:
| Name | Type |
|---|---|
result |
TResult |
Returns: OkResult‹TResult›
isErr
▸ isErr<TResult, TError>(result: Result‹TResult, TError›): result is ErrorResult
Defined in packages/sdk/base/src/result.ts:98
Type parameters:
▪ TResult
▪ TError: Error
Parameters:
| Name | Type |
|---|---|
result |
Result‹TResult, TError› |
Returns: result is ErrorResult
isOk
▸ isOk<TResult, TError>(result: Result‹TResult, TError›): result is OkResult
Defined in packages/sdk/base/src/result.ts:92
Type parameters:
▪ TResult
▪ TError: Error
Parameters:
| Name | Type |
|---|---|
result |
Result‹TResult, TError› |
Returns: result is OkResult
makeAsyncThrowable
▸ makeAsyncThrowable<TArgs, TResult, TError, TModifiedError>(f: function, errorModifier?: undefined | function): (Anonymous function)
Defined in packages/sdk/base/src/result.ts:47
Type parameters:
▪ TArgs: any[]
▪ TResult
▪ TError: Error
▪ TModifiedError: Error
Parameters:
▪ f: function
▸ (...args: TArgs): Promise‹Result‹TResult, TError››
Parameters:
| Name | Type |
|---|---|
...args |
TArgs |
▪Optional errorModifier: undefined | function
Returns: (Anonymous function)
makeThrowable
▸ makeThrowable<TArgs, TResult, TError, TModifiedError>(f: function, errorModifier?: undefined | function): (Anonymous function)
Defined in packages/sdk/base/src/result.ts:35
Type parameters:
▪ TArgs: any[]
▪ TResult
▪ TError: Error
▪ TModifiedError: Error
Parameters:
▪ f: function
▸ (...args: TArgs): Result‹TResult, TError›
Parameters:
| Name | Type |
|---|---|
...args |
TArgs |
▪Optional errorModifier: undefined | function
Returns: (Anonymous function)
parseJsonAsResult
▸ parseJsonAsResult(data: string): OkResult‹any› | ErrorResult‹JSONParseError‹››
Defined in packages/sdk/base/src/result.ts:84
Parameters:
| Name | Type |
|---|---|
data |
string |
Returns: OkResult‹any› | ErrorResult‹JSONParseError‹››
throwIfError
▸ throwIfError<TResult, TError, TModifiedError>(result: Result‹TResult, TError›, errorModifier?: undefined | function): TResult
Defined in packages/sdk/base/src/result.ts:21
Type parameters:
▪ TResult
▪ TError: Error
▪ TModifiedError: Error
Parameters:
| Name | Type |
|---|---|
result |
Result‹TResult, TError› |
errorModifier? |
undefined | function |
Returns: TResult