FieldDefinition
Defined in: types.ts:23
Represents the definition of a single field in a table schema.
Extends
Section titled “Extends”Type Parameters
Section titled “Type Parameters”T = unknown
The TypeScript type this field maps to.
Properties
Section titled “Properties”arrayElementType?
Section titled “arrayElementType?”
optionalarrayElementType:FieldDefinition<unknown>
Defined in: types.ts:33
assert?
Section titled “assert?”
optionalassert:string
Defined in: types.ts:11
Inherited from
Section titled “Inherited from”comment?
Section titled “comment?”
optionalcomment:string
Defined in: types.ts:16
Inherited from
Section titled “Inherited from”default?
Section titled “default?”
optionaldefault:string
Defined in: types.ts:12
Inherited from
Section titled “Inherited from”flexible?
Section titled “flexible?”
optionalflexible:boolean
Defined in: types.ts:27
If true, generates SurrealQL ‘FLEXIBLE’ for object/custom fields. Only set by Field.object/custom builders.
isOptional?
Section titled “isOptional?”
optionalisOptional:boolean
Defined in: types.ts:31
objectSchema?
Section titled “objectSchema?”
optionalobjectSchema:Record<string,FieldDefinition<unknown>>
Defined in: types.ts:34
permissions?
Section titled “permissions?”
optionalpermissions:string|PermissionsClause
Defined in: types.ts:15
Inherited from
Section titled “Inherited from”readonly?
Section titled “readonly?”
optionalreadonly:boolean
Defined in: types.ts:14
Inherited from
Section titled “Inherited from”recordOnDelete?
Section titled “recordOnDelete?”
optionalrecordOnDelete:"cascade"|"set null"|"none"
Defined in: types.ts:38
recordReference?
Section titled “recordReference?”
optionalrecordReference:boolean
Defined in: types.ts:37
recordTableThunk()?
Section titled “recordTableThunk()?”
optionalrecordTableThunk: () =>ModelStatic<any,any>
Defined in: types.ts:36
Returns
Section titled “Returns”ModelStatic<any, any>
type:
string
Defined in: types.ts:29
value?
Section titled “value?”
optionalvalue:string
Defined in: types.ts:13