@types/webpack-manifest-plugin

  • Version 3.0.8
  • Published
  • 5.64 kB
  • 2 dependencies
  • MIT license

Install

npm i @types/webpack-manifest-plugin
yarn add @types/webpack-manifest-plugin
pnpm add @types/webpack-manifest-plugin

Overview

TypeScript definitions for webpack-manifest-plugin

Index

Variables

variable WebpackManifestPlugin

const WebpackManifestPlugin: new (options?: Options) => WebpackPluginInstance;

    Functions

    function getCompilerHooks

    getCompilerHooks: (compiler: Compiler) => {
    afterEmit: SyncWaterfallHook;
    beforeEmit: SyncWaterfallHook;
    };

      Interfaces

      interface FileDescriptor

      interface FileDescriptor {}

        property chunk

        chunk?: Chunk | undefined;
        • Only available if isChunk is true.

        property isAsset

        isAsset: boolean;

          property isChunk

          isChunk: boolean;

            property isInitial

            isInitial: boolean;
            • Is required to run you app. Cannot be true if isChunk is false.

            property isModuleAsset

            isModuleAsset: boolean;
            • Is required by a module. Cannot be true if isAsset is false.

            property name

            name: string | null;

              property path

              path: string;

                interface Options

                interface Options {}

                  property basePath

                  basePath?: string | undefined;
                  • A path prefix for all keys. Useful for including your output path in the manifest. Default: ''

                  property fileName

                  fileName?: string | undefined;
                  • The manifest filename in your output directory. Default: 'manifest.json'

                  property filter

                  filter?: ((file: FileDescriptor) => boolean) | undefined;
                  • Filter out files which make up the manifest. Return true to keep the file, false to remove it.

                  property generate

                  generate?:
                  | ((
                  seed: object,
                  files: FileDescriptor[],
                  entries: Record<string, string[]>
                  ) => object)
                  | undefined;
                  • Create the manifest. It can return anything as long as it's serializable by JSON.stringify.

                  property map

                  map?: ((file: FileDescriptor) => FileDescriptor) | undefined;
                  • Modify file details before the manifest is created.

                  property publicPath

                  publicPath?: string | undefined;
                  • A path prefix that will be added to values of the manifest. Default: output.publicPath

                  property removeKeyHash

                  removeKeyHash?: RegExp | boolean | undefined;
                  • Remove hashes from manifest keys. Defaults to Webpack's md5 hash. Default: /([a-f0-9]{32}.?)/gi

                  property seed

                  seed?: object | undefined;
                  • A cache of key/value pairs to used to seed the manifest. Default: {}

                  property serialize

                  serialize?: ((manifest: object) => string) | undefined;
                  • Output manifest file in different format then json (i.e. yaml).

                  property sort

                  sort?: ((fileA: FileDescriptor, fileB: FileDescriptor) => number) | undefined;
                  • Sort files before they are passed to generate.

                  property useEntryKeys

                  useEntryKeys?: boolean | undefined;
                  • If true, the keys specified in the entry property will be used as keys in the manifest. Default: false

                  property writeToFileEmit

                  writeToFileEmit?: boolean | undefined;
                  • If set to true will emit to build folder and memory in combination with webpack-dev-server. Default: false

                  Package Files (1)

                  Dependencies (2)

                  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/webpack-manifest-plugin.

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