types-pkg-json

    1.2.1 • Public • Published

    types-pkg-json

    NPM TypeScript Coverage Status GitHub Stars Twitter Follow

    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;

    Dependenciesdependencies


    Dev DependenciesDavid

    License license

    MIT


    Related Projects

    Install

    npm i types-pkg-json

    DownloadsWeekly Downloads

    203

    Version

    1.2.1

    License

    MIT

    Unpacked Size

    25 kB

    Total Files

    21

    Last publish

    Collaborators

    • bconnorwhite