Class OnmsResult<T>

Type parameters

T

Hierarchy

OnmsResult

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new OnmsResult(data: T, message?: string, code?: number, type?: string): OnmsResult

- Defined in api/OnmsResult.ts:34
construct a new result

Parameters
- data: T
- Optional message: string
  
  the status message
- Optional code: number
  
  the response code
- Optional type: string
Returns OnmsResult

Properties

code

code: number

the response code associated with this result

data

data: T

the data, if any

message

message: string

the status message associated with this result

type

type: string

the request type, if any

Methods

isSuccess

isSuccess(): boolean

- Defined in api/OnmsResult.ts:49
whether this response is a successful response

Returns boolean

Static error

error(message: string, code?: number): OnmsResult<any>

- Defined in api/OnmsResult.ts:9
create a new error result

Parameters
- message: string
- Optional code: number
Returns OnmsResult<any>

Static noContent

noContent(): OnmsResult<string>

- Defined in api/OnmsResult.ts:19
create a new "No Content" result

Returns OnmsResult<string>

Static ok

ok(response: any, message?: string, code?: number, type?: string): OnmsResult<any>

- Defined in api/OnmsResult.ts:14
create a new "OK" result

Parameters
- response: any
- Optional message: string
- Optional code: number
- Optional type: string
Returns OnmsResult<any>

Generated using TypeDoc