Skip to content

Commit

Permalink
Merge pull request DefinitelyTyped#34551 from vladhrapov/localtunnel
Browse files Browse the repository at this point in the history
feat(DefinitelyTyped#34550): [@types/localtunnel] Create localtunnel type definitions
  • Loading branch information
DanielRosenwasser authored Apr 11, 2019
2 parents e440986 + 15d7f39 commit e6955cb
Show file tree
Hide file tree
Showing 4 changed files with 76 additions and 0 deletions.
42 changes: 42 additions & 0 deletions types/localtunnel/index.d.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
// Type definitions for localtunnel 1.9
// Project: https://github.com/localtunnel/localtunnel
// Definitions by: Vladyslav Khrapov <https://github.com/vladhrapov>
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped

export = localtunnel;

declare function localtunnel(
port: number,
opt: localtunnel.TunnelConfig,
callback: localtunnel.TunnelCallback
): localtunnel.Tunnel;

declare function localtunnel(
port: number,
callback: localtunnel.TunnelCallback
): localtunnel.Tunnel;

declare namespace localtunnel {
type TunnelCallback = (
err: string,
tunnel?: Tunnel
) => void;

interface TunnelConfig {
host?: string;
subdomain?: string;
port?: number;
local_host?: string;
}

interface Tunnel {
url: string;
tunnel_cluster: TunnelCluster;
open(err: string, tunnel?: Tunnel): void;
close(): void;
}

interface TunnelCluster {
domain: string;
}
}
10 changes: 10 additions & 0 deletions types/localtunnel/localtunnel-tests.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
import localtunnel = require('localtunnel');

let tunnel: localtunnel.Tunnel;

tunnel = localtunnel(3000, () => {});
tunnel = localtunnel(
3000,
{ host: '', local_host: '', port: 3000, subdomain: '' },
() => {}
);
23 changes: 23 additions & 0 deletions types/localtunnel/tsconfig.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
{
"compilerOptions": {
"module": "commonjs",
"lib": [
"es6"
],
"noImplicitAny": true,
"noImplicitThis": true,
"strictNullChecks": true,
"strictFunctionTypes": true,
"baseUrl": "../",
"typeRoots": [
"../"
],
"types": [],
"noEmit": true,
"forceConsistentCasingInFileNames": true
},
"files": [
"index.d.ts",
"localtunnel-tests.ts"
]
}
1 change: 1 addition & 0 deletions types/localtunnel/tslint.json
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
{ "extends": "dtslint/dt.json" }

0 comments on commit e6955cb

Please sign in to comment.