Skip to main content
zerotal

Documentation

Documentation / @zerotal/orm / index / ArrayCast

Class: ArrayCast<T>

Defined in: packages/orm/src/casts/Cast.ts:155

Cast a JSON column to an array of typed values, optionally hydrated. Non-array stored values read back as []; on write the array is stringified. Usually created via the arrayOf helper.

Extends

Type Parameters

T

T = unknown

Constructors

Constructor

new ArrayCast<T>(mapper?): ArrayCast<T>

Defined in: packages/orm/src/casts/Cast.ts:158

Parameters

mapper?

CastMapper<T>

Returns

ArrayCast<T>

Overrides

Cast.constructor

Properties

shape

readonly shape: "array"

Defined in: packages/orm/src/casts/Cast.ts:157

Structural hint for the admin UI: a repeating list of nested objects.

Methods

fields()

fields(): CastField[]

Defined in: packages/orm/src/casts/Cast.ts:162

Sub-fields of each element, derived from the mapper class.

Returns

CastField[]

get()

get(dbValue): T[]

Defined in: packages/orm/src/casts/Cast.ts:165

DB value → model value (on read).

Parameters

dbValue

unknown

Returns

T[]

Overrides

Cast.get

set()

set(value): unknown

Defined in: packages/orm/src/casts/Cast.ts:170

Model value → DB value (on write).

Parameters

value

T[]

Returns

unknown

Overrides

Cast.set