pmcf
Version:
Poor mans configuration management
66 lines (43 loc) • 2.58 kB
Markdown
[](https://www.npmjs.com/package/pmcf)
[](https://spdx.org/licenses/0BSD.html)
[](https://typescriptlang.org)
[](https://bundlejs.com/?q=pmcf)
[](https://npmjs.org/package/pmcf)
[](https://github.com/arlac77/pmcf/issues)
[](https://actions-badge.atrox.dev/arlac77/pmcf/goto)
[](https://github.com/prettier/prettier)
[](http://commitizen.github.io/cz-cli/)
[](https://snyk.io/test/github/arlac77/pmcf)
[](https://coveralls.io/github/arlac77/pmcf)
# pmcf
## Poor mans configuration management
# API
<!-- Generated by documentation.js. Update this documentation by updating the source code. -->
### Table of Contents
* [networkAddresses](#networkaddresses)
* [Parameters](#parameters)
* [NetworkAddress](#networkaddress)
* [Parameters](#parameters-1)
* [subnet](#subnet)
* [networkInterface](#networkinterface)
* [address](#address)
## networkAddresses
### Parameters
* `filter` **[object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** (optional, default `n=>true`)
Returns **Iterable<[NetworkAddress](#networkaddress)>** 
## NetworkAddress
### Parameters
* `networkInterface`  
* `address`  
* `subnet`  
### subnet
Type: Subnet
### networkInterface
Type: NetworkInterface
### address
Type: ([string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String) | [Uint8Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Uint8Array) | [Uint16Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Uint16Array))
# install
With [npm](http://npmjs.org) do:
```shell
npm install pmcf
```