types-pkg-json

types-pkg-json

Type checking for package.json.

Derived from type-fest with a focus on package.json types.

Installation

yarn add types-pkg-json

npm install types-pkg-json

API

Types

import { PackageJSON, fileName, PackageJSONFileName } from "types-pkg-json"; // Type for NPM's package.json file

console.log(fileName); // "package.json"

Field Types

import {
  BugsLocation, // Used by the `bugs` field.
  LicenseID, // Used by the `license` and `licenses.type` fields.
  Person, // Used by the `author`, `contributors`, and `maintainers` fields.
  DirectoryLocations, // Used by the `directories` field.
  Repository, // Used by the `repository` field.
  Scripts, // Used by the `scripts` field.
  Dependencies // Used by the `dependencies`, `devDependencies`, `optionalDependencies`, and `peerDependencies` fields.
} from "types-pkg-json";

Configuration Types

import {
  NonStandardEntryPoints, // module, esnext, browser, sideEffects
  TypeScriptConfiguration, // types, typings
  WorkspaceConfig, // packages, nohoist
  YarnConfiguration, // workspaces, flat, resolutions
  JSPMConfiguration, // jspm
  ESLintConfiguration // eslintConfig
} from "types-pkg-json";

Utility Types

import {
  isJSONObject
  JSONObject,
  JSONValue,
  JSONArray,
  Primitive,
  LiteralUnion
} from "types-pkg-json";

function isJSONObject(object?: JSONValue): object is JSONObject;

Dependencies

• types-json: Type checking for JSON objects
• types-eslintrc: Type checking for .eslintrc.json

Dev Dependencies

• @bconnorwhite/bob: Bob is a toolkit for TypeScript projects

License

MIT

Related Projects

• types-json: Type checking for JSON objects
• types-tsconfig: Type checking for tsconfig.json
• types-eslintrc: Type checking for .eslintrc.json

Changelog

1.2.1 (2020-10-09)

Bug Fixes

• bumped dependencies (be564bd)
• fixed repo url (2659d33)

Features

• export PackageJSONFileName type (2dedb04)