# node-reign

> A simple web based control panel for node scripts.

Latest version **0.0.1** (published 2016-04-05) · MIT license · 0 weekly downloads

## Install

```sh
npm install node-reign
pnpm add node-reign
yarn add node-reign
bun add node-reign
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.1 |
| Published | 2016-04-05 |
| First published | 2016-04-05 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 4 |
| Known vulnerabilities | 0 (+2 in 1 direct dependencies) |
| Install scripts | no |
| Author | Rab Rennie |
| Maintainers | spookyco |

## Links

- npm: https://www.npmjs.com/package/node-reign
- npm.io page: https://npm.io/package/node-reign

## Dependencies (4)

- [koa](https://npm.io/package/koa.md) ^1.2.0
- [koa-router](https://npm.io/package/koa-router.md) ^5.4.0
- [koa-socket](https://npm.io/package/koa-socket.md) ^4.3.0
- [koa-static](https://npm.io/package/koa-static.md) ^2.0.0

## Recent versions

- 0.0.1 (latest) — 2016-04-05

## README

# reign

A simple web based control panel for node scripts.

# Installation
---------
````
  npm install node-reign
````
# Example Usage
---------------
````
const Reign = require('node-reign');

const reign = new Reign();

reign.start();

reign.add(test);
reign.add(returnFunction);


function test() {
  console.log('test');
}

function returnFunction() {
  return 'returned';
}
````

# Documentation
-------

## Creating a new control panel

`````
const Reign = require('node-reign');

const reign = new Reign([options]);

`````

options are an object
`````
{
  port: 3000, //default is 3000
}
`````

## Methods
-----------
### start()

Starts the control panel

### add(function [,options])

Adds a new function to the control panel. Options are passed as an object
`````
{
  type: (button, range, toggle, text) //default is button
  range: [min, max] //needed if type is range
}
`````

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