OINO TS
    Preparing search index...

    Class OINOHttpResult

    Specialized result for HTTP responses.

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    body expires headers lastModified messages status statusText success

    Methods

    addDebug addInfo addWarning bodyAsBuffer bodyAsFormData bodyAsParsedJson bodyAsText copy copyMessagesToHeaders getEtag getFetchResponse printLog setError setOk fromFetchResponse

    Constructors

    Properties

    Readonlybody

    body: string | Buffer<ArrayBufferLike>

    HTTP body data

    expires: number

    HTTP cache expiration value Note: default 0 means no expiration and 'Pragma: no-cache' is set.

    headers: OINOHeaders

    HTTP headers

    lastModified: number

    HTTP cache last-modified value

    messages: string[]

    Error / warning messages

    status: number

    HTTP status code

    statusText: string

    HTTP status message

    success: boolean

    Wheter request was successfully executed

    Methods

    • Returns the request body as URLSearchParams (form body).

      Returns URLSearchParams

    • Copy given messages to HTTP headers.

      Parameters

      • headers: OINOHeaders

        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

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

      Returns string

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

      Parameters

      • status: number

        HTTP status code

      • statusText: string

        HTTP status message

      • operation: string

        operation where error occured

      Returns OINOResult

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods