- 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
19 lines
312 B
Markdown
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,
|
|
})
|
|
})
|
|
```
|