# ipgen

> NodeJS wrapper arround the steerapi c code, of same name https://github.com/steerapi/ipgen

Latest version **0.0.10** (published 2016-01-13) · ISC license · 0 weekly downloads

## Install

```sh
npm install ipgen
pnpm add ipgen
yarn add ipgen
bun add ipgen
```

## 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.10 |
| Published | 2016-01-13 |
| First published | 2015-01-19 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Known vulnerabilities | 0 (+2 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Vicente Trevisan Neto |
| Maintainers | netrevisanto |
| Keywords | ipgen, generate, traffic, udp |

## Links

- npm: https://www.npmjs.com/package/ipgen
- Repository: https://github.com/netrevisanto/ipgen
- Issues: https://github.com/netrevisanto/ipgen/issues
- npm.io page: https://npm.io/package/ipgen

## Dependencies (2)

- [colors](https://npm.io/package/colors.md) ^1.1.2
- [shelljs](https://npm.io/package/shelljs.md) ^0.3.0

## Recent versions

- 0.0.10 (latest) — 2016-01-13
- 0.0.9 — 2016-01-13
- 0.0.8 — 2016-01-11
- 0.0.7 — 2016-01-08
- 0.0.6 — 2016-01-06
- 0.0.5 — 2015-01-23
- 0.0.4 — 2015-01-23
- 0.0.3 — 2015-01-23
- 0.0.2 — 2015-01-23
- 0.0.1 — 2015-01-19
- 0.0.0 — 2015-01-19

## README

NodeJS wrapper arround the steerapi c code, of same name https://github.com/steerapi/ipgen

### Instalation
	npm install ipgen

How to use?
### You can send an json object to the generate method, containing:
	require("ipgen").generate({
		host: 'localhost',
		port: '5556',
		bandwidth: 1000, // 1 kbps
		time: 10000 // for how long? in miliseconds
	})

### Or even supply with a callback!
	require("ipgen").generate({
		host: 'localhost',
		port: '5556',
		bandwidth: 1000, // 1 kbps
		time: 10000 // for how long? in miliseconds
	}, function(err,succ){
		if (err) throw err;
		console.log("Network flush is over!")
	});

### For a less verbose output, please, start with silent parameter:
	require("ipgen").generate({
		silent: true,
		host: 'localhost',
		port: '5556',
		bandwidth: 1000, // 1 kbps
		time: 10000 // for how long? in miliseconds
	}, function(err,succ){
		if (err) throw err;
		console.log("Network flush is over!")
	});

### You can also specify the source IP address for an execution(Default is 127.0.0.1):
	require("ipgen").generate({
		silent: true,
		host: 'localhost',
		port: '5556',
		bandwidth: 1000, // 1 kbps
		time: 10000, // for how long? in miliseconds
		srcIp: '1.1.1.1' // Will generate packages with source ip address like 1.1.1.1
	}, function(err,succ){
		if (err) throw err;
		console.log("Network flush is over!")
	});

### Credits
* [Neto Trevisan] - Backend/Frontend Web Developer

[Neto Trevisan]:http://netrevisanto.com

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