UNPKG

1.5 kBTypeScriptView Raw
1interface v6 {
2 /**
3 @returns The IPv6 address of the internet-facing interface, as determined from the default gateway. When the address cannot be determined for any reason, `undefined` will be returned.
4
5 @example
6 ```
7 import internalIp = require('internal-ip');
8
9 console.log(internalIp.v6.sync());
10 //=> 'fe80::1'
11 ```
12 */
13 sync: () => string | undefined;
14
15 /**
16 @returns The IPv6 address of the internet-facing interface, as determined from the default gateway. When the address cannot be determined for any reason, `undefined` will be returned.
17
18 @example
19 ```
20 import internalIp = require('internal-ip');
21
22 console.log(await internalIp.v6());
23 //=> 'fe80::1'
24 ```
25 */
26 (): Promise<string | undefined>;
27}
28
29interface v4 {
30 /**
31 @returns The IPv4 address of the internet-facing interface, as determined from the default gateway. When the address cannot be determined for any reason, `undefined` will be returned.
32
33 @example
34 ```
35 import internalIp = require('internal-ip');
36
37 console.log(internalIp.v4.sync())
38 //=> '10.0.0.79'
39 ```
40 */
41 sync: () => string | undefined;
42
43 /**
44 @returns The IPv4 address of the internet-facing interface, as determined from the default gateway. When the address cannot be determined for any reason, `undefined` will be returned.
45
46 @example
47 ```
48 import internalIp = require('internal-ip');
49
50 console.log(await internalIp.v4())
51 //=> '10.0.0.79'
52 ```
53 */
54 (): Promise<string | undefined>;
55}
56
57declare const internalIp: {
58 v6: v6;
59 v4: v4;
60};
61
62export = internalIp;