Interface BooleanResponse

Response from a http request. Acts & can be used like a boolean including the data

Hierarchy

Properties

$res clientError data errorMsg? headers knorryError serverError status statusText successful

Methods

$plain valueOf

Properties

$res

$res: KnorryResponseObj

This will include the complete response without pretending to be a different type

clientError

clientError: boolean

Will be true if status code is between 400 and 499

data

data: string | JSONData

The body of the response

Optional errorMsg

errorMsg?: string

If an error occured, this will be the error message

headers

headers: {
    cache-control?: string;
    content-length?: string;
    content-type?: string;
    date?: string;
    server?: string;
    [key: string]: string | undefined;
}

Response headers in lowercase

Type declaration

  • [key: string]: string | undefined
  • Optional cache-control?: string
  • Optional content-length?: string
  • Optional content-type?: string
  • Optional date?: string
  • Optional server?: string

knorryError

knorryError: boolean

Specifies if there was an error produced by the client (knorry)

serverError

serverError: boolean

Will be true if status code is between 500 and 599

status

status: number

statusText

statusText: string

successful

successful: boolean

Represents wether the status code indicates that the request was successful or not. NOTE: This won't always be true if a knorryError occured

Methods

$plain

  • $plain(): boolean

  • Returns the plain response so the typeof operator works again

    Returns boolean

valueOf

  • Returns the primitive value of the specified object.

    Returns boolean

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc