🧭 life cycle

This page contains 4 configuration items, sourced from UserDefinedOptions.

Configuration overview

Configuration item	Type	Default value	Description
onLoad	(() => void)	—	Triggered when the plug-in apply is initially called.
onStart	(() => void)	—	Triggered before starting processing.
onUpdate	(filename: string, oldVal: string, newVal: string) => void	—	Triggered after matching and modifying the file.
onEnd	(() => void)	—	Triggered when processing ends.

Detailed description

onLoad

Optional | Type: (() => void)

Fired when the plugin apply is initially called.

return

void

onStart

Optional | Type: (() => void)

Triggered before starting processing.

return

void

onUpdate

Optional | Type: (filename: string, oldVal: string, newVal: string) => void

Triggered after a file is matched and modified.

Parameters

filename

string

oldVal

string

newVal

string

return

void

onEnd

Optional | Type: (() => void)

Fires when processing ends.

return

void