bothy-sdk
    Preparing search index...

    Class GatewayOpError

    An error frame of the gateway for one op (docs/spec/04-sync-protocol.md 6.2).

    The status comes from PROBLEM_STATUS, 0 for an unknown code.

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    code correlationId current detail errors instance op operation reason ref retryAfterMs status title

    Methods

    toJSON

    Constructors

    • Creates the error.

      Parameters

      • op: string

        The op that failed.

      • code: string

        The problem code of the frame.

      • options: { detail?: string; ref?: string } = {}

        The optional detail and ref of the frame.

      Returns GatewayOpError

    Properties

    code: string

    The stable machine code as sent; may be a code this SDK does not know.

    correlationId: string | undefined

    The correlation ID for support.

    current: Readonly<Record<string, unknown>> | undefined

    The current resource of a conflict, as a raw object.

    detail: string | undefined

    The detail text; never part of the error message.

    errors: readonly {}[]

    Field errors of 400 validation_failed.

    instance: string | undefined

    The instance URI.

    op: string

    The op that failed.

    operation: string | undefined

    The operation that failed.

    reason: string | undefined

    The finer reason, for example expired.

    ref: string | undefined

    The ref the client sent with the op, if any.

    retryAfterMs: number | undefined

    The wait of Retry-After in milliseconds.

    status: number

    The HTTP status (0 for a gateway error frame of an unknown code).

    title: string

    The short title.

    Methods

    • Returns the members that are safe to log (no detail, no title, no current document).

      Returns Record<string, unknown>

      The name, status, code, reason, correlation ID and operation.

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods