Skip to content

Latest commit

 

History

History
101 lines (78 loc) · 1.79 KB

README.md

File metadata and controls

101 lines (78 loc) · 1.79 KB
Raw

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