@itwin/ecschema-metadata 3.4.0-dev.9 → 3.5.0-dev.5

package/lib/cjs/SchemaKey.d.ts

@@ -1,111 +1,111 @@
-/** @packageDocumentation
- * @module Metadata
- */
-import { SchemaKeyProps } from "./Deserialization/JsonProps";
-import { SchemaMatchType } from "./ECObjects";
-/**
- * @beta
- */
-export declare class ECVersion {
-    private _read;
-    private _write;
-    private _minor;
-    /**
-     * The constructor will throw an ECObjectsError if any of the parameters below are above the threshold.
-     * @param read Can support up to 999.
-     * @param write Can support up to 999.
-     * @param minor Can support up to 9999999.
-     *
-     */
-    constructor(read?: number, write?: number, minor?: number);
-    get read(): number;
-    get write(): number;
-    get minor(): number;
-    /**
-     * Creates a string, in the format 'RR.ww.mm', representing this ECVersion.
-     * @note The default is to pad with zeroes.
-     * @param padZeroes If true, the returned string will strictly follow `RR.ww.mm` and add leading zeroes if necessary.
-     */
-    toString(padZeroes?: boolean): string;
-    /**
-     * Given a valid version string the
-     * @param versionString A valid version string of the format, 'RR.ww.mm'.
-     */
-    static fromString(versionString: string): ECVersion;
-    /**
-     * Compares two schema versions.
-     * @param rhs The schema to compare.
-     * @return A negative number if this schema version is less than the given version, a positive number if greater, and 0 if are equivalent.
-     */
-    compare(rhv: ECVersion): number;
-}
-/**
- * The SchemaKey contains a Schemas name and version.
- * @beta
- */
-export declare class SchemaKey {
-    private _name;
-    protected _version: ECVersion;
-    constructor(name: string, version: ECVersion);
-    constructor(name: string, readVersion?: number, writeVersion?: number, minorVersion?: number);
-    get version(): ECVersion;
-    get name(): string;
-    get readVersion(): number;
-    get writeVersion(): number;
-    get minorVersion(): number;
-    /**
-     * Creates a string, in the format 'RR.ww.mm', representing this SchemaKey.
-     * @note The default is to pad the full name with zeroes.
-     * @param padZeroes If true, the returned string will strictly follow `Name.RR.ww.mm` and add leading zeroes if necessary.
-     */
-    toString(padZeroes?: boolean): string;
-    static parseString(fullName: string): SchemaKey;
-    /**
-     * Compares two schema names, case-insensitive.
-     * @return True if they match; otherwise, false.
-     */
-    compareByName(rhs: SchemaKey | string | undefined): boolean;
-    /**
-     * Compares two schema versions.
-     * @param rhs The schema to compare.
-     * @return A negative number if this schema version is less than the given version, a positive number if greater, and 0 if are equivalent.
-     */
-    compareByVersion(rhs: SchemaKey): number;
-    /**
-     *
-     * @param rhs The SchemaKey to compare with
-     * @param matchType The match type to use for comparison.
-     */
-    matches(rhs: SchemaKey, matchType?: SchemaMatchType): boolean;
-    /**
-     * Deserializes a SchemaKeyProps JSON object into a SchemaKey object.
-     * @param props SchemaKeyProps
-     * @returns A SchemaKey object.
-     */
-    static fromJSON(props: SchemaKeyProps): SchemaKey;
-    /**
-     * Save this SchemaKey's properties to an object for serializing to JSON.
-     */
-    toJSON(): SchemaKeyProps;
-}
-/**
- * The SchemaItemKey contains a SchemaItem's name and SchemaKey.
- * @beta
- */
-export declare class SchemaItemKey {
-    private _name;
-    protected _schemaKey: SchemaKey;
-    constructor(name: string, schema: SchemaKey);
-    get schemaKey(): SchemaKey;
-    get name(): string;
-    get schemaName(): string;
-    /** Returns the name in the format, {schemaName}.{name}. */
-    get fullName(): string;
-    /**
-     * Checks whether this SchemaItemKey matches the one provided.
-     * @param rhs The SchemaItemKey to compare to this.
-     */
-    matches(rhs: SchemaItemKey): boolean;
-    matchesFullName(name: string): boolean;
-}
+/** @packageDocumentation
+ * @module Metadata
+ */
+import { SchemaKeyProps } from "./Deserialization/JsonProps";
+import { SchemaMatchType } from "./ECObjects";
+/**
+ * @beta
+ */
+export declare class ECVersion {
+    private _read;
+    private _write;
+    private _minor;
+    /**
+     * The constructor will throw an ECObjectsError if any of the parameters below are above the threshold.
+     * @param read Can support up to 999.
+     * @param write Can support up to 999.
+     * @param minor Can support up to 9999999.
+     *
+     */
+    constructor(read?: number, write?: number, minor?: number);
+    get read(): number;
+    get write(): number;
+    get minor(): number;
+    /**
+     * Creates a string, in the format 'RR.ww.mm', representing this ECVersion.
+     * @note The default is to pad with zeroes.
+     * @param padZeroes If true, the returned string will strictly follow `RR.ww.mm` and add leading zeroes if necessary.
+     */
+    toString(padZeroes?: boolean): string;
+    /**
+     * Given a valid version string the
+     * @param versionString A valid version string of the format, 'RR.ww.mm'.
+     */
+    static fromString(versionString: string): ECVersion;
+    /**
+     * Compares two schema versions.
+     * @param rhs The schema to compare.
+     * @return A negative number if this schema version is less than the given version, a positive number if greater, and 0 if are equivalent.
+     */
+    compare(rhv: ECVersion): number;
+}
+/**
+ * The SchemaKey contains a Schemas name and version.
+ * @beta
+ */
+export declare class SchemaKey {
+    private _name;
+    protected _version: ECVersion;
+    constructor(name: string, version: ECVersion);
+    constructor(name: string, readVersion?: number, writeVersion?: number, minorVersion?: number);
+    get version(): ECVersion;
+    get name(): string;
+    get readVersion(): number;
+    get writeVersion(): number;
+    get minorVersion(): number;
+    /**
+     * Creates a string, in the format 'RR.ww.mm', representing this SchemaKey.
+     * @note The default is to pad the full name with zeroes.
+     * @param padZeroes If true, the returned string will strictly follow `Name.RR.ww.mm` and add leading zeroes if necessary.
+     */
+    toString(padZeroes?: boolean): string;
+    static parseString(fullName: string): SchemaKey;
+    /**
+     * Compares two schema names, case-insensitive.
+     * @return True if they match; otherwise, false.
+     */
+    compareByName(rhs: SchemaKey | string | undefined): boolean;
+    /**
+     * Compares two schema versions.
+     * @param rhs The schema to compare.
+     * @return A negative number if this schema version is less than the given version, a positive number if greater, and 0 if are equivalent.
+     */
+    compareByVersion(rhs: SchemaKey): number;
+    /**
+     *
+     * @param rhs The SchemaKey to compare with
+     * @param matchType The match type to use for comparison.
+     */
+    matches(rhs: SchemaKey, matchType?: SchemaMatchType): boolean;
+    /**
+     * Deserializes a SchemaKeyProps JSON object into a SchemaKey object.
+     * @param props SchemaKeyProps
+     * @returns A SchemaKey object.
+     */
+    static fromJSON(props: SchemaKeyProps): SchemaKey;
+    /**
+     * Save this SchemaKey's properties to an object for serializing to JSON.
+     */
+    toJSON(): SchemaKeyProps;
+}
+/**
+ * The SchemaItemKey contains a SchemaItem's name and SchemaKey.
+ * @beta
+ */
+export declare class SchemaItemKey {
+    private _name;
+    protected _schemaKey: SchemaKey;
+    constructor(name: string, schema: SchemaKey);
+    get schemaKey(): SchemaKey;
+    get name(): string;
+    get schemaName(): string;
+    /** Returns the name in the format, {schemaName}.{name}. */
+    get fullName(): string;
+    /**
+     * Checks whether this SchemaItemKey matches the one provided.
+     * @param rhs The SchemaItemKey to compare to this.
+     */
+    matches(rhs: SchemaItemKey): boolean;
+    matchesFullName(name: string): boolean;
+}
 //# sourceMappingURL=SchemaKey.d.ts.map

