diff options
Diffstat (limited to 'node_modules/builtins/Readme.md')
-rw-r--r-- | node_modules/builtins/Readme.md | 35 |
1 files changed, 28 insertions, 7 deletions
diff --git a/node_modules/builtins/Readme.md b/node_modules/builtins/Readme.md index 96f4b1f6c..b1c0007d6 100644 --- a/node_modules/builtins/Readme.md +++ b/node_modules/builtins/Readme.md @@ -1,18 +1,39 @@ - # builtins - List of node.js [builtin modules](http://nodejs.org/api/). +[![CI](https://github.com/juliangruber/builtins/actions/workflows/ci.yml/badge.svg)](https://github.com/juliangruber/builtins/actions/workflows/ci.yml) + +List of node.js [builtin modules](http://nodejs.org/api/). + +## Usage + +```js +const builtins = require('builtins') +``` + +Get list of core modules for current Node.js version: + +```js +assert(builtins().includes('http')) +``` - [![build status](https://secure.travis-ci.org/juliangruber/builtins.svg)](http://travis-ci.org/juliangruber/builtins) +Get list of core modules for specific Node.js version: + +```js +assert(builtins({ version: '6.0.0' }).includes('http')) +``` -## Example +Get list of core modules present in one or mode Node.js versions: ```js -var builtins = require('builtins'); +assert(builtins({ version: '*' }).includes('worker_threads')) +``` -assert(builtins.indexOf('http') > -1); +Add experimental modules to the list: + +```js +assert(builtins({ experimental: true }).includes('wasi')) ``` ## License - MIT +MIT |