Class Response

Response Class

Constructors

constructor

Properties

hash raw

Methods

addColumn addRecord getCode getColumn getColumnIndex getColumnKeys getColumns getCommand getCommandPlain getCurrentPageNumber getCurrentRecord getDescription getFirstRecordIndex getHash getLastRecordIndex getListHash getNextPageNumber getNextRecord getNumberOfPages getPagination getPlain getPreviousPageNumber getPreviousRecord getQueuetime getRecord getRecords getRecordsCount getRecordsLimitation getRecordsTotalCount getRuntime hasNextPage hasPreviousPage isError isPending isSuccess isTmpError rewindRecordList

Constructors

constructor

  • new Response(raw, cmd?, ph?): Response

  • Constructor

    Parameters

    • raw: string

      API plain response

    • cmd: any = {}

      API command used within this request

    • ph: any = {}

      placeholder array to get vars in response description dynamically replaced

    Returns Response

Properties

Protectedhash

hash: any

hash representation of plain API response

Protectedraw

raw: string

plain API response

Methods

addColumn

  • addColumn(key, data): Response

  • Add a column to the column list

    Parameters

    • key: string

      column name

    • data: string[]

      array of column data

    Returns Response

    Current Response Instance for method chaining

addRecord

  • addRecord(h): Response

  • Add a record to the record list

    Parameters

    • h: any

      row hash data

    Returns Response

    Current Response Instance for method chaining

getCode

  • getCode(): number

  • Get API response code

    Returns number

    API response code

getColumn

  • getColumn(key): null | Column

  • Get column by column name

    Parameters

    • key: string

      column name

    Returns null | Column

    column instance or null if column does not exist

getColumnIndex

  • getColumnIndex(colkey, index): null | string

  • Get Data by Column Name and Index

    Parameters

    • colkey: string

      column name

    • index: number

      column data index

    Returns null | string

    column data at index or null if not found

getColumnKeys

  • getColumnKeys(): string[]

  • Get Column Names

    Returns string[]

    Array of Column Names

getColumns

getCommand

  • getCommand(): any

  • Get Command used in this request

    Returns any

    command

getCommandPlain

  • getCommandPlain(): string

  • Get Command used in this request in plain text format

    Returns string

    command as plain text

getCurrentPageNumber

  • getCurrentPageNumber(): null | number

  • Get Page Number of current List Query

    Returns null | number

    page number or null in case of a non-list response

getCurrentRecord

  • getCurrentRecord(): null | Record

  • Get Record of current record index

    Returns null | Record

    Record or null in case of a non-list response

getDescription

  • getDescription(): string

  • Get API response description

    Returns string

    API response description

getFirstRecordIndex

  • getFirstRecordIndex(): null | number

  • Get Index of first row in this response

    Returns null | number

    first row index

getHash

  • getHash(): any

  • Get API response as Hash

    Returns any

    API response hash

getLastRecordIndex

  • getLastRecordIndex(): null | number

  • Get last record index of the current list query

    Returns null | number

    record index or null for a non-list response

getListHash

  • getListHash(): any

  • Get Response as List Hash including useful meta data for tables

    Returns any

    hash including list meta data and array of rows in hash notation

getNextPageNumber

  • getNextPageNumber(): null | number

  • Get Page Number of next list query

    Returns null | number

    page number or null if there's no next page

getNextRecord

  • getNextRecord(): null | Record

  • Get next record in record list

    Returns null | Record

    Record or null in case there's no further record

getNumberOfPages

  • getNumberOfPages(): number

  • Get the number of pages available for this list query

    Returns number

    number of pages

getPagination

  • getPagination(): any

  • Get object containing all paging data

    Returns any

    paginator data

getPlain

  • getPlain(): string

  • Get Plain API response

    Returns string

    Plain API response

getPreviousPageNumber

  • getPreviousPageNumber(): null | number

  • Get Page Number of previous list query

    Returns null | number

    page number or null if there's no previous page

getPreviousRecord

  • getPreviousRecord(): null | Record

  • Get previous record in record list

    Returns null | Record

    Record or null if there's no previous record

getQueuetime

  • getQueuetime(): number

  • Get Queuetime of API response

    Returns number

    Queuetime of API response

getRecord

  • getRecord(idx): null | Record

  • Get Record at given index

    Parameters

    • idx: number

      record index

    Returns null | Record

    Record or null if index does not exist

getRecords

getRecordsCount

  • getRecordsCount(): number

  • Get count of rows in this response

    Returns number

    count of rows

getRecordsLimitation

  • getRecordsLimitation(): number

  • Get limit(ation) setting of the current list query This is the count of requested rows

    Returns number

    limit setting or count requested rows

getRecordsTotalCount

  • getRecordsTotalCount(): number

  • Get total count of records available for the list query

    Returns number

    total count of records or count of records for a non-list response

getRuntime

  • getRuntime(): number

  • Get Runtime of API response

    Returns number

    Runtime of API response

hasNextPage

  • hasNextPage(): boolean

  • Check if this list query has a next page

    Returns boolean

    boolean result

hasPreviousPage

  • hasPreviousPage(): boolean

  • Check if this list query has a previous page

    Returns boolean

    boolean result

isError

  • isError(): boolean

  • Check if current API response represents an error case API response code is an 5xx code

    Returns boolean

    boolean result

isPending

  • isPending(): boolean

  • Check if current operation is returned as pending

    Returns boolean

    boolean result

isSuccess

  • isSuccess(): boolean

  • Check if current API response represents a success case API response code is an 2xx code

    Returns boolean

    boolean result

isTmpError

  • isTmpError(): boolean

  • Check if current API response represents a temporary error case API response code is an 4xx code

    Returns boolean

    boolean result

rewindRecordList

  • rewindRecordList(): Response

  • Reset index in record list back to zero

    Returns Response

    Current Response Instance for method chaining

Settings

Member Visibility

On This Page

Constructors
Properties
Methods