Name	Last modified	Size	Description
	Parent Directory		-
	LICENSE	1985-10-26 08:15	1.3K
	README.md	1985-10-26 08:15	1.8K	d7c1522 post receive test [كارل مبارك]
	android.js	1985-10-26 08:15	940
	darwin.js	1985-10-26 08:15	1.3K
	freebsd.js	1985-10-26 08:15	1.0K
	ibmi.js	1985-10-26 08:15	1.0K
	index.js	1985-10-26 08:15	867
	linux.js	1985-10-26 08:15	1.5K
	openbsd.js	1985-10-26 08:15	1.1K
	sunos.js	1985-10-26 08:15	1.1K
	win32.js	1985-10-26 08:15	3.1K
	package.json	2023-06-15 18:21	1.8K

# 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

© [silverwind](https://github.com/silverwind), distributed under BSD licence