Code Monkey home page Code Monkey logo

most-node-streams's Introduction

most-node-streams

Convert Node.js Streams to Most.js Streams

Allows you to translate basic Node.js Streams into Most.js Streams.

WARNING: This does not attempt to cover the use case where you need backpressure or flow control. If you need backpressure or flow control then please continue to use Node.js Streams.

Let me have it!

npm install --save most-node-streams

API

fromReadable(stream: NodeJS.ReadableStream, dataEventName?: string): Stream<Buffer>

Creates a Most.js Stream from a Node.js Readable Stream. Optionally takes an event name to recieve events defaulting to data if none is provided.

fromWritable(stream: NodeJS.WritableStream): Stream<Buffer>

Creates a Most.js Stream that replicates the values being written to a WritableStream.

toWritable (nodeStream: NodeJS.WritableStream, mostStream: Stream<Buffer | string>): Subscription

Subscribes to a stream and replicates its values into a NodeJS WritableStream.

fromStream(nodeStream: NodeStream, options?: FromStreamOptions): Stream<Buffer>

This is the function that fromReadable and fromWritable are built from for when you need a little more configuration.

Types

FromStreamOptions

export interface FromStreamOptions {
  endEventName?: string;
  dataEventName?: string;
}

NodeStram

export type NodeStream =
  NodeJS.WritableStream | NodeJS.ReadableStream | NodeJS.ReadWriteStream;

most-node-streams's People

Contributors

tylors avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.