Web Fragments full API reference
Last updated: March 19, 2024
Full API Reference
Fragment Gatway API reference
For usage go to the gateway document.
| Member | Type | Description | | -------------------------------------------------------- | --------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ----- | ------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | #private | (private) | Internal private property (implementation details are hidden). | | fragmentConfigs | (private) | Internal storage for fragment configurations. | | routeMap | (private) | Internal mapping of routes for fragment handling. | | Constructor | constructor(config?: FragmentGatewayConfig) | Initializes a new instance of the FragmentGateway class. Accepts an optional configuration object (FragmentGatewayConfig). | | piercingStyles | string | Returns a string representing styles applied before piercing fragments. | | registerFragment(fragmentConfig: FragmentConfig): void | Method | Registers a fragment in the gateway worker for integration with the gateway worker.
Parameters:
fragmentConfig: Configuration object for the fragment.
matchRequestToFragment(urlOrRequest: string | URL | Request): FragmentConfig | null | Method | Matches an incoming request to a fragment configuration.Parameters:
urlOrRequest: The URL or request to match against registered fragments.
FragmentConfig or null if no match is found. |Fragment configuration object and API reference
| Property | Type | Description | | ------------------------- | ---------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | fragmentId | string | Unique ID for the fragment. | | piercingClassNames | string[] | Styles to apply to the fragment before it gets pierced. Their purpose is to style the fragment to look as close as possible to the final pierced view, ensuring the piercing operation appears seamless. For best results, use the following selector: :not(piercing-fragment-outlet) > piercing-fragment-host[fragment-id="fragmentId"]. | | routePatterns | string[] | An array of route patterns this fragment should handle serving. Pattern format must adhere to path-to-regexp syntax. | | upstream | string | The upstream URI of the fragment application. This will be fetched for any request paths matching the specified routePatterns. | | forwardFragmentHeaders? | string[] | An optional list of fragment response headers to forward to the gateway response. | | onSsrFetchError? | (req: RequestInfo, failedResOrError: Response | unknown) => Promise<SSRFetchErrorResponse> | A handler or fallback to apply when the fetch for a fragment SSR code fails. It allows the gateway to serve a fallback response instead of an error response from the server.
Parameters:
req: The request sent to the fragment.failedResOrError: The failed response (4xx/5xx status) or the thrown error.