aboutsummaryrefslogtreecommitdiff
path: root/node_modules/get-package-type/README.md
diff options
context:
space:
mode:
authorJoel Kronqvist <joel.h.kronqvist@gmail.com>2022-03-05 19:02:27 +0200
committerJoel Kronqvist <joel.h.kronqvist@gmail.com>2022-03-05 19:02:27 +0200
commit5d309ff52cd399a6b71968a6b9a70c8ac0b98981 (patch)
tree360f7eb50f956e2367ef38fa1fc6ac7ac5258042 /node_modules/get-package-type/README.md
parentb500a50f1b97d93c98b36ed9a980f8188d648147 (diff)
downloadLYLLRuoka-5d309ff52cd399a6b71968a6b9a70c8ac0b98981.tar.gz
LYLLRuoka-5d309ff52cd399a6b71968a6b9a70c8ac0b98981.zip
Added node_modules for the updating to work properly.
Diffstat (limited to 'node_modules/get-package-type/README.md')
-rw-r--r--node_modules/get-package-type/README.md32
1 files changed, 32 insertions, 0 deletions
diff --git a/node_modules/get-package-type/README.md b/node_modules/get-package-type/README.md
new file mode 100644
index 0000000..8e1ebf2
--- /dev/null
+++ b/node_modules/get-package-type/README.md
@@ -0,0 +1,32 @@
+# get-package-type [![NPM Version][npm-image]][npm-url]
+
+Determine the `package.json#type` which applies to a location.
+
+## Usage
+
+```js
+const getPackageType = require('get-package-type');
+
+(async () => {
+ console.log(await getPackageType('file.js'));
+ console.log(getPackageType.sync('file.js'));
+})();
+```
+
+This function does not validate the value found in `package.json#type`. Any truthy value
+found will be returned. Non-truthy values will be reported as `commonjs`.
+
+The argument must be a filename.
+```js
+// This never looks at `dir1/`, first attempts to load `./package.json`.
+const type1 = await getPackageType('dir1/');
+
+// This attempts to load `dir1/package.json`.
+const type2 = await getPackageType('dir1/index.cjs');
+```
+
+The extension of the filename does not effect the result. The primary use case for this
+module is to determine if `myapp.config.js` should be loaded with `require` or `import`.
+
+[npm-image]: https://img.shields.io/npm/v/get-package-type.svg
+[npm-url]: https://npmjs.org/package/get-package-type