# @types/tunnel

> TypeScript definitions for tunnel

Latest version **0.0.7** (published 2024-01-26) · MIT license · 0 weekly downloads

## Install

```sh
npm install @types/tunnel
pnpm add @types/tunnel
yarn add @types/tunnel
bun add @types/tunnel
```

## Health

**Score 45/100 (D)** — status: abandoned.

Positive: has types; no vulnerabilities; high maintenance score; popular repo; extremely popular.

Warnings: low downloads; no esm support; pre 1.0.

Negative: abandoned.

## Facts

| | |
|---|---|
| Version | 0.0.7 |
| Published | 2024-01-26 |
| First published | 2017-07-24 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 5.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 51440 |
| Maintainers | types |

## Links

- npm: https://www.npmjs.com/package/@types/tunnel
- Repository: https://github.com/DefinitelyTyped/DefinitelyTyped
- Homepage: https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/tunnel
- npm.io page: https://npm.io/package/@types/tunnel

## Dependencies (1)

- [@types/node](https://npm.io/package/@types/node.md) *

## Recent versions

- 0.0.7 (latest) — 2024-01-26
- 0.0.6 (ts4.5) — 2023-11-07
- 0.0.4 (ts4.3) — 2023-09-12
- 0.0.3 (ts3.6) — 2021-07-02
- 0.0.2 (ts3.5) — 2021-03-07
- 0.0.1 (ts2.0) — 2019-06-12
- 0.0.5 — 2023-10-18
- 0.0.0 — 2017-07-24

## README

# Installation
> `npm install --save @types/tunnel`

# Summary
This package contains type definitions for tunnel (https://github.com/koichik/node-tunnel/).

# Details
Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/tunnel.
## [index.d.ts](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/tunnel/index.d.ts)
````ts
/// <reference types="node" />
import { Agent, AgentOptions as HttpAgentOptions } from "http";
import { Agent as HttpsAgent, AgentOptions as HttpsAgentOptions } from "https";

export function httpOverHttp(options?: HttpOptions): Agent;
export function httpsOverHttp(options?: HttpsOverHttpOptions): Agent;
export function httpOverHttps(options?: HttpOverHttpsOptions): HttpsAgent;
export function httpsOverHttps(options?: HttpsOverHttpsOptions): HttpsAgent;

export interface HttpOptions extends HttpAgentOptions {
    proxy?: ProxyOptions | undefined;
}

export interface HttpsOptions extends HttpsAgentOptions {
    proxy?: ProxyOptions | undefined;
}

export interface HttpsOverHttpOptions extends HttpsOptions {
    ca?: Buffer[] | undefined;
    key?: Buffer | undefined;
    cert?: Buffer | undefined;
}

export interface HttpOverHttpsOptions extends HttpOptions {
    proxy?: HttpsProxyOptions | undefined;
}

export interface HttpsOverHttpsOptions extends HttpsOverHttpOptions {
    proxy?: HttpsProxyOptions | undefined;
}

export interface ProxyOptions {
    host: string;
    port: number;
    localAddress?: string | undefined;
    proxyAuth?: string | undefined;
    headers?: { [key: string]: any } | undefined;
}

export interface HttpsProxyOptions extends ProxyOptions {
    ca?: Buffer[] | undefined;
    servername?: string | undefined;
    key?: Buffer | undefined;
    cert?: Buffer | undefined;
}

````

### Additional Details
 * Last updated: Fri, 26 Jan 2024 01:52:35 GMT
 * Dependencies: [@types/node](https://npmjs.com/package/@types/node)

# Credits
These definitions were written by [BendingBender](https://github.com/BendingBender).

---
_Source: https://npm.io/package/@types/tunnel · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._