• Daml Documentation

Getting started

  • Installing the SDK
    • Setting JAVA_HOME and PATH Variables
    • Manually Installing the SDK
  • Building Your App
  • App Architecture
  • Your First Feature
  • Testing Your Web App

Application development

  • Writing Daml
    • An Introduction to Daml
      • Basic Contracts
      • Test Templates using Daml Script
      • Data Types
      • Transform Data Using Choices
      • Add Constraints to a Contract
      • Parties and Authority
      • Composing Choices
      • Exception Handling
      • Work with Dependencies
      • Functional Programming 101
      • Introduction to the Daml Standard Library
      • Test Daml Contracts
    • Language Reference
      • Overview: Template Structure
      • Templates
      • Choices
      • Updates
      • Data types
      • Built-in functions
      • Expressions
      • Functions
      • File structure
      • Packages
      • Contract keys
      • Exceptions
      • Interfaces
    • The standard library
      • Prelude
      • DA.Action
      • DA.Action.State
      • DA.Action.State.Class
      • DA.Assert
      • DA.Bifunctor
      • DA.BigNumeric
      • DA.Date
      • DA.Either
      • DA.Exception
      • DA.Foldable
      • DA.Functor
      • DA.List
      • DA.List.BuiltinOrder
      • DA.List.Total
      • DA.Logic
      • DA.Map
      • DA.Math
      • DA.Monoid
      • DA.NonEmpty
      • DA.NonEmpty.Types
      • DA.Numeric
      • DA.Optional
      • DA.Record
      • DA.Semigroup
      • DA.Set
      • DA.Stack
      • DA.Text
      • DA.TextMap
      • DA.Time
      • DA.Traversable
      • DA.Tuple
      • DA.Validation
    • Good Design Patterns
      • The Initiate and Accept Pattern
      • The Multiple Party Agreement Pattern
      • The Delegation Pattern
      • The Authorization Pattern
      • The Locking Pattern
        • Lock by Archiving
        • Lock by State
        • Lock by Safekeeping
      • Diagram Legends
  • Building Applications
    • Daml Application Architecture
    • Using JavaScript Client Libraries with Daml
      • Use the JavaScript Code Generator
      • @daml/react
      • @daml/ledger
      • @daml/types
    • HTTP JSON API Service
      • Daml-LF JSON Encoding
      • Query Language
      • Production Setup
    • Java Bindings
      • Generate Java Code from Daml
      • Ping Pong Example
      • Iou Quickstart Tutorial
    • Daml Script
      • Daml Script Library
        • Daml.Script
    • Daml REPL
    • Upgrading and Extending Daml Applications
      • Extending Daml Applications
      • Upgrading Daml Applications
      • Automating the Upgrade Process
    • Authorization
    • The Ledger API
      • The Ledger API Services
      • Parties and Users On a Daml Ledger
      • Use the Ledger API With gRPC
      • Error Codes
      • Ledger API Reference
      • How Daml Types are Translated to Protobuf
      • How Daml Types are Translated to Daml-LF
      • Create Your Own Bindings
    • Command Deduplication
    • Daml Triggers - Off-Ledger Automation in Daml
      • Daml Trigger Library
        • Daml.Trigger
        • Daml.Trigger.Assert
        • Daml.Trigger.LowLevel
    • Trigger Service
      • Authorization
      • Auth0 Example Configuration
    • Auth Middleware
      • OAuth 2.0 Auth Middleware
  • Deploying to Daml Ledgers
  • Operating Daml
    • Participant Pruning
    • Participant Metering
    • System Requirements
    • System Architecture FAQ
  • Developer Tools
    • Daml Assistant (daml)
    • Daml Studio
    • Daml Sandbox
    • Navigator
    • Daml Codegen
    • Daml Profiler

Platform operations

  • Introduction
  • Tutorials
    • Canton Demo
    • Getting Started
    • Daml SDK and Canton
    • Composability
  • User Manual
    • Obtaining Canton
    • Installing Canton
    • Upgrading
    • Running in Docker
    • Static Configuration
    • Persistence
    • Api Configuration
    • Command-line Arguments
    • Canton Console
    • Sequencer Connections
    • Manage Dars and Packages
    • Identity Management
    • Security
    • Enterprise Drivers
      • Oracle Domain
      • Trusted Enclave Domain (CCF)
      • Fabric Domain
      • Ethereum Domain
    • Manage Domains
    • Manage Domain Entities
    • High Availability Usage
    • Scaling and Performance
    • Monitoring
    • Ledger Pruning
    • Repairing Nodes
    • Versioning
    • Contract Keys in Canton
    • Frequently Asked Questions
  • Architecture-In-Depth
    • High-Level Requirements
    • Overview and Assumptions
    • Domain Architecture and Integrations
      • Canton Domain on Ethereum
      • Canton Domain on Fabric
    • High Availability
      • Canton High Availability: Overview and Principles
      • Replicated Participant Node Architecture
      • Domain HA
    • Identity Management
    • Research Publications
  • Reference Manual
    • Console Commands
    • Error codes
    • Canton Administration APIs

Help

  • Troubleshooting
  • Getting Help
  • Portability, Compatibility, and Support Durations

Reference

  • Cheat Sheet
  • Glossary of concepts
  • Examples
  • Daml Ledger Model
    • Structure
    • Integrity
    • Privacy
    • Daml: Define Contract Models Compactly
    • Exceptions
  • Identity and Package Management
  • Time on Daml Ledgers
  • Causality and Local Daml Ledgers
  • Test Evidence
  • Daml Ecosystem Overview
    • Status Definitions
    • Feature and Component Statuses
  • Releases and Versioning

Early access

  • Ledger Export
  • Visualizing Daml Contracts
  • Daml Ledger Interoperability
  • Non-repudiation
  • Daml Helm Chart
  • Setting Up Auth0
Download as PDF

Developers
Products
Company
Version 
Please enter at least 3 letters.
In This Section
  • @daml/types

@daml/typesΒΆ

@daml/types documentation

Previous Next

Copyright (c) 2022 Digital Asset (Switzerland) GmbH and/or its affiliates. All rights reserved. Any unauthorized use, duplication or distribution is strictly prohibited. "Digital Asset" and "Daml" are Registered in the U.S. Patent and Trademark Office.