Class QBField<CustomGetSet>

Type Parameters

CustomGetSet extends Object = Record<any, any>

Hierarchy

QBField

Index

Constructors

constructor

new QBField<CustomGetSet>(options?: Partial<QBFieldOptions>): QBField<CustomGetSet>
Type Parameters
- CustomGetSet extends Object = Record<any, any>
Parameters
- Optional options: Partial<QBFieldOptions>
Returns QBField<CustomGetSet>
- Defined in src/qb-field.ts:115

Properties

`Readonly` CLASS_NAME

CLASS_NAME: "QBField" = 'QBField'

`Private` _data

_data: Record<any, any> = {}

`Private` _fid

_fid: number = -1

`Private` _qb

_qb: QuickBase

`Private` _tableId

_tableId: string = ''

`Private` _usage

_usage: {} = ...

Type declaration

id

id: string

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

`Static` `Readonly` CLASS_NAME

CLASS_NAME: "QBField" = 'QBField'

`Static` `Readonly` VERSION

VERSION: string = VERSION

`Static` defaults

defaults: QBFieldOptions = ...

The default settings of a QuickBase instance

Methods

clear

clear(): QBField<CustomGetSet>
This method clears the QBField instance of any trace of the existing field, but preserves defined connection settings.

Returns QBField<CustomGetSet>
- Defined in src/qb-field.ts:143

delete

delete(__namedParameters?: QuickBaseRequest): Promise<QuickBaseResponseDeleteFields>
This method deletes the field from QuickBase, then calls .clear().
Parameters
- __namedParameters: QuickBaseRequest = {}
Returns Promise<QuickBaseResponseDeleteFields>
- Defined in src/qb-field.ts:154

fromJSON

fromJSON(json: string | QBFieldJSON): QBField<CustomGetSet>
Rebuild the QBField instance from serialized JSON
Parameters
- json: string | QBFieldJSON
 
 QBField serialized JSON
Returns QBField<CustomGetSet>
- Defined in src/qb-field.ts:436

get

get(attribute: "tableId"): string
Get an attribute value
Parameters
- attribute: "tableId"
  
  Quick Base Field attribute name
Returns string
- Defined in src/qb-field.ts:201
get(attribute: "fid"): number
Parameters
- attribute: "fid"
Returns number
- Defined in src/qb-field.ts:202
get(attribute: "id"): number
Parameters
- attribute: "id"
Returns number
- Defined in src/qb-field.ts:203
get(attribute: "type"): string
Parameters
- attribute: "type"
Returns string
- Defined in src/qb-field.ts:204
get(attribute: "addToForms"): boolean
Parameters
- attribute: "addToForms"
Returns boolean
- Defined in src/qb-field.ts:205
get(attribute: "usage"): {}
Parameters
- attribute: "usage"
Returns {}
- Defined in src/qb-field.ts:206
get(prop: P): QuickBaseResponseGetField[P]
Type Parameters
- P extends keyof QuickBaseResponseGetField
Parameters
- prop: P
Returns QuickBaseResponseGetField[P]
- Defined in src/qb-field.ts:207
get(prop: P): CustomGetSet[P]
Type Parameters
- P extends string | number | symbol
Parameters
- prop: P
Returns CustomGetSet[P]
- Defined in src/qb-field.ts:208
get(prop: P): P extends keyof QuickBaseResponseGetField ? QuickBaseResponseGetField[P] : P extends keyof CustomGetSet ? CustomGetSet[P] : any
Type Parameters
- P extends string
Parameters
- prop: P
Returns P extends keyof QuickBaseResponseGetField ? QuickBaseResponseGetField[P] : P extends keyof CustomGetSet ? CustomGetSet[P] : any
- Defined in src/qb-field.ts:209

getFid

getFid(): number
Get the set QBField Field ID

Returns number
- Defined in src/qb-field.ts:231

getTableId

getTableId(): string
Get the set QBField Table ID

