Skip to content
unreal-orm-logo unreal-orm-logo unreal-orm
🚀 This documentation is for unreal-orm 1.0.0 alpha which requires SurrealDB 2.0 alpha SDK. For the stable version, see npm.

SelectOption

SelectOption<TFields> = FieldSelect<TFields> | string[] | BoundQuery | Expr

Defined in: define/table/types/select.ts:125

All valid forms of the select option.

  • Object: Type-safe field selection
  • String array: Pass-through field names (less type-safe)
  • BoundQuery/Expr: Raw SurrealQL (escape hatch)

Type Parameters

Section titled “Type Parameters”

TFields

Section titled “TFields”

TFields extends Record<string, FieldDefinition<unknown>>

The field definitions of the table.