Class: Result<T, E>
Type parameters
| Name | Type |
|---|---|
T | T |
E | extends Error = Error |
Constructors
constructor
• new Result<T, E>(success, value?, error?): Result<T, E>
Type parameters
| Name | Type |
|---|---|
T | T |
E | extends Error = Error |
Parameters
| Name | Type |
|---|---|
success | boolean |
value? | T |
error? | E |
Returns
Result<T, E>
Defined in
projects/shapeshift/src/lib/Result.ts:6
Properties
error
• Optional Readonly error: E
Defined in
projects/shapeshift/src/lib/Result.ts:4
success
• Readonly success: boolean
Defined in
projects/shapeshift/src/lib/Result.ts:2
value
• Optional Readonly value: T
Defined in
projects/shapeshift/src/lib/Result.ts:3
Methods
isErr
▸ isErr(): this is Object
Returns
this is Object
Defined in
projects/shapeshift/src/lib/Result.ts:19
isOk
▸ isOk(): this is Object
Returns
this is Object
Defined in
projects/shapeshift/src/lib/Result.ts:15
unwrap
▸ unwrap(): T
Returns
T
Defined in
projects/shapeshift/src/lib/Result.ts:23
err
▸ err<T, E>(error): Result<T, E>
Type parameters
| Name | Type |
|---|---|
T | T |
E | extends Error = Error |
Parameters
| Name | Type |
|---|---|
error | E |
Returns
Result<T, E>
Defined in
projects/shapeshift/src/lib/Result.ts:32
ok
▸ ok<T, E>(value): Result<T, E>
Type parameters
| Name | Type |
|---|---|
T | T |
E | extends Error = Error |
Parameters
| Name | Type |
|---|---|
value | T |
Returns
Result<T, E>