urltomarkdown/node_modules/get-package-type
Lee Hanken ca3866eae3 added unit tests 2022-12-23 12:03:25 +00:00
..
CHANGELOG.md added unit tests 2022-12-23 12:03:25 +00:00
LICENSE added unit tests 2022-12-23 12:03:25 +00:00
README.md added unit tests 2022-12-23 12:03:25 +00:00
async.cjs added unit tests 2022-12-23 12:03:25 +00:00
cache.cjs added unit tests 2022-12-23 12:03:25 +00:00
index.cjs added unit tests 2022-12-23 12:03:25 +00:00
is-node-modules.cjs added unit tests 2022-12-23 12:03:25 +00:00
package.json added unit tests 2022-12-23 12:03:25 +00:00
sync.cjs added unit tests 2022-12-23 12:03:25 +00:00

README.md

get-package-type NPM Version

Determine the package.json#type which applies to a location.

Usage

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.

// 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.