# get-package-type

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

Latest version **0.1.0** (published 2020-05-19) · MIT license · 0 weekly downloads

## Install

```sh
npm install get-package-type
pnpm add get-package-type
yarn add get-package-type
bun add get-package-type
```

## Health

**Score 28/100 (F)** — status: abandoned.

Positive: has types package; esm support; no vulnerabilities; high quality score.

Warnings: low downloads; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.0 |
| Published | 2020-05-19 |
| First published | 2020-05-19 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | separate (@types/get-package-type) |
| Module format | ESM + CommonJS |
| Node | >=8.0.0 |
| Dependencies | 0 |
| Unpacked size | 5.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 5 |
| Author | Corey Farrell |
| Maintainers | coreyfarrell |

## Links

- npm: https://www.npmjs.com/package/get-package-type
- Repository: https://github.com/cfware/get-package-type
- Homepage: https://github.com/cfware/get-package-type#readme
- Issues: https://github.com/cfware/get-package-type/issues
- npm.io page: https://npm.io/package/get-package-type

## Recent versions

- 0.1.0 (latest) — 2020-05-19

## 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

---
_Source: https://npm.io/package/get-package-type · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._