open-file

Open a file with resolving its file descriptor

Usage no npm install needed!

<script type="module">
  import openFile from 'https://cdn.skypack.dev/open-file';
</script>

README

open-file

NPM version Build Status Coverage Status dependencies Status devDependencies Status

A Node module to open a file with resolving its file descriptor

const openFile = require('open-file');

openFile('file.txt', 'r').then(fileDescriptor => {
  fileDescriptor; //=> 15
});

Installation

Use npm.

npm install open-file

API

openFile = require('open-file');

openFile(filePath, flags [, mode])

filePath: String (a file path to open)
flags: String or Number
mode: Integer
Return: Promise of the file descriptor (Integer)

Almost the same function as fs.open, except:

  • The first argument is restricted to String and doesn't accept Buffer by design.
  • It returns a promise instead of calling a callback function.

License

Copyright (c) 2016 - 2017 Shinnosuke Watanabe

Licensed under the MIT License.