@types/rollup-plugin-visualizer
Version:
TypeScript definitions for rollup-plugin-visualizer
74 lines (65 loc) • 2.45 kB
Markdown
# Installation
> `npm install --save @types/rollup-plugin-visualizer`
# Summary
This package contains type definitions for rollup-plugin-visualizer (https://github.com/doesdev/rollup-plugin-analyzer#readme).
# Details
Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/rollup-plugin-visualizer.
## [index.d.ts](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/rollup-plugin-visualizer/index.d.ts)
````ts
/// <reference types="node" />
import { Plugin } from "rollup";
declare namespace visualizer {
interface PluginVisualizerOptions {
/**
* Name of the file with diagram to generate
* @default "stats.html"
*/
filename?: string | undefined;
/**
* Title tag value
* @default "Rollup Visualizer"
*/
title?: string | undefined;
/**
* Use sourcemaps to calculate sizes (e.g. after UglifyJs or Terser)
* @default false
*/
sourcemap?: boolean | undefined;
/**
* Open generated file in default user agent
* @default false
*/
open?: boolean | undefined;
/**
* Which diagram type to use
* @default "treemap"
*/
template?: "treemap" | "sunburst" | "network" | undefined;
/**
* Product portable json file that can be used with
* plugin CLI util to generate graph from several json files.
* Every UI property ignored in this case.
* @default false
*/
json?: boolean | undefined;
/**
* Collect gzip size from source code and display it at chart
* @default false
*/
gzipSize?: boolean | undefined;
/**
* Collect brotli size from source code and display it at chart.
* Only if current node version supports it
* @default false
*/
brotliSize?: boolean | undefined;
}
}
declare function visualizer(options?: visualizer.PluginVisualizerOptions): Plugin;
export = visualizer;
````
### Additional Details
* Last updated: Tue, 07 Nov 2023 15:11:36 GMT
* Dependencies: [@types/node](https://npmjs.com/package/@types/node), [rollup](https://npmjs.com/package/rollup)
# Credits
These definitions were written by [Nick](https://github.com/fobdy), and [Max Boguslavskiy](https://github.com/maxbogus).