# ts-socks

> a simple socks5 server you can use

Latest version **0.9.3** (published 2020-02-22) · MIT license · 0 weekly downloads

## Install

```sh
npm install ts-socks
pnpm add ts-socks
yarn add ts-socks
bun add ts-socks
```

## Health

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

Positive: has types; no vulnerabilities; high quality score.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.9.3 |
| Published | 2020-02-22 |
| First published | 2020-02-22 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 19 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | Jaenster |
| Maintainers | jaenster |
| Keywords | socks5, socksv5, network, typescript, no dependencies, standalone, intercept |

## Links

- npm: https://www.npmjs.com/package/ts-socks
- Repository: https://github.com/jaenster/socks5-ts
- Homepage: https://github.com/jaenster/socks5-ts#readme
- Issues: https://github.com/jaenster/socks5-ts/issues
- npm.io page: https://npm.io/package/ts-socks

## Alternatives

- [@openai/codex-sdk](https://npm.io/package/@openai/codex-sdk.md) — 731.4K weekly downloads
- [babel-plugin-transform-react-jsx](https://npm.io/package/babel-plugin-transform-react-jsx.md) — 565.0K weekly downloads
- [babel-helper-remove-or-void](https://npm.io/package/babel-helper-remove-or-void.md) — 508.5K weekly downloads
- [@pnpm/store-controller-types](https://npm.io/package/@pnpm/store-controller-types.md) — 186.9K weekly downloads
- [react-native-signature-canvas](https://npm.io/package/react-native-signature-canvas.md) — 155.6K weekly downloads

## Recent versions

- 0.9.3 (latest) — 2020-02-22
- 0.9.2 — 2020-02-22
- 0.9.1 — 2020-02-22
- 0.9.0 — 2020-02-22

## README

# Socks5
[![npm version](https://d25lcipzij17d.cloudfront.net/badge.svg?id=js&type=6&v=0.9.1&x2=0)](https://www.npmjs.com/package/ts-socks)

A simple socks5 server written in typescript.

No dependencies

# Javascript
```javascript
const Socks5 = require('ts-socks');

new Socks5({
	options: {
		listen: 12345,
		allowNoAuth: true,
	},
	users: [{username: 'test', password: 'test'}],
}).on('connection', (proxy) => {

	console.log(proxy.remote.remoteAddress + ':' + proxy.remote.remotePort);
	proxy.origin.pipe(proxy.remote);
	proxy.remote.pipe(proxy.origin);
});
```
# Typescript
```typescript
import Socks5 from 'ts-socks';

new Socks5({
    options: {
        listen: 12345,
        allowNoAuth: true,
    },
    users: [{username: 'test', password: 'test'}],
}).on('connection', (proxy) => {

    console.log(proxy.remote.remoteAddress + ':' + proxy.remote.remotePort);
    proxy.origin.pipe(proxy.remote);
    proxy.remote.pipe(proxy.origin);
});
```

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