@itwin/core-common/lib/cjs/EntityReference.d.ts

iTwin.js components common to frontend and backend

/** @packageDocumentation
 * @module Schema
 */
import { Id64String } from "@itwin/core-bentley";
/**
 * Types of concrete entities. Used for storing strings in JavaScript reference-equality containers which encode
 * low-level entity information.
 * @note the values of this enum are unstable, do not depend upon their values between versions of iTwin.js
 *       (e.g. do not serialize them and load them in another version of iTwin.js and expect them to work)
 * CodeSpecs are excepted since their JavaScript representation does not derive from [Entity]($backend)
 * @note the string value of each variant is required/guaranteed to be 1 character
 * @see EntityReference
 * @alpha
 */
export declare enum ConcreteEntityTypes {
    Model = "m",
    Element = "e",
    ElementAspect = "a",
    Relationship = "r"
}
/**
 * Adds some utilities to the [[ConcreteEntityTypes]] enum
 * @alpha
 */
export declare namespace ConcreteEntityTypes {
    /** used by the transformer to figure out where to check for the existence in a db of a concrete element id
     * @internal
     */
    function toBisCoreRootClassFullName(type: ConcreteEntityTypes): string;
}
/**
 * This id format can be used for storing a unique key for an entity in containers like `Map`.
 * Elements and non-element entities have different id sequences, they can collide with each other, but not within themselves.
 * @note for utilities that require runtime backend classes, see [EntityReferences]($backend)
 * @alpha
 */
export type EntityReference = `${ConcreteEntityTypes}${Id64String}`;
/** A set of concrete entity ids, with additional functions to more literately add ids where you have the raw id and know what type it is
 * @alpha
 */
export declare class EntityReferenceSet extends Set<EntityReference> {
    addElement(id: Id64String): void;
    addModel(id: Id64String): void;
    addAspect(id: Id64String): void;
    addRelationship(id: Id64String): void;
}
/** @internal entity reference type information of a relationship */
export interface RelTypeInfo {
    source: ConcreteEntityTypes;
    target: ConcreteEntityTypes;
}
//# sourceMappingURL=EntityReference.d.ts.map