minca
ApiCoreFunctions

Function: describeCollection()

function describeCollection(definition): readonly string[];

Defined in: packages/core/src/records/describe.ts:78

The collection's rules, links and history as short sentences, in a fixed order: who may add, who may change or remove, what must be unique, what can't change, what it points at, which permissions roles can hold, and whether old versions are kept.

Parameters

ParameterType
definitionDescribable

Returns

readonly string[]

Throws

When the rules hold something this doesn't know how to say

On this page