module@warp-drive/schema-dsl

Interface SchemaArrayOptions

Defined in: fields/schema-array.ts:11

Options accepted by the schemaArray decorator.

Properties

defaultValue?

optional defaultValue?: boolean;

Defined in: fields/schema-array.ts:88

If true, a missing cache value becomes [] instead of null. Compiles onto the SchemaArrayField's options.defaultValue.

---

key?

optional key?: string;

Defined in: fields/schema-array.ts:80

How the array decides that a cache object is the same schema-object it already instantiated. Compiles onto the SchemaArrayField's options.key. Runtime defaults to '@identity'.

• '@identity' — referential identity of the cached object
• '@index' — the element's index in the array
• '@hash' — the @hash function on the contained object schema
• a field name — a kind: 'field' on the contained object schema

---

polymorphic?

optional polymorphic?: boolean;

Defined in: fields/schema-array.ts:50

Whether each element may be a different object-schema type. Compiles onto the SchemaArrayField's options.polymorphic.

This is not resource-relationship polymorphism: there is no inverse, no async, and no as trait. Runtime picks each element's object schema by reading typeField from the raw value, or by running the hash function named by type when typeField is '@hash'.

---

sourceKey?

optional sourceKey?: string;

Defined in: fields/schema-array.ts:36

The name of the field as returned by the API, if it differs from the decorated property's name. Compiles onto the SchemaArrayField's sourceKey.

---

type?

optional type?: string | null;

Defined in: fields/schema-array.ts:27

If the field is not polymorphic, the type of the ObjectSchema that describes each element.

If the field is polymorphic and typeField is '@hash', the name of the HashFn used to compute each element's type from the raw cache value.

If the field is polymorphic and typeField is a payload key, this may be omitted (compiles to null). Runtime reads the type from that key.

Compiles onto the SchemaArrayField's type.

---

typeField?

optional typeField?: string;

Defined in: fields/schema-array.ts:65

When polymorphic is true, the key on each raw element that holds the object-schema type, or '@hash' to compute it.

Compiles onto the SchemaArrayField's options.type. Runtime defaults to 'type' when this is omitted.

Named typeField on the decorator so it does not collide with type (the object-schema or hash function name).