IUrlResolver Interface
This API is provided for existing users, but is not recommended for new users.
To use, import via @fluidframework/driver-definitions/legacy.
For more information about our API support guarantees, see here.
Signature
export interface IUrlResolver
Methods
| Method | Alerts | Return Type | Description |
|---|---|---|---|
| getAbsoluteUrl(resolvedUrl, relativeUrl, packageInfoSource) | Alpha |
Promise<string> | Creates a url for the created container with any data store path given in the relative url. |
| resolve(request) | Alpha |
Promise<IResolvedUrl | undefined> |
Method Details
getAbsoluteUrl
Creates a url for the created container with any data store path given in the relative url.
This API is provided as an alpha preview and may change without notice.
To use, import via @fluidframework/driver-definitions/alpha.
For more information about our API support guarantees, see here.
Signature
getAbsoluteUrl(resolvedUrl: IResolvedUrl, relativeUrl: string, packageInfoSource?: IContainerPackageInfo): Promise<string>;
Parameters
| Parameter | Modifiers | Type | Description |
|---|---|---|---|
| resolvedUrl | IResolvedUrl | resolved url for the container. | |
| relativeUrl | string | relative url containing data store path; '/' represents root path. | |
| packageInfoSource | optional | IContainerPackageInfo | optional, represents container package information to be included in url. |
Returns
absolute url combining container url with dta store path and optional additional information.
Return type: Promise<string>
resolve
This API is provided as an alpha preview and may change without notice.
To use, import via @fluidframework/driver-definitions/alpha.
For more information about our API support guarantees, see here.
Signature
resolve(request: IRequest): Promise<IResolvedUrl | undefined>;
Parameters
| Parameter | Type | Description |
|---|---|---|
| request | IRequest |
Returns
Return type: Promise<IResolvedUrl | undefined>