purgecss

constructor

constructor(er: ExtractorResult);

method hasAttrName

hasAttrName: (name: string) => boolean;

method hasAttrPrefix

hasAttrPrefix: (prefix: string) => boolean;

method hasAttrSubstr

hasAttrSubstr: (substr: string) => boolean;

method hasAttrSuffix

hasAttrSuffix: (suffix: string) => boolean;

method hasAttrValue

hasAttrValue: (value: string) => boolean;

method hasClass

hasClass: (name: string) => boolean;

method hasId

hasId: (id: string) => boolean;

method hasTag

hasTag: (tag: string) => boolean;

method merge

merge: (that: ExtractorResult | ExtractorResultSets) => this;

property options

options: Options;

property removedNodes

removedNodes: postcss.Node[];

property selectorsRemoved

selectorsRemoved: Set<string>;

property variablesStructure

variablesStructure: VariablesStructure;

method extractSelectorsFromFiles

extractSelectorsFromFiles: (
    files: string[],
    extractors: Extractors[]
) => Promise<ExtractorResultSets>;

• Extract the selectors present in the files using a PurgeCSS extractor

  Parameter files

  Array of files path or glob pattern

  Parameter extractors

  Array of extractors

method extractSelectorsFromString

extractSelectorsFromString: (
    content: RawContent[],
    extractors: Extractors[]
) => Promise<ExtractorResultSets>;

• Extract the selectors present in the passed string using a PurgeCSS extractor

  Parameter content

  Array of content

  Parameter extractors

  Array of extractors

method getPurgedCSS

getPurgedCSS: (
    cssOptions: Array<string | RawCSS>,
    selectors: ExtractorResultSets
) => Promise<ResultPurge[]>;

• Get the purged version of the css based on the files

  Parameter cssOptions

  css options, files or raw strings

  Parameter selectors

  set of extracted css selectors

method purge

purge: (
    userOptions: UserDefinedOptions | string | undefined
) => Promise<ResultPurge[]>;

• Remove unused CSS

  Parameter userOptions

  PurgeCSS options or path to the configuration file

  Returns

  an array of object containing the filename and the associated CSS

  Example 1

  Using a configuration file named purgecss.config.js

  const purgeCSSResults = await new PurgeCSS().purge()

  Example 2

  Using a custom path to the configuration file

  const purgeCSSResults = await new PurgeCSS().purge('./purgecss.config.js')

  Example 3

  Using the PurgeCSS options

  const purgeCSSResults = await new PurgeCSS().purge({
     content: ['index.html', '**\/*.js', '**\/*.html', '**\/*.vue'],
     css: ['css/app.css']
  })

method removeUnusedCSSVariables

removeUnusedCSSVariables: () => void;

• Remove unused CSS variables

method removeUnusedFontFaces

removeUnusedFontFaces: () => void;

• Remove unused font-faces

method removeUnusedKeyframes

removeUnusedKeyframes: () => void;

• Remove unused keyframes

method walkThroughCSS

walkThroughCSS: (root: postcss.Root, selectors: ExtractorResultSets) => void;

• Walk through the CSS AST and remove unused CSS

  Parameter root

  root node of the postcss AST

  Parameter selectors

  selectors used in content files

constructor

constructor(declaration: postcss.Declaration);

property isUsed

isUsed: boolean;

property nodes

nodes: VariableNode[];

property value

value: postcss.Declaration;

property nodes

nodes: Map<string, VariableNode[]>;

property safelist

safelist: StringRegExpArray;

property usedVariables

usedVariables: Set<string>;

method addVariable

addVariable: (declaration: postcss.Declaration) => void;

method addVariableUsage

addVariableUsage: (
    declaration: postcss.Declaration,
    matchedVariables: IterableIterator<RegExpMatchArray>
) => void;

method addVariableUsageInProperties

addVariableUsageInProperties: (
    matchedVariables: IterableIterator<RegExpMatchArray>
) => void;

method isVariablesSafelisted

isVariablesSafelisted: (variable: string) => boolean;

method removeUnused

removeUnused: () => void;

method setAsUsed

setAsUsed: (variableName: string) => void;

property attributes

attributes: {
    names: string[];
    values: string[];
};

property classes

classes: string[];

property ids

ids: string[];

property tags

tags: string[];

property undetermined

undetermined: string[];

property extensions

extensions: string[];

property extractor

extractor: ExtractorFunction;

property blocklist

blocklist: StringRegExpArray;

• Blocklist will block the CSS selectors from appearing in the final output CSS. The selectors will be removed even when they are seen as used by PurgeCSS.

