Resolve-pkg-option NPM

resolve-pkg-option

Returns a normalized node package representation by either specifying an object or a file path.

Installation

npm install --save resolve-pkg-option@^

yarn add resolve-pkg-option@^

Try it out

Open a browser's JavaScript console and execute:

const scriptElement = document.createElement("script");
scriptElement.setAttribute("type","text/javascript");
scriptElement.setAttribute("src","https://unpkg.com/resolve-pkg-option@1.0.8");
document.querySelector("head").appendChild(scriptElement);

The module is now loaded in a variable.

typeof resolve-pkg-option.default

Documentation

resolve-pkg-option
- ~default(pkg, options) ⇒ Promise.<result>
- ~result : object
- ~options : object

Loads a package.json or prepares given pkg data

Kind: inner method of resolve-pkg-option
Returns: Promise.<result> - Resolving result with package data and an optional file path resolvePkgOption({name: " test"}) // { path: false, pkg: {name: "test"} }

Param	Type	Description
pkg	object \| string	Either a path where the package.json is searched at, or pkg data as an object
options	options	Resolving options

Example

resolvePkgOption({name: " test"}, {normalize: false})
// { path: false, pkg: {name: " test"} }

Kind: inner typedef of resolve-pkg-option
Properties

Name	Type	Description
pkg	object	The final pkg data
path	string \| false	The file path where the pkg data got loaded from

Kind: inner typedef of resolve-pkg-option
Properties

Name	Type	Default	Description
normalize	boolean	true	Apply normalize-package-data
json5	boolean	true	Parse package.json with json5
preventDependencyCopy	boolean	true	Prevents `pkg.optionalDependencies` from getting copied to `pkg.dependencies` by normalize-package-data, see: https://github.com/npm/normalize-package-data/issues/91

License

MIT License

Copyright © 2019, Jaid <jaid.jsx@gmail.com> (github.com/jaid)

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.