Class OINOHttpResult

Specialized result for HTTP responses.

Hierarchy (view full)

Constructors

constructor

Properties

body expires lastModified messages statusCode statusMessage success

Methods

addDebug addInfo addWarning copy copyMessagesToHeaders getEtag getHttpResponse getStatusResponse printLog setError setOk

Constructors

constructor

Properties

Readonly body

body: string

HTTP body data

expires

expires: number

HTTP cache expiration value

lastModified

lastModified: number

HTTP cache last-modified value

messages

messages: string[]

Error / warning messages

statusCode

statusCode: number

HTTP status code

statusMessage

statusMessage: string

HTTP status message

success

success: boolean

Wheter request was successfully executed

Methods

addDebug

addInfo

addWarning

copy

copyMessagesToHeaders

  • copyMessagesToHeaders(headers, copyErrors?, copyWarnings?, copyInfos?, copyDebug?): void

  • Copy given messages to HTTP headers.

    Parameters

    • headers: Headers

      HTTP headers

    • copyErrors: boolean = true

      wether error messages should be copied (default true)

    • copyWarnings: boolean = false

      wether warning messages should be copied (default false)

    • copyInfos: boolean = false

      wether info messages should be copied (default false)

    • copyDebug: boolean = false

      wether debug messages should be copied (default false)

    Returns void

getEtag

  • getEtag(): string

  • Get the ETag value for the body opportunistically, i.e. don't calculate until requested and reuse value.

    Returns string

getHttpResponse

  • getHttpResponse(headers?): Response

  • Get a Response object from the result values.

    Parameters

    • Optional headers: Record<string, string>

      HTTP headers (overrides existing values)

    Returns Response

getStatusResponse

printLog

setError

  • setError(statusCode, statusMessage, operation): OINOResult

  • Set HTTP error status using given code and message. Returns self reference for chaining.

    Parameters

    • statusCode: number

      HTTP status code

    • statusMessage: string

      HTTP status message

    • operation: string

      operation where error occured

    Returns OINOResult

setOk

Settings

Member Visibility

Theme

On This Page

constructorbodyexpireslastModifiedmessagesstatusCodestatusMessagesuccessaddDebugaddInfoaddWarningcopycopyMessagesToHeadersgetEtaggetHttpResponsegetStatusResponseprintLogsetErrorsetOk