# @types/lazystream

> TypeScript definitions for lazystream

Latest version **1.0.0** (published 2024-10-18) · MIT license · 0 weekly downloads

## Install

```sh
npm install @types/lazystream
pnpm add @types/lazystream
yarn add @types/lazystream
bun add @types/lazystream
```

## Health

**Score 55/100 (C)** — status: stable.

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

Warnings: low downloads; no esm support.

Negative: stale.

## Facts

| | |
|---|---|
| Version | 1.0.0 |
| Published | 2024-10-18 |
| First published | 2024-10-18 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 6.1 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 51443 |
| Maintainers | types |

## Links

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

## Dependencies (2)

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

## Recent versions

- 1.0.0 (latest) — 2024-10-18

## README

# Installation
> `npm install --save @types/lazystream`

# Summary
This package contains type definitions for lazystream (https://github.com/jpommerening/node-lazystream).

# Details
Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/lazystream.
## [index.d.ts](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/lazystream/index.d.ts)
````ts
/// <reference types="node" />
import { Stream as NodeStream } from "node:stream";
import { PassThrough, Stream, TransformOptions } from "readable-stream";

export class Readable extends PassThrough {
    /**
     * @param fn The function to call to obtain the stream to read from
     */
    constructor(fn: () => NodeStream | Stream);
    /**
     * @param fn The function to call to obtain the stream to read from
     * @param options Options for the underlying {@link PassThrough} class.
     * Accessible via {@link fn}
     */
    constructor(fn: (options: TransformOptions) => NodeStream | Stream, options: TransformOptions);
    /**
     * @param fn The function to call to obtain the stream to read from
     * @param options Options for the underlying {@link PassThrough} class.
     * Accessible via {@link fn}, if they are passed
     */
    constructor(fn: (options?: TransformOptions) => NodeStream | Stream, options?: TransformOptions);
}

export class Writable extends PassThrough {
    /**
     * @param fn The function to call to obtain the stream to write to
     */
    constructor(fn: () => NodeStream | Stream);
    /**
     * @param fn The function to call to obtain the stream to write to
     * @param options Options for the underlying {@link PassThrough} class.
     * Accessible via {@link fn}
     */
    constructor(fn: (options: TransformOptions) => NodeStream | Stream, options: TransformOptions);
    /**
     * @param fn The function to call to obtain the stream to write to
     * @param options Options for the underlying {@link PassThrough} class.
     * Accessible via {@link fn}, if they are passed
     */
    constructor(fn: (options?: TransformOptions) => NodeStream | Stream, options?: TransformOptions);
}

````

### Additional Details
 * Last updated: Fri, 18 Oct 2024 15:36:54 GMT
 * Dependencies: [@types/node](https://npmjs.com/package/@types/node), [@types/readable-stream](https://npmjs.com/package/@types/readable-stream)

# Credits
These definitions were written by [Adam Thompson-Sharpe](https://github.com/MysteryBlokHed).

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