@stream-toolbox/replace

English 中文文档

💱 Replace the given Buffer in a readable stream with another Buffer.

Features

• Fast 🚀，throughput is about 5GB/s (data is in memory).
• Supports limiting the maximum number of replacements.

Installation

npm i @stream-toolbox/replace

Quick Start

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

const readable = createReadStream("crlf.text");
const duplex = createReplace("\r\n", "\n"); // replace all '\r\n' in crlf.text with '\n'
const writable = createWriteStream(`lf.text`);

readable.pipe(duplex).pipe(writable);

API

createReplace(find: string | Buffer, replace: string | Buffer, limit?: number): Duplex

If limit is not specified, all find will be replaced with replace, if limit is an positive interger, then only the first limit find will be replaced, the subsequent ones will remain as they are.

💱 用提供的 Buffer 替换可读流中的特定 Buffer。

特点

• 速度快 🚀，吞吐量大概在 5GB/s (数据在内存中).
• 支持限制最多替换多少次。

安装

npm i @stream-toolbox/replace

快速开始

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

const readable = createReadStream("crlf.text");
const duplex = createReplace("\r\n", "\n"); // 将 crlf.text 中的所有 '\r\n' 替换成 '\n'
const writable = createWriteStream(`lf.text`);

readable.pipe(duplex).pipe(writable);

API

createReplace(find: string | Buffer, replace: string | Buffer, limit?: number): Duplex

如果没有指定 limit，所有的 find 都将被替换成 replace，如果 limit 是一个正整数，那么只有前 limit 个 find 会被替换，后面的将保持原样。