Logo for jsDocs.io

rollup-plugin-filesize

  • Version 10.0.0
  • Published
  • 36.5 kB
  • 8 dependencies
  • MIT license

Install

npm i rollup-plugin-filesize
yarn add rollup-plugin-filesize
pnpm add rollup-plugin-filesize

Overview

A rollup plugin to show filesize in the cli

Index

Functions

Interfaces

Type Aliases

Functions

function filesize

filesize: (options?: FileSizePluginOptions) => Plugin;

    Interfaces

    interface FileSizeInfo

    interface FileSizeInfo {}

      property brotliSize

      brotliSize: string;

        property brotliSizeBefore

        brotliSizeBefore?: string;

          property bundleSize

          bundleSize: string;

            property bundleSizeBefore

            bundleSizeBefore?: string;

              property fileName

              fileName: string;

                property gzipSize

                gzipSize: string;

                  property gzipSizeBefore

                  gzipSizeBefore?: string;

                    property lastVersion

                    lastVersion?: string;

                      property minSize

                      minSize: string;

                        property minSizeBefore

                        minSizeBefore?: string;

                          interface FileSizeOptions

                          interface FileSizeOptions {}

                            property format

                            format?: Parameters<typeof partial>[0];

                              property render

                              render?: FileSizeRender<string>;

                                property showBeforeSizes

                                showBeforeSizes?: 'release' | 'build' | 'none';

                                  property showBrotliSize

                                  showBrotliSize?: boolean;

                                    property showGzippedSize

                                    showGzippedSize?: boolean;

                                      property showMinifiedSize

                                      showMinifiedSize?: boolean;

                                        property theme

                                        theme?: 'dark' | 'light';

                                          interface FileSizePluginOptions

                                          interface FileSizePluginOptions extends FileSizeOptions {}

                                            property reporter

                                            reporter?: FileSizeReporter | FileSizeReporter[];

                                              Type Aliases

                                              type FileSizeRender

                                              type FileSizeRender<T> = (
                                                  options: FileSizeOptions,
                                                  outputOptions: OutputOptions,
                                                  info: FileSizeInfo
                                              ) => T;

                                                type FileSizeReporter

                                                type FileSizeReporter = 'boxen' | FileSizeRender<string | Promise<string>>;

                                                  Package Files (1)

                                                  Dependencies (8)

                                                  Dev Dependencies (17)

                                                  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/rollup-plugin-filesize.

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