Class UserscriptPlugin

Hierarchy

UserscriptPlugin

Implements

WebpackPluginInstance
UserscriptPluginInstance

Index

Constructors

constructor

new UserscriptPlugin(options?: UserscriptOptions): UserscriptPlugin
Parameters
- options: UserscriptOptions = {}
Returns UserscriptPlugin
- Defined in plugin.ts:95

Properties

`Private` `Readonly` contexts

contexts: WeakMap<Compilation, CompilationContext> = ...

`Readonly` features

features: Feature<unknown>[]

`Readonly` hooks

hooks: {
    close: AsyncParallelHook<[Compiler], UnsetAdditionalOptions>;
    headers: AsyncSeriesWaterfallHook<[HeadersProps, WaterfallContext], UnsetAdditionalOptions>;
    init: AsyncParallelHook<[Compiler], UnsetAdditionalOptions>;
    preprocess: AsyncParallelHook<[Compilation, CompilationContext], UnsetAdditionalOptions>;
    process: AsyncParallelHook<[Compilation, CompilationContext], UnsetAdditionalOptions>;
    proxyHeaders: AsyncSeriesWaterfallHook<[HeadersProps, WaterfallContext], UnsetAdditionalOptions>;
    proxyScriptFile: AsyncSeriesWaterfallHook<[string, WaterfallContext], UnsetAdditionalOptions>;
    renderHeaders: AsyncSeriesBailHook<Map<string, HeadersProps>, string, UnsetAdditionalOptions>;
    renderProxyHeaders: AsyncSeriesBailHook<HeadersProps, string, UnsetAdditionalOptions>;
} = ...

Type declaration

close: AsyncParallelHook<[Compiler], UnsetAdditionalOptions>
headers: AsyncSeriesWaterfallHook<[HeadersProps, WaterfallContext], UnsetAdditionalOptions>
init: AsyncParallelHook<[Compiler], UnsetAdditionalOptions>
preprocess: AsyncParallelHook<[Compilation, CompilationContext], UnsetAdditionalOptions>
process: AsyncParallelHook<[Compilation, CompilationContext], UnsetAdditionalOptions>
proxyHeaders: AsyncSeriesWaterfallHook<[HeadersProps, WaterfallContext], UnsetAdditionalOptions>
proxyScriptFile: AsyncSeriesWaterfallHook<[string, WaterfallContext], UnsetAdditionalOptions>
renderHeaders: AsyncSeriesBailHook<Map<string, HeadersProps>, string, UnsetAdditionalOptions>
renderProxyHeaders: AsyncSeriesBailHook<HeadersProps, string, UnsetAdditionalOptions>

`Readonly` name

name: "UserscriptPlugin" = 'UserscriptPlugin'

`Private` options

options: UserscriptPluginOptions = {}

Methods

apply

apply(compiler: Compiler): void
Parameters
- compiler: Compiler
Returns void
Implementation of WebpackPluginInstance.apply
- Defined in plugin.ts:114

`Private` close

close(compiler: Compiler): Promise<void>
Parameters
- compiler: Compiler
Returns Promise<void>
- Defined in plugin.ts:161

`Private` collectFileInfo

collectFileInfo(compilation: Compilation): FileInfo[]
Parameters
- compilation: Compilation
Returns FileInfo[]
- Defined in plugin.ts:201

`Private` emitUserscript

emitUserscript(compilation: Compilation, context: CompilationContext, fileInfo: FileInfo): Promise<void>
Parameters
- compilation: Compilation
- context: CompilationContext
- fileInfo: FileInfo
Returns Promise<void>
- Defined in plugin.ts:248

`Private` init

init(compiler: Compiler): Promise<void>
Parameters
- compiler: Compiler
Returns Promise<void>
- Defined in plugin.ts:157

`Private` preprocess

preprocess(compilation: Compilation): Promise<void>
Parameters
- compilation: Compilation
Returns Promise<void>
- Defined in plugin.ts:165

`Private` process

process(compilation: Compilation): Promise<void>
Parameters
- compilation: Compilation
Returns Promise<void>
- Defined in plugin.ts:178

Class UserscriptPlugin

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

options: UserscriptOptions = {}

Returns UserscriptPlugin

Properties

Private Readonly contexts

Readonly features

Readonly hooks

Type declaration

close: AsyncParallelHook<[Compiler], UnsetAdditionalOptions>

headers: AsyncSeriesWaterfallHook<[HeadersProps, WaterfallContext], UnsetAdditionalOptions>

init: AsyncParallelHook<[Compiler], UnsetAdditionalOptions>

preprocess: AsyncParallelHook<[Compilation, CompilationContext], UnsetAdditionalOptions>

process: AsyncParallelHook<[Compilation, CompilationContext], UnsetAdditionalOptions>

proxyHeaders: AsyncSeriesWaterfallHook<[HeadersProps, WaterfallContext], UnsetAdditionalOptions>

proxyScriptFile: AsyncSeriesWaterfallHook<[string, WaterfallContext], UnsetAdditionalOptions>

renderHeaders: AsyncSeriesBailHook<Map<string, HeadersProps>, string, UnsetAdditionalOptions>

renderProxyHeaders: AsyncSeriesBailHook<HeadersProps, string, UnsetAdditionalOptions>

Readonly name

Private options

Methods

apply

Parameters

compiler: Compiler

Returns void

Private close

Parameters

compiler: Compiler

Returns Promise<void>

Private collectFileInfo

Parameters

compilation: Compilation

Returns FileInfo[]

Private emitUserscript

Parameters

compilation: Compilation

context: CompilationContext

fileInfo: FileInfo

Returns Promise<void>

Private init

Parameters

compiler: Compiler

Returns Promise<void>

Private preprocess

Parameters

compilation: Compilation

Returns Promise<void>

Private process

Parameters

compilation: Compilation

Returns Promise<void>

Settings

Member Visibility

Theme

`Private` `Readonly` contexts

`Readonly` features

`Readonly` hooks

`Readonly` name

`Private` options

`Private` close

`Private` collectFileInfo

`Private` emitUserscript

`Private` init

`Private` preprocess

`Private` process