property content

content: Array<string | RawContent>;

• You can specify content that should be analyzed by PurgeCSS with an array of filenames or globs. The files can be HTML, Pug, Blade, etc.

  Example 1

  await new PurgeCSS().purge({
    content: ['index.html', '*.js', '*.html', '*.vue'],
    css: ['css/app.css']
  })

  Example 2

  PurgeCSS also works with raw content. To do this, you need to pass an object with the raw property instead of a filename. To work properly with custom extractors you need to pass the extension property along with the raw content.

  await new PurgeCSS().purge({
    content: [
      {
        raw: '<html><body><div class="app"></div></body></html>',
        extension: 'html'
      },
      '*.js',
      '*.html',
      '*.vue'
    ],
    css: [
      {
        raw: 'body { margin: 0 }'
      },
      'css/app.css'
    ]
  })

property css

css: Array<string | RawCSS>;

• Similar to content, you can specify css that should be processed by PurgeCSS with an array of filenames or globs

property defaultExtractor

defaultExtractor: ExtractorFunction;

property dynamicAttributes

dynamicAttributes: string[];

• Option to add custom CSS attribute selectors like "aria-selected", "data-selected", ...etc.

property extractors

extractors: Array<Extractors>;

property fontFace

fontFace: boolean;

• If there are any unused @font-face rules in your css, you can remove them by setting the fontFace option to true.

  Example 1

  await new PurgeCSS().purge({
    content: ['index.html', '*.js', '*.html', '*.vue'],
    css: ['css/app.css'],
    fontFace: true
  })

property keyframes

keyframes: boolean;

property output

output?: string;

property rejected

rejected: boolean;

property rejectedCss

rejectedCss: boolean;

property safelist

safelist: Required<ComplexSafelist>;

• You can indicate which selectors are safe to leave in the final CSS. This can be accomplished with the option safelist.

property skippedContentGlobs

skippedContentGlobs: Array<string>;

• If you provide globs for the content parameter, you can use this option to exclude certain files or folders that would otherwise be scanned. Pass an array of globs matching items that should be excluded. (Note: this option has no effect if content is not globs.)

property sourceMap

sourceMap:
    | boolean
    | (postcss.SourceMapOptions & {
          to?: string;
      });

• See documentation for SourceMapOptions from package postcss.

property stdin

stdin: boolean;

property stdout

stdout: boolean;

property variables

variables: boolean;

property extension

extension: string;

property raw

raw: T;

property name

name?: string;

property raw

raw: string;

property css

css: string;

property file

file?: string;

property rejected

rejected?: string[];

property rejectedCss

rejectedCss?: string;

property sourceMap

sourceMap?: string;

• sourceMap property will be empty if UserDefinedOptions.sourceMap inline is not set to false, as the source map will be contained within the text of ResultPurge.css

property blocklist

blocklist?: StringRegExpArray;

• See documentation for Options.blocklist from package purgecss.

property content

content: Array<string | RawContent>;

• See documentation for Options.content from package purgecss.

property css

css: Array<string | RawCSS>;

• See documentation for Options.css from package purgecss.

property defaultExtractor

defaultExtractor?: ExtractorFunction;

• See documentation for Options.defaultExtractor from package purgecss.

property dynamicAttributes

dynamicAttributes?: string[];

• See documentation for Options.dynamicAttributes from package purgecss.

property extractors

extractors?: Array<Extractors>;

• See documentation for Options.extractors from package purgecss.

property fontFace

fontFace?: boolean;

• See documentation for Options.fontFace from package purgecss.

property keyframes

keyframes?: boolean;

• See documentation for Options.keyframes from package purgecss.

property output

output?: string;

• See documentation for Options.output from package purgecss.

property rejected

rejected?: boolean;

• See documentation for Options.rejected from package purgecss.

property rejectedCss

rejectedCss?: boolean;

• See documentation for Options.rejectedCss from package purgecss.

property safelist

safelist?: UserDefinedSafelist;

• See documentation for Options.safelist from package purgecss.

property skippedContentGlobs

skippedContentGlobs?: Array<string>;

• See documentation for Options.skippedContentGlobs from package purgecss.

property sourceMap

sourceMap?:
    | boolean
    | (postcss.SourceMapOptions & {
          to?: string;
      });

• See documentation for Options.sourceMap from package purgecss.

property stdin

stdin?: boolean;

• See documentation for Options.stdin from package purgecss.

property stdout

stdout?: boolean;

• See documentation for Options.stdout from package purgecss.

property variables

variables?: boolean;

• See documentation for Options.variables from package purgecss.