Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface PluginWrapper

An interface that represents a wrapper around user-provided plugin objects.

Hierarchy

  • PluginWrapper

Implemented by

Index

Methods

applyPlugin

  • applyPlugin<T>(moduleExports: T, file: string, version: string): T
  • Applies this object's underlying plugin patches to a file, returning the patched or intercepted value.

    Type parameters

    • T

    Parameters

    • moduleExports: T

      The module exports of the file.

    • file: string

      The file path, relative to the module root.

    • version: string

      The module version.

    Returns T

isSupported

  • isSupported(version: string): boolean
  • Returns whether the given version of the module is supported by this plugin. This may load the plugin into memory.

    Parameters

    • version: string

      A semver version string.

    Returns boolean

unapplyAll

  • unapplyAll(): void

Generated using TypeDoc