Skip to main content

ScalarHooks

@quik/http-express

@quik/http-express / ScalarHooks

Variable: ScalarHooks

const ScalarHooks: object

Defined in: http-express/src/index.ts:10

Type Declaration​

addConfiguration​

addConfiguration: (hook) => void = addScalarConfigurationHook

Registers a hook that can extend the Scalar API Reference configuration.

Parameters​

hook​

ScalarConfigurationHook

Hook used to extend the Scalar configuration.

Returns​

void

getConfiguration​

getConfiguration: (configuration) => ScalarConfiguration = getScalarConfiguration

Builds the Scalar API Reference configuration by executing all registered hooks.

Parameters​

configuration?​

ScalarConfiguration = {}

Initial Scalar configuration.

Returns​

ScalarConfiguration