# os-proxy-socks

> WIP: Manage system-wide SOCKS proxy settings.

Latest version **1.0.0** (published 2017-06-25) · ISC license · 0 weekly downloads

## Install

```sh
npm install os-proxy-socks
pnpm add os-proxy-socks
yarn add os-proxy-socks
bun add os-proxy-socks
```

## 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 | 1.0.0 |
| Published | 2017-06-25 |
| First published | 2017-06-25 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | oyyd |

## Links

- npm: https://www.npmjs.com/package/os-proxy-socks
- npm.io page: https://npm.io/package/os-proxy-socks

## Recent versions

- 1.0.0 (latest) — 2017-06-25

## README

# os-proxy-socks

WIP: Manage system-wide SOCKS proxy settings.

## Platform

- osx

## Usage

Get current setting:

```js
import { get } from 'os-proxy-socks'

get().then(options => {
  console.log(options.enable) // true
  console.log(options.server) // 127.0.0.1
  console.log(options.port) // 1080
})
```

Set SOCKS setting:

```js
import { set } from 'os-proxy-socks'

const options = {
  server: '127.0.0.1',
  port: 1080,
  auth: {
    name: 'name',
    password: 'password',
  }
}

set(options).then(() => {
  // ...
}).catch(err => console.error(err))
```

## API

### get()


## Test

```
npm run test
```

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