Class DomainList

Represents a list of route domains.

Implements

Iterable<string>

Index

Constructors

Properties

Accessors

count isReadOnly

Methods

at set indexOf insert removeAt add clear contains copyTo remove encode toString [iterator] parse tryParseInternal

Constructors

constructor

new DomainList(domains?: Iterable<string, any, any>): DomainList
Creates a new domain list.
Parameters
- Optionaldomains: Iterable<string, any, any>
  The domains to initialize the list with.
Returns DomainList

Throws
domains is null.
- Defined in src/domain-list.ts:39

Properties

onChanged

onChanged: (() => void) | null = null

Invoked when the domain list changes.

Accessors

count

get count(): number
The number of domains.

Returns number
- Defined in src/domain-list.ts:50

isReadOnly

get isReadOnly(): boolean
Whether this list is read-only.

Returns boolean
- Defined in src/domain-list.ts:55

Methods

at

at(index: number): string
Gets the domain at the specified index.
Parameters
- index: number
Returns string
- Defined in src/domain-list.ts:60

set

set(index: number, domain: string): void
Sets the domain at the specified index.
Parameters
- index: number
- domain: string
Returns void
- Defined in src/domain-list.ts:66

indexOf

indexOf(domain: string): number
Gets the index of the requested domain, or -1 if it is not found.
Parameters
- domain: string
Returns number
- Defined in src/domain-list.ts:75

insert

insert(index: number, domain: string): void
Inserts a domain at the specified index.
Parameters
- index: number
- domain: string
Returns void
- Defined in src/domain-list.ts:81

removeAt

removeAt(index: number): void
Removes the domain at the specified index.
Parameters
- index: number
Returns void
- Defined in src/domain-list.ts:90

add

add(domain: string): void
Adds a domain to the list.
Parameters
- domain: string
Returns void
- Defined in src/domain-list.ts:97

clear

clear(): void
Removes all domains from the list.

Returns void
- Defined in src/domain-list.ts:104

contains

contains(domain: string): boolean
Determines whether the list contains the specified domain.
Parameters
- domain: string
Returns boolean
- Defined in src/domain-list.ts:110

copyTo

copyTo(array: string[], arrayIndex: number): void
Copies the domains to an array.
Parameters
- array: string[]
- arrayIndex: number
Returns void
- Defined in src/domain-list.ts:116

remove

remove(domain: string): boolean
Removes a domain from the list.
Parameters
- domain: string
Returns boolean
- Defined in src/domain-list.ts:127

encode

encode(options: FormatOptions): string
Encodes the domain list.
Parameters
- options: FormatOptions
  The formatting options.
Returns string
The encoded domain list.
- Defined in src/domain-list.ts:142

toString

toString(): string
Serializes the domain list.

Returns string
- Defined in src/domain-list.ts:154

[iterator]

"[iterator]"(): Iterator<string>
Returns Iterator<string>
Implementation of Iterable.[iterator]
- Defined in src/domain-list.ts:164

`Static`parse

parse(text: string | Uint8Array<ArrayBufferLike>): Result<DomainList>
Parses a domain list.
Parameters
- text: string | Uint8Array<ArrayBufferLike>
  The text to parse.
Returns Result<DomainList>
A Result; { ok: false } with a MimeError on malformed input.
- Defined in src/domain-list.ts:174

`Static`tryParseInternal

tryParseInternal(
    buffer: Uint8Array,
    cursor: ParseCursor,
    endIndex: number,
): Result<DomainList>
Attempts to parse a domain list from a byte range.
Parameters
- buffer: Uint8Array
  The input buffer.
- cursor: ParseCursor
  The current parse cursor.
- endIndex: number
  The end index of the input range.
Returns Result<DomainList>
A Result; { ok: false } with a MimeError on malformed input.
- Defined in src/domain-list.ts:191