-
Notifications
You must be signed in to change notification settings - Fork 0
/
spec.ts
84 lines (72 loc) · 1.67 KB
/
spec.ts
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
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
// Copyright © 2023 Tomoki Miyauchi. All rights reserved. MIT license.
// This module is browser compatible.
/** The result type. */
export enum ResultType {
Ok,
Err,
}
/** Common type. */
interface Container {
/** {@linkcode Result} type. */
get type(): ResultType;
/** Return contained value. */
get get(): unknown;
}
/** The {@linkcode Err} API. */
export interface Err<E> extends Container {
get type(): ResultType.Err;
get get(): E;
}
/** The {@linkcode Ok} API. */
export interface Ok<T> extends Container {
get type(): ResultType.Ok;
get get(): T;
}
/** {@linkcode Ok} constructor. */
export interface OkConstructor {
/** {@linkcode Ok} value of type {@linkcode T} . */
<const T>(value: T): Ok<T>;
}
/** {@linkcode Err} constructor. */
export interface ErrConstructor {
/** {@linkcode Err} value of type {@linkcode E} . */
<const E>(value: E): Err<E>;
}
/** {@linkcode Ok} constructor.
*
* @example
* ```ts
* import { Ok } from "https://deno.land/x/result_js/spec.ts";
* const ok = Ok(0);
* ```
*/
export const Ok: OkConstructor = function Ok<T>(value: T): Ok<T> {
return {
get type(): ResultType.Ok {
return ResultType.Ok;
},
get get(): T {
return value;
},
};
};
/** {@linkcode Err} constructor.
*
* @example
* ```ts
* import { Err } from "https://deno.land/x/result_js/spec.ts";
* const err = Err(0);
* ```
*/
export const Err: ErrConstructor = function Err<E>(value: E): Err<E> {
return {
get type(): ResultType.Err {
return ResultType.Err;
},
get get(): E {
return value;
},
};
};
/** Representation of {@linkcode Ok} or {@linkcode Err}. */
export type Result<T, E> = Ok<T> | Err<E>;