Class QBRecord<RecordData>

Type Parameters

RecordData extends QBRecordData = QBRecordData

Hierarchy

QBRecord

Index

Constructors

constructor

new QBRecord<RecordData>(options?: Partial<QBRecordOptions<RecordData>>): QBRecord<RecordData>
Type Parameters
- RecordData extends QBRecordData = QBRecordData
Parameters
- Optional options: Partial<QBRecordOptions<RecordData>>
Returns QBRecord<RecordData>
- Defined in qb-record.ts:70

Properties

`Readonly` CLASS_NAME

CLASS_NAME: "QBRecord" = 'QBRecord'

`Private` _data

_data: Record<any, any> = {}

`Private` _fids

_fids: Record<any, number> = {}

`Private` _fields

_fields: QBField<Record<any, any>>[] = []

`Private` _qb

_qb: QuickBase

`Private` _tableId

_tableId: string = ''

id

id: string

An internal id (guid) used for tracking/managing object instances

`Static` `Readonly` CLASS_NAME

CLASS_NAME: "QBRecord" = 'QBRecord'

`Static` `Readonly` VERSION

VERSION: string = VERSION

`Static` defaults

defaults: QBRecordOptions<{
primaryKey: number;
recordid: number;
}> = ...

The default settings of a QuickBase instance

Methods

clear

clear(): QBRecord<RecordData>
Returns QBRecord<RecordData>
- Defined in qb-record.ts:99

delete

delete(__namedParameters?: QuickBaseRequest): Promise<QuickBaseResponseDeleteRecords>
Parameters
- __namedParameters: QuickBaseRequest = {}
Returns Promise<QuickBaseResponseDeleteRecords>
- Defined in qb-record.ts:106

fromJSON

fromJSON(json: string | QBRecordJSON<RecordData>): QBRecord<RecordData>
Rebuild the QBRecord instance from serialized JSON
Parameters
- json: string | QBRecordJSON<RecordData>
  
  QBRecord serialized JSON
Returns QBRecord<RecordData>
- Defined in qb-record.ts:432

get

get<F>(field: F): RecordData[F]
Type Parameters
- F extends string | number | symbol
Parameters
- field: F
Returns RecordData[F]
- Defined in qb-record.ts:130
get<F>(field: F): F extends keyof RecordData ? RecordData[F] : any
Type Parameters
- F extends string
Parameters
- field: F
Returns F extends keyof RecordData ? RecordData[F] : any
- Defined in qb-record.ts:131

getFid

getFid<T>(field: T): number
Type Parameters
- T extends string | number | symbol
Parameters
- field: T
Returns number
- Defined in qb-record.ts:136
getFid(field: number, byId: true): string
Parameters
- field: number
- byId: true
Returns string
- Defined in qb-record.ts:137
getFid(field: string | number, byId?: false): number
Parameters
- field: string | number
- Optional byId: false
Returns number
- Defined in qb-record.ts:138

getFids

getFids(): QBFids<RecordData>
Returns QBFids<RecordData>
- Defined in qb-record.ts:165

getField

getField(id: number, returnIndex: true): undefined | number
Parameters
- id: number
- returnIndex: true
Returns undefined | number
- Defined in qb-record.ts:169
getField(id: number, returnIndex?: false): undefined | QBField<Record<any, any>>
Parameters
- id: number
- Optional returnIndex: false
Returns undefined | QBField<Record<any, any>>
- Defined in qb-record.ts:170

getFields

getFields(): QBField<Record<any, any>>[]
Returns QBField<Record<any, any>>[]
- Defined in qb-record.ts:185

getTableId

getTableId(): string
Returns string
- Defined in qb-record.ts:189

getTempToken

getTempToken(__namedParameters?: QuickBaseRequest): Promise<void>
Parameters
- __namedParameters: QuickBaseRequest = {}
Returns Promise<void>
- Defined in qb-record.ts:193

load

load(__namedParameters?: QBRecordLoad): Promise<Record<any, any>>
Parameters
- __namedParameters: QBRecordLoad = {}
Returns Promise<Record<any, any>>
- Defined in qb-record.ts:200

loadSchema

loadSchema(__namedParameters?: QuickBaseRequest): Promise<QBField<Record<any, any>>[]>
Parameters
- __namedParameters: QuickBaseRequest = {}
Returns Promise<QBField<Record<any, any>>[]>
- Defined in qb-record.ts:281

save

save(__namedParameters?: QuickBaseRequest & {
fidsToSave?: (number | keyof RecordData)[];
mergeFieldId?: number;
}): Promise<Record<any, any>>
Parameters
- __namedParameters: QuickBaseRequest & {
  fidsToSave?: (number | keyof RecordData)[];
  mergeFieldId?: number;
  } = {}
Returns Promise<Record<any, any>>
- Defined in qb-record.ts:308

set

