Type Alias: Plugin<Ts, IsAsync>

Plugin<Ts, IsAsync> = (crossPluginContext) => PluginInstance<Ts, IsAsync>

Defined in: packages/fast-check/src/check/plugin/Plugin.ts:56

Builder instantiating a plugin. Each property will instantiate its own plugin when starting to be assessed via check or assert.

NOTE: The function gets called with a parameter shared across all builders. The variable can be leveraged to exchange insights with other builders. As such it is writable and can be mutated via the builder. We recommend using symbol keys when adding entries to the variable to reduce the risk of collision with other unrelated plugins.

Type Parameters

Type Parameter
Ts
IsAsync extends boolean

Parameters

Parameter	Type
crossPluginContext	{ [K in any]?: unknown }

Returns

PluginInstance<Ts, IsAsync>

Remarks

Since 4.10.0