@stream-toolbox/join
TypeScript icon, indicating that this package has built-in type declarations

1.0.0 • Public • Published

@stream-toolbox/join

version downloads license node-current

English 中文文档


🔗 Join multiple readable streams (or Buffers) into one readable stream.

Installation

npm i @stream-toolbox/join

Quick Start

const join = require("@stream-toolbox/join");
const { createReadStream, createWriteStream } = require("fs");

const readable = join([
  createReadStream("a_file"),
  createReadStream("b_file"),
  createReadStream("c_file")
]);

readable.pipe(createWriteStream("joined_file"));

API

join(sources: (Buffer | string | Readable)[], separator?: Buffer | string): Readable;
  • sources: An Array contians Buffer, string or Readable, string will be treated as utf-8 encoded.

  • separator: Optional, can be Buffer or string, string will be treated as utf-8 encoded.

    join(["foo", "bar", "baz"], "_"); // foo_bar_baz

🔗 将多个可读流(或 Buffer)连接成一个可读流。

安装

npm i @stream-toolbox/join

快速开始

const join = require("@stream-toolbox/join");
const { createReadStream, createWriteStream } = require("fs");

const readable = join([
  createReadStream("a_file"),
  createReadStream("b_file"),
  createReadStream("c_file")
]);

readable.pipe(createWriteStream("joined_file"));

API

join(sources: (Buffer | string | Readable)[], separator?: Buffer | string): Readable;
  • sources: 一个包含了 Buffer, stringReadable 的数组, string 按照 utf-8 编码处理.

  • separator: 可选, 类型是 Bufferstring, string 按照 utf-8 编码处理.

    join(["foo", "bar", "baz"], "_"); // foo_bar_baz

Package Sidebar

Install

npm i @stream-toolbox/join

Weekly Downloads

0

Version

1.0.0

License

MIT

Unpacked Size

6.49 kB

Total Files

5

Last publish

Collaborators

  • haochuan9421