Logo for jsDocs.io

inspectpack

  • Version 4.7.1
  • Published
  • 148 kB
  • 7 dependencies
  • MIT license

Install

npm i inspectpack
yarn add inspectpack
pnpm add inspectpack

Overview

An inspection tool for Webpack frontend JavaScript bundles.

Index

Variables

Functions

Interfaces

Enums

Type Aliases

Variables

variable ACTIONS

const ACTIONS: IActions;

    Functions

    function actions

    actions: (name: string, opts: IActionConstructor) => Promise<IAction>;

    • Get action instance.

      Parameter name

      name of action

      Parameter opts

      action options

      Parameter

      opts.stats {Object} webpack stats object

      Returns

      {Promise} action instance

    function readJson

    readJson: (file: string) => Promise<any>;

      function render

      render: ({
          action,
          format,
          stats,
          ignoredPackages,
      }: IRenderOptions) => Promise<string>;

      • Render action to final template format.

        Parameter opts

        action + render options

        Parameter

        opts.action {String} name of action

        Parameter

        opts.format {Object} output format

        Parameter

        opts.stats {Object} webpack stats object

        Returns

        {Promise} Rendered result

      Interfaces

      interface IRenderOptions

      interface IRenderOptions extends IActionConstructor {}

        property action

        action: 'duplicates' | 'sizes' | 'versions';

          property format

          format: TemplateFormat;

            property ignoredPackages

            ignoredPackages: (string | RegExp)[];

              property stats

              stats: IWebpackStats;

                Enums

                enum TemplateFormat

                enum TemplateFormat {
                    json = 'json',
                    text = 'text',
                    tsv = 'tsv',
                }

                  member json

                  json = 'json'

                    member text

                    text = 'text'

                      member tsv

                      tsv = 'tsv'

                        Type Aliases

                        type IAction

                        type IAction = Action;

                          Package Files (4)

                          Dependencies (7)

                          Dev Dependencies (40)

                          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/inspectpack.

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