Rush StackShopBlogEvents
Skip to main content

Home > @rushstack/heft > IHeftPlugin > apply

IHeftPlugin.apply() method

Apply the plugin to the session. Plugins are expected to hook into session hooks to provide plugin implementation. The apply(...) method is called once per phase.

Signature:

apply(session: TSession, heftConfiguration: HeftConfiguration, pluginOptions?: TOptions): void;

Parameters

ParameterTypeDescription
sessionTSessionThe session to apply the plugin to.
heftConfigurationHeftConfigurationThe Heft configuration.
pluginOptionsTOptions(Optional) Options for the plugin, specified in heft.json.

Returns:

void