Class LoggerResult<T>

A "result" type that is used in conjuction with the LoggerError enum to describe and handle a possible error returned from the log functions.

Type Parameters

T

Hierarchy

LoggerResult

Index

Constructors

Properties

Methods

isErr isOk unwrap unwrapErr Err Ok

Constructors

`Private` constructor

new LoggerResult<T>(inner: T | LoggerError, message?: string): LoggerResult<T>
Type Parameters
- T
Parameters
- inner: T | LoggerError
- Optional message: string
Returns LoggerResult<T>
- Defined in lib/logger.ts:36

Properties

`Private` inner

inner: null | T | LoggerError = null

`Private` `Optional` message

message?: string

Methods

isErr

isErr(): boolean
Returns whether or not the inner value of this result type is LoggerError.

Returns boolean
- Defined in lib/logger.ts:98

isOk

isOk(): boolean
Returns whether or not the inner value of this result type is T.

Returns boolean
- Defined in lib/logger.ts:91

unwrap

unwrap(): null | T
Returns the T value if the inner value is expected to be T, otherwise return null.

Returns null | T
- Defined in lib/logger.ts:66

unwrapErr

unwrapErr(): null | {
error: LoggerError;
message: undefined | string;
}
Returns an object containing the inner data and the optional message if it is expected to be a LoggerError, otherwise return null.

Returns null | {
error: LoggerError;
message: undefined | string;
}
- Defined in lib/logger.ts:78

`Static` Err

Err<T>(error: LoggerError, message?: string): LoggerResult<T>
Create a new LoggerResult<T> that is guaranteed to have an inner data of LoggerError with an optional accompanying message string.
Type Parameters
- T
Parameters
- error: LoggerError
  
  The enum describes the reason behind the error.
- Optional message: string
  
  The optional message for additional context to the error.
Returns LoggerResult<T>
- Defined in lib/logger.ts:58

`Static` Ok

Ok<T>(data: T): LoggerResult<T>
Create a new LoggerResult<T> that is guaranteed to have an inner data of type T.
Type Parameters
- T
Parameters
- data: T
  
  The T data to insert into the inner value of this result type.
Returns LoggerResult<T>
- Defined in lib/logger.ts:47

Generated using TypeDoc