@push.rocks/webstream

Web Streams transforms and adapters for Node.js and browser environments.

Issue Reporting and Security

For reporting bugs, issues, or security vulnerabilities, please visit community.foss.global/. This is the central community hub for all issue reporting. Developers who sign and comply with our contribution agreement and go through identification can also get a code.foss.global/ account to submit Pull Requests directly.

Install

pnpm add @push.rocks/webstream

Usage

import { WebDuplexStream, convertDuplexToWebStream } from '@push.rocks/webstream';

const stream = WebDuplexStream.fromUInt8Array(new Uint8Array([1, 2, 3]));
const reader = stream.readable.getReader();
const chunk = await reader.read();
console.log(chunk.value);
reader.releaseLock();

WebDuplexStream<TInput, TOutput> extends TransformStream and accepts a writeFunction that receives each input chunk and tools for pushing output or terminating the transform. Its readable and writable properties use the Web Streams API. fromUInt8Array() writes the supplied bytes and closes the writer.

convertDuplexToWebStream(duplex) adapts an existing Node-style duplex object to { readable, writable }. The object must implement the exported IDuplexStream methods. Reads follow its readable and end events; writes honor its callback and drain event, while cancellation destroys the underlying duplex.

The source repository is available on legacy Gitea.

License and Legal Information

This repository contains open-source code licensed under the MIT License. A copy of the license can be found in license.md.

Please note: The MIT License does not grant permission to use the trade names, trademarks, service marks, or product names of the project, except as required for reasonable and customary use in describing the origin of the work and reproducing the content of the NOTICE file.

Trademarks

This project is owned and maintained by Task Venture Capital GmbH. The names and logos associated with Task Venture Capital GmbH and any related products or services are trademarks of Task Venture Capital GmbH or third parties, and are not included within the scope of the MIT license granted herein.

Use of these trademarks must comply with Task Venture Capital GmbH's Trademark Guidelines, and any usage must be approved in writing. Third-party trademarks used herein are the property of their respective owners and used only in a descriptive manner, e.g. for an implementation of an API or similar.

Company Information

Task Venture Capital GmbH Registered at District Court Bremen HRB 35230 HB, Germany

For any legal inquiries or further information, please contact us via email at [email protected].

By using this repository, you acknowledge that you have read this section, agree to comply with its terms, and understand that the licensing of the code does not imply endorsement by Task Venture Capital GmbH of any derivative works.