aswi2020vldc-gitlab/templetes/node_modules/internal-ip/index.d.ts @ 9bb1e829

interface v6 {
	/**
	 * @returns The IPv6 address of the internet-facing interface, as determined from the default gateway. When the address cannot be determined for any reason, `null` will be returned.
	 *
	 * @example
	 *
	 * console.log(await internalIp.v6());
	 * //=> 'fe80::1'
	 */
	(): Promise<string>;

	/**
	 * @returns The IPv6 address of the internet-facing interface, as determined from the default gateway. When the address cannot be determined for any reason, `null` will be returned.
	 *
	 * @example
	 *
	 * console.log(internalIp.v6.sync());
	 * //=> 'fe80::1'
	 */
	sync(): string;
}

interface v4 {
	/**
	 * @returns The IPv4 address of the internet-facing interface, as determined from the default gateway. When the address cannot be determined for any reason, `null` will be returned.
	 *
	 * @example
	 *
	 * console.log(await internalIp.v4())
	 * //=> '10.0.0.79'
	 */
	(): Promise<string>;

	/**
	 * @returns The IPv4 address of the internet-facing interface, as determined from the default gateway. When the address cannot be determined for any reason, `null` will be returned.
	 *
	 * @example
	 *
	 * console.log(internalIp.v4.sync())
	 * //=> '10.0.0.79'
	 */
	sync(): string;
}

declare const internalIp: {
	v6: v6;
	v4: v4;

	// TODO: Remove this for the next major release
	default: typeof internalIp;
};

export = internalIp;