Class Name

Name. This type is immutable.

Hierarchy

Name

Index

Constructors

constructor

Properties

comps

Accessors

Methods

Constructors

constructor

new Name(input?: NameLike): Name
new Name(uri: string, parseComponent?: (input: string) => Component): Name
new Name(value: Uint8Array): Name
new Name(comps: readonly ComponentLike[]): Name

- Defined in packages/packet/src/name/name.ts:25
Create empty name, or copy from other name, or parse from URI.

Parameters
- Optional input: NameLike
Returns Name
- Defined in packages/packet/src/name/name.ts:28
Parse from URI, with specific component parser.

Parameters
- uri: string
- Optional parseComponent: (input: string) => Component
  - - (input: string): Component
    - Parameters
      - input: string
      Returns Component
Returns Name
- Defined in packages/packet/src/name/name.ts:31
Construct from TLV-VALUE.

Parameters
- value: Uint8Array
Returns Name
- Defined in packages/packet/src/name/name.ts:34
Construct from components.

Parameters
- comps: readonly ComponentLike[]
Returns Name

Properties

Readonly comps

comps: readonly Component[]

List of name components.

Accessors

length

get length(): number

- Defined in packages/packet/src/name/name.ts:80
Number of name components.

Returns number

value

get value(): Uint8Array

- Defined in packages/packet/src/name/name.ts:85
Name TLV-VALUE.

Returns Uint8Array

valueHex

get valueHex(): string

- Defined in packages/packet/src/name/name.ts:93
Name TLV-VALUE hexadecimal representation, good for map keys.

Returns string

Methods

append

append<A>(convention: NamingConvention<A, unknown>, v: A): Name
append(...suffix: readonly ComponentLike[]): Name

- Defined in packages/packet/src/name/name.ts:133
Append a component from naming convention.

Type parameters
- A
Parameters
- convention: NamingConvention<A, unknown>
- v: A
Returns Name
- Defined in packages/packet/src/name/name.ts:136
Append suffix with one or more components.

Parameters
- Rest ...suffix: readonly ComponentLike[]
Returns Name

at

at(i: number): Component

- Defined in packages/packet/src/name/name.ts:108
Retrieve i-th component.

throws
i-th component does not exist.

Parameters
- i: number
Returns Component

compare

compare(other: NameLike): Name.CompareResult

- Defined in packages/packet/src/name/name.ts:155
Compare with other name.

Parameters
- other: NameLike
Returns Name.CompareResult

encodeTo

encodeTo(encoder: Encoder): void

- Defined in packages/packet/src/name/name.ts:184
Parameters
- encoder: Encoder
Returns void

equals

equals(other: NameLike): boolean

- Defined in packages/packet/src/name/name.ts:174
Determine if this name equals other.

Parameters
- other: NameLike
Returns boolean

get

get(i: number): undefined | Component

- Defined in packages/packet/src/name/name.ts:99
Retrieve i-th component.

Parameters
- i: number
Returns undefined | Component

getPrefix

getPrefix(n: number): Name

- Defined in packages/packet/src/name/name.ts:128
Get prefix of n components.

Parameters
- n: number
Returns Name

isPrefixOf

isPrefixOf(other: NameLike): boolean

- Defined in packages/packet/src/name/name.ts:179
Determine if this name is a prefix of other.

Parameters
- other: NameLike
Returns boolean

replaceAt

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

- Defined in packages/packet/src/name/name.ts:148
Return a copy of Name with a component replaced.

Parameters
- i: number
- comp: ComponentLike
Returns Name

slice

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

- Defined in packages/packet/src/name/name.ts:123
Get sub name [begin, end).

Parameters
- Optional begin: number
- Optional end: number
Returns Name

toString

toString(): string

- Defined in packages/packet/src/name/name.ts:117
Get URI string.

Returns string

Static decodeFrom

decodeFrom(decoder: Decoder): Name

- Defined in packages/packet/src/name/name.ts:16
Parameters
- decoder: Decoder
Returns Name

Generated using TypeDoc