readme.md

unified-stream

Streaming interface for unified.

Contents

• What is this?
• When should I use this?
• Install
• Use
• API
  • stream(processor)
  • MinimalDuplex
• Types
• Compatibility
• Contribute
• License

What is this?

This package turns a unified processor into a (duplex) Node.js stream.

👉 Note: the interface is streaming but the code buffers.

When should I use this?

You can use this if you have to use Node streams and are integrating with unified. As the code actually buffers, in almost all cases, you can use unified itself.

Install

This package is ESM only. In Node.js (version 16+), install with npm:

npm install unified-stream

In Deno with esm.sh:

import {stream} from 'https://esm.sh/unified-stream@3'

In browsers with esm.sh:

<script type="module">
  import {stream} from 'https://esm.sh/unified-stream@3?bundle'
</script>

Use

import process from 'node:process'
import rehypeFormat from 'rehype-format'
import rehypeParse from 'rehype-parse'
import rehypeStringify from 'rehype-stringify'
import {unified} from 'unified'
import {stream} from 'unified-stream'

// Pipe stdin, into an HTML formatter, to stdout.
process.stdin
  .pipe(
    stream(unified().use(rehypeParse).use(rehypeFormat).use(rehypeStringify))
  )
  .pipe(process.stdout)

API

This package exports the identifier stream. There is no default export.

stream(processor)

Create a duplex (readable and writable) stream that transforms with processor.

Parameters

• processor (Processor) — unified processor

Returns

Duplex stream (MinimalDuplex).

MinimalDuplex

Simple readable and writable (duplex) stream (TypeScript type).

Types

This package is fully typed with TypeScript. It exports the additional type MinimalDuplex.

Compatibility

Projects maintained by the unified collective are compatible with maintained versions of Node.js.

When we cut a new major release, we drop support for unmaintained versions of Node. This means we try to keep the current release line, unified-stream@^3, compatible with Node.js 16.

Contribute

See contributing.md in unifiedjs/.github for ways to get started. See support.md for ways to get help.

This project has a code of conduct. By interacting with this repository, organization, or community you agree to abide by its terms.

License

MIT © Titus Wormer