GetTypedField

cartographer

---

cartographer / getTypedField

Function: getTypedField()

getTypedField<T>(item, fieldKey, settings): T | null

Defined in: types/types.ts:80

Helper to get typed field from CatalogItem based on schema. Looks up the field definition in the schema and returns the typed value.

Type Parameters

T

T

Expected return type of the field

Parameters

item

CatalogItem

The CatalogItem to read from

fieldKey

string

The field key to retrieve

settings

DatacoreSettings

Plugin settings (contains the schema)

Returns

T | null

• The typed field value, or null if field not found or not set

Example

const title = getTypedField<string>(item, 'title', settings);
const wordCount = getTypedField<number>(item, 'word-count', settings);
const authors = getTypedField<string[]>(item, 'authors', settings);