{
"repo": "fifofile",
"timestamp": "2026-01-16T23:56:23.780Z",
"entryPoint": "index.js",
"exports": {
"packageJson": {
"main": "index.js"
}
},
"api": {
"file": "index.js",
"exports": [
{
"type": "default",
"name": "class"
}
],
"classes": [
{
"name": "FIFOFile"
}
],
"functions": [
{
"name": "waitForLock"
},
{
"name": "writeMessages"
},
{
"name": "loop"
},
{
"name": "readMessages"
},
{
"name": "ontruncate"
},
{
"name": "loop"
},
{
"name": "defaultMapWritable"
},
{
"name": "createMapWritable"
},
{
"name": "createMapReadable"
},
{
"name": "dummyFree"
},
{
"name": "closeSync"
}
]
},
"readme": {
"content": "# fifofile\n\nUserland FIFO file.\n\n```\nnpm install fifofile\n```\n\n## Usage\n\nTo consume, in any process\n\n```js\nconst FIFOFile = require('fifofile')\n\nfor await (const msg of new FIFOFile('/tmp/my-fifo')) {\n console.log('incoming:', msg)\n}\n```\n\nTo produce, in any process\n\n```js\nconst FIFOFile = require('fifofile')\n\nconst fifo = new FIFOFile('/tmp/my-fifo')\n\nfifo.write(Buffer.from('a msg'))\n```\n\n## License\n\nApache-2.0\n",
"sections": [
"intro",
"usage",
"license"
],
"hasApi": true,
"hasExamples": true,
"exampleCount": 3,
"examples": [
"npm install fifofile",
"const FIFOFile = require('fifofile')\n\nfor await (const msg of new FIFOFile('/tmp/my-fifo')) {\n console.log('incoming:', msg)\n}",
"const FIFOFile = require('fifofile')\n\nconst fifo = new FIFOFile('/tmp/my-fifo')\n\nfifo.write(Buffer.from('a msg'))"
]
},
"patterns": [
"streaming"
]
}