Archived

This repository has been archived on 2020-11-02. You can view files and clone it, but cannot push or open issues or pull requests.

History

cranberry ed23347e56 Initial comission of TheLounge base files		2020-11-01 22:46:04 +00:00
..
index.js	Initial comission of TheLounge base files	2020-11-01 22:46:04 +00:00
LICENSE	Initial comission of TheLounge base files	2020-11-01 22:46:04 +00:00
package.json	Initial comission of TheLounge base files	2020-11-01 22:46:04 +00:00
README.md	Initial comission of TheLounge base files	2020-11-01 22:46:04 +00:00

README.md

with-open-file

Do stuff with an open file, knowing it will finally be closed

Because the built-in way requires way too much boilerplate.

Install

$ npm install with-open-file

Usage

const withOpenFile = require('with-open-file')

withOpenFile('foo.txt', 'r', fd => {
  // Process file using fd
})

withOpenFile.sync('foo.txt', 'r', fd => {
  // Process file synchronously using fd
})

API

withOpenFile(…openArgs, callback)

Returns a Promise wrapping the result of calling callback with the requested file descriptor.

withOpenFile.sync(…openArgs, callback)

Returns the result of calling callback with the requested file descriptor.

…openArgs

Arguments as supported by fs.openSync

callback

Type: function