@coasys/ad4m / Exports / PropertyOptions
Interface: PropertyOptions
Table of contents
Properties
Properties
getter
• Optional getter: string
Custom getter to get the value of the property in the prolog engine. If not provided, the default getter will be used.
Defined in
model/decorators.ts:149
initial
• Optional initial: string
The initial value of the property. Required if the property is marked as required.
Defined in
model/decorators.ts:129
local
• Optional local: boolean
Indicates whether the property is stored locally in the perspective and not in the network. Useful for properties that are not meant to be shared with the network.
Defined in
model/decorators.ts:159
required
• Optional required: boolean
Indicates whether the property is required. If true, an initial value must be provided.
Defined in
model/decorators.ts:134
resolveLanguage
• Optional resolveLanguage: string
The language used to store the property. Can be the default Literal Language or a custom language address.
Defined in
model/decorators.ts:144
setter
• Optional setter: string
Custom setter to set the value of the property in the prolog engine. Only available if the property is writable.
Defined in
model/decorators.ts:154
through
• Optional through: string
The predicate of the property. All properties must have this option.
Defined in
model/decorators.ts:124
transform
• Optional transform: (value: any) => any
Type declaration
▸ (value): any
Optional transform function to modify the property value after it is retrieved. This is useful for transforming raw data into a more usable format. The function takes the raw value as input and returns the transformed value.
Parameters
| Name | Type |
|---|---|
value | any |
Returns
any
Defined in
model/decorators.ts:166
writable
• Optional writable: boolean
Indicates whether the property is writable. If true, a setter will be available in the prolog engine.
Defined in
model/decorators.ts:139