JSPM

  • Created
  • Published
  • Downloads 4574
  • Score
    100M100P100Q117801F
  • License GPL-3.0

A handful set of package.json types and interfaces to improve working with dynamically imported package.json files.

Package Exports

  • types-package-json

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (types-package-json) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

types-package-json

A handful set of package.json types and interfaces to improve working with dynamically imported package.json files.

Table of contents

  1. Getting Started

  2. Usage

  3. Features

Getting Started

npm i -D types-package-json

Usage

import { IPackageJson } from 'types-package-json';

const packageJsonPath = path.resolve(process.cwd(), `package.json`);
const packageJson: Partial<IPackageJson> = await import(packageJsonPath);

Features

Zero overhead - contains only types and interfaces, no actual objects. I prefixed - all interfaces are prefiexed with I to avoid misunderstanding interface with a class and decrease naming overlaps. IPackageJson - full package.json interface, name and version is required IPackageJsonAddress - optional email and url IPackageJsonPerson - required name, optional email and url IPackageJsonDependencyTypes - 'dependencies' | 'devDependencies' | 'peerDependencies' | 'optionalDependencies' (bundledDependencies are not included in this type as they serve different purpose).