Documentation

Documentation / zerotal / orm / JsonCast

Class: JsonCast<T>

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

Cast a JSON column to a typed object, optionally hydrated into a class. On read the stored JSON is parsed (and mapped via the constructor's fromJSON or prototype hydration when a class mapper is given); on write it is stringified. Usually created via the json / objectOf helpers.

Extends

• Cast<T | null>

Type Parameters

T

T = unknown

Constructors

Constructor

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

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

Parameters

mapper?

CastMapper<T>

Returns

JsonCast<T>

Overrides

Cast.constructor

Properties

shape

readonly shape: "object"

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

Structural hint for the admin UI: a single nested object.

Methods

fields()

fields(): CastField[]

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

Sub-fields derived from the mapper class (empty for plain JSON).

Returns

CastField[]

get()

get(dbValue): T | null

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

DB value → model value (on read).

Parameters

dbValue

unknown

Returns

T | null

Overrides

Cast.get

set()

set(value): unknown

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

Model value → DB value (on write).

Parameters

value

T | null

Returns

unknown

Overrides

Cast.set