@itwin/ecschema-metadata/lib/esm/utils/SchemaLoadingController.d.ts

ECObjects core concepts in typescript

/**
 * Assists in tracking the loading progress of Schemas and SchemaItems. An instance of this
 * class is set in Schema and SchemaItem instances.
 * @internal
 */
export declare class SchemaLoadingController {
    private _complete;
    private _inProgress;
    private _promise?;
    /**
     * Indicates of the Schema or SchemaItem has been fully loaded.
     */
    get isComplete(): boolean;
    /**
     * Marks that a Schema or SchemaItem has been fully loaded.
     */
    set isComplete(value: boolean);
    /**
     * Indicates that the loading of a Schema or SchemaItem is still in progress
     */
    get inProgress(): boolean;
    /**
     * Initializes a new SchemaLoadingController instance.
     */
    constructor();
    /**
     * Call this method when starting to load a Schema or SchemaItem
     * @param promise The promise used to update the controller state when the promise is resolved.
     */
    start(promise: Promise<void>): void;
    /**
     * Waits on the Promise given in SchemaLoadingController.start().
     * @returns A Promised that can be awaited while the Schema or SchemaItem is being loaded.
     */
    wait(): Promise<void>;
}
//# sourceMappingURL=SchemaLoadingController.d.ts.map