# rollerpunk

> Rolling file adapter for whistlepunk

Latest version **0.0.1** (published 2015-03-05) · Copyright LeanKit 2014 license · 0 weekly downloads

## Install

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

## 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 | 2015-03-05 |
| First published | 2015-03-05 |
| Weekly downloads | 0 |
| License | Copyright LeanKit 2014 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 6 |
| Known vulnerabilities | 0 (+8 in 2 direct dependencies) |
| Install scripts | no |
| Author | LeanKit |
| Maintainers | brian_edgerton |

## Links

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

## Dependencies (6)

- [when](https://npm.io/package/when.md) 3.7.x
- [debug](https://npm.io/package/debug.md) ^2.1.2
- [lodash](https://npm.io/package/lodash.md) ~3.3.1
- [moment](https://npm.io/package/moment.md) ~2.6.0
- [machina](https://npm.io/package/machina.md) ^1.0.0-1
- [fs-extra](https://npm.io/package/fs-extra.md) 0.16.x

## Recent versions

- 0.0.1 (latest) — 2015-03-05

## README

# Rollerpunk

Rollerpunk is a rotating file adapter for [Whistlepunk](https://github.com/LeanKit-Labs/whistlepunk).

## Usage

Use it just like you would any `whistlepunk` adapter. After you've installed it, `rollerpunk` will be required automatically by `whistlepunk`.

```javascript
var postal = require( "postal" );
var wp = require( "whistlepunk" )( postal, {
	adapters: {
		rollerpunk: {
			level: 4,
			logFolder: "/var/log/myapp", // Folder where logs will live
			fileName: "whistlepunk.log",
			maxSize: 500, // Maximum file size in KB
			maxLogFiles: 0, // Limit the number of archived files in your directory. 0 == unlimited
			maxUnwritten: 1000, // Maximum number of queued log writes when FileWriter is in an invalid state
			maxConsecutiveReboots: 25, // Number of times the log will try to restart itself consecutively before giving up
			rebootInterval: 60 // Number of seconds in between
		}
	}
});
```

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