-
Notifications
You must be signed in to change notification settings - Fork 0
/
index.d.ts
108 lines (94 loc) · 2.27 KB
/
index.d.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
declare type DetectAddressOptions = {
/**
* The URL of the IP address detection service.
* @default 'https://domains.google.com/checkip'
*/
detectAddressURL?: string
/**
* The IP address family.
* @default 4
*/
family?: 4 | 6
}
/**
* Detects the public IP address of the client.
* @param options
* @returns A Promise that resolves with the detected IP address.
*/
export declare function detectAddress(
options?: DetectAddressOptions,
): Promise<string>
declare type ResolveFQDNOptions = {
/**
* A list of DNS servers to use.
* @default ['8.8.8.8', '8.8.4.4']
*/
dnsServers?: string[]
/**
* The IP address family.
* @default 4
*/
family?: 4 | 6
}
/**
* Resolves the IP addresses of a domain name.
* @param fqdn The fully qualified domain name to resolve.
* @param options
* @returns A Promise that resolves with a list of IP addresses for the domain
* name.
*/
export declare function resolveFQDN(
fqdn: string,
options?: ResolveFQDNOptions,
): Promise<string[]>
declare type UpdateFQDNOptions = {
/**
* The username for updating the domain name.
*/
username: string
/**
* The password for updating the domain name.
*/
password: string
/**
* The IP address to update the domain name with. If omitted, the IP address
* will be detected.
*/
address?: string
/**
* The URL of the IP address detection service.
* @default 'https://domains.google.com/checkip'
*/
detectAddressURL?: string | URL
/**
* A list of DNS servers to use.
* @default ['8.8.8.8', '8.8.4.4']
*/
dnsServers?: string[]
/**
* The IP address family.
* @default 4
*/
family?: 4 | 6
/**
* Update the IP address of the domain name even if it hasn't changed.
* @default false
*/
force?: boolean
/**
* The URL of the update service.
* @default 'https://domains.google.com/nic/update'
*/
updateURL?: string | URL
}
/**
* Updates a domain name with a new IP address.
* @param fqdn The fully qualified domain name to update.
* @param options
* @returns A promise that resolves with either the response from the update
* server or `false` if no update was requested.
*/
export declare function updateFQDN(
fqdn: string,
options: UpdateFQDNOptions,
): Promise<string | false>