Interface ObjectField
Defined in: warp-drive-packages/core/src/types/schema/fields.ts:473
Represents a field whose value is an object with keys pointing to values that are primitive values.
If values of the keys are not primitives, or if the key/value pairs have well-defined shape, use 'schema-object' instead.
Properties
kind
kind: "object";Defined in: warp-drive-packages/core/src/types/schema/fields.ts:479
The kind of field this is.
name
name: string;Defined in: warp-drive-packages/core/src/types/schema/fields.ts:486
The name of the field.
options?
optional options?: object;Defined in: warp-drive-packages/core/src/types/schema/fields.ts:528
Options to pass to the transform, if any
Must comply to the specific transform's options schema.
Index Signature
[key: string]: Value | undefinedobjectExtensions?
optional objectExtensions?: string[];⚠️ Dangerous Feature Ahead
Configures which extensions this object should use.
Extensions are registered with the store's schema service via SchemaService.CAUTION_MEGA_DANGER_ZONE_registerExtension
Extensions should only be used for temporary enhancements to objects to support migrating away from deprecated patterns like custom getters, computeds, and methods
sourceKey?
optional sourceKey?: string;Defined in: warp-drive-packages/core/src/types/schema/fields.ts:510
The name of the field as returned by the API and inserted into the Cache if it differs from ObjectField.name
For instance, if the API returns:
{
attributes: {
'first-name': 'Chris'
}
}But the app desires to use record.firstName; // 'Chris'
Then name would be set to 'firstName' and sourceKey would be set to 'first-name'.
This option is only needed when the value differs from name.
type?
optional type?: string;Defined in: warp-drive-packages/core/src/types/schema/fields.ts:518
The name of a transform to pass the entire object through before displaying or serializing it.