API Reference
interfaces
Propertymetadata

@coasys/ad4m / Exports / PropertyMetadata

Interface: PropertyMetadata

Metadata for a single property extracted from decorators.

Table of contents

Properties

Properties

flag

Optional flag: boolean

Whether this is a flag property

Defined in

model/types.ts:144 (opens in a new tab)


getter

Optional getter: string

Custom SurrealQL getter code

Defined in

model/types.ts:138 (opens in a new tab)


initial

Optional initial: string

Initial value if specified

Defined in

model/types.ts:130 (opens in a new tab)


local

Optional local: boolean

Whether stored locally only

Defined in

model/types.ts:140 (opens in a new tab)


name

name: string

The property name

Defined in

model/types.ts:122 (opens in a new tab)


predicate

predicate: string

The predicate URI (through value)

Defined in

model/types.ts:124 (opens in a new tab)


prologGetter

Optional prologGetter: string

Custom Prolog getter code

Defined in

model/types.ts:134 (opens in a new tab)


prologSetter

Optional prologSetter: string

Custom Prolog setter code

Defined in

model/types.ts:136 (opens in a new tab)


readOnly

readOnly: boolean

Whether the property is read-only

Defined in

model/types.ts:128 (opens in a new tab)


required

required: boolean

Whether the property is required

Defined in

model/types.ts:126 (opens in a new tab)


resolveLanguage

Optional resolveLanguage: string

Language for resolution (e.g., "literal")

Defined in

model/types.ts:132 (opens in a new tab)


transform

Optional transform: (value: any) => any

Type declaration

▸ (value): any

Transform function

Parameters
NameType
valueany
Returns

any

Defined in

model/types.ts:142 (opens in a new tab)