Returns string
- Defined in src/qb-field.ts:238

getTempToken

getTempToken(__namedParameters?: QuickBaseRequest): Promise<void>
Parameters
- __namedParameters: QuickBaseRequest = {}
Returns Promise<void>
- Defined in src/qb-field.ts:242

getUsage

getUsage(): {}
Get the Quick Base Field usage

.loadUsage() must be called first

Returns {}
- Defined in src/qb-field.ts:254

load

load(__namedParameters?: QuickBaseRequest): Promise<QuickBaseResponseGetField>
Load the Quick Base Field attributes and permissions
Parameters
- __namedParameters: QuickBaseRequest = {}
Returns Promise<QuickBaseResponseGetField>
- Defined in src/qb-field.ts:261

loadUsage

loadUsage(__namedParameters?: QuickBaseRequest): Promise<{}>
Load the Quick Base Field usage
Parameters
- __namedParameters: QuickBaseRequest = {}
Returns Promise<{}>
- Defined in src/qb-field.ts:278

save

save(attributesToSave?: QuickBaseRequest & {
attributesToSave?: QBFieldAttributeSavable[];
}): Promise<QuickBaseResponseGetField>
If a field id is not defined, this will execute the createField option. After a successful createField, or if a field id was previously defined, this will execute an updateField.

If attributesToSave is defined, then only configured attributes in this array will be saved.

If this executes a createField, the newly assigned Field ID is automatically stored internally.

After a successful save, all new attributes are available for use.
Parameters
- attributesToSave: QuickBaseRequest & {
 attributesToSave?: QBFieldAttributeSavable[];
 } = {}
 
 Array of attributes to save
Returns Promise<QuickBaseResponseGetField>
- Defined in src/qb-field.ts:302

set

set(attribute: "tableId", value: string): QBField<CustomGetSet>
Sets the passed in value associated with the attribute argument.
Parameters
- attribute: "tableId"
 
 Quick Base Field attribute name
- value: string
 
 Attribute value
Returns QBField<CustomGetSet>
- Defined in src/qb-field.ts:376
set(attribute: "fid", value: number): QBField<CustomGetSet>
Parameters
- attribute: "fid"
- value: number
Returns QBField<CustomGetSet>
- Defined in src/qb-field.ts:377
set(attribute: "id", value: number): QBField<CustomGetSet>
Parameters
- attribute: "id"
- value: number
Returns QBField<CustomGetSet>
- Defined in src/qb-field.ts:378
set(attribute: "type", value: string): QBField<CustomGetSet>
Parameters
- attribute: "type"
- value: string
Returns QBField<CustomGetSet>
- Defined in src/qb-field.ts:379
set(attribute: "addToForms", value: boolean): QBField<CustomGetSet>
Parameters
- attribute: "addToForms"
- value: boolean
Returns QBField<CustomGetSet>
- Defined in src/qb-field.ts:380
set(attribute: "usage", value: {}): QBField<CustomGetSet>
Parameters
- attribute: "usage"
- value: {}
Returns QBField<CustomGetSet>
- Defined in src/qb-field.ts:381
set(prop: P, value: QuickBaseResponseGetField[P]): void
Type Parameters
- P extends keyof QuickBaseResponseGetField
Parameters
- prop: P
- value: QuickBaseResponseGetField[P]
Returns void
- Defined in src/qb-field.ts:382
set(prop: P, value: CustomGetSet[P]): void
Type Parameters
- P extends string | number | symbol
Parameters
- prop: P
- value: CustomGetSet[P]
Returns void
- Defined in src/qb-field.ts:383
set(prop: P, value: P extends keyof QuickBaseResponseGetField ? QuickBaseResponseGetField[P] : P extends keyof CustomGetSet ? CustomGetSet[P] : any): void
Type Parameters
- P extends string
Parameters
- prop: P
- value: P extends keyof QuickBaseResponseGetField ? QuickBaseResponseGetField[P] : P extends keyof CustomGetSet ? CustomGetSet[P] : any
Returns void
- Defined in src/qb-field.ts:384

