Class Client

Airtable Client

Hierarchy

Client

Index

Constructors

constructor

Methods

Constructors

constructor

new Client(__namedParameters: object): Client

- Defined in lib/Client.ts:18
Parameters
- __namedParameters: object
Returns Client

Methods

base

base(baseId: string): Base

- Defined in lib/Client.ts:34
Create a new Base reference

Parameters
- baseId: string
Returns Base

create

create(baseId: string, tableName: string, fields: RecordFields): Promise<Record>

- Defined in lib/Client.ts:72
Create new Record

Parameters
- baseId: string
- tableName: string
- fields: RecordFields
Returns Promise<Record>

delete

delete(baseId: string, tableName: string, recordId: string): Promise<undefined>

- Defined in lib/Client.ts:103
Delete a Record

Parameters
- baseId: string
- tableName: string
- recordId: string
Returns Promise<undefined>

get

get(baseId: string, tableName: string, recordId: string): Promise<Record | null>

- Defined in lib/Client.ts:52
Fetch a Record

Parameters
- baseId: string
- tableName: string
- recordId: string
Returns Promise<Record | null>

query

query(baseId: string, tableName: string, params: QueryParams): Query

- Defined in lib/Client.ts:41
Create a query

Parameters
- baseId: string
- tableName: string
- params: QueryParams
Returns Query

request

request<T>(__namedParameters: object): Promise<T>

- Defined in lib/Client.ts:117
Make an authorized request

Type parameters
- T
Parameters
- __namedParameters: object
Returns Promise<T>

update

update(baseId: string, tableName: string, record: Record, __namedParameters?: object): Promise<Record>

- Defined in lib/Client.ts:87
Update existing Record

Parameters
- baseId: string
- tableName: string
- record: Record
- Default value __namedParameters: object = {}
Returns Promise<Record>

Generated using TypeDoc