size-limit

property brotli

brotli?: boolean;

• With false it will disable any compression.

property compareWith

compareWith?: string;

• Path to stats.json from another build to compare (when --why is using).

property config

config?: string;

• A path to a custom webpack, esbuild or rolldown config.

property disableModuleConcatenation

disableModuleConcatenation?: boolean;

property disablePlugins

disablePlugins?: string[];

• Plugin npm package names to skip for this check. For example: ["@size-limit/webpack"], ["@size-limit/esbuild"], ["@size-limit/rolldown"], or ["@size-limit/time"].

property entry

entry?: string | string[];

• When using a custom bundler config, an entry point could be given. It could be a string or an array of strings. By default, the total size of all entry points will be checked.

property gzip

gzip?: boolean;

• With true it will use Gzip compression and disable Brotli compression.

property hidePassed

hidePassed?: boolean;

property highlightLess

highlightLess?: boolean;

property ignore

ignore?: string[];

• An array of files and dependencies to exclude from the project size calculation.

property import

import?: string | Record<string, string>;

• Partial import to test tree-shaking. It could be "{ lib }" to test import { lib } from 'lib', * to test all exports, or { "a.js": "{ a }", "b.js": "{ b }" } to test multiple files.

property limit

limit?: string;

• Size or time limit for files from the path option. It should be a string with a number and unit, separated by a space. Format: 100 B, 10 kB, 500 ms, 1 s.

property modifyEsbuildConfig

modifyEsbuildConfig?: (config: object) => object;

• (.size-limit.js only) Function that can be used to do last-minute changes to the esbuild config, like adding a plugin. Annotate the parameter with BuildOptions to read properties.

property modifyRolldownConfig

modifyRolldownConfig?: (config: object) => object;

• (.size-limit.js only) Function that can be used to do last-minute changes to the rolldown config, like adding a plugin. Annotate the parameter with RolldownOptions to read properties.

property modifyWebpackConfig

modifyWebpackConfig?: (config: object) => object;

• (.size-limit.js only) Function that can be used to do last-minute changes to the webpack config, like adding a plugin. Annotate the parameter with Configuration to read properties.

property module

module?: boolean;

property name

name?: string;

• The name of the current section. It will only be useful if you have multiple sections.

property path

path: string | string[];

• Relative paths to files. The only mandatory option. It could be a path "index.js", a "dist/app-*.js" or an array ["index.js", "dist/app-*.js", "!dist/app-exclude.js"].

property rolldown

rolldown?: boolean;

• With false it will disable rolldown.

property running

running?: boolean;

• With false it will disable calculating running time.

property time

time?: TimeOptions;

• Options for @size-limit/time plugin.

property uiReports

uiReports?: object;

• Custom UI reports list.

  See Also

property webpack

webpack?: boolean;

• With false it will disable webpack.

property before

before?: PluginHook;

• Called before the first step.

property finally

finally?: PluginHook;

• Called after the last step, even when a step has thrown.

property name

name: string;

• NPM package name of the plugin, for example @size-limit/file. It is also the name to use in the disablePlugins option.

property bundles

bundles?: string[];

• Built files to measure instead of files, set by a bundler plugin.

property entry

entry?: string[];

• Entry points, normalized into an array.

property esbuild

esbuild?: boolean;

• With false it will disable esbuild.

property esbuildConfig

esbuildConfig?: Record<string, unknown>;

• esbuild build options, set by @size-limit/esbuild. Use esbuild types for its exact shape.

property esbuildMetafile

esbuildMetafile?: Record<string, unknown>;

• esbuild build metadata, set by @size-limit/esbuild. Use esbuild types for its exact shape.

property esbuildOutfile

esbuildOutfile?: string;

• Directory with the esbuild output, set by @size-limit/esbuild.

property esbuildVisualizerFile

esbuildVisualizerFile?: string;

• Path to the esbuild bundle analyzer report, set by @size-limit/esbuild-why.

property files

files?: string[];

• Absolute paths of the files to measure, after globbing. It is not set when the check is defined by entry and a bundler plugin provides bundles.

property import

import?: Record<string, string>;

• Partial imports to test tree-shaking, keyed by the absolute path of a file.

property loadTime

loadTime?: number;

• Time to load the files, in seconds, set by @size-limit/time.

property missed

missed?: boolean;

• With true the check has missed all of its files. It is set after the last step.

property passed

passed?: boolean;

• With false the check has failed. It is set after the last step.

property path

path?: string | string[];

• Path of the check before it was resolved into files. It is not set when the check is defined by entry.

property rolldownConfig

rolldownConfig?: Record<string, unknown>;

• rolldown configuration, set by @size-limit/rolldown. Use rolldown types for its exact shape.

property rolldownOutput

rolldownOutput?: string;

• Directory with the rolldown output, set by @size-limit/rolldown.

property rolldownVisualizerFile

rolldownVisualizerFile?: string;

• Path to the rolldown bundle analyzer report, set by @size-limit/rolldown-why.

property runTime

runTime?: number;

• Time to execute the files, in seconds, set by @size-limit/time.

property size

size?: number;

• Total size of bundles or files in bytes, set by @size-limit/file.

property sizeLimit

sizeLimit?: number;

• Size limit in bytes, parsed from the limit option.

property time

time?: Omit<TimeOptions, 'latency' | 'networkSpeed'> & {
    latency?: number;
    networkSpeed?: number;
};

• Options of @size-limit/time after normalization: latency in seconds and networkSpeed in bytes.

property timeLimit

timeLimit?: number;

• Time limit in seconds, parsed from the limit option.

property totalTime

totalTime?: number;

• Total time of the check, in seconds, set by @size-limit/time.

property webpackConfig

webpackConfig?: Record<string, unknown>;

• webpack configuration, set by @size-limit/webpack. Use webpack types for its exact shape.

property webpackOutput

webpackOutput?: string;

• Directory with the webpack output, set by @size-limit/webpack.

property checks

checks: PluginCheck[];

• Checks to run.

property cleanDir

cleanDir?: boolean;

• With true the saveBundle directory will be cleaned before the build, set by the --clean-dir argument.

property compareWith

compareWith?: string;

• Absolute path to stats.json from another build to compare, set by the --compare-with argument.

property configPath

configPath?: string;

• Path to the config file relative to cwd. It is set only when the config comes from a config file.

property cwd

cwd?: string;

• Directory the checks are resolved from. It is set only when the config comes from a config file.

property failed

failed?: boolean;

• With true at least one check has failed. It is set after the last step.

property missed

missed?: boolean;

• With true at least one check has missed all of its files. It is set after the last step.

property project

project?: string;

• Package name, set by the --why argument.

property saveBundle

saveBundle?: string;

• Absolute path to the directory from the --save-bundle argument.

property why

why?: boolean;

• With true it will open the bundle analyzer, set by the --why argument.

property latency

latency?: string;

• Delay for calculating loading time that simulates network latency It should be a string with a number and unit, separated by a space. Format: 500 ms, 1 s. @default: "0"

property loadingMessage

loadingMessage?: string;

• A message for loading time details "on slow 3G"

property networkSpeed

networkSpeed?: string;

• A network speed to calculate loading time of files. It should be a string with a number and unit, separated by a space. Format: 100 B, 10 kB. "50 kB"