mtcute/packages/socks-proxy/README.md
teidesu 390b65f796 build(docs): api reference generation improvements
- added readme in each package
- updated typedoc, fixed related issues
- use @link instead of @see
- moved configs to typedoc.js, improved exclusion of unneeded stuff
- custom plugin for typedoc for cross-package references
- preparing to move documentation to separate repository
2022-08-24 23:37:26 +03:00

19 lines
312 B
Markdown

# @mtcute/socks-proxy
![](./coverage.svg)
Socks4/5 proxy transport for mtcute.
## Usage
```typescript
import { SocksTcpTransport } from '@mtcute/socks-proxy'
const tg = new TelegramClient({
// ...
transport: () => new SocksTcpTransport({
host: 'localhost',
port: 1080,
})
})
```