# @types/logrotate-stream

> TypeScript definitions for logrotate-stream

Latest version **0.2.34** (published 2023-11-07) · MIT license · 0 weekly downloads

## Install

```sh
npm install @types/logrotate-stream
pnpm add @types/logrotate-stream
yarn add @types/logrotate-stream
bun add @types/logrotate-stream
```

## Health

**Score 45/100 (D)** — status: abandoned.

Positive: has types; no vulnerabilities; high maintenance score; popular repo; extremely popular.

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

Negative: abandoned.

## Facts

| | |
|---|---|
| Version | 0.2.34 |
| Published | 2023-11-07 |
| First published | 2016-05-17 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 4.6 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 51445 |
| Maintainers | types |

## Links

- npm: https://www.npmjs.com/package/@types/logrotate-stream
- Repository: https://github.com/DefinitelyTyped/DefinitelyTyped
- Homepage: https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/logrotate-stream
- npm.io page: https://npm.io/package/@types/logrotate-stream

## Dependencies (1)

- [@types/node](https://npm.io/package/@types/node.md) *

## Recent versions

- 0.2.34 (latest) — 2023-11-07
- 0.2.32 (ts4.3) — 2023-08-30
- 0.2.31 (ts3.7) — 2021-10-01
- 0.2.30 (ts3.6) — 2021-07-08
- 0.2.29 (ts2.0) — 2016-09-19
- 0.2.33 — 2023-10-18
- 0.2.28 — 2016-07-14
- 0.2.27-alpha — 2016-07-08
- 0.2.26-alpha — 2016-07-04
- 0.2.25-alpha — 2016-07-02
- 0.2.24-alpha — 2016-07-01
- 0.2.23-alpha — 2016-07-01
- 0.2.22-alpha — 2016-05-25
- 0.2.21-alpha — 2016-05-20
- 0.2.16-alpha — 2016-05-19
- … 1 more at https://npm.io/package/@types/logrotate-stream/versions

## README

# Installation
> `npm install --save @types/logrotate-stream`

# Summary
This package contains type definitions for logrotate-stream (https://github.com/dstokes/logrotate-stream).

# Details
Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/logrotate-stream.
## [index.d.ts](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/logrotate-stream/index.d.ts)
````ts
/// <reference types="node" />

import stream = require("stream");

// wrapper to be able to use "export =" while also exporting the Options interface
declare namespace logrotateStream {
    /**
     * Options object for the exported function.
     */
    export interface Options {
        /**
         * The file log file to write data to.
         */
        file: string;
        /**
         * The max file size of a log before rotation occurs. Supports 1024, 1k, 1m, 1g
         */
        size: string | number;
        /**
         * The number of rotated log files to keep (including the primary log file). Additional logs are deleted no rotation.
         */
        keep: number;
        /**
         * Optionally compress rotated files with gzip.
         */
        compress?: boolean | undefined;
    }
}

/**
 * Create a rotating log stream.
 * @returns a writable stream to a rotating log file
 */
declare function logrotateStream(opts: logrotateStream.Options): stream.Writable;

export = logrotateStream;

````

### Additional Details
 * Last updated: Tue, 07 Nov 2023 09:09:38 GMT
 * Dependencies: [@types/node](https://npmjs.com/package/@types/node)

# Credits
These definitions were written by [Rogier Schouten](https://github.com/rogierschouten).

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