https://github.com/cfware/get-package-type

Determine the `package.json#type` which applies to a location.
https://github.com/cfware/get-package-type

Last synced: 29 days ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/cfware/get-package-type
• Owner: cfware
• License: mit
• Created: 2020-05-17T21:40:11.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2020-05-19T10:06:23.000Z (over 4 years ago)
• Last Synced: 2024-11-08T21:03:17.142Z (about 1 month ago)
• Language: JavaScript
• Size: 8.79 KB
• Stars: 5
• Watchers: 2
• Forks: 3
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# 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