• 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

Daml Guide

  • Writing Daml
    • An introduction to Daml
      • 1 Basic contracts
      • 2 Testing templates using Daml Script
      • 3 Data types
      • 4 Transforming data using choices
      • 5 Adding constraints to a contract
      • 6 Parties and authority
      • 7 Composing choices
      • 8 Exception Handling
      • 9 Working with Dependencies
      • 10 Functional Programming 101
      • 11 Intro to the Daml Standard Library
      • 12 Testing Daml Contracts
    • Language reference docs
      • Overview: template structure
      • Templates
      • Choices
      • Updates
      • Data types
      • Built-in functions
      • Expressions
      • Functions
      • File structure
      • Packages
      • Contract keys
      • Exceptions
    • 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
      • Initiate and Accept
      • Multiple party agreement
      • Delegation
      • Authorization
      • Locking
        • Locking by archiving
        • Locking by state
        • Locking by safekeeping
      • Diagram legends
  • Building Applications
    • Application architecture
    • JavaScript Client Libraries
      • JavaScript Code Generator
      • @daml/react
      • @daml/ledger
      • @daml/types
      • Testing Your Web App
    • HTTP JSON API Service
      • Daml-LF JSON Encoding
      • Query language
      • Production Setup
    • 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
      • gRPC
      • Error Codes
      • Ledger API Reference
      • How Daml types are translated to protobuf
      • How Daml types are translated to Daml-LF
      • Java bindings
        • Generate Java code from Daml
        • Ping Pong Example
        • Iou Quickstart Tutorial
      • Creating 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
    • Overview of Daml ledgers
    • Deploying to a generic Daml ledger
    • Daml Ledger Topologies
  • Operating Daml
    • Operating Daml
      • Daml Helm Chart
      • Setting Up Auth0
    • Daml Participant pruning
  • Developer Tools
    • Daml Assistant (daml)
    • Daml Studio
    • Daml Sandbox
    • Navigator
    • Daml codegen
    • Daml Profiler

Canton Guide

  • Introduction
  • Tutorials
    • Canton Demo
    • Getting Started
    • Daml SDK and Canton
    • Key Concepts
    • Composability
  • User Manual
    • Obtaining Canton
    • Installing Canton
    • Running in Docker
    • Static Configuration
    • Canton Administration APIs
    • Command-line Arguments
    • Canton Console
    • Contract Keys in Canton
    • Enterprise Domain Integrations
      • Fabric Domain
      • Ethereum Domain
    • Error codes
    • High Availability Usage
    • Identity Management
    • Monitoring
    • Operational Processes
    • Versioning
    • Frequently Asked Questions
  • Architecture-In-Depth
    • High-Level Requirements
    • Overview and Assumptions
    • Domain Architecture and Integrations
      • Canton Domain on Fabric
    • High Availability
      • Canton High Availability: Overview and Principles
      • Replicated Participant Node Architecture
      • Domain HA
    • Identity Management
    • Research Publications
    • Security

Help

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

Reference

  • Cheat Sheet
  • Glossary of concepts
  • Examples
  • Daml Ledger Model
    • Structure
    • Integrity
    • Privacy
    • Daml: Defining Contract Models Compactly
    • Exceptions
  • Identity and Package Management
  • Time
  • Causality and Local Ledgers
  • Daml Ecosystem Overview
    • Status Definitions
    • Feature and Component Statuses
  • Releases and Versioning
  • Canton Administration APIs
  • Research Publications
  • Security
  • System Requirements

Advanced

  • Ledger Export
  • Visualizing Daml Contracts
  • Ledger Interoperability
  • Non-repudiation
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.