Id64 Namespace

The Id64 namespace provides facilities for working with 64-bit identifiers. These Ids are stored as 64-bit integers inside an IModelDb, but must be represented as strings in JavaScript because JavaScript does not intrinsically support 64-bit integers.

The Id64String type alias is used to indicate function arguments, return types, and variables which are known to contain a well-formed representation of a 64-bit Id.

See Working with Ids for a detailed description and code examples.

Class

Name	Description
Id64.Uint32Map	A specialized replacement for Map<Id64String, T> optimized for performance-critical code.
Id64.Uint32Set	A specialized replacement for Set optimized for performance-critical code which represents large sets of Id64s as pairs of

Interface

Name	Description
Id64.Uint32Pair	Represents an Id64 as a pair of unsigned 32-bit integers.

Variable

Name	Description
Id64.invalid	The string representation of an invalid Id.

Function

Name	Description
Id64.fromJSON	Create an Id64String from its JSON representation.
Id64.fromLocalAndBriefcaseIds	Produce an Id string from a local and briefcase Id.
Id64.fromString	Given a string value, attempt to normalize it into a well-formed Id string.
Id64.fromUint32Pair	Create an Id64String from a pair of unsigned 32-bit integers.
Id64.fromUint32PairObject	Create an Id64String from a Uint32Pair.
Id64.getBriefcaseId	Extract the briefcase Id portion of an Id64String, contained in the upper 24 bits of the 64-bit value.
Id64.getFirst	Return the first Id64String of an Id64Arg.
Id64.getLocalId	Extract the "local" Id portion of an Id64String, contained in the lower 40 bits of the 64-bit value.
Id64.getLowerUint32	Extract an unsigned 32-bit integer from the lower 4 bytes of an Id64String.
Id64.getUint32Pair	Convert an Id64String to a 64-bit unsigned integer represented as a pair of unsigned 32-bit integers.
Id64.getUpperUint32	Extract an unsigned 32-bit integer from the upper 4 bytes of an Id64String.
Id64.has	Returns true if the Id64Arg contains the specified Id.
Id64.isId64	Determine if the input is a well-formed Id64String.
Id64.isInvalid	Returns true if the input is a well-formed Id64String representing an invalid Id.
Id64.isTransient	Determine if the supplied id string represents a transient Id.
Id64.isTransientId64	Determine if the input is a well-formed Id64String and represents a transient Id.
Id64.isValid	Returns true if the input is not equal to the representation of an invalid Id.
Id64.isValidId64	Returns true if the input is a well-formed Id64String representing a valid Id.
Id64.isValidUint32Pair	Returns true if the inputs represent two halves of a valid 64-bit Id.
Id64.iterable	Obtain an iterable over the specified Ids.
Id64.iterator	Obtain iterator over the specified Ids.
Id64.sizeOf	Return the number of Id64Strings represented by an Id64Arg.
Id64.toIdSet	Convert an Id64Arg into an Id64Set.

Defined in

• core/bentley/src/Id.ts Line 75