# @types/jsonstream

> TypeScript definitions for jsonstream

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

## Install

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

## 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.8.33 |
| 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 | 51443 |
| Maintainers | types |

## Links

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

## Dependencies (1)

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

## Recent versions

- 0.8.33 (latest) — 2023-11-07
- 0.8.31 (ts4.2) — 2023-02-14
- 0.8.30 (ts2.0) — 2017-12-03
- 0.8.32 — 2023-10-18
- 0.8.29 — 2017-08-21
- 0.8.28 — 2016-09-19
- 0.8.27 — 2016-07-14
- 0.8.26-alpha — 2016-07-08
- 0.8.25-alpha — 2016-07-03
- 0.8.24-alpha — 2016-07-02
- 0.8.23-alpha — 2016-07-01
- 0.8.22-alpha — 2016-07-01
- 0.8.21-alpha — 2016-05-25
- 0.8.20-alpha — 2016-05-20
- 0.8.15-alpha — 2016-05-19
- … 1 more at https://npm.io/package/@types/jsonstream/versions

## README

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

# Summary
This package contains type definitions for jsonstream (https://github.com/dominictarr/JSONStream).

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

export interface Options {
    recurse: boolean;
}

export function parse(pattern: any): NodeJS.ReadWriteStream;
export function parse(patterns: any[]): NodeJS.ReadWriteStream;

/**
 * Create a writable stream.
 * You may pass in custom open, close, and seperator strings, but, by default,
 * JSONStream.stringify() will create an array,
 * (with default options open='[\n', sep='\n,\n', close='\n]\n')
 */
export function stringify(): NodeJS.ReadWriteStream;

/**
 * Create a writable stream.
 * You may pass in custom open, close, and seperator strings.
 */
export function stringify(open: string, sep: string, close: string): NodeJS.ReadWriteStream;

/** Creates a writable stream where elements are only seperated by a newline. */
export function stringify(newlineOnly: NewlineOnlyIndicator): NodeJS.ReadWriteStream;
export type NewlineOnlyIndicator = false;

export function stringifyObject(): NodeJS.ReadWriteStream;
export function stringifyObject(open: string, sep: string, close: string): NodeJS.ReadWriteStream;

````

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

# Credits
These definitions were written by [Bart van der Schoor](https://github.com/Bartvds).

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