camera.ui Node SDK

Appearance

@camera.ui/sdk / storage / JsonSchemaObject

Interface: JsonSchemaObject ​

Defined in: storage/index.ts:235

Complete object schema with callbacks.

Extends ​

Properties ​

condition? ​

optional condition?: SchemaCondition | SchemaCondition[]

Defined in: storage/index.ts:73

Condition for conditional field visibility. Array = all must be true (AND).

Inherited from ​

JsonBaseSchema.condition

defaultValue? ​

optional defaultValue?: any

Defined in: storage/index.ts:71

Default value when not set.

Inherited from ​

JsonBaseSchema.defaultValue

description ​

description: string

Defined in: storage/index.ts:52

Field description/help text.

Inherited from ​

JsonBaseSchema.description

group? ​

optional group?: string

Defined in: storage/index.ts:54

Optional group name for organizing fields.

Inherited from ​

JsonBaseSchema.group

hidden? ​

optional hidden?: boolean

Defined in: storage/index.ts:63

Hide field from UI.

Inherited from ​

JsonBaseSchema.hidden

key ​

key: string

Defined in: storage/index.ts:48

Unique field identifier.

Inherited from ​

JsonBaseSchema.key

onGet? ​

optional onGet?: () => Promise<any>

Defined in: storage/index.ts:98

Callback to get computed value.

Returns ​

Promise<any>

Inherited from ​

JsonBaseSchema.onGet

onSet? ​

optional onSet?: (newValue, oldValue) => Promise<void>

Defined in: storage/index.ts:96

Callback after a write. setValue fires it whether or not the value changed; setConfig fires it only for keys that changed.

Parameters ​

newValue ​

any

oldValue ​

any

Returns ​

Promise<void>

Inherited from ​

JsonBaseSchema.onSet

placeholder? ​

optional placeholder?: string

Defined in: storage/index.ts:69

Placeholder text for empty fields.

Inherited from ​

JsonBaseSchema.placeholder

properties ​

properties: JsonSchemaWithoutCallbacks[]

Defined in: storage/index.ts:181

Sub-fields of the object value.

Inherited from ​

JsonObjectSchema.properties

readonly? ​

optional readonly?: boolean

Defined in: storage/index.ts:67

Make field read-only.

Inherited from ​

JsonBaseSchema.readonly

required? ​

optional required?: boolean

Defined in: storage/index.ts:65

Mark field as required.

Inherited from ​

JsonBaseSchema.required

store? ​

optional store?: boolean

Defined in: storage/index.ts:94

Whether to persist this field to storage.

Inherited from ​

JsonBaseSchema.store

title ​

title: string

Defined in: storage/index.ts:50

Display title.

Inherited from ​

JsonBaseSchema.title

type ​

type: "object"

Defined in: storage/index.ts:236

Field type.

Overrides ​

JsonBaseSchema.type