Class QBTable<RecordData, CustomGetSet>

Type Parameters

  • RecordData extends QBRecordData = QBRecordData

  • CustomGetSet extends Object = Record<any, any>

Hierarchy

  • QBTable

Constructors

constructor

Properties

CLASS_NAME _appId _data _fids _fields _qb _records _reports _tableId id CLASS_NAME VERSION defaults

Methods

_runQueryAll clear delete deleteRecord deleteRecords get getAppId getFid getFids getField getFields getNRecords getRecord getRecords getReport getReports getTableId getTempToken loadField loadFields loadReport loadReports loadSchema loadTable runQuery runReport saveFields saveRecords saveTable set setAppId setFid setFids setTableId upsertField upsertFields upsertRecord upsertRecords IsQBTable NewRecord ToCSV

Constructors

constructor

  • Type Parameters

    • RecordData extends QBRecordData = QBRecordData

    • CustomGetSet extends Object = Record<any, any>

    Parameters

    Returns QBTable<RecordData, CustomGetSet>

Properties

Readonly CLASS_NAME

CLASS_NAME: "QBTable" = 'QBTable'

Private _appId

_appId: string = ''

Private _data

_data: Record<any, any> = {}

Private _fids

_fids: Record<any, number> = {}

Private _fields

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

Private _qb

_qb: QuickBase

Private _records

_records: QBRecord<RecordData>[] = []

Private _reports

_reports: QBReport<RecordData, Record<any, any>>[] = []

Private _tableId

_tableId: string = ''

id

id: string

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

Static Readonly CLASS_NAME

CLASS_NAME: "QBTable" = 'QBTable'

Static Readonly VERSION

VERSION: string = VERSION

The loaded library version

Static defaults

defaults: QBTableOptions<{}> = ...

The default settings of a QuickBase instance

Methods

Private _runQueryAll

  • _runQueryAll(query: QuickBaseRequestRunQuery): Promise<QuickBaseResponseRunQuery>

  • Parameters

    • query: QuickBaseRequestRunQuery

    Returns Promise<QuickBaseResponseRunQuery>

clear

delete

  • Parameters

    • __namedParameters: QuickBaseRequest = {}

    Returns Promise<QuickBaseResponseDeleteTable>

deleteRecord

  • Parameters

    • __namedParameters: {
          record: QBRecord<RecordData>;
      } & QuickBaseRequest

    Returns Promise<QuickBaseResponseDeleteRecords>

deleteRecords

  • Parameters

    • __namedParameters: {
          individually?: boolean;
          records?: QBRecord<RecordData>[];
      } & QuickBaseRequest = {}

    Returns Promise<QuickBaseResponseDeleteRecords>

get

  • Parameters

    • attribute: "id" | "appId" | "tableId"

    Returns string

  • Type Parameters

    • P extends keyof QuickBaseResponseGetTable

    Parameters

    • attribute: P

    Returns QuickBaseResponseGetTable[P]

  • Type Parameters

    • P extends string | number | symbol

    Parameters

    • attribute: P

    Returns CustomGetSet[P]

  • Type Parameters

    • P extends string

    Parameters

    • attribute: P

    Returns P extends keyof QuickBaseResponseGetTable ? QuickBaseResponseGetTable[P] : P extends keyof CustomGetSet ? CustomGetSet[P] : any

getAppId

getFid

  • Type Parameters

    • T extends string | number | symbol

    Parameters

    • field: T

    Returns number

  • Parameters

    • field: string | number
    • Optional byId: false

    Returns number

  • Parameters

    • field: number
    • byId: true

    Returns string

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>>[]

getNRecords

getRecord

  • Type Parameters

    • T extends string | number | symbol

    Parameters

    • value: RecordData[T]
    • fieldName: T
    • returnIndex: true

    Returns number

  • Type Parameters

    • T extends string | number | symbol

    Parameters

    • value: RecordData[T]
    • fieldName: T
    • Optional returnIndex: false

    Returns undefined | QBRecord<RecordData>

  • Parameters

    • value: any
    • fieldName: string
    • returnIndex: true

    Returns number

  • Parameters

    • value: any
    • Optional fieldName: string
    • Optional returnIndex: false

    Returns undefined | QBRecord<RecordData>

getRecords

  • Returns QBRecord<RecordData>[]

getReport

  • Parameters

    • id: string

    Returns undefined | QBReport<RecordData, Record<any, any>>

getReports

  • Returns QBReport<RecordData, Record<any, any>>[]

getTableId

getTempToken

  • Parameters

    • __namedParameters: QuickBaseRequest = {}

    Returns Promise<void>

loadField

  • Parameters

    • __namedParameters: QuickBaseRequest & {
          field: number | QBField<Record<any, any>>;
      }

    Returns Promise<QBField<Record<any, any>>>

loadFields

  • Parameters

    • __namedParameters: QuickBaseRequest = {}

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

