# caw

> Construct HTTP/HTTPS agents for tunneling proxies

Latest version **2.0.1** (published 2017-07-20) · MIT license · 0 weekly downloads

## Install

```sh
npm install caw
pnpm add caw
yarn add caw
bun add caw
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 2.0.1 |
| Published | 2017-07-20 |
| First published | 2015-07-31 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=4 |
| Dependencies | 4 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 41 |
| Author | Kevin Mårtensson |
| Maintainers | kevva |
| Keywords | http, https, proxy, tunnel |

## Links

- npm: https://www.npmjs.com/package/caw
- Repository: https://github.com/kevva/caw
- Homepage: https://github.com/kevva/caw#readme
- Issues: https://github.com/kevva/caw/issues
- npm.io page: https://npm.io/package/caw

## Dependencies (4)

- [isurl](https://npm.io/package/isurl.md) ^1.0.0-alpha5
- [get-proxy](https://npm.io/package/get-proxy.md) ^2.0.0
- [tunnel-agent](https://npm.io/package/tunnel-agent.md) ^0.6.0
- [url-to-options](https://npm.io/package/url-to-options.md) ^1.0.1

## Recent versions

- 2.0.1 (latest) — 2017-07-20
- 2.0.0 — 2016-05-21
- 1.2.0 — 2015-12-07
- 1.1.0 — 2015-08-04
- 1.0.2 — 2015-08-03
- 1.0.1 — 2015-07-31
- 1.0.0 — 2015-07-31

## README

# caw [![Build Status](https://travis-ci.org/kevva/caw.svg?branch=master)](https://travis-ci.org/kevva/caw)

> Construct HTTP/HTTPS agents for tunneling proxies


## Install

```
$ npm install caw
```


## Usage

```js
const caw = require('caw');
const got = require('got');

got('todomvc.com', {
	agent: caw()
}, () => {});
```


## API

### caw([proxy], [options])

#### proxy

Type: `string`

Proxy URL. If not set, it'll try getting it using [`get-proxy`](https://github.com/kevva/get-proxy).

#### options

Type: `Object`

Besides the options below, you can pass in options allowed in [tunnel-agent](https://github.com/request/tunnel-agent).

##### protocol

Type: `string`<br>
Default: `http`

Endpoint protocol.


## License

MIT © [Kevin Mårtensson](https://github.com/kevva)

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