Giter VIP home page Giter VIP logo

fifo-js's Introduction

FIFO.js

Node.js module provides a class which handles a fifo file.

npm: https://www.npmjs.com/package/fifo-js

Installation

npm install fifo-js

Usage

Example

const FIFO = require('fifo-js')

let fifo = new FIFO()

fifo.read(console.log.bind(console))

fifo.write('foo')

fifo.close()

Create fifo

The constructor creates a new fifo in /tmp/ if a path isn't provided. If a path is provided and there's an existing fifo with that name it uses that one. Otherwise it creates a new one with that name.

let fifo = new FIFO([path])

Read

Asynchronous

fifo.read(callback)

callback:Function(data:String)

Synchronous

fifo.readSync()

Example

fifo.read(text => {
    // 'text' contains the text which was read from the fifo.
})

let text = fifo.readSync()
// 'text' contains the text which was read from the fifo.

Listener

This function will read and call the callback for each message until the fifo is closed. If read or readSync is called after a reader is set a FIFOError is thrown.

fifo.setReader(text => {
    // 'text' contains the text which was read from the fifo.
})

Write

When writing the boolean flag 'trim' can be supplied. This prevents a trailing new line to be added.

Asynchronous

fifo.write(data:String, trim:Boolean, callback:Function())

Synchronous

fifo.writeSync(data:String, trim:Boolean)

Example

fifo.write(text, () => {
    // The written text has been read.
})

fifo.writeSync(text, true)
// The written text has been read.

Close

fifo.close()

Contact

Licence

MIT: https://opensource.org/licenses/MIT

fifo-js's People

Contributors

raksooo avatar yoshiwalsh avatar

Watchers

James Cloos 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.