Class ComponentsError

Error raised by every component operation.

try {
  Digest.from(bytes);
} catch (e) {
  if (ComponentsError.isComponentsError(e) && e.code === "InvalidSize") {
    console.log(e.details.expected, e.details.actual);
  }
}

Hierarchy

Error
- ComponentsError

Index

Properties

`Readonly`name

name: "ComponentsError"

Always "ComponentsError"; the cross-copy identity isComponentsError checks.

`Readonly`code

code: ComponentsErrorCode

The failure code.

`Readonly`details

details: ComponentsErrorDetails

Structured details, discriminated by code.

Methods

`Static`isComponentsError

isComponentsError(value: unknown): value is ComponentsError
true for a ComponentsError from any copy of this package.
Parameters
- value: unknown
Returns value is ComponentsError
- Defined in error.ts:131

is

is(code: ComponentsErrorCode): boolean
true when this error carries code.
Parameters
- code: ComponentsErrorCode
Returns boolean
- Defined in error.ts:136

`Static`invalidSize

invalidSize(dataType: string, expected: number, actual: number): ComponentsError
InvalidSize: invalid <dataType> size: expected <expected>, got <actual>, with the reference's data_type ("digest", "nonce", "symmetric key", "ECDSA public key", …).
Parameters
- dataType: string
- expected: number
- actual: number
Returns ComponentsError
- Defined in error.ts:147

`Static`invalidData

invalidData(reason: string, cause?: unknown): ComponentsError
InvalidData for unnamed data.
Parameters
- reason: string
- Optionalcause: unknown
Returns ComponentsError
- Defined in error.ts:157

`Static`invalidDataForType

invalidDataForType(
    dataType: string,
    reason: string,
    cause?: unknown,
): ComponentsError
InvalidData naming the type or parameter.
Parameters
- dataType: string
- reason: string
- Optionalcause: unknown
Returns ComponentsError
- Defined in error.ts:162

`Static`dataTooShort

dataTooShort(dataType: string, minimum: number, actual: number): ComponentsError
DataTooShort: fewer bytes than the type's minimum.
Parameters
- dataType: string
- minimum: number
- actual: number
Returns ComponentsError
- Defined in error.ts:171

`Static`invalidFormat

invalidFormat(reason: string, cause?: unknown): ComponentsError
InvalidData for a malformed text form (an SSH PEM, a URI).
Parameters
- reason: string
- Optionalcause: unknown
Returns ComponentsError
- Defined in error.ts:179

`Static`crypto

crypto(message: string, cause?: unknown): ComponentsError
Crypto: a cryptographic operation failed (authentication, signing).
Parameters
- message: string
- Optionalcause: unknown
Returns ComponentsError
- Defined in error.ts:186

`Static`cbor

cbor(message: string, cause?: unknown): ComponentsError
Cbor with the CBOR error: prefix: a dcbor failure inside an operation whose reference error type is the component Error (Error::Cbor), or a dcbor failure met outside a decoder.
Parameters
- message: string
- Optionalcause: unknown
Returns ComponentsError
- Defined in error.ts:200

`Static`cborDecode

cborDecode(cause: Error): ComponentsError
Cbor as a decoder reports it: the message is the dcbor Display of cause with no prefix, as the reference's from_tagged_cbor returns a dcbor::Error; cause is that CborError.
Parameters
- cause: Error
Returns ComponentsError
- Defined in error.ts:209

`Static`sskr

sskr(message: string, cause?: unknown): ComponentsError
Sskr: a failure from the sskr package.
Parameters
- message: string
- Optionalcause: unknown
Returns ComponentsError
- Defined in error.ts:214

`Static`ssh

ssh(message: string, cause?: unknown): ComponentsError
Ssh: an SSH key, signature or certificate could not be parsed or used.
Parameters
- message: string
- Optionalcause: unknown
Returns ComponentsError
- Defined in error.ts:219

`Static`sshAgent

sshAgent(message: string, cause?: unknown): ComponentsError
SshAgent: an SSH-agent operation is not available.
Parameters
- message: string
- Optionalcause: unknown
Returns ComponentsError
- Defined in error.ts:224

`Static`uri

