Class IlcAppWrapperSdk

Entrypoint for SDK that should be used within application server that executes SSR bundle

Hierarchy

IlcSdk
- IlcAppWrapperSdk

Index

Constructors

Methods

assetsDiscoveryHandler forwardRequest processRequest

Constructors

constructor

new IlcAppWrapperSdk(options?: {
logger?: IlcSdkLogger;
}): IlcAppWrapperSdk
Parameters
- options: {
  logger?: IlcSdkLogger;
  } = {}
  - Optional logger?: IlcSdkLogger
    
    Default value: console
Returns IlcAppWrapperSdk
Inherited from IlcSdk.constructor
- Defined in server/IlcSdk.ts:26

Methods

assetsDiscoveryHandler

assetsDiscoveryHandler(req: IncomingMessage, res: ServerResponse<IncomingMessage>, appAssets: AppAssets): void
Correctly responds to ILC for the assets discovery request.

WARNING: this method should never be used in production if application is running in more than a single instance
Parameters
- req: IncomingMessage
- res: ServerResponse<IncomingMessage>
- appAssets: AppAssets
Returns void
Inherited from IlcSdk.assetsDiscoveryHandler
- Defined in server/IlcSdk.ts:143

forwardRequest

forwardRequest(reqData: RequestData<unknown>, res: ServerResponse<IncomingMessage>, data?: WrapperResponseData): void
Parameters
- reqData: RequestData<unknown>
- res: ServerResponse<IncomingMessage>
- Optional data: WrapperResponseData
Returns void
- Defined in server/IlcAppWrapperSdk.ts:7

processRequest

processRequest<RegistryProps>(req: IncomingMessage): ProcessedRequest<RegistryProps>
Processes incoming request and returns object that can be used to fetch information passed by ILC to the application.
Type Parameters
- RegistryProps = unknown
Parameters
- req: IncomingMessage
Returns ProcessedRequest<RegistryProps>
Inherited from IlcSdk.processRequest
- Defined in server/IlcSdk.ts:33

Generated using TypeDoc