FM / default-gateway

/var/www/flurhymez/node_modules/default-gateway/

/var/www/flurhymez/node_modules/default-gateway

Name	Size	Mode	Actions
android.js	940	0644	edit dl rm
darwin.js	1377	0644	edit dl rm
freebsd.js	1037	0644	edit dl rm
ibmi.js	1049	0644	edit dl rm
index.js	867	0644	edit dl rm
LICENSE	1290	0644	edit dl rm
linux.js	1551	0644	edit dl rm
openbsd.js	1110	0644	edit dl rm
package.json	1825	0644	edit dl rm
README.md	1810	0644	edit dl rm
sunos.js	1110	0644	edit dl rm
win32.js	3177	0644	edit dl rm

Edit: /var/www/flurhymez/node_modules/default-gateway/README.md (1810B)

# default-gateway
[![](https://img.shields.io/npm/v/default-gateway.svg?style=flat)](https://www.npmjs.org/package/default-gateway) [![](https://img.shields.io/npm/dm/default-gateway.svg)](https://www.npmjs.org/package/default-gateway)

Obtains the machine's default gateway through `exec` calls to OS routing interfaces.

- On Linux and Android, the `ip` command must be available (usually provided by the `iproute2` package).
- On Windows, `wmic` must be available.
- On IBM i, the `db2util` command must be available (provided by the `db2util` package).
- On Unix (and macOS), the `netstat` command must be available.

## Installation

```
$ npm i default-gateway
```

## Example

```js
const defaultGateway = require('default-gateway');

const {gateway, interface} = await defaultGateway.v4();
// gateway = '1.2.3.4', interface = 'en1'

const {gateway, interface} = await defaultGateway.v6();
// gateway = '2001:db8::1', interface = 'en2'

const {gateway, interface} = defaultGateway.v4.sync();
// gateway = '1.2.3.4', interface = 'en1'

const {gateway, interface} = defaultGateway.v6.sync();
// gateway = '2001:db8::1', interface = 'en2'
```

## API
### defaultGateway.v4()
### defaultGateway.v6()
### defaultGateway.v4.sync()
### defaultGateway.v6.sync()

Returns: `result` *Object*
  - `gateway`: The IP address of the default gateway.
  - `interface`: The name of the interface. On Windows, this is the network adapter name.

The `.v{4,6}()` methods return a Promise while the `.v{4,6}.sync()` variants will return the result synchronously.

The `gateway` property will always be defined on success, while `interface` can be `null` if it cannot be determined. All methods reject/throw on unexpected conditions.

## License

cmd: