Class DcborComposeError

Thrown by composeDcborArray and composeDcborMap (and carried by the try… forms). A ParseError carries the item's DcborParseError as cause and in details.cause. Instances come from the static factories only.

Hierarchy

Error
- DcborComposeError

Index

Properties

name code details cause?

Methods

isDcborComposeError is oddMapLength duplicateMapKey parseError

Properties

`Readonly`name

name: "DcborComposeError"

Always "DcborComposeError"; the cross-copy identity DcborComposeError.isDcborComposeError checks.

`Readonly`code

code: DcborComposeErrorCode

The discriminant; equals details.code.

`Readonly`details

details: DcborComposeErrorDetails

The structured payload, discriminated by code.

`Optional` `Readonly`cause

cause?: DcborParseError

The item's error, for a ParseError.

Methods

`Static`isDcborComposeError

isDcborComposeError(
    value: unknown,
): value is
    | DcborComposeError & {
        code: "DuplicateMapKey";
        details: { code: "DuplicateMapKey" };
    }
    | DcborComposeError & {
        code: "OddMapLength";
        details: { code: "OddMapLength" };
    }
    | DcborComposeError & {
        code: "ParseError";
        details: { code: "ParseError"; cause: DcborParseError };
    }
Type guard for a DcborComposeError, including one from another copy of this package.
Parameters
- value: unknown
Returns value is
    | DcborComposeError & {
        code: "DuplicateMapKey";
        details: { code: "DuplicateMapKey" };
    }
    | DcborComposeError & {
        code: "OddMapLength";
        details: { code: "OddMapLength" };
    }
    | DcborComposeError & {
        code: "ParseError";
        details: { code: "ParseError"; cause: DcborParseError };
    }
- Defined in error.ts:544

is

is(code: DcborComposeErrorCode): boolean
true when code is this error's code.
Parameters
- code: DcborComposeErrorCode
Returns boolean
- Defined in error.ts:549

`Static`oddMapLength

oddMapLength(): DcborComposeError & {
code: "OddMapLength";
details: { code: "OddMapLength" };
}
A map needs an even number of items.

Returns DcborComposeError & { code: "OddMapLength"; details: { code: "OddMapLength" } }
- Readonlycode: "OddMapLength"
  
  The discriminant.
- Readonlydetails: { code: "OddMapLength" }
  
  The payload of code.
  - Readonlycode: "OddMapLength"
    
    The discriminant.
- Defined in error.ts:561

`Static`duplicateMapKey

duplicateMapKey(): DcborComposeError & {
code: "DuplicateMapKey";
details: { code: "DuplicateMapKey" };
}
A map key that appears twice.

Returns DcborComposeError & {
code: "DuplicateMapKey";
details: { code: "DuplicateMapKey" };
}
- Readonlycode: "DuplicateMapKey"
  
  The discriminant.
- Readonlydetails: { code: "DuplicateMapKey" }
  
  The payload of code.
  - Readonlycode: "DuplicateMapKey"
    
    The discriminant.
- Defined in error.ts:565

`Static`parseError

parseError(
    cause: DcborParseError,
): DcborComposeError & {
    code: "ParseError";
    details: { code: "ParseError"; cause: DcborParseError };
}
An item did not parse.
Parameters
- cause: DcborParseError
Returns DcborComposeError & {
code: "ParseError";
details: { code: "ParseError"; cause: DcborParseError };
}
- Readonlycode: "ParseError"
  
  The discriminant.
- Readonlydetails: { code: "ParseError"; cause: DcborParseError }
  
  The payload of code.
  - Readonlycode: "ParseError"
    
    The discriminant.
  - Readonlycause: DcborParseError
    
    The item's error.
- Defined in error.ts:569

Class DcborComposeError

Hierarchy

Index

Properties

Methods

Properties

`Readonly`name

`Readonly`code

`Readonly`details

`Optional` `Readonly`cause

Methods

`Static`isDcborComposeError

Parameters

is

Parameters

Returns boolean

`Static`oddMapLength

Returns DcborComposeError & { code: "OddMapLength"; details: { code: "OddMapLength" } }

`Readonly`code: "OddMapLength"

`Readonly`details: { code: "OddMapLength" }

`Readonly`code: "OddMapLength"

`Static`duplicateMapKey

Returns DcborComposeError & {
code: "DuplicateMapKey";
details: { code: "DuplicateMapKey" };
}

`Readonly`code: "DuplicateMapKey"

`Readonly`details: { code: "DuplicateMapKey" }

`Readonly`code: "DuplicateMapKey"

`Static`parseError

Parameters

Returns DcborComposeError & {
code: "ParseError";
details: { code: "ParseError"; cause: DcborParseError };
}

`Readonly`code: "ParseError"

`Readonly`details: { code: "ParseError"; cause: DcborParseError }

`Readonly`code: "ParseError"

`Readonly`cause: DcborParseError

Settings

On This Page

Class DcborComposeError

Hierarchy

Index

Properties

Methods

Properties

Readonlyname

Readonlycode

Readonlydetails

Optional Readonlycause

Methods

StaticisDcborComposeError

Parameters

Returns value is | DcborComposeError & { code: "DuplicateMapKey"; details: { code: "DuplicateMapKey" }; } | DcborComposeError & { code: "OddMapLength"; details: { code: "OddMapLength" }; } | DcborComposeError & { code: "ParseError"; details: { code: "ParseError"; cause: DcborParseError }; }

is

Parameters

Returns boolean

StaticoddMapLength

Returns DcborComposeError & { code: "OddMapLength"; details: { code: "OddMapLength" } }

Readonlycode: "OddMapLength"

Readonlydetails: { code: "OddMapLength" }

Readonlycode: "OddMapLength"

StaticduplicateMapKey

Returns DcborComposeError & { code: "DuplicateMapKey"; details: { code: "DuplicateMapKey" };}

Readonlycode: "DuplicateMapKey"

Readonlydetails: { code: "DuplicateMapKey" }

Readonlycode: "DuplicateMapKey"

StaticparseError

Parameters

Returns DcborComposeError & { code: "ParseError"; details: { code: "ParseError"; cause: DcborParseError };}

Readonlycode: "ParseError"

Readonlydetails: { code: "ParseError"; cause: DcborParseError }

Readonlycode: "ParseError"

Readonlycause: DcborParseError

Settings

On This Page

`Readonly`name

`Readonly`code

`Readonly`details

`Optional` `Readonly`cause

`Static`isDcborComposeError

Returns value is
| DcborComposeError & {
code: "DuplicateMapKey";
details: { code: "DuplicateMapKey" };
}
| DcborComposeError & {
code: "OddMapLength";
details: { code: "OddMapLength" };
}
| DcborComposeError & {
code: "ParseError";
details: { code: "ParseError"; cause: DcborParseError };
}

`Static`oddMapLength

`Readonly`code: "OddMapLength"

`Readonly`details: { code: "OddMapLength" }

`Readonly`code: "OddMapLength"

`Static`duplicateMapKey

Returns DcborComposeError & {
code: "DuplicateMapKey";
details: { code: "DuplicateMapKey" };
}

`Readonly`code: "DuplicateMapKey"

`Readonly`details: { code: "DuplicateMapKey" }

`Readonly`code: "DuplicateMapKey"

`Static`parseError

Returns DcborComposeError & {
code: "ParseError";
details: { code: "ParseError"; cause: DcborParseError };
}

`Readonly`code: "ParseError"

`Readonly`details: { code: "ParseError"; cause: DcborParseError }

`Readonly`code: "ParseError"

`Readonly`cause: DcborParseError