Skip to content

Latest commit

 

History

History
35 lines (24 loc) · 773 Bytes

readme.md

File metadata and controls

35 lines (24 loc) · 773 Bytes

FS Source (BOB)

A file system source for the BOB streaming protocol.

Usage

const FileSource = require('fs-source')
new FileSource(path, options)

Implements a BOB source from files.

Example

const FileSource = require('fs-source')

const source = new FileSource('my-file')
const sink = new MyBOBSink()

sink.bindSource(source, error => {
  if (error)
    console.error('Stream returned error ->', error.stack)
  else {
    console.log('ok')
  }
})

See test-basic for a good working example.

License

MIT Licensed — Contributions via DCO 1.1