summaryrefslogtreecommitdiff
path: root/node_modules/npm-normalize-package-bin/README.md
diff options
context:
space:
mode:
author8cy <[email protected]>2020-04-03 02:37:42 -0700
committer8cy <[email protected]>2020-04-03 02:37:42 -0700
commit60867fb030bae582082340ead7dbc7efdc2f5398 (patch)
tree4c6a7356351be2e4914e15c4703172597c45656e /node_modules/npm-normalize-package-bin/README.md
parentcommenting (diff)
downloads5nical-60867fb030bae582082340ead7dbc7efdc2f5398.tar.xz
s5nical-60867fb030bae582082340ead7dbc7efdc2f5398.zip
2020/04/03, 02:34, v1.2.0
Diffstat (limited to 'node_modules/npm-normalize-package-bin/README.md')
-rw-r--r--node_modules/npm-normalize-package-bin/README.md14
1 files changed, 14 insertions, 0 deletions
diff --git a/node_modules/npm-normalize-package-bin/README.md b/node_modules/npm-normalize-package-bin/README.md
new file mode 100644
index 0000000..65ba316
--- /dev/null
+++ b/node_modules/npm-normalize-package-bin/README.md
@@ -0,0 +1,14 @@
+# npm-normalize-package-bin
+
+Turn any flavor of allowable package.json bin into a normalized object.
+
+## API
+
+```js
+const normalize = require('npm-normalize-package-bin')
+const pkg = {name: 'foo', bin: 'bar'}
+console.log(normalize(pkg)) // {name:'foo', bin:{foo: 'bar'}}
+```
+
+Also strips out weird dots and slashes to prevent accidental and/or
+malicious bad behavior when the package is installed.