Skip to content
This repository was archived by the owner on Mar 10, 2025. It is now read-only.

ModelViewDefinition.md

Latest commit

 

History

History
20 lines (13 loc) · 1.29 KB

ModelViewDefinition.md

File metadata and controls

20 lines (13 loc) · 1.29 KB

@ceramic-sdk/model-protocol v0.2.1 • Docs

Ceramic SDK / @ceramic-sdk/model-protocol / ModelViewDefinition

Variable: ModelViewDefinition

const ModelViewDefinition: UnionCodec<[UnionCodec<[ExactCodec<TypeCodec<object>>, ExactCodec<TypeCodec<object>>]>, UnionCodec<[ExactCodec<TypeCodec<object>>, ExactCodec<TypeCodec<object>>, ExactCodec<TypeCodec<object>>]>]>

Identifies types of properties that are supported as view properties at DApps' runtime

A view-property is one that is not stored in related MIDs' content, but is derived from their other properties

Currently supported types of view properties:

  • 'documentAccount': view properties of this type have the MID's controller DID as values
  • 'documentVersion': view properties of this type have the MID's commit ID as values
  • 'relationDocument': view properties of this type represent document relations identified by the given 'property' field
  • 'relationFrom': view properties of this type represent inverse relations identified by the given 'model' and 'property' fields
  • 'relationCountFrom': view properties of this type represent the number of inverse relations identified by the given 'model' and 'property' fields