loadReport

  • Parameters

    • __namedParameters: QuickBaseRequest & {
          report: string | QBReport<RecordData, Record<any, any>>;
      }

    Returns Promise<QBReport<RecordData, Record<any, any>>>

loadReports

  • Parameters

    • __namedParameters: QuickBaseRequest = {}

    Returns Promise<QBReport<RecordData, Record<any, any>>[]>

loadSchema

  • Parameters

    • __namedParameters: QuickBaseRequest = {}

    Returns Promise<QuickBaseResponseGetTable & {
        fields: QBField<Record<any, any>>[];
        reports: QBReport<RecordData, Record<any, any>>[];
    }>

loadTable

  • Parameters

    • __namedParameters: QuickBaseRequest = {}

    Returns Promise<QuickBaseResponseGetTable>

runQuery

runReport

  • Parameters

    • __namedParameters: Pick<QuickBaseRequestRunReport, "top" | "skip"> & QuickBaseRequest & {
          report: string | QBReport<RecordData, Record<any, any>>;
      }

    Returns Promise<QBReportRunResponse<RecordData>>

saveFields

  • Parameters

    • __namedParameters: {
          attributesToSave?: QBFieldAttributeSavable[];
      } & QuickBaseRequest = {}

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

saveRecords

  • Parameters

    • __namedParameters: {
          fidsToSave?: (number | keyof RecordData)[];
          individually?: boolean;
          mergeFieldId?: number;
          recordsToSave?: QBRecord<RecordData>[];
      } & QuickBaseRequest = {}

    Returns Promise<QBRecord<RecordData>[]>

saveTable

  • Parameters

    • __namedParameters: {
          attributesToSave?: string[];
      } & QuickBaseRequest = {}

    Returns Promise<QuickBaseResponseGetTable>

set

  • Parameters

    • attribute: "id" | "tableId" | "appid"
    • value: string

    Returns QBTable<RecordData, CustomGetSet>

  • Type Parameters

    • P extends keyof QuickBaseResponseGetTable

    Parameters

    • attribute: P
    • value: QuickBaseResponseGetTable[P]

    Returns QBTable<RecordData, CustomGetSet>

  • Type Parameters

    • P extends string | number | symbol

    Parameters

    • attribute: P
    • value: CustomGetSet[P]

    Returns QBTable<RecordData, CustomGetSet>

  • Type Parameters

    • P extends string

    Parameters

    • attribute: P
    • value: P extends keyof QuickBaseResponseGetTable ? QuickBaseResponseGetTable[P] : P extends keyof CustomGetSet ? CustomGetSet[P] : any

    Returns QBTable<RecordData, CustomGetSet>

setAppId

  • Parameters

    • appId: string

    Returns QBTable<RecordData, CustomGetSet>

setFid

  • Type Parameters

    • T extends string | number | symbol

    Parameters

    • name: T
    • id: number

    Returns QBTable<RecordData, CustomGetSet>

  • Parameters

    • name: string | number
    • id: number

    Returns QBTable<RecordData, CustomGetSet>

setFids

  • Parameters

    • fields: Record<any, number>

    Returns QBTable<RecordData, CustomGetSet>

setTableId

  • Parameters

    • tableId: string

    Returns QBTable<RecordData, CustomGetSet>

upsertField

  • Parameters

    • options: QBField<Record<any, any>> | Partial<undefined | Partial<QuickBaseResponseGetField> & Record<any, any>>
    • autoSave: boolean = false

    Returns Promise<QBField<Record<any, any>>>

upsertFields

  • Parameters

    • fields: (QBField<Record<any, any>> | Partial<QBFieldJSON>)[]
    • autoSave: boolean = false

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

upsertRecord

  • Parameters

    • Optional options: QBRecord<RecordData> | Partial<RecordData>
    • autoSave: boolean = false

    Returns Promise<QBRecord<RecordData>>

upsertRecords

  • Parameters

    • records: (QBRecord<RecordData> | Partial<RecordData>)[]
    • autoSave: boolean = false

    Returns Promise<QBRecord<RecordData>[]>

Static IsQBTable

  • Test if a variable is a qb-record object

    Type Parameters

    • T extends QBRecordData = QBRecordData

    • K extends Object = Record<any, any>

    Parameters

    • obj: any

      A variable you'd like to test

    Returns obj is QBTable<T, K>

Static NewRecord

  • Type Parameters

    • T extends QBRecordData

    • K extends Object

    Parameters

    • table: QBTable<T, K>
    • Optional data: Partial<T>

    Returns QBRecord<T>

Static ToCSV

  • Type Parameters

    • T extends QBRecordData

    • K extends Object

    Parameters

    • table: QBTable<T, K>
    • columns: (keyof T)[]
    • Optional data: QBRecord<T>[]

    Returns string

Settings

Member Visibility

Theme

Generated using TypeDoc