Class OnmsResult<T>

constructor

• new OnmsResult<T>(
      data: T,
      message?: string,
      code?: number,
      type?: string,
  ): 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 OnmsResult<T>

Optional Readonlycode

Readonlydata

Optional Readonlymessage

Optional Readonlytype

isSuccess

• isSuccess(): boolean

  Whether this result is considered successful.

  Returns boolean

StaticnoContent

• noContent(): OnmsResult<any>

  Create a new "No Content" result.

  Returns OnmsResult<any>

Staticok

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

  Create a new success result.

  Parameters

  • response: any
  • Optionalmessage: string
  • Optionalcode: number
  • Optionaltype: string

  Returns OnmsResult<any>