Type aliases

Bool

Bool: boolean

The counterpart of Daml's Bool type.

ContractId

ContractId<T>: string & { [ContractIdBrand]: T }

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.

Type parameters

T

The contract template.

Date

Date: string

The counterpart of Daml's Date type.

We represent Dates as strings with format YYYY-MM-DD.

Decimal

Decimal: Numeric

The counterpart of Daml's Decimal type.

In Daml, Decimal's are the same as Numeric with precision 10.

DisclosedContract

DisclosedContract: { contractId: ContractId<unknown>; createdEventBlob: string; templateId: string }

A disclosed contract that can be passed on a command submission.

property: contractId the contract id of the contract.
property: templateId the template id of the contract.
property: createdEventBlob The created_event_blob obtained from the CreatedEvent.

Type declaration

contractId: ContractId<unknown>
createdEventBlob: string
templateId: string

Int

Int: string

The counterpart of Daml's Int type.

We represent Ints as string in order to avoid a loss of precision.

Interface

Interface<IfId>: { [InterfaceBrand]: IfId }

An interface type, for use with contract IDs.

Type parameters

IfId

The interface ID as a constant string.

Type declaration

Readonly [InterfaceBrand]: IfId

InterfaceCompanion

InterfaceCompanion<T, K, I>: ContractTypeCompanion<T, K, I>

Interface for objects representing Daml interfaces.

Type parameters

T: object
K
I: string = string

List

List<T>: T[]

The counterpart of Daml's [T] list type.

We represent lists using arrays.

Type parameters

T

The type of the list values.

Numeric

Numeric: string

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

Optional<T>: null | OptionalInner<T>

The counterpart of Daml's Optional T type.

Type parameters

T

The type of the optionally present value.

Party

Party: string

The counterpart of Daml's Party type.

We represent Partys as strings matching the regular expression [A-Za-z0-9:_\- ]+.

TemplateOrInterface

TemplateOrInterface<T, K, I>: Template<T, K, I> | InterfaceCompanion<T, K, I>

Type parameters

T: object
K = unknown
I: string = string

Text

Text: string

The counterpart of Daml's Text type.

TextMap

TextMap<T>: {}

The counterpart of Daml's TextMap T type.

We represent TextMaps as dictionaries.

Type parameters

T

The type of the map values.

Type declaration

[key: string]: T

Time

Time: string

The counterpart of Daml's Time type.

We represent Timess as strings with format YYYY-MM-DDThh:mm:ss[.ssssss]Z.

Variables

Bool

Bool: Serializable<boolean>

Companion object of the Bool type.

Date

Date: Serializable<string>

Companion object of the Date type.

Decimal

Decimal: Serializable<string>

Companion object of the Decimal type.

Int

Int: Serializable<string>

Companion object of the Int type.

Party

Party: Serializable<string>

Companion object of the Party type.

Text

Text: Serializable<string>

Companion object of the Text type.

Time

Time: Serializable<string>

Companion object of the Time type.

Unit

Unit: Serializable<Unit>

Companion object of the Unit type.

Functions

Const ContractId

ContractId<T>(_t: Serializable<T> | TemplateOrInterface<T & object, unknown, string>): Serializable<ContractId<T>>

- Defined in index.ts:492
Companion object of the ContractId type.

Type parameters
- T
Parameters
- _t: Serializable<T> | TemplateOrInterface<T & object, unknown, string>
Returns Serializable<ContractId<T>>

Const List

List<T>(t: Serializable<T>): Serializable<T[]>

- Defined in index.ts:449
Companion object of the List type.

Type parameters
- T
Parameters
- t: Serializable<T>
Returns Serializable<T[]>

Const Map

Map<K, V>(kd: Serializable<K>, vd: Serializable<V>): Serializable<Map<K, V>>

- Defined in index.ts:701
Companion function of the [[GenMap]] type.

Type parameters
- K
- V
Parameters
- kd: Serializable<K>
- vd: Serializable<V>
Returns Serializable<Map<K, V>>

Const Numeric

Numeric(_: number): Serializable<string>

- Defined in index.ts:384
Companion function of the Numeric type.

Parameters
- _: number
Returns Serializable<string>

Const Optional

Optional<T>(t: Serializable<T>): Serializable<Optional<T>>

- Defined in index.ts:574
Companion function of the Optional type.

Type parameters
- T
Parameters
- t: Serializable<T>
Returns Serializable<Optional<T>>

Const TextMap

