Function: defineAdapterMiddleware()
Function: defineAdapterMiddleware()
Registers an adapter-specific middleware in the blueprint.
This function dynamically inserts a middleware definition into the blueprint if the adapter context matches either the platform or alias (or both are undefined).
Param
The middleware module to register (function, factory, or class).
Param
Metadata describing which adapter(s) the middleware applies to.
Call Signature
function defineAdapterMiddleware<ExecutionContextType, RawResponseType>(module, options?): Partial<StoneBlueprint>;
Defines a function-based adapter middleware.
This overload is used to register middleware as a simple function for a specific adapter platform or alias.
Type Parameters
ExecutionContextType
ExecutionContextType = any
RawResponseType
RawResponseType = any
Parameters
module
FunctionalMiddleware<ExecutionContextType, RawResponseType>
The middleware function to be registered.
options?
AdapterMiddlewareOptions & object
Adapter-specific metadata such as platform or alias.
Returns
Partial<StoneBlueprint>
A blueprint fragment that registers the middleware conditionally.
Param
The middleware module to register (function, factory, or class).
Param
Metadata describing which adapter(s) the middleware applies to.
Call Signature
function defineAdapterMiddleware<ExecutionContextType, RawResponseType>(module, options): Partial<StoneBlueprint>;
Defines a factory-based adapter middleware.
This overload registers a middleware factory function for a specific adapter platform or alias.
Type Parameters
ExecutionContextType
ExecutionContextType = any
RawResponseType
RawResponseType = any
Parameters
module
FactoryMiddleware<ExecutionContextType, RawResponseType>
The factory function that returns middleware.
options
AdapterMiddlewareOptions & object
Adapter-specific metadata such as platform or alias.
Returns
Partial<StoneBlueprint>
A blueprint fragment that registers the middleware conditionally.
Param
The middleware module to register (function, factory, or class).
Param
Metadata describing which adapter(s) the middleware applies to.
Call Signature
function defineAdapterMiddleware<ExecutionContextType, RawResponseType>(module, options): Partial<StoneBlueprint>;
Defines a class-based adapter middleware.
This overload registers a middleware class for a specific adapter platform or alias.
Type Parameters
ExecutionContextType
ExecutionContextType = any
RawResponseType
RawResponseType = any
Parameters
module
MiddlewareClass<ExecutionContextType, RawResponseType>
The class to be used as middleware.
options
AdapterMiddlewareOptions & object
Adapter-specific metadata such as platform or alias.
Returns
Partial<StoneBlueprint>
A blueprint fragment that registers the middleware conditionally.
Param
The middleware module to register (function, factory, or class).
Param
Metadata describing which adapter(s) the middleware applies to.