Class TwitarrResult<T>

An ITwitarrHTTP query result.

Type parameters

T

Hierarchy

TwitarrResult

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

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

- Defined in api/TwitarrResult.ts:32
Construct a new result.

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 TwitarrResult

Properties

code

code: number

The response code associated with this result.

data

data: T

The data, if any.

error

error: TwitarrError

The error associated with this response 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/TwitarrResult.ts:60
Whether this result is considered successful.

Returns boolean

Static noContent

noContent(): TwitarrResult<any>

- Defined in api/TwitarrResult.ts:14
Create a new "No Content" result.

Returns TwitarrResult<any>

Static ok

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

- Defined in api/TwitarrResult.ts:9
Create a new success result.

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

Generated using TypeDoc