Class Component

constructor

• new Component(): Component

• Construct GenericNameComponent with TLV-LENGTH zero.

  Returns Component
• new Component(type, value?): Component

• Construct from TLV-TYPE and TLV-VALUE.

  Parameters

  • type: number

    TLV-TYPE.
  • Optionalvalue: string | Uint8Array

    TLV-VALUE. If specified as string, it's encoded as UTF-8 but not interpreted as URI. Use Component.from() to interpret URI.

  Returns Component

  Throws

  Error Thrown if type is not a valid name component TLV-TYPE.

• new Component(tlv): Component

• Decode from TLV.

  Parameters

  • tlv: Uint8Array

    Complete name component TLV.

  Returns Component

  Throws

  Error Thrown if tlv does not contain a complete name component TLV and nothing else.

• new Component(type, encoder, length): Component
• Internal

  Parameters

  • type: number
  • encoder: Encoder
  • length: number

  Returns Component

Readonlytlv

Readonlytype

Readonlyvalue

length

• get length(): number

• TLV-LENGTH.

  Returns number

text

• get text(): string

• TLV-VALUE interpreted as UTF-8 string.

  Returns string

as

• as<R>(convention): R

• Convert with naming convention.

  Type Parameters

  • R

  Parameters

  • convention: NamingConvention<any, R>

  Returns R

compare

• compare(other): Component.CompareResult

• Compare this component with other.

  Parameters

  • other: ComponentLike

  Returns Component.CompareResult

encodeTo

• encodeTo(encoder): void

• Parameters

  • encoder: Encoder

  Returns void

equals

• equals(other): boolean

• Determine if this component equals other.

  Parameters

  • other: ComponentLike

  Returns boolean

is

• is(convention): boolean

• Determine if component follows a naming convention.

  Parameters

  • convention: NamingConvention<any, any>

  Returns boolean

toString

• toString(): string

• Get URI string.

  Returns string

StaticdecodeFrom

• decodeFrom(decoder): Component

• Parameters

  • decoder: Decoder

  Returns Component

Staticfrom

• from(input): Component

• Parse from URI representation, or return existing Component.

  Parameters

  • input: ComponentLike

  Returns Component