Installation
npm install --save @types/localtunnel
Summary
This package contains type definitions for localtunnel (https://github.com/localtunnel/localtunnel).
Details
Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/localtunnel.
index.d.ts
/// <reference types="node" />
import { EventEmitter } from "events";
export = localtunnel;
declare function localtunnel(
port: number | localtunnel.TunnelConfig & { port: number },
): Promise<localtunnel.Tunnel>;
declare function localtunnel(
opts: localtunnel.TunnelConfig & { port: number },
callback: localtunnel.TunnelCallback,
): localtunnel.Tunnel;
declare function localtunnel(
port: number,
opts: localtunnel.TunnelConfig,
): Promise<localtunnel.Tunnel>;
declare function localtunnel(
port: number,
opts: localtunnel.TunnelConfig,
callback: localtunnel.TunnelCallback,
): localtunnel.Tunnel;
declare namespace localtunnel {
type TunnelCallback = (
err?: string,
tunnel?: Tunnel,
) => void;
interface TunnelConfig {
subdomain?: string | undefined;
host?: string | undefined;
local_host?: string | undefined;
local_https?: boolean | undefined;
local_cert?: string | undefined;
local_key?: string | undefined;
local_ca?: string | undefined;
allow_invalid_cert?: boolean | undefined;
}
interface Tunnel extends EventEmitter {
url: string;
tunnelCluster: TunnelCluster;
open(cb: ((err: string) => void) | (() => void)): void;
close(): void;
}
interface TunnelCluster extends EventEmitter {
open(): void;
}
}
Additional Details
- Last updated: Tue, 07 Nov 2023 09:09:38 GMT
- Dependencies: @types/node
Credits
These definitions were written by Vladyslav Khrapov, and Noam Alffasy.