setFid

setFid(fid: number): QBField<CustomGetSet>
Sets the defined Field ID

An alias for .set('id', 6) and .set('fid', 6).
Parameters
- fid: number
 
 Quick Base Field ID
Returns QBField<CustomGetSet>
- Defined in src/qb-field.ts:412

setTableId

setTableId(tableId: string): QBField<CustomGetSet>
Sets the defined Table ID

An alias for .set('tableId', 'xxxxxxxxx').
Parameters
- tableId: string
 
 Quick Base Field Table ID
Returns QBField<CustomGetSet>
- Defined in src/qb-field.ts:425

toJSON

toJSON(): QBFieldJSON
Serialize the QBField instance into JSON

Returns QBFieldJSON
- Defined in src/qb-field.ts:473

`Static` IsQBField

IsQBField(obj: any): obj is QBField<Record<any, any>>
Test if a variable is a qb-field object
Parameters
- obj: any
 
 A variable you'd like to test
Returns obj is QBField<Record<any, any>>
- Defined in src/qb-field.ts:507

`Static` NewField

NewField(options: Partial<QBFieldOptions>, attributes?: Partial<QuickBaseResponseGetField> & Record<any, any>): QBField<Record<any, any>>
Returns a new QBField instance built off of options, that inherits configuration data from the passed in attributes argument.
Parameters
- options: Partial<QBFieldOptions>
 
 QBField instance options
- Optional attributes: Partial<QuickBaseResponseGetField> & Record<any, any>
 
 Quick Base Field attribute data
Returns QBField<Record<any, any>>
- Defined in src/qb-field.ts:517

`Static` fromJSON

fromJSON(json: string | QBFieldJSON): QBField<Record<any, any>>
Create a new QBField instance from serialized JSON
Parameters
- json: string | QBFieldJSON
 
 QBField serialized JSON
Returns QBField<Record<any, any>>
- Defined in src/qb-field.ts:488

Class QBField<CustomGetSet>

Type Parameters

CustomGetSet extends Object = Record<any, any>

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

CustomGetSet extends Object = Record<any, any>

Parameters

Optional options: Partial<QBFieldOptions>

Returns QBField<CustomGetSet>

Properties

Readonly CLASS_NAME

Private _data

Private _fid

Private _qb

Private _tableId

Private _usage

Type declaration

id

Static Readonly CLASS_NAME

Static Readonly VERSION

Static defaults

Methods

clear

Returns QBField<CustomGetSet>

delete

Parameters

__namedParameters: QuickBaseRequest = {}

Returns Promise<QuickBaseResponseDeleteFields>

fromJSON

Parameters

json: string | QBFieldJSON

Returns QBField<CustomGetSet>

get

Parameters

attribute: "tableId"

Returns string

Parameters

attribute: "fid"

Returns number

Parameters

attribute: "id"

Returns number

Parameters

attribute: "type"

Returns string

Parameters

attribute: "addToForms"

Returns boolean

Parameters

attribute: "usage"

Returns {}

Type Parameters

P extends keyof QuickBaseResponseGetField

Parameters

prop: P

Returns QuickBaseResponseGetField[P]

Type Parameters

P extends string | number | symbol

Parameters

prop: P

Returns CustomGetSet[P]

Type Parameters

P extends string

Parameters

prop: P

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

getFid

Returns number

getTableId

Returns string

getTempToken

Parameters

__namedParameters: QuickBaseRequest = {}

Returns Promise<void>

`Optional` options: Partial<QBFieldOptions>

`Readonly` CLASS_NAME

`Private` _data

`Private` _fid

`Private` _qb

`Private` _tableId

`Private` _usage

`Static` `Readonly` CLASS_NAME

`Static` `Readonly` VERSION

`Static` defaults

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

`Static` IsQBField