Skip to content
Legato Docs

Contract Package

Use @ddgutierrezc/legato-contract when you need shared contract primitives without Capacitor runtime behavior.

Install

Section titled “Install”

  1. Install the package.

    Terminal window
    npm install @ddgutierrezc/legato-contract

  2. Import from the package root.

    import { LEGATO_EVENT_NAMES } from '@ddgutierrezc/legato-contract';

  3. Build your app against typed contract events, snapshots, and invariants.

Package role

Section titled “Package role”
  • Contract-only surface for track, state, queue, snapshot, and errors.
  • Event constants and payload maps, including LEGATO_EVENT_NAMES.
  • Capability and invariant helpers.
  • Transport-neutral binding-adapter contract primitives.

Learn by path

Section titled “Learn by path”

Public export contract

Section titled “Public export contract”
  • ✅ Supported: root import from @ddgutierrezc/legato-contract.
  • ❌ Unsupported: undocumented deep imports like @ddgutierrezc/legato-contract/dist/*.

Support and community

Section titled “Support and community”