Class ApiResult<T>

Factory for IApiResult interface.

Type parameters

T: any = any

Hierarchy

ApiResult

Implements

IApiResult<T>

Index

Constructors

constructor

Properties

Methods

Constructors

Private constructor

new ApiResult<T>(success: boolean, data?: T, errors?: null | ApiErrors): ApiResult<T>

- Defined in src/api/index.ts:44
Type parameters
- T: unknown = any
Parameters
- success: boolean
- Optional data: T
- Optional errors: null | ApiErrors
Returns ApiResult<T>

Properties

Optional data

data: T

The data.

Optional errors

errors: null | ApiErrors

One or more errors.

success

success: boolean

Api call was successful or not.

Methods

toJSON

toJSON(): any

- Defined in src/api/index.ts:90
inheritdoc

Returns any

Static failed

failed<T>(errors: null | ApiErrors, data?: T): ApiResult<T>

- Defined in src/api/index.ts:72
Creates a new instance with 'success = false',

Type parameters
- T
Parameters
- errors: null | ApiErrors
  
  One or more errors (if defined).
- Optional data: T
Returns ApiResult<T>

The new instance.

Static success

success<T>(data?: T): ApiResult<T>

- Defined in src/api/index.ts:83
Creates a new instance with 'success = false',

Type parameters
- T
Parameters
- Optional data: T
Returns ApiResult<T>

The new instance.

Generated using TypeDoc