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

Optional count

count?: number

Number of routers. Ignored if transports is a Record.

Optional ipv4

ipv4?: boolean

IPv4 allowed?

Optional ipv6

ipv6?: boolean

IPv6 allowed?

Optional network

network?: string

Network authority, such as "yoursunny".

Optional position

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

Client geolocation.

Optional server

server?: string

FCH service URI.

Optional signal

signal?: AbortSignal

AbortSignal that allows canceling the request via AbortController.

Optional transport

transport?: string

Transport protocol, such as "udp". Ignored if transports is specified.

Optional transports

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

Transport protocols. 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

Theme

On This Page

Generated using TypeDoc