Skip to main content
Version: v1

IUrlResolver Interface

Signature

export interface IUrlResolver

Methods

Method Return Type Description
getAbsoluteUrl(resolvedUrl, relativeUrl, packageInfoSource) Promise<string> Creates a url for the created container with any data store path given in the relative url.
resolve(request) Promise<IResolvedUrl | undefined>

Method Details

getAbsoluteUrl

Creates a url for the created container with any data store path given in the relative url.

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

Signature

resolve(request: IRequest): Promise<IResolvedUrl | undefined>;

Parameters

Parameter Type Description
request IRequest

Returns

Return type: Promise<IResolvedUrl | undefined>