Class ErrorInvocation

Represents a JMAP method-level error invocation.

This class encapsulates error responses from the JMAP server, providing a similar interface to Invocation, but with no dataType property. The error arguments are stored as a map and can be accessed via the arguments getter. The error type is available via the type getter.

Index

Constructors

constructor

Accessors

arguments id name type

Constructors

constructor

new ErrorInvocation(
args: JMAPResponseInvocationErrorArgs,
methodCallId?: symbol,
): ErrorInvocation
Construct a new ErrorInvocation.
Parameters
- args: JMAPResponseInvocationErrorArgs
  The error arguments, including the required type property.
- OptionalmethodCallId: symbol
  The unique symbol for this invocation (optional; a new symbol is generated if omitted).
Returns ErrorInvocation
- Defined in src/invocation/error-invocation.ts:21

Accessors

arguments

get arguments(): { [k: string]: JSONValue }
The error arguments as a plain object.

Returns { [k: string]: JSONValue }
- Defined in src/invocation/error-invocation.ts:31

id

get id(): symbol
The unique symbol identifier for this error invocation.

Returns symbol
- Defined in src/invocation/error-invocation.ts:36

name

get name(): "error"
The name of this invocation, always "error".

Returns "error"
- Defined in src/invocation/error-invocation.ts:26

type

get type(): HintedString<
    | "forbidden"
    | "serverUnavailable"
    | "serverFail"
    | "serverPartialFail"
    | "unknownMethod"
    | "invalidArguments"
    | "invalidResultReference"
    | "accountNotFound"
    | "accountNotSupportedByMethod"
    | "accountReadOnly"
    | "requestTooLarge"
    | "cannotCalculateChanges"
    | "stateMismatch"
    | "anchorNotFound"
    | "unsupportedSort"
    | "unsupportedFilter"
    | "tooManyChanges",
>
The error type string (e.g., "serverFail", "invalidArguments").

Returns HintedString<
    | "forbidden"
    | "serverUnavailable"
    | "serverFail"
    | "serverPartialFail"
    | "unknownMethod"
    | "invalidArguments"
    | "invalidResultReference"
    | "accountNotFound"
    | "accountNotSupportedByMethod"
    | "accountReadOnly"
    | "requestTooLarge"
    | "cannotCalculateChanges"
    | "stateMismatch"
    | "anchorNotFound"
    | "unsupportedSort"
    | "unsupportedFilter"
    | "tooManyChanges",
>
- Defined in src/invocation/error-invocation.ts:41

Class ErrorInvocation

Index

Constructors

Accessors

Constructors

constructor

Parameters

Returns ErrorInvocation

Accessors

arguments

Returns { [k: string]: JSONValue }

id

Returns symbol

name

Returns "error"

type

Settings

On This Page