@itwin/core-backend/lib/esm/workspace/SettingsDb.d.ts

iTwin.js backend components

/** @packageDocumentation
 * @module Workspace
 */
import type { WorkspaceDb, WorkspaceDbName } from "./Workspace";
/**
 * The fixed db name used by [[WorkspaceDb]]'s meant to hold settings.
 * [[Workspace.loadSettingsDictionary]] will treat rows in the 'strings' table as setting dictionary entries when [[WorkspaceDbSettingsProps.dbName]] matches this value.
 * @see [[Workspace.loadSettingsDictionary]]
 * @internal
 */
export declare const settingsWorkspaceDbName: WorkspaceDbName;
/** The db name type for the iTwin settings [[WorkspaceDb]].
 * @internal
 */
export type SettingsDbName = typeof settingsWorkspaceDbName;
/** A [[WorkspaceDb]] whose name is the fixed iTwin settings db name.
 * @internal
 */
export type SettingsDb = WorkspaceDb & {
    readonly dbName: SettingsDbName;
};
/** Return true if a [[WorkspaceDb]] is a [[SettingsDb]].
 * @internal
 */
export declare function isSettingsDb(db: WorkspaceDb): db is SettingsDb;
/** Query all string resource names from a [[SettingsDb]].
 * @internal
 */
export declare function queryStringResourceNames(db: SettingsDb): WorkspaceDbName[];
//# sourceMappingURL=SettingsDb.d.ts.map