OINO TS
    Preparing search index...

    Class OINOResult

    OINO API request result object with returned data and/or http status code/message and error / warning messages.

    Hierarchy (View Summary)

    Index

    Constructors

    Properties

    messages: string[]

    Error / warning messages

    statusCode: number

    HTTP status code

    statusMessage: string

    HTTP status message

    success: boolean

    Wheter request was successfully executed

    Methods

    • Add debug message. Returns self reference for chaining.

      Parameters

      • message: string

        HTTP status message

      • operation: string

        operation where debug occured

      Returns OINOResult

    • Add info message. Returns self reference for chaining.

      Parameters

      • message: string

        HTTP status message

      • operation: string

        operation where info occured

      Returns OINOResult

    • Add warning message. Returns self reference for chaining.

      Parameters

      • message: string

        HTTP status message

      • operation: string

        operation where warning occured

      Returns OINOResult

    • 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

    • Get a Response object from the result values.

      Parameters

      • Optionalheaders: Record<string, string>

        HTTP headers (overrides existing values)

      Returns Response

    • 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