0.0.5 • Published 4 years ago

@dennis14e/node-opnsense v0.0.5

Weekly downloads
-
License
MIT
Repository
github
Last release
4 years ago

Node OPNsense Client API (node-opnsense)

npm version Documentation Lint

This Node Client API is mostly based on the documentation here and the source code here. However, it is known that the documentation is not always up to date.

Not every one of these APIs have been tested. It is possible that e.g. input parameters may be missing.

Use at your own risk.

Example

const OPNsense = require('./src/index');

const client = new OPNsense.Client(
    'https://opnsense.local/',
    'api-key',
    'api-secret'
);

new OPNsense.Wol.WolClient(client).wakeByMAC('AA:BB:CC:00:11:22').then(res => {
    console.log(res);
});

NPM scripts

CommandDescription
npm run lintLint code in ./src
npm run jsdocGenerate documentation ./docs
npm run openapiGenerate OpenAPI file ./openapi/openapi.json
0.0.5

4 years ago

0.0.4

4 years ago

0.0.3

4 years ago

0.0.1

4 years ago