Class NCResult<T>

Result wrapper for API calls

Type Parameters

T = void

Hierarchy

NCResult

Index

Properties

Methods

Properties

Readonly isOk

isOk: boolean

Whether the operation succeeded, equivalent to code === 0

Readonly code

code: number

Status code

Readonly msg

msg: string

Error message

Optional Readonly data

data?: T

Response data

Methods

Static from

from<T>(code: number, msg?: string, data?: T): NCResult<T>

Type Parameters
- T = void
Parameters
- code: number
- Optional msg: string
- Optional data: T
Returns NCResult<T>

Static ok

ok<T>(data?: T, desc?: string): NCResult<T>

Type Parameters
- T
Parameters
- Optional data: T
- Optional desc: string
Returns NCResult<T>

Static fail

fail<T>(code: number, desc?: string, data?: T): NCResult<T>

Type Parameters
- T
Parameters
- code: number
- Optional desc: string
- Optional data: T
Returns NCResult<T>