enumconsts
v2.0.1
Published
Node.js constants (ERRNO, SIGNALS, DLOPEN, PRIORITY) as javascript enums (frozen objects). Typescript types included.
Downloads
15
Maintainers
Readme
Enum Consts
Just the contents of os.constants
, in a form better parsed by IDE-s and editors. Also includes explanations as JSDoc.
npm install enumconsts
or
yarn add enumconsts
... then:
const fs = require('fs');
const { errno } = require('enumconsts');
fs.readFile('test.txt', (err, data) => {
if (err && err.code === errno.ENOENT) {
console.log("File doesn't exist");
}
});
You can see all the constants here: https://nodejs.org/api/os.html#os_os_constants_1
One small addition is that consts are available in uppercase as well, for those who like that.
const { SIGNALS } = require('enumconsts');
console.log(SIGNALS.SIGINT);
API
This module exports the following enum objects:
errno
Type: object
Error constants as strings.
signals
Type: object
Signal constants as strings.
dlopen
Type: object
Dlopen constants as strings.
priority
Type: object
Process scheduling constants as strings.
libuv
Type: object
Libuv constants as strings.
ERRNO
Type: object
Alias for errno
.
SIGNALS
Type: object
Alias for signals
.
DLOPEN
Type: object
Alias for dlopen
.
PRIORITY
Type: object
Alias for priority
.
LIBUV
Type: object
Alias for libuv
.
Updates
1.1.0
- Better JSDOC structure
- Probably better intellisense in JetBrains editors
2.0.0
Big update by BendingBender:
- Typescript types
- Use frozen objects instead of classes
- Update to latest Node.js constants + descriptions
- Document all exported members
- Reduce NPM package size
Major version bump is due to:
- the usage of
Object.freeze()
in exports dlopen
andlibuv
constants are now exported as separate objects, no longer included witherrno
.
2.0.1
- Update README to include correct 2.0.0 breaking changes information.
Releasing
Just run npm run release
and follow the instructions.
Licence
MIT