CollectionRelation

CollectionRelation<TField, TTarget> = object

Defined in: packages/core/src/cms.ts:87

Defines the type of relationship between collections.

• single: One-to-one relationship returning an Option of the target
• array: One-to-many relationship returning an array of targets
• map: Key-value mapping relationship returning a Map

Example

const authorRelation: CollectionRelation<"authorId", "authors"> = {
  type: "single",
  field: "authorId",
  target: "authors"
};

Type Parameters

TField

TField extends string = string

TTarget

TTarget extends string = string

Properties

field

readonly field: TField

Defined in: packages/core/src/cms.ts:92

---

target

readonly target: TTarget

Defined in: packages/core/src/cms.ts:93

---

type

readonly type: "single" | "array" | "map"

Defined in: packages/core/src/cms.ts:91