Interface FchRequest

FCH service request.

interface FchRequest {
    count?: number;
    ipv4?: boolean;
    ipv6?: boolean;
    network?: string;
    position?: [lon: number, lat: number];
    server?: string;
    signal?: AbortSignal;
    transport?: string;
    transports?: readonly string[] | Record<string, number>;
}

Properties

count? ipv4? ipv6? network? position? server? signal? transport? transports?

Properties

Optionalcount

count?: number

Number of routers.

Remarks

Ignored if transports is a Record.

Optionalipv4

ipv4?: boolean

IPv4 allowed?

Default Value

auto detect

Optionalipv6

ipv6?: boolean

IPv6 allowed?

Default Value

auto detect

Optionalnetwork

network?: string

Network authority, such as "yoursunny".

Optionalposition

position?: [lon: number, lat: number]

Client geolocation.

Optionalserver

server?: string

FCH service URI.

Default Value

https://fch.ndn.today

Optionalsignal

signal?: AbortSignal

AbortSignal that allows canceling the request via AbortController.

Optionaltransport

transport?: string

Transport protocol, such as "udp".

Remarks

Ignored if .transports is specified.

Optionaltransports

transports?: readonly string[] | Record<string, number>

Transport protocols.

Remarks

If this is an array of transport protocols, the quantity of each is specified by count. If this is a Record, each key is a transport protocol and each value is the quantity.

Settings

Member Visibility

On This Page

Properties