Class: ExpressAdapter
Hierarchy
-
AbstractAdapter<express>↳
ExpressAdapter
Accessors
keycloakConnector
• get keycloakConnector(): KeycloakConnector<express>
Returns
KeycloakConnector<express>
Defined in
packages/backend/server/src/adapter/express-adapter.ts:203
Methods
buildConnectorRequest
▸ buildConnectorRequest<RouteConfig>(request, routeConfig): Promise<ConnectorRequest<Record<string, unknown>, Record<string, unknown>>>
Type parameters
| Name |
|---|
RouteConfig |
Parameters
| Name | Type |
|---|---|
request | Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>> |
routeConfig | undefined | RouteConfig |
Returns
Promise<ConnectorRequest<Record<string, unknown>, Record<string, unknown>>>
Overrides
AbstractAdapter.buildConnectorRequest
Defined in
packages/backend/server/src/adapter/express-adapter.ts:37
handleResponse
▸ handleResponse(connectorResponse, req, res, next): Promise<void>
Parameters
| Name | Type |
|---|---|
connectorResponse | ConnectorResponse<express> |
req | Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>> |
res | Response<any, Record<string, any>, number> |
next | NextFunction |
Returns
Promise<void>
Overrides
AbstractAdapter.handleResponse
Defined in
packages/backend/server/src/adapter/express-adapter.ts:54
onRequest
▸ onRequest<RouteConfig>(routeConfig, ...args): Promise<void>
Type parameters
| Name | Type |
|---|---|
RouteConfig | KeycloakRouteConfig |
Parameters
| Name | Type |
|---|---|
routeConfig | undefined | RouteConfig |
...args | [req: Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>, res: Response<any, Record<string, any>, number>, next: NextFunction] |
Returns
Promise<void>
Defined in
packages/backend/server/src/adapter/express-adapter.ts:165
registerRoute
▸ registerRoute(options, connectorCallback): void
Parameters
| Name | Type |
|---|---|
options | RouteRegistrationOptions |
connectorCallback | ConnectorCallback<express> |
Returns
void
Overrides
AbstractAdapter.registerRoute
Defined in
packages/backend/server/src/adapter/express-adapter.ts:115
init
▸ init(app, customConfig): Promise<{ config: KeycloakConnectorConfigBase ; registerAuthPlugin: (plugin: AbstractAuthPlugin) => Promise<undefined> }>
Parameters
| Name | Type |
|---|---|
app | Express |
customConfig | KeycloakConnectorConfigCustom |
Returns
Promise<{ config: KeycloakConnectorConfigBase ; registerAuthPlugin: (plugin: AbstractAuthPlugin) => Promise<undefined> }>