IParsedUrl Interface

Interface to represent the parsed parts of IResolvedUrl.url to help in getting info about different parts of the url. May not be compatible or relevant for any Url Resolver

This API is provided for existing users, but is not recommended for new users.

To use, import via @fluidframework/container-loader/legacy.

For more information about our API support guarantees, see here.

Signature

export interface IParsedUrl

Properties

Property	Alerts	Type	Description
id	Beta	string	It is combination of tenantid/docId part of the url.
path	Beta	string	It is the deep link path in the url.
query	Beta	string	Query string part of the url.
version	Beta	string | undefined	Undefined means load latest snapshot, otherwise it's version ID passed to IDocumentStorageService.getVersions() to figure out what snapshot to use.

Property Details

id

It is combination of tenantid/docId part of the url.

This API is provided for existing users, but is not recommended for new users.

For more information about our API support guarantees, see here.

Signature

id: string;

Type: string

path

It is the deep link path in the url.

This API is provided for existing users, but is not recommended for new users.

For more information about our API support guarantees, see here.

Signature

path: string;

Type: string

query

Query string part of the url.

This API is provided for existing users, but is not recommended for new users.

For more information about our API support guarantees, see here.

Signature

query: string;

Type: string

version

Undefined means load latest snapshot, otherwise it's version ID passed to IDocumentStorageService.getVersions() to figure out what snapshot to use.

This API is provided for existing users, but is not recommended for new users.

For more information about our API support guarantees, see here.

Signature

version: string | undefined;

Type: string | undefined