package/lib/cjs/SchemaKey.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"SchemaKey.d.ts","sourceRoot":"","sources":["../../src/SchemaKey.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,cAAc,EAAE,MAAM,6BAA6B,CAAC;AAC7D,OAAO,EAAE,eAAe,EAAE,MAAM,aAAa,CAAC;AAI9C;;GAEG;AACH,qBAAa,SAAS;IACpB,OAAO,CAAC,KAAK,CAAa;IAC1B,OAAO,CAAC,MAAM,CAAa;IAC3B,OAAO,CAAC,MAAM,CAAa;IAE3B;;;;;;OAMG;gBACS,IAAI,CAAC,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,MAAM;IASzD,IAAW,IAAI,WAAyB;IACxC,IAAW,KAAK,WAA0B;IAC1C,IAAW,KAAK,WAA0B;IAE1C;;;;OAIG;IACI,QAAQ,CAAC,SAAS,GAAE,OAAc,GAAG,MAAM;IAWlD;;;OAGG;WACW,UAAU,CAAC,aAAa,EAAE,MAAM,GAAG,SAAS;IAc1D;;;;OAIG;IACI,OAAO,CAAC,GAAG,EAAE,SAAS,GAAG,MAAM;CASvC;AAED;;;GAGG;AACH,qBAAa,SAAS;IACpB,OAAO,CAAC,KAAK,CAAS;IACtB,SAAS,CAAC,QAAQ,EAAE,SAAS,CAAC;gBAIlB,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,SAAS;gBAChC,IAAI,EAAE,MAAM,EAAE,WAAW,CAAC,EAAE,MAAM,EAAE,YAAY,CAAC,EAAE,MAAM,EAAE,YAAY,CAAC,EAAE,MAAM;IAS5F,IAAW,OAAO,cAA4B;IAC9C,IAAW,IAAI,WAA8B;IAC7C,IAAW,WAAW,WAAgC;IACtD,IAAW,YAAY,WAAiC;IACxD,IAAW,YAAY,WAAiC;IAExD;;;;OAIG;IACI,QAAQ,CAAC,SAAS,GAAE,OAAc;WAE3B,WAAW,CAAC,QAAQ,EAAE,MAAM;IAY1C;;;OAGG;IACI,aAAa,CAAC,GAAG,EAAE,SAAS,GAAG,MAAM,GAAG,SAAS,GAAG,OAAO;IAOlE;;;;OAIG;IACI,gBAAgB,CAAC,GAAG,EAAE,SAAS,GAAG,MAAM;IAI/C;;;;OAIG;IACI,OAAO,CAAC,GAAG,EAAE,SAAS,EAAE,SAAS,GAAE,eAA2C,GAAG,OAAO;IA+B/F;;;;OAIG;WACW,QAAQ,CAAC,KAAK,EAAE,cAAc,GAAG,SAAS;IAIxD;;OAEG;IACI,MAAM,IAAI,cAAc;CAQhC;AAED;;;GAGG;AACH,qBAAa,aAAa;IACxB,OAAO,CAAC,KAAK,CAAS;IACtB,SAAS,CAAC,UAAU,EAAE,SAAS,CAAC;gBAEpB,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,SAAS;IAK3C,IAAW,SAAS,cAA8B;IAClD,IAAW,IAAI,WAA8B;IAE7C,IAAW,UAAU,WAAkC;IAEvD,2DAA2D;IAC3D,IAAW,QAAQ,WAAgD;IAEnE;;;OAGG;IAEI,OAAO,CAAC,GAAG,EAAE,aAAa,GAAG,OAAO;IAUpC,eAAe,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO;CAK9C"}
+{"version":3,"file":"SchemaKey.d.ts","sourceRoot":"","sources":["../../src/SchemaKey.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,cAAc,EAAE,MAAM,6BAA6B,CAAC;AAC7D,OAAO,EAAE,eAAe,EAAE,MAAM,aAAa,CAAC;AAI9C;;GAEG;AACH,qBAAa,SAAS;IACpB,OAAO,CAAC,KAAK,CAAa;IAC1B,OAAO,CAAC,MAAM,CAAa;IAC3B,OAAO,CAAC,MAAM,CAAa;IAE3B;;;;;;OAMG;gBACS,IAAI,CAAC,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,MAAM;IAYzD,IAAW,IAAI,WAAyB;IACxC,IAAW,KAAK,WAA0B;IAC1C,IAAW,KAAK,WAA0B;IAE1C;;;;OAIG;IACI,QAAQ,CAAC,SAAS,GAAE,OAAc,GAAG,MAAM;IAWlD;;;OAGG;WACW,UAAU,CAAC,aAAa,EAAE,MAAM,GAAG,SAAS;IAc1D;;;;OAIG;IACI,OAAO,CAAC,GAAG,EAAE,SAAS,GAAG,MAAM;CASvC;AAED;;;GAGG;AACH,qBAAa,SAAS;IACpB,OAAO,CAAC,KAAK,CAAS;IACtB,SAAS,CAAC,QAAQ,EAAE,SAAS,CAAC;gBAIlB,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,SAAS;gBAChC,IAAI,EAAE,MAAM,EAAE,WAAW,CAAC,EAAE,MAAM,EAAE,YAAY,CAAC,EAAE,MAAM,EAAE,YAAY,CAAC,EAAE,MAAM;IAS5F,IAAW,OAAO,cAA4B;IAC9C,IAAW,IAAI,WAA8B;IAC7C,IAAW,WAAW,WAAgC;IACtD,IAAW,YAAY,WAAiC;IACxD,IAAW,YAAY,WAAiC;IAExD;;;;OAIG;IACI,QAAQ,CAAC,SAAS,GAAE,OAAc;WAE3B,WAAW,CAAC,QAAQ,EAAE,MAAM;IAY1C;;;OAGG;IACI,aAAa,CAAC,GAAG,EAAE,SAAS,GAAG,MAAM,GAAG,SAAS,GAAG,OAAO;IAUlE;;;;OAIG;IACI,gBAAgB,CAAC,GAAG,EAAE,SAAS,GAAG,MAAM;IAI/C;;;;OAIG;IACI,OAAO,CAAC,GAAG,EAAE,SAAS,EAAE,SAAS,GAAE,eAA2C,GAAG,OAAO;IA+B/F;;;;OAIG;WACW,QAAQ,CAAC,KAAK,EAAE,cAAc,GAAG,SAAS;IAIxD;;OAEG;IACI,MAAM,IAAI,cAAc;CAQhC;AAED;;;GAGG;AACH,qBAAa,aAAa;IACxB,OAAO,CAAC,KAAK,CAAS;IACtB,SAAS,CAAC,UAAU,EAAE,SAAS,CAAC;gBAEpB,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,SAAS;IAK3C,IAAW,SAAS,cAA8B;IAClD,IAAW,IAAI,WAA8B;IAE7C,IAAW,UAAU,WAAkC;IAEvD,2DAA2D;IAC3D,IAAW,QAAQ,WAAgD;IAEnE;;;OAGG;IAEI,OAAO,CAAC,GAAG,EAAE,aAAa,GAAG,OAAO;IAUpC,eAAe,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO;CAK9C"}