set<F>(field: F, value: RecordData[F]): QBRecord<RecordData>
Type Parameters
- F extends string | number | symbol
Parameters
- field: F
- value: RecordData[F]
Returns QBRecord<RecordData>
- Defined in qb-record.ts:391
set<F>(field: F, value: F extends keyof RecordData ? RecordData[F] : any): QBRecord<RecordData>
Type Parameters
- F extends string
Parameters
- field: F
- value: F extends keyof RecordData ? RecordData[F] : any
Returns QBRecord<RecordData>
- Defined in qb-record.ts:392

setFid

setFid<T>(name: T, id: number): QBRecord<RecordData>
Type Parameters
- T extends string | number | symbol
Parameters
- name: T
- id: number
Returns QBRecord<RecordData>
- Defined in qb-record.ts:405
setFid(name: string | number, id: number): QBRecord<RecordData>
Parameters
- name: string | number
- id: number
Returns QBRecord<RecordData>
- Defined in qb-record.ts:406

setFids

setFids(fields: Record<any, number>): QBRecord<RecordData>
Parameters
- fields: Record<any, number>
Returns QBRecord<RecordData>
- Defined in qb-record.ts:413

setFields

setFields(fields: QBField<Record<any, any>>[]): QBRecord<RecordData>
Parameters
- fields: QBField<Record<any, any>>[]
Returns QBRecord<RecordData>
- Defined in qb-record.ts:421

setTableId

setTableId(tableId: string): QBRecord<RecordData>
Parameters
- tableId: string
Returns QBRecord<RecordData>
- Defined in qb-record.ts:399

toJSON

toJSON(fidsToConvert?: (string | number)[]): QBRecordJSON<RecordData>
Serialize the QBRecord instance into JSON
Parameters
- Optional fidsToConvert: (string | number)[]
Returns QBRecordJSON<RecordData>
- Defined in qb-record.ts:481

`Static` IsQBRecord

IsQBRecord<T>(obj: any): obj is QBRecord<T>
Test if a variable is a qb-record object
Type Parameters
- T extends QBRecordData = QBRecordData
Parameters
- obj: any
  
  A variable you'd like to test
Returns obj is QBRecord<T>
- Defined in qb-record.ts:525

`Static` NewRecord

NewRecord<T>(options: Partial<QBRecordOptions<T>>, data?: Partial<T>): QBRecord<T>
Returns a new QBRecord instance built off of options, that inherits configuration data from the passed in data argument.
Type Parameters
- T extends QBRecordData = QBRecordData
Parameters
- options: Partial<QBRecordOptions<T>>
  
  QBRecord instance options
- Optional data: Partial<T>
  
  Quick Base Record data
Returns QBRecord<T>
- Defined in qb-record.ts:535

`Static` fromJSON

fromJSON<T>(json: string | QBRecordJSON<T>): QBRecord<T>
Create a new QBRecord instance from serialized JSON
Type Parameters
- T extends QBRecordData = QBRecordData
Parameters
- json: string | QBRecordJSON<T>
  
  QBRecord serialized JSON
Returns QBRecord<T>
- Defined in qb-record.ts:506

Class QBRecord<RecordData>

Type Parameters

RecordData extends QBRecordData = QBRecordData

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

RecordData extends QBRecordData = QBRecordData

Parameters

Optional options: Partial<QBRecordOptions<RecordData>>

Returns QBRecord<RecordData>

Properties

Readonly CLASS_NAME

Private _data

Private _fids

Private _fields

Private _qb

Private _tableId

id

Static Readonly CLASS_NAME

Static Readonly VERSION

Static defaults

Methods

clear

Returns QBRecord<RecordData>

delete

Parameters

__namedParameters: QuickBaseRequest = {}

Returns Promise<QuickBaseResponseDeleteRecords>

fromJSON

Parameters

json: string | QBRecordJSON<RecordData>

Returns QBRecord<RecordData>

get

Type Parameters

F extends string | number | symbol

Parameters

field: F

Returns RecordData[F]

Type Parameters

F extends string

Parameters

field: F

Returns F extends keyof RecordData ? RecordData[F] : any

getFid

Type Parameters

T extends string | number | symbol

Parameters

field: T

Returns number

Parameters

field: number

byId: true

Returns string

Parameters

field: string | number

Optional byId: false

Returns number

getFids

Returns QBFids<RecordData>

getField

Parameters

id: number

returnIndex: true

Returns undefined | number

Parameters

id: number

Optional returnIndex: false

Returns undefined | QBField<Record<any, any>>

getFields

Returns QBField<Record<any, any>>[]

getTableId

Returns string

getTempToken

Parameters

__namedParameters: QuickBaseRequest = {}

`Optional` options: Partial<QBRecordOptions<RecordData>>

`Readonly` CLASS_NAME

`Private` _data

`Private` _fids

`Private` _fields

`Private` _qb

`Private` _tableId

`Static` `Readonly` CLASS_NAME

`Static` `Readonly` VERSION

`Static` defaults

`Optional` byId: false

`Optional` returnIndex: false

__namedParameters: QuickBaseRequest & {
fidsToSave?: (number | keyof RecordData)[];
mergeFieldId?: number;
} = {}

`Optional` fidsToConvert: (string | number)[]

`Static` IsQBRecord

`Static` NewRecord

`Optional` data: Partial<T>

`Static` fromJSON