Skip to main content

DriverPreCheckInfo Interface

Information that can be returned by a lightweight, seperately exported driver function. Used to preanalyze a URL for driver compatibility and preload information.

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 DriverPreCheckInfo

Properties

Property Alerts Modifiers Type Description
codeDetailsHint Alpha optional string A code details hint that can potentially be used to prefetch container code prior to having a snapshot.
criticalBootDomains Alpha optional string[] Domains that will be connected to on the critical boot path. Hosts can choose to preconnect to these for improved performance.

Property Details

codeDetailsHint

A code details hint that can potentially be used to prefetch container code prior to having a snapshot.

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

codeDetailsHint?: string;

Type: string

criticalBootDomains

Domains that will be connected to on the critical boot path. Hosts can choose to preconnect to these for improved performance.

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

criticalBootDomains?: string[];

Type: string[]