Class Name

constructor

• new Name(input?: NameLike): Name

  Create empty name, or copy from other name, or parse from URI.

  Parameters

  • Optionalinput: NameLike

  Returns Name
• new Name(uri: string, parseComponent?: (input: string) => Component): Name

  Parse from URI, with specific component parser.

  Parameters

  • uri: string
  • OptionalparseComponent: (input: string) => Component

  Returns Name
• new Name(value: Uint8Array): Name

  Construct from TLV-VALUE.

  Parameters

  • value: Uint8Array

  Returns Name
• new Name(comps: readonly ComponentLike[]): Name

  Construct from components.

  Parameters

  • comps: readonly ComponentLike[]

  Returns Name

Readonlycomps

length

• get length(): number

  Number of name components.

  Returns number

value

• get value(): Uint8Array

  Name TLV-VALUE.

  Returns Uint8Array

valueHex

• get valueHex(): string

  Name TLV-VALUE hexadecimal representation, good for map keys.

  Returns string

append

• append<A>(convention: NamingConvention<A, unknown>, v: A): Name

  Append a component from naming convention.

  Type Parameters

  • A

  Parameters

  • convention: NamingConvention<A, unknown>
  • v: A

  Returns Name
• append(...suffix: readonly ComponentLike[]): Name

  Append suffix with one or more components.

  Parameters

  • ...suffix: readonly ComponentLike[]

  Returns Name

at

• at(i: number): Component

  Retrieve i-th component.

  Parameters

  • i: number

    Component index. Negative number counts from the end.

  Returns Component

  i-th component.

  Throws

  RangeError Thrown if i-th component does not exist.

compare

• compare(other: NameLike): Name.CompareResult

  Compare with other name.

  Parameters

  • other: NameLike

  Returns Name.CompareResult

encodeTo

• encodeTo(encoder: Encoder): void

  Parameters

  • encoder: Encoder

  Returns void

equals

• equals(other: NameLike): boolean

  Determine if this name equals other.

  Parameters

  • other: NameLike

  Returns boolean

get

• get(i: number): undefined | Component

  Retrieve i-th component.

  Parameters

  • i: number

    Component index. Negative number counts from the end.

  Returns undefined | Component

  i-th component, or undefined if it does not exist.

getPrefix

• getPrefix(n: number): Name

  Get prefix of n components.

  Parameters

  • n: number

  Returns Name

isPrefixOf

• isPrefixOf(other: NameLike): boolean

  Determine if this name is a prefix of other.

  Parameters

  • other: NameLike

  Returns boolean

replaceAt

• replaceAt(i: number, comp: ComponentLike): Name

  Return a copy of Name with i-th component replaced with comp.

  Parameters

  • i: number
  • comp: ComponentLike

  Returns Name

slice

• slice(begin?: number, end?: number): Name

  Get sub name [begin,end).

  Parameters

  • Optionalbegin: number
  • Optionalend: number

  Returns Name

toString

• toString(): string

  Get URI string.

  Returns string

StaticdecodeFrom

• decodeFrom(decoder: Decoder): Name

  Parameters

  • decoder: Decoder

  Returns Name

Staticfrom

• from(input: NameLike): Name

  Create Name from Name or Name URI.

  Parameters

  • input: NameLike

  Returns Name

  Remarks

  This is more efficient than new Name(input) if input is already a Name.