Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface Contract<TData, TLinks>

The base interface that must be implemented by every contract.

Type parameters

Hierarchy

Index

Properties

active: boolean

Specifies whether the contract is currently active.

capabilities: {}[]

A list of capabilities for this contract.

created_at: string

The date/time the contract was created, expressed as an ISO 8601 string.

data: TData

The data associated with this contract.

id: string

A UUID that uniquely identifies this contract.

linked_at?: {}

Link timestamps, keyed by 'link verb'.

Type declaration

  • [k: string]: unknown
links?: TLinks

Linked contracts, keyed by the 'link verb'.

loop?: null | string

The slug of the loop that the contract belongs to.

markers: string[]

Markers associated with this contract.

name?: null | string

An optional user-friendly name for this contract.

requires: {}[]

A list of requirements/dependencies for this contract.

slug: string

A string that uniquely identifies this contract.

tags: string[]

The tags associated with this contract.

type: string

The type of this contract. The type value should include the version.

For example: 'my-type@1.0.0'

updated_at?: null | string

The date/time the contract was most recently updated, expressed as an ISO 8601 string.

version: string

A semantic version of the contract.

Generated using TypeDoc