@salesforce/b2c-tooling-sdk / clients / MiddlewareRegistry

Class: MiddlewareRegistry

Defined in: packages/b2c-tooling-sdk/src/clients/middleware-registry.ts:132

Registry for HTTP middleware providers.

The registry collects middleware from multiple providers and returns them in registration order when requested by client factories.

Usage Modes

SDK Mode: Register providers directly via register():

globalMiddlewareRegistry.register(myProvider);

CLI Mode: Providers are collected via the b2c:http-middleware hook and registered during command initialization.

Constructors

Constructor

new MiddlewareRegistry(): MiddlewareRegistry

Returns

MiddlewareRegistry

Accessors

size

Get Signature

get size(): number

Defined in: packages/b2c-tooling-sdk/src/clients/middleware-registry.ts:192

Returns the number of registered providers.

Returns

number

Methods

clear()

clear(): void

Defined in: packages/b2c-tooling-sdk/src/clients/middleware-registry.ts:185

Clears all registered providers.

Primarily useful for testing.

Returns

void

---

getMiddleware()

getMiddleware(clientType): Middleware[]

Defined in: packages/b2c-tooling-sdk/src/clients/middleware-registry.ts:167

Collects middleware from all providers for a specific client type.

Parameters

clientType

HttpClientType

The type of client requesting middleware

Returns

Middleware[]

Array of middleware in registration order

---

getProviderNames()

getProviderNames(): string[]

Defined in: packages/b2c-tooling-sdk/src/clients/middleware-registry.ts:199

Returns the names of all registered providers.

Returns

string[]

---

register()

register(provider): void

Defined in: packages/b2c-tooling-sdk/src/clients/middleware-registry.ts:142

Registers a middleware provider.

Providers are called in registration order when middleware is requested.

Parameters

provider

HttpMiddlewareProvider

The provider to register

Returns

void

---

unregister()

unregister(name): boolean

Defined in: packages/b2c-tooling-sdk/src/clients/middleware-registry.ts:152

Unregisters a middleware provider by name.

Parameters

name

string

The name of the provider to remove

Returns

boolean

true if a provider was removed, false if not found