Skip to main content

Interface: ClientPlugin

client.ClientPlugin

Plugin to control the configuration of a native connection.

Plugins is an experimental feature; APIs may change without notice.

Implemented by

Accessors

name

get name(): string

Gets the name of this plugin.

Returns

string

Methods

configureClient

configureClient(options): Omit<ClientOptions, "plugins">

Hook called when creating a client to allow modification of configuration.

This method is called during client creation and allows plugins to modify the client configuration before the client is fully initialized.

Parameters

NameType
optionsOmit<ClientOptions, "plugins">

Returns

Omit<ClientOptions, "plugins">