index.d.ts

import { FilterPattern } from '@rollup/pluginutils';
import { Plugin } from 'rollup';

type Replacement = string | ((id: string) => string);

export interface RollupReplaceOptions {
  /**
   * All other options are treated as `string: replacement` replacers,
   * or `string: (id) => replacement` functions.
   */
  [str: string]: Replacement | RollupReplaceOptions['include'] | RollupReplaceOptions['values'];

  /**
   * A minimatch pattern, or array of patterns, of files that should be
   * processed by this plugin (if omitted, all files are included by default)
   */
  include?: FilterPattern;
  /**
   * Files that should be excluded, if `include` is otherwise too permissive.
   */
  exclude?: FilterPattern;
  /**
   * To replace every occurrence of `<@foo@>` instead of every occurrence
   * of `foo`, supply delimiters
   */
  delimiters?: [string, string];
  /**
   * You can separate values to replace from other options.
   */
  values?: { [str: string]: Replacement };
  /**
   * Prevents replacing strings where they are followed by a single equals sign
   * It is recommended to set this option to `true`, as the next major version will default this option to `true`
   */
  preventAssignment?: Boolean;
}

/**
 * Replace strings in files while bundling them.
 */
export default function replace(options?: RollupReplaceOptions): Plugin;