Logo for jsDocs.io

@types/pkginfo

  • Version 0.4.4
  • Published
  • 4.62 kB
  • 1 dependency
  • MIT license

Install

npm i @types/pkginfo
yarn add @types/pkginfo
pnpm add @types/pkginfo

Overview

TypeScript definitions for pkginfo

Index

Variables

Namespaces

Variables

variable pkgInfo

const pkgInfo: PkgInfo.PkgInfo & { version: string };

    Namespaces

    namespace PkgInfo

    namespace PkgInfo {}

      interface FindResults

      interface FindResults {}

        property dir

        dir?: string;

          property package

          package: Record<string, any>;

            interface Options

            interface Options {}

              property dir

              dir?: string;

                property include

                include: string[];

                  interface PkgInfo

                  interface PkgInfo {}

                    method find

                    find: (pmodule: NodeJS.Module, dir?: string) => Record<string, any>;

                      method read

                      read: (pmodule: NodeJS.Module, dir?: string) => FindResults;

                        call signature

                        (
                            pmodule: NodeJS.Module,
                            options?: Options | string[] | string,
                            ...properties: string[]
                        ): PkgInfo;

                          Package Files (1)

                          Dependencies (1)

                          Dev Dependencies (0)

                          No dev dependencies.

                          Peer Dependencies (0)

                          No peer dependencies.

                          Badge

                          To add a badge like this onejsDocs.io badgeto your package's README, use the codes available below.

                          You may also use Shields.io to create a custom badge linking to https://www.jsdocs.io/package/@types/pkginfo.

                          • Markdown
                            [![jsDocs.io](https://img.shields.io/badge/jsDocs.io-reference-blue)](https://www.jsdocs.io/package/@types/pkginfo)
                          • HTML
                            <a href="https://www.jsdocs.io/package/@types/pkginfo"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>