Class OnmsResult<T>

An [[IOnmsHTTP]] query result.

Type Parameters

T

Index

Constructors

Properties

code? data message? type?

Methods

isSuccess noContent ok

Constructors

constructor

new OnmsResult<T>(
    data: T,
    message?: string,
    code?: number,
    type?: string,
): API.OnmsResult<T>
Construct a new result.
Type Parameters
- T
Parameters
- data: T
  The payload of the response.
- Optionalmessage: string
  The status message associated with the result.
- Optionalcode: number
  The response code of the response.
- Optionaltype: string
  The request type of the response.
Returns API.OnmsResult<T>
- Defined in src/api/OnmsResult.ts:36

Properties

`Optional` `Readonly`code

code?: number

The response code associated with this result.

`Readonly`data

data: T

The data, if any.

`Optional` `Readonly`message

message?: string

The status message associated with this result.

`Optional` `Readonly`type

type?: string

The request type, if any.

Methods

isSuccess

isSuccess(): boolean
Whether this result is considered successful.

Returns boolean
- Defined in src/api/OnmsResult.ts:44

`Static`noContent

noContent(): API.OnmsResult<any>
Create a new "No Content" result.

Returns API.OnmsResult<any>
- Defined in src/api/OnmsResult.ts:12

`Static`ok

ok(
    response: any,
    message?: string,
    code?: number,
    type?: string,
): API.OnmsResult<any>
Create a new success result.
Parameters
- response: any
- Optionalmessage: string
- Optionalcode: number
- Optionaltype: string
Returns API.OnmsResult<any>
- Defined in src/api/OnmsResult.ts:7