TextMap<T>(t: Serializable<T>): Serializable<TextMap<T>>

- Defined in index.ts:589
Companion object of the TextMap type.

Type parameters
- T
Parameters
- t: Serializable<T>
Returns Serializable<TextMap<T>>

assembleInterface

assembleInterface<T, I, C>(templateId: I, decoderSource: () => Serializable<T>, choices: C): InterfaceCompanion<Interface<I> & T, unknown, I> & C

- Defined in index.ts:217
internal
Type parameters
- T: object
- I: string
- C: object
Parameters
- templateId: I
- decoderSource: () => Serializable<T>
  - - (): Serializable<T>
    - Returns Serializable<T>
- choices: C
Returns InterfaceCompanion<Interface<I> & T, unknown, I> & C

assembleTemplate

assembleTemplate<T, TC, IfU>(template: TC, ..._interfaces: FromTemplate<IfU, unknown>[]): TC & ToInterface<T, IfU>

- Defined in index.ts:204
internal
Type parameters
- T: object
- TC: Template<T, unknown, string, TC>
- IfU
Parameters
- template: TC
- Rest ..._interfaces: FromTemplate<IfU, unknown>[]
Returns TC & ToInterface<T, IfU>

Const emptyMap

emptyMap<K, V>(): Map<K, V>

- Defined in index.ts:696
Type parameters
- K
- V
Returns Map<K, V>

lazyMemo

lazyMemo<A>(mkDecoder: () => Decoder<A>): jtv.Decoder<A>

- Defined in index.ts:310
internal
Variation of jtv.lazy which memoizes the computed decoder on its first invocation.

Type parameters
- A
Parameters
- mkDecoder: () => Decoder<A>
  - - (): Decoder<A>
    - Returns Decoder<A>
Returns jtv.Decoder<A>

Const lookupTemplate

lookupTemplate(templateId: string): Template<object, unknown, string>

- Defined in index.ts:278
internal
Parameters
- templateId: string
Returns Template<object, unknown, string>

memo

memo<A>(thunk: () => A): () => A

- Defined in index.ts:294
internal
Turn a thunk into a memoized version of itself. The memoized thunk invokes the original thunk only on its first invocation and caches the result for later uses. We use this to implement a version of jtv.lazy with memoization.

Type parameters
- A
Parameters
- thunk: () => A
  - - (): A
    - Returns A
Returns () => A
- - (): A
  - internal
    Turn a thunk into a memoized version of itself. The memoized thunk invokes the original thunk only on its first invocation and caches the result for later uses. We use this to implement a version of jtv.lazy with memoization.
    
    Returns A

Const registerTemplate

registerTemplate<T>(template: Template<T, unknown, string>, packageSpecifiers?: string[]): void

- Defined in index.ts:246
internal
Type parameters
- T: object
Parameters
- template: Template<T, unknown, string>
- packageSpecifiers: string[] = []
Returns void

Const templateIdWithPackageId

templateIdWithPackageId<T, K, I>(t: Template<T, K, I>): (pkgId: string) => string

- Defined in index.ts:268
internal
Type parameters
- T: object
- K
- I: string
Parameters
- t: Template<T, K, I>
Returns (pkgId: string) => string
- - (pkgId: string): string
  - Parameters
    - pkgId: string
    Returns string

Index

Interfaces

Type aliases

Variables

Functions

Type aliases

Bool

ContractId

Type parameters

T

Date

Decimal

DisclosedContract

Type declaration

contractId: ContractId<unknown>

createdEventBlob: string

templateId: string

Int

Interface

Type parameters

IfId

Type declaration

Readonly [InterfaceBrand]: IfId

InterfaceCompanion

Type parameters

T: object

K

I: string = string

List

Type parameters

T

Numeric

Optional

Type parameters

T

Party

TemplateOrInterface

Type parameters

T: object

K = unknown

I: string = string

Text

TextMap

Type parameters

T

Type declaration

[key: string]: T

Time

Variables

Bool

Date

Decimal

Int

Party

Text

Time

Unit

Functions

Const ContractId

Type parameters

T

Parameters

_t: Serializable<T> | TemplateOrInterface<T & object, unknown, string>

Returns Serializable<ContractId<T>>

Const List

Type parameters

T

Parameters

t: Serializable<T>

Returns Serializable<T[]>

Const Map

Type parameters

K

V

Parameters

kd: Serializable<K>

vd: Serializable<V>

Returns Serializable<Map<K, V>>

Const Numeric

Parameters