Skip to content

shared-types


Interface: Parsable<ClassJSONMap, ClassJSON>

Defined in: lib/types/Parsable.ts:6

Contract for types that can serialize to JSON and provide default values.

Type Parameters

ClassJSONMap

ClassJSONMap

ClassJSON

ClassJSON

Methods

getDefaultJSON()

getDefaultJSON(): ClassJSON

Defined in: lib/types/Parsable.ts:27

Provide default values for the plain JSON shape.

Returns

ClassJSON

Defaults for the plain JSON structure.


getDefaultMappedJSON()

getDefaultMappedJSON(): Defaults<ClassJSONMap>

Defined in: lib/types/Parsable.ts:22

Provide default values for the mapped JSON shape.

Returns

Defaults<ClassJSONMap>

Defaults for the mapped JSON structure.


toJSON()

toJSON(): ClassJSON

Defined in: lib/types/Parsable.ts:11

Serialize this instance to its JSON form.

Returns

ClassJSON

A JSON object representing this instance.


toPartialMappedJSON()

toPartialMappedJSON(): Partial<ClassJSONMap>

Defined in: lib/types/Parsable.ts:16

Serialize a partial, mapped JSON structure (e.g., keyed by identifier).

Returns

Partial<ClassJSONMap>

A partial mapping from id to JSON representation.