Options
All
  • Public
  • Public/Protected
  • All
Menu

Index

Interfaces

Type aliases

Variables

Functions

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

Const List

Const Map

Const Numeric

  • Companion function of the Numeric type.

    Parameters

    • _: number

    Returns Serializable<string>

Const Optional

Const TextMap

assembleInterface

assembleTemplate

  • 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>

  • Type parameters

    • K

    • V

    Returns Map<K, V>

lazyMemo

  • lazyMemo<A>(mkDecoder: () => Decoder<A>): jtv.Decoder<A>
  • 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>
  • internal

    Parameters

    • templateId: string

    Returns Template<object, unknown, string>

memo

  • memo<A>(thunk: () => 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.

    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>): void
  • internal

    Type parameters

    • T: object

    Parameters

    Returns void

Generated using TypeDoc