primaryKey?
typescript
1
readonly optional primaryKey: string
Defined in: ridb_core.d.ts:418
The primary key of the property, if applicable.
Class: Property
Defined in: ridb_core.d.ts:404
Represents a property within a schema, including various constraints and nested properties.
Constructors
Constructor
typescript
1
new Property(): Property
Returns
Property
Properties
default?
typescript
1
readonly optional default: any
Defined in: ridb_core.d.ts:453
An optional default value for the property.
items?
typescript
1
readonly optional items: Property
Defined in: ridb_core.d.ts:423
An optional array of nested properties for array-type properties.
maxItems?
typescript
1
readonly optional maxItems: number
Defined in: ridb_core.d.ts:428
The maximum number of items for array-type properties, if applicable.
maxLength?
typescript
1
readonly optional maxLength: number
Defined in: ridb_core.d.ts:438
The maximum length for string-type properties, if applicable.
minItems?
typescript
1
readonly optional minItems: number
Defined in: ridb_core.d.ts:433
The minimum number of items for array-type properties, if applicable.
minLength?
typescript
1
readonly optional minLength: number
Defined in: ridb_core.d.ts:443
The minimum length for string-type properties, if applicable.
properties?
typescript
1
readonly optional properties: object
Defined in: ridb_core.d.ts:458
An optional map of nested properties for object-type properties.
Index Signature
[name: string]: Property
required?
typescript
1
readonly optional required: boolean
Defined in: ridb_core.d.ts:448
An optional array of required fields for object-type properties.
type
typescript
1
readonly type: SchemaFieldType
Defined in: ridb_core.d.ts:408
The type of the property.
version?
typescript
1
readonly optional version: number
Defined in: ridb_core.d.ts:413
The version of the property, if applicable.