uri(message: string, cause?: unknown): ComponentsError
Uri: not a valid URI.
Parameters
- message: string
- Optionalcause: unknown
Returns ComponentsError
- Defined in error.ts:229

`Static`compression

compression(message: string, cause?: unknown): ComponentsError
Compression: a DEFLATE stream or its checksum is corrupt.
Parameters
- message: string
- Optionalcause: unknown
Returns ComponentsError
- Defined in error.ts:234

`Static`postQuantum

postQuantum(message: string, cause?: unknown): ComponentsError
PostQuantum: an ML-DSA / ML-KEM level or key is invalid.
Parameters
- message: string
- Optionalcause: unknown
Returns ComponentsError
- Defined in error.ts:239

`Static`levelMismatch

levelMismatch(): ComponentsError
LevelMismatch: an ML-DSA signature and key of different levels.

Returns ComponentsError
- Defined in error.ts:249

`Static`hex

hex(message: string, cause?: unknown): ComponentsError
Hex: a malformed hex string (hex decoding error: <reason>, the hex crate's texts).
Parameters
- message: string
- Optionalcause: unknown
Returns ComponentsError
- Defined in error.ts:255

`Static`utf8

utf8(message: string, cause?: unknown): ComponentsError
Utf8: bytes that are not valid UTF-8 (UTF-8 conversion error: <reason>).
Parameters
- message: string
- Optionalcause: unknown
Returns ComponentsError
- Defined in error.ts:260

`Static`env

env(message: string, cause?: unknown): ComponentsError
Env: an environment variable an SSH-agent transport needs is missing or unreadable.
Parameters
- message: string
- Optionalcause: unknown
Returns ComponentsError
- Defined in error.ts:265

`Static`sshAgentClient

sshAgentClient(message: string, cause?: unknown): ComponentsError
SshAgentClient: the SSH-agent transport failed (socket, protocol).
Parameters
- message: string
- Optionalcause: unknown
Returns ComponentsError
- Defined in error.ts:270

`Static`general

general(message: string, cause?: unknown): ComponentsError
General: anything the other codes do not name.
Parameters
- message: string
- Optionalcause: unknown
Returns ComponentsError
- Defined in error.ts:280

Class ComponentsError

Hierarchy

Index

Properties

Methods

Properties

Readonlyname

Readonlycode

Readonlydetails

Methods

StaticisComponentsError

Parameters

Returns value is ComponentsError

is

Parameters

Returns boolean

StaticinvalidSize

Parameters

Returns ComponentsError

StaticinvalidData

Parameters

Returns ComponentsError

StaticinvalidDataForType

Parameters

Returns ComponentsError

StaticdataTooShort

Parameters

Returns ComponentsError

StaticinvalidFormat

Parameters

Returns ComponentsError

Staticcrypto

Parameters

Returns ComponentsError

Staticcbor

Parameters

Returns ComponentsError

StaticcborDecode

Parameters

Returns ComponentsError

Staticsskr

Parameters

Returns ComponentsError

Staticssh

Parameters

Returns ComponentsError

StaticsshAgent

Parameters

Returns ComponentsError

Staticuri

Parameters

Returns ComponentsError

Staticcompression

Parameters

Returns ComponentsError

StaticpostQuantum

Parameters

Returns ComponentsError

StaticlevelMismatch

Returns ComponentsError

Statichex

Parameters

Returns ComponentsError

Staticutf8

Parameters

Returns ComponentsError

Staticenv

Parameters

Returns ComponentsError

StaticsshAgentClient

Parameters

Returns ComponentsError

Staticgeneral

Parameters

Returns ComponentsError

Settings

On This Page

`Readonly`name

`Readonly`code

`Readonly`details

`Static`isComponentsError

`Static`invalidSize

`Static`invalidData

`Static`invalidDataForType

`Static`dataTooShort

`Static`invalidFormat

`Static`crypto

`Static`cbor

`Static`cborDecode

`Static`sskr

`Static`ssh

`Static`sshAgent

`Static`uri

`Static`compression

`Static`postQuantum

`Static`levelMismatch

`Static`hex

`Static`utf8

`Static`env

`Static`sshAgentClient

`Static`general