Class OnmsResult<T>

constructor

• new OnmsResult<T>(data, message?, code?, type?): OnmsResult<T>

• Construct a new result.

  Type Parameters

  • T

  Parameters

  • data: T

    The payload of the response.
  • Optional message: string

    The status message associated with the result.
  • Optional code: number

    The response code of the response.
  • Optional type: string

    The request type of the response.

  Returns OnmsResult<T>

Optional Readonly code

Readonly data

Optional Readonly message

Optional Readonly type

isSuccess

• isSuccess(): boolean

• Whether this result is considered successful.

  Returns boolean

Static noContent

• noContent(): OnmsResult<any>

• Create a new "No Content" result.

  Returns OnmsResult<any>

Static ok

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

• Create a new success result.

  Parameters

  • response: any
  • Optional message: string
  • Optional code: number
  • Optional type: string

  Returns OnmsResult<any>