@itwin/ecschema-metadata 4.0.0-dev.1 → 4.0.0-dev.100

package/lib/cjs/SchemaLoader.d.ts

@@ -1,24 +1,24 @@
-import { Schema } from "./Metadata/Schema";
-import { SchemaPropsGetter } from "./SchemaJsonLocater";
-/**
- * A utility class for loading EC Schema objects using a function that returns schema json for a given schema name.
- * Loaded schemas are held in memory within  a schema context managed by SchemaLoader.
- * The SchemaLoader object should be held in memory if multiple calls to [[getSchema]] or [[tryGetSchema]]
- * is a possibility, thereby avoiding unnecessary schema retrievals from the function.
- * @alpha
- */
-export declare class SchemaLoader {
-    private _context;
-    constructor(getSchema: SchemaPropsGetter);
-    /** Get a schema by name
-     * @param schemaName a string with the name of the schema to load.
-     * @throws [ECObjectsError]($ecschema-metadata) if the schema is not found or cannot be loaded.
-     */
-    getSchema<T extends Schema>(schemaName: string): T;
-    /** Attempts to get a schema by name
-     * @param schemaName a string with the name of the schema to load.
-     * @throws [ECObjectsError]($ecschema-metadata) if the schema exists, but cannot be loaded.
-     */
-    tryGetSchema<T extends Schema>(schemaName: string): T | undefined;
-}
+import { Schema } from "./Metadata/Schema";
+import { SchemaPropsGetter } from "./SchemaJsonLocater";
+/**
+ * A utility class for loading EC Schema objects using a function that returns schema json for a given schema name.
+ * Loaded schemas are held in memory within  a schema context managed by SchemaLoader.
+ * The SchemaLoader object should be held in memory if multiple calls to [[getSchema]] or [[tryGetSchema]]
+ * is a possibility, thereby avoiding unnecessary schema retrievals from the function.
+ * @alpha
+ */
+export declare class SchemaLoader {
+    private _context;
+    constructor(getSchema: SchemaPropsGetter);
+    /** Get a schema by name
+     * @param schemaName a string with the name of the schema to load.
+     * @throws [ECObjectsError]($ecschema-metadata) if the schema is not found or cannot be loaded.
+     */
+    getSchema<T extends Schema>(schemaName: string): T;
+    /** Attempts to get a schema by name
+     * @param schemaName a string with the name of the schema to load.
+     * @throws [ECObjectsError]($ecschema-metadata) if the schema exists, but cannot be loaded.
+     */
+    tryGetSchema<T extends Schema>(schemaName: string): T | undefined;
+}
 //# sourceMappingURL=SchemaLoader.d.ts.map

package/lib/cjs/SchemaLoader.js

@@ -1,48 +1,48 @@
-"use strict";
-/*---------------------------------------------------------------------------------------------
-* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
-* See LICENSE.md in the project root for license terms and full copyright notice.
-*--------------------------------------------------------------------------------------------*/
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.SchemaLoader = void 0;
-const Context_1 = require("./Context");
-const ECObjects_1 = require("./ECObjects");
-const Exception_1 = require("./Exception");
-const SchemaJsonLocater_1 = require("./SchemaJsonLocater");
-const SchemaKey_1 = require("./SchemaKey");
-/**
- * A utility class for loading EC Schema objects using a function that returns schema json for a given schema name.
- * Loaded schemas are held in memory within  a schema context managed by SchemaLoader.
- * The SchemaLoader object should be held in memory if multiple calls to [[getSchema]] or [[tryGetSchema]]
- * is a possibility, thereby avoiding unnecessary schema retrievals from the function.
- * @alpha
- */
-class SchemaLoader {
-    constructor(getSchema) {
-        this._context = new Context_1.SchemaContext();
-        const locater = new SchemaJsonLocater_1.SchemaJsonLocater(getSchema);
-        this._context.addLocater(locater);
-    }
-    /** Get a schema by name
-     * @param schemaName a string with the name of the schema to load.
-     * @throws [ECObjectsError]($ecschema-metadata) if the schema is not found or cannot be loaded.
-     */
-    getSchema(schemaName) {
-        const schema = this.tryGetSchema(schemaName);
-        if (!schema)
-            throw new Exception_1.ECObjectsError(Exception_1.ECObjectsStatus.UnableToLocateSchema, `reading schema=${schemaName}`);
-        return schema;
-    }
-    /** Attempts to get a schema by name
-     * @param schemaName a string with the name of the schema to load.
-     * @throws [ECObjectsError]($ecschema-metadata) if the schema exists, but cannot be loaded.
-     */
-    tryGetSchema(schemaName) {
-        // SchemaKey version is not used when locating schema in an iModel, so the version is arbitrary.
-        const key = new SchemaKey_1.SchemaKey(schemaName, new SchemaKey_1.ECVersion(1, 0, 0));
-        const schema = this._context.getSchemaSync(key, ECObjects_1.SchemaMatchType.Latest);
-        return schema;
-    }
-}
-exports.SchemaLoader = SchemaLoader;
+"use strict";
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SchemaLoader = void 0;
+const Context_1 = require("./Context");
+const ECObjects_1 = require("./ECObjects");
+const Exception_1 = require("./Exception");
+const SchemaJsonLocater_1 = require("./SchemaJsonLocater");
+const SchemaKey_1 = require("./SchemaKey");
+/**
+ * A utility class for loading EC Schema objects using a function that returns schema json for a given schema name.
+ * Loaded schemas are held in memory within  a schema context managed by SchemaLoader.
+ * The SchemaLoader object should be held in memory if multiple calls to [[getSchema]] or [[tryGetSchema]]
+ * is a possibility, thereby avoiding unnecessary schema retrievals from the function.
+ * @alpha
+ */
+class SchemaLoader {
+    constructor(getSchema) {
+        this._context = new Context_1.SchemaContext();
+        const locater = new SchemaJsonLocater_1.SchemaJsonLocater(getSchema);
+        this._context.addLocater(locater);
+    }
+    /** Get a schema by name
+     * @param schemaName a string with the name of the schema to load.
+     * @throws [ECObjectsError]($ecschema-metadata) if the schema is not found or cannot be loaded.
+     */
+    getSchema(schemaName) {
+        const schema = this.tryGetSchema(schemaName);
+        if (!schema)
+            throw new Exception_1.ECObjectsError(Exception_1.ECObjectsStatus.UnableToLocateSchema, `reading schema=${schemaName}`);
+        return schema;
+    }
+    /** Attempts to get a schema by name
+     * @param schemaName a string with the name of the schema to load.
+     * @throws [ECObjectsError]($ecschema-metadata) if the schema exists, but cannot be loaded.
+     */
+    tryGetSchema(schemaName) {
+        // SchemaKey version is not used when locating schema in an iModel, so the version is arbitrary.
+        const key = new SchemaKey_1.SchemaKey(schemaName, new SchemaKey_1.ECVersion(1, 0, 0));
+        const schema = this._context.getSchemaSync(key, ECObjects_1.SchemaMatchType.Latest);
+        return schema;
+    }
+}
+exports.SchemaLoader = SchemaLoader;
 //# sourceMappingURL=SchemaLoader.js.map