UNPKG

@cprussin/option-result

Version:

Yet another Typescript clone of the rust `Option` & `Result` enums.

www.cprussin.net/modules/_cprussin_option-result.html

cprussin/cprussin-monorepo

46 lines (24 loc) • 886 B
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
[**@cprussin/option-result v2.0.1**](../README.md) *** # Function: Err() > **Err**\<`T`, `E`\>(`error`): [`Result`](../classes/Result.md)\<`T`, `E`\> Defined in: [result.ts:598](https://github.com/cprussin/cprussin-monorepo/blob/45be92bc13a41d9f46c6ab9ed2d9a61167827e46/packages/option-result/src/result.ts#L598) Construct a [Result](../classes/Result.md) containing an error value. ## Type Parameters ### T `T` *extends* `object` the type of success values ### E `E` *extends* `object` the type of the error value ## Parameters ### error `E` the error contained by the [Result](../classes/Result.md) ## Returns [`Result`](../classes/Result.md)\<`T`, `E`\> a [Result](../classes/Result.md) containing an error `error` ## See - [Result.Ok](../classes/Result.md#ok-2) - [Result.wrap](../classes/Result.md#wrap) - [Result.wrapAsync](../classes/Result.md#wrapasync)