aboutsummaryrefslogtreecommitdiff
path: root/node_modules/fs-constants/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'node_modules/fs-constants/README.md')
-rw-r--r--node_modules/fs-constants/README.md26
1 files changed, 26 insertions, 0 deletions
diff --git a/node_modules/fs-constants/README.md b/node_modules/fs-constants/README.md
new file mode 100644
index 0000000..62b3374
--- /dev/null
+++ b/node_modules/fs-constants/README.md
@@ -0,0 +1,26 @@
+# fs-constants
+
+Small module that allows you to get the fs constants across
+Node and the browser.
+
+```
+npm install fs-constants
+```
+
+Previously you would use `require('constants')` for this in node but that has been
+deprecated and changed to `require('fs').constants` which does not browserify.
+
+This module uses `require('constants')` in the browser and `require('fs').constants` in node to work around this
+
+
+## Usage
+
+``` js
+var constants = require('fs-constants')
+
+console.log('constants:', constants)
+```
+
+## License
+
+MIT