@bconnorwhite/module
    TypeScript icon, indicating that this package has built-in type declarations

    2.0.2 • Public • Published

    @bconnorwhite/module

    npm typescript GitHub stars Twitter Follow

    Read your module's package.json without importing it.

    Why not just import your package.json? Importing your package.json can break your project's structure when using TypeScript if package.json is outside of your source folder.

    Installation

    yarn add @bconnorwhite/module
    npm install @bconnorwhite/module

    API

    import {
      PackageJSON,
      getPackageJSON,
      getPackageJSONSync,
      getVersion,
      getVersionSync
    } from "@bconnorwhite/module";
     
    function getPackageJSON(dirname: string): Promise<PackageJSON | undefined>;
     
    function getPackageJSONSync(dirname: string): PackageJSON | undefined;
     
    function getVersion(dirname: string): Promise<string | undefined>;
     
    function getVersionSync(dirname: string): string | undefined;

    Dependenciesdependencies

    • find-up: Find a file or directory by walking up parent directories
    • read-json-safe: Read objects from JSON files without try catch.
    • types-pkg-json: Type checking for package.json

    Dev DependenciesDavid


    License license

    MIT


    Related Packages

    • @bconnorwhite/package: A utility for reading package.json of a project, and forming paths relative to it.

    Install

    npm i @bconnorwhite/module

    DownloadsWeekly Downloads

    123

    Version

    2.0.2

    License

    MIT

    Unpacked Size

    8.74 kB

    Total Files

    11

    Last publish

    Collaborators

    • bconnorwhite