@types/webpack-assets-manifest

/// <reference types="node" /> import { AsyncSeriesHook, SyncHook, SyncWaterfallHook } from "tapable"; import { Asset, Compilation, Compiler, LoaderContext, Module, Stats, WebpackPluginInstance } from "webpack"; declare class WebpackAssetsManifest implements WebpackPluginInstance { constructor(options?: WebpackAssetsManifest.Options); /** https://github.com/webdeveric/webpack-assets-manifest#hooks */ hooks: { apply: SyncHook<[WebpackAssetsManifest]>; customize: SyncWaterfallHook< [WebpackAssetsManifest.Entry, WebpackAssetsManifest.Entry, WebpackAssetsManifest, Asset | null] >; transform: SyncWaterfallHook<[WebpackAssetsManifest.Assets, WebpackAssetsManifest]>; done: AsyncSeriesHook<[WebpackAssetsManifest, Stats]>; options: SyncWaterfallHook<[WebpackAssetsManifest.Options]>; afterOptions: SyncHook<[WebpackAssetsManifest.Options]>; }; /** https://github.com/webdeveric/webpack-assets-manifest#options-read-the-schema */ options: WebpackAssetsManifest.Options; /** This is what gets JSON stringified */ assets: WebpackAssetsManifest.Assets; /** original filename : hashed filename */ assetNames: Map<string, string>; /** This is passed to the customize() hook */ currentAsset: Asset | null; /** The Webpack compiler instance */ compiler: Compiler | null; /** Hook into the Webpack compiler */ apply(compiler: Compiler): void; /** https://github.com/webdeveric/webpack-assets-manifest#options-read-the-schema */ get defaultOptions(): WebpackAssetsManifest.Options; /** Determine if the manifest data is currently being merged */ get isMerging(): boolean; /** Get the file extension */ getExtension(filename: string): string; /** Replace backslash with forward slash */ fixKey(key: string): string; /** Add item to assets without modifying the key or value */ setRaw(key: string, value: unknown): this; /** Add an item to the manifest */ set(key: string, value: unknown): this; /** Determine if an item exist in the manifest */ has(key: string): boolean; /** Get an item from the manifest */ get(key: string, defaultValue?: unknown): unknown; /** Delete an item from the manifest */ delete(key: string): boolean; /** Process compilation assets */ processAssetsByChunkName( assets: Record<string, string | readonly string[]>, hmrFiles?: Set<string>, ): this["assetNames"]; /** Get the data for `JSON.stringify()` */ toJSON(): unknown; /** `JSON.stringify()` the manifest */ toString(): string; /** Merge data if the output file already exists */ maybeMerge(): void; /** Emit the assets manifest */ emitAssetsManifest(compilation: Compilation): Promise<void>; /** Record details of Asset Modules */ handleProcessAssetsAnalyse(compilation: Compilation): void; /** * When using webpack 5 persistent cache, loaderContext.emitFile sometimes doesn't * get called and so the asset names are not recorded. To work around this, lets * loops over the stats.assets and record the asset names. */ processStatsAssets(assets: readonly Asset[]): void; /** Get assets and hot module replacement files from a compilation object */ getCompilationAssets(compilation: Compilation): { assets: Asset[]; hmrFiles: Set<string> }; /** Gather asset details */ handleProcessAssetsReport(compilation: Compilation): Promise<void>; /** Get the parsed output path. [hash] is supported. */ getManifestPath(compilation: Compilation, filename: string): string; /** Write the asset manifest to the file system */ writeTo(destination: string): Promise<void>; clear(): void; /** Cleanup before running Webpack */ handleWatchRun(): void; /** Determine if the manifest should be written to disk with fs */ shouldWriteToDisk(compilation: Compilation): boolean; /** Last chance to write the manifest to disk */ handleAfterEmit(compilation: Compilation): Promise<void>; /** Record asset names */ handleNormalModuleLoader(compilation: Compilation, loaderContext: LoaderContext<unknown>, module: Module): void; /** Add the SRI hash to the assetsInfo map */ recordSubresourceIntegrity(compilation: Compilation): void; /** Hook into compilation objects */ handleCompilation(compilation: Compilation): void; /** Hook into the compilation object */ handleThisCompilation(compilation: Compilation): void; /** * Determine if webpack-dev-server is being used * * The WEBPACK_DEV_SERVER / WEBPACK_SERVE env vars cannot be relied upon. * See issue {@link https://github.com/webdeveric/webpack-assets-manifest/issues/125|#125} */ inDevServer(): boolean; /** Get the file system path to the manifest */ getOutputPath(): string; /** Get the public path for the filename */ getPublicPath(filename: string): string; /** * Get a {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Proxy/handler|Proxy} for the manifest. * This allows you to use `[]` to manage entries. * * @param raw - Should the proxy use `setRaw` instead of `set`? */ getProxy(raw?: boolean): WebpackAssetsManifest.Assets; } declare namespace WebpackAssetsManifest { interface Options { /** https://github.com/webdeveric/webpack-assets-manifest#enabled */ enabled?: boolean | undefined; /** https://github.com/webdeveric/webpack-assets-manifest#assets */ assets?: Assets | undefined; /** https://github.com/webdeveric/webpack-assets-manifest#output */ output?: string | undefined; /** https://github.com/webdeveric/webpack-assets-manifest#replacer */ replacer?: | ((this: unknown, key: string, value: unknown) => unknown) | ReadonlyArray<string | number> | null | undefined; /** https://github.com/webdeveric/webpack-assets-manifest#space */ space?: number | string | undefined; /** https://github.com/webdeveric/webpack-assets-manifest#writetodisk */ writeToDisk?: boolean | "auto" | undefined; /** https://github.com/webdeveric/webpack-assets-manifest#fileextregex */ fileExtRegex?: RegExp | null | false | undefined; /** https://github.com/webdeveric/webpack-assets-manifest#sortmanifest */ sortManifest?: boolean | ((this: WebpackAssetsManifest, a: string, b: string) => number) | undefined; /** https://github.com/webdeveric/webpack-assets-manifest#merge */ merge?: boolean | "customize" | undefined; /** https://github.com/webdeveric/webpack-assets-manifest#publicpath */ publicPath?: | string | boolean | null | ((filename: string, manifest: WebpackAssetsManifest) => string) | undefined; /** https://github.com/webdeveric/webpack-assets-manifest#contextrelativekeys */ contextRelativeKeys?: boolean | undefined; /** https://github.com/webdeveric/webpack-assets-manifest#apply */ apply?: ((manifest: WebpackAssetsManifest) => void) | null | undefined; /** https://github.com/webdeveric/webpack-assets-manifest#customize */ customize?: | ((entry: Entry, original: Entry, manifest: WebpackAssetsManifest, asset: Asset | null) => Entry | false) | null | undefined; /** https://github.com/webdeveric/webpack-assets-manifest#transform */ transform?: ((assets: Assets, manifest: WebpackAssetsManifest) => unknown) | null | undefined; /** https://github.com/webdeveric/webpack-assets-manifest#done */ done?: ((manifest: WebpackAssetsManifest, stats: Stats) => void) | null | undefined; /** https://github.com/webdeveric/webpack-assets-manifest#entrypoints */ entrypoints?: boolean | undefined; /** https://github.com/webdeveric/webpack-assets-manifest#entrypointskey */ entrypointsKey?: string | false | undefined; /** https://github.com/webdeveric/webpack-assets-manifest#entrypointsuseassets */ entrypointsUseAssets?: boolean | undefined; /** https://github.com/webdeveric/webpack-assets-manifest#integrity */ integrity?: boolean | undefined; /** https://github.com/webdeveric/webpack-assets-manifest#integrityhashes */ integrityHashes?: readonly string[] | undefined; /** https://github.com/webdeveric/webpack-assets-manifest#integritypropertyname */ integrityPropertyName?: string | undefined; /** * A place to put your arbitrary data * @default {} */ extra?: Record<string, unknown> | undefined; } interface Entry { key: string; value: string; } interface Assets extends Record<string, unknown> {} } export = WebpackAssetsManifest;