@daml/types details and history

TypeScript and JavaScript language bindings for Canton.

Details and history

@daml/types details and history

Generated-source metadata, version coverage, export inventory, and per-version changes for this source stream.

TypeDoc3.4.11

Generated from

Generated reference page

The TypeScript reference page is generated from the publish-version TypeDoc JSON, with history calculated across selected snapshots.

Version summary

Active since / addedChangedRemovedDeprecated

VERSION	STATUS	SUMMARY
3.4.8	40 added	40 added.
3.4.9	3 changed	3 changed.
3.4.10	0 surface changes	No surface changes detected in the selected inputs.
3.4.11	0 surface changes	No surface changes detected in the selected inputs.

Current reference inventory

Interfaces

TYPE	STATUS	SUMMARY
Choice	Since 3.4.8	Interface for objects representing Daml choices.
ChoiceFrom	Since 3.4.8	The origin companion that contained a [[Choice]].
ContractTypeCompanion	Since 3.4.8Changed 3.4.9	Companion objects for templates and interfaces, containing their choices.
FromTemplate	Since 3.4.8	A mixin for [[InterfaceCompanion]]. This supplies the basis for the methods of [[ToInterface]]. Even interfaces that retroactively implement for no templates implement this, because forward implementations still require this marker to work.
Map	Since 3.4.8	The counterpart of Daml’s DA.Map.Map K V type. This is an immutable map which compares keys via deep equality. The order of iteration is unspecified; the only guarantee is that the order in keys and values match, i.e. m.get(k) is (deep-, value-based) equal to [...m.values()][[...m.keys()].findIndex((l) => _.isEqual(k, l))]
Serializable	Since 3.4.8	Interface for companion objects of serializable types. Its main purpose is to serialize and deserialize values between raw JSON and typed values.
Template	Since 3.4.8Changed 3.4.9	Interface for objects representing Daml templates. It is similar to the Template type class in Daml.
ToInterface	Since 3.4.8	A mixin for [[Template]] that provides the toInterface and unsafeFromInterface contract ID conversion functions. Even templates that directly implement no interfaces implement this, because this also permits conversion with interfaces that supply retroactive implementations to this template.
Unit	Since 3.4.8	The counterpart of Daml’s () type.

Type Aliases

TYPE	STATUS	SUMMARY
Bool	Since 3.4.8	The counterpart of Daml’s Bool type.
ContractId	Since 3.4.8	The counterpart of Daml’s ContractId T type. We represent ContractIds as strings. Their exact format of these strings depends on the ledger the Daml application is running on. The purpose of the intersection with { [ContractIdBrand]: T } is to prevent accidental use of a ContractId<T> when a ContractId<U> is needed (unless T is a subtype of U). This technique is known as “branding” in the TypeScript community.
Date	Since 3.4.8	The counterpart of Daml’s Date type. We represent Dates as strings with format YYYY-MM-DD.
Decimal	Since 3.4.8	The counterpart of Daml’s Decimal type. In Daml, Decimal’s are the same as Numeric with precision 10.
DisclosedContract	Since 3.4.8	A disclosed contract that can be passed on a command submission.
Int	Since 3.4.8	The counterpart of Daml’s Int type. We represent Ints as string in order to avoid a loss of precision.
Interface	Since 3.4.8	An interface type, for use with contract IDs.
InterfaceCompanion	Since 3.4.8	Interface for objects representing Daml interfaces.
List	Since 3.4.8	The counterpart of Daml’s [T] list type. We represent lists using arrays.
Numeric	Since 3.4.8	The counterpart of Daml’s Numeric type. We represent Numerics as string in order to avoid a loss of precision. The string must match the regular expression -?(?:0|[1-9]\d*)(?:\.\d+)?(?:[eE][+-]?\d+)?.
Optional	Since 3.4.8	The counterpart of Daml’s Optional T type.
Party	Since 3.4.8	The counterpart of Daml’s Party type. We represent Partys as strings matching the regular expression [A-Za-z0-9:_\- ]+.
TemplateOrInterface	Since 3.4.8Changed 3.4.9	-
Text	Since 3.4.8	The counterpart of Daml’s Text type.
TextMap	Since 3.4.8	The counterpart of Daml’s TextMap T type. We represent TextMaps as dictionaries.
Time	Since 3.4.8	The counterpart of Daml’s Time type. We represent Timess as strings with format YYYY-MM-DDThh:mm:ss[.ssssss]Z.

Variables

TYPE	STATUS	SUMMARY
Bool	Since 3.4.8	Companion object of the [[Bool]] type.
Date	Since 3.4.8	Companion object of the [[Date]] type.
Decimal	Since 3.4.8	Companion object of the [[Decimal]] type.
Int	Since 3.4.8	Companion object of the [[Int]] type.
Party	Since 3.4.8	Companion object of the [[Party]] type.
Text	Since 3.4.8	Companion object of the [[Text]] type.
Time	Since 3.4.8	Companion object of the [[Time]] type.
Unit	Since 3.4.8	Companion object of the [[Unit]] type.

Functions

TYPE	STATUS	SUMMARY
ContractId	Since 3.4.8	Companion object of the [[ContractId]] type.
emptyMap	Since 3.4.8	-
List	Since 3.4.8	Companion object of the [[List]] type.
Map	Since 3.4.8	Companion function of the [[GenMap]] type.
Numeric	Since 3.4.8	Companion function of the [[Numeric]] type.
Optional	Since 3.4.8	Companion function of the [[Optional]] type.
TextMap	Since 3.4.8	Companion object of the [[TextMap]] type.

Change details

3.4.9Changed ContractTypeCompanionmembers added: templateIdWithPackageId

3.4.9Changed Templatemembers added: templateIdWithPackageId

3.4.9Changed TemplateOrInterfacesignature updated; type parameter renamed: I -> Id

Known limits

• Change detection is structural and compares selected TypeDoc JSON inputs; it does not infer behavioral compatibility.

• Lifecycle labels and replacement links are included only when parsed from supported TypeDoc metadata.