• English

      • @scml/addon-module-css-replacer

      TypeScript type definitions for Module CSS replacer addon, for replacing content in module CSS files.

      Installation

      npm
      yarn
      pnpm
      bun
      deno
      npm install -D @scml/addon-module-css-replacer

      Quick Start

      Add type reference

      /// <reference types="@scml/addon-module-css-replacer" />

      Use global instance

      addonModuleCssReplacer is mounted on window.

      Import types on demand

      import type { ModuleCssReplacer, ReplaceParams } from '@scml/addon-module-css-replacer/ModuleCssReplacer';

      Global Types global

      PropertyTypeDescription
      addonModuleCssReplacerModuleCssReplacerAddon instance, replaces module CSS
      Main entry
      Subpath import
      /// <reference types="@scml/addon-module-css-replacer" />

      Subpath Exports

      SubpathDescription
      .Main entry, augments Window/global
      ./ModuleCssReplacerMain class and ReplaceParams

      API Reference

      ./ModuleCssReplacer

      ModuleCssReplacer class

      Property/MethodTypeDescription
      infoMap<string, ReplaceInfo>Replace info
      registerMod()(addonName, mod, modZip) => Promise<void>Register mod
      afterPreload()() => Promise<void>After-preload hook
      getAllModuleStyleNode()() => Map<string, HTMLStyleElement>Get all module style nodes
      do_patch()(ri, ns) => Promise<void>Execute replace
      exportDataZip()(zip: JSZip) => Promise<JSZip>Export data
      init()() => voidInitialize

      ReplaceParams interface

      PropertyTypeDescription
      cssNamestringCSS file name
      findStringstringFind string
      findRegexstringFind regex
      replacestringReplace string
      replaceFilestringReplace file path
      debugbooleanDebug mode
      allbooleanReplace all

      Type Definition Source

      Source Code
      INFO