Label overview

COSE Label types and constructors.

Added in v2.0.0

Table of contents

• Constructors
  • labelFromAlgorithmId
  • labelFromCurveType
  • labelFromInt
  • labelFromKeyType
  • labelFromText
• Model
  • Label (class)
    • toJSON (method)
    • toString (method)
    • [Inspectable.NodeInspectSymbol] (method)
    • [Equal.symbol] (method)
    • [Hash.symbol] (method)
    • asInt (method)
    • asText (method)

Constructors

labelFromAlgorithmId

Create a Label from AlgorithmId.

Signature

export declare const labelFromAlgorithmId: (alg: AlgorithmId) => Label

Added in v2.0.0

labelFromCurveType

Create a Label from CurveType.

Signature

export declare const labelFromCurveType: (crv: CurveType) => Label

Added in v2.0.0

labelFromInt

Create a Label from an integer.

Signature

export declare const labelFromInt: (value: bigint) => Label

Added in v2.0.0

labelFromKeyType

Create a Label from KeyType.

Signature

export declare const labelFromKeyType: (kty: KeyType) => Label

Added in v2.0.0

labelFromText

Create a Label from a text string.

Signature

export declare const labelFromText: (value: string) => Label

Added in v2.0.0

Model

Label (class)

COSE header label - can be an integer or text string (RFC 8152).

Signature

export declare class Label

Added in v2.0.0

toJSON (method)

Signature

toJSON()

toString (method)

Signature

toString(): string

[Inspectable.NodeInspectSymbol] (method)

Signature

[Inspectable.NodeInspectSymbol](): unknown

[Equal.symbol] (method)

Signature

[Equal.symbol](that: unknown): boolean

[Hash.symbol] (method)

Signature

[Hash.symbol](): number

asInt (method)

Get the integer value (throws if label is text).

Signature

asInt(): bigint

Added in v2.0.0

asText (method)

Get the text value (throws if label is integer).

Signature

asText(): string

Added in v2.0.0