types-pkg-json

> Type checking for package.json.

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

Installation

``bash
yarn add types-pkg-json
`

`bash
npm install types-pkg-json
`

API

$3

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

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

#### Field Types

`ts
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

`ts
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

`ts
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