@ti-platform/client-airtable v0.2.5

@ti-platform/client-airtable

This client provides a client to interact with Airtable.

Ideally, this package should not even need to exist since Airtable have provided their own client. However, they refuse to actually implement all features of their REST APIs with their client. This package tries to fix that.

Contents

• Example Usage
• API Docs
  • Enumerations
    • CellFormat
    • Direction
    • Timezone
    • UpdateType
    • UserLocale
  • Classes
    • AirtableClient
  • Interfaces
    • CreateRecordsRequest\
    • CreateRecordsResponse\
    • DeleteRecordsRequest
    • DeleteRecordsResponse
    • GetRecordRequest
    • IndividualRecord\
    • ListRecordsRequest\
    • ListRecordsResponse\
    • UpdateRecordsRequestNonUpsert\
    • UpdateRecordsRequestUpsert\
    • UpdateRecordsResponseNonUpsert\
    • UpdateRecordsResponseUpsert\
  • Type Aliases
    • RecordFields
    • UnionToTuple\<U, R>
  • Variables
    • MAXIMUM_RECORDS_PER_BATCH
    • REQUESTS_PER_SECOND_PER_ACCESS_TOKEN
    • REQUESTS_PER_SECOND_PER_BASE

Example Usage

import {AirtableClient } from "@ti-platform/client-airtable";

const client = new AirtableClient('my-api-token');

const records = await client.listRecords<{ Field1: boolean; Field2: string }>({
    baseId: 'app12345',
    tableId: 'tbl12345',
    fields: ['Field1', 'Field2'],
    maxRecords: 10,
});

API Docs

Enumerations

CellFormat

The format that should be used for cell values.

The Timezone and UserLocale parameters are required when using string as the cell format.

Note: You should not rely on the format of these strings, as it is subject to change.

The default is json.

Enumeration Members

Direction

The direction to sort results.

The default is asc.

Enumeration Members

Timezone

The time zone that should be used to format dates when using string as the CellFormat.

Enumeration Members

UpdateType

When updating records, the type specifies how data are updated.

Enumeration Members

UserLocale

The user locale that should be used to format dates when using string as the CellFormat.

Enumeration Members

Classes

AirtableClient

Client for interacting with Airtable.

This client will handle and throttle requests to ensure that users will not overstep the rate limits set by Airtable.

Constructors

new AirtableClient()

new AirtableClient(apiToken, requestOptions): AirtableClient

Create a new instance.

Parameters

Returns

AirtableClient

Defined in

packages/client-airtable/src/client.ts:53

Methods

createRecords()

createRecords<RequestFields, ResponseFields>(request): Promise<{records: {createdTime: Date;fields: ResponseFields;id: string; }[]; }>

Create new records.

Type Parameters

Parameters

Returns

Promise<{records: {createdTime: Date;fields: ResponseFields;id: string; }[]; }>

Refer to CreateRecordsResponse.

Defined in

packages/client-airtable/src/client.ts:84

deleteRecords()

deleteRecords(request): Promise<{records: {deleted: boolean;id: string; }[]; }>

Delete records.

Parameters

Returns

Promise<{records: {deleted: boolean;id: string; }[]; }>

Refer to DeleteRecordsResponse.

Defined in

packages/client-airtable/src/client.ts:96

getRecord()

getRecord<Fields>(request): Promise<IndividualRecord<Fields>>

Get a record.

Type Parameters

Parameters

Returns

Promise<IndividualRecord<Fields>>

Refer to IndividualRecord.

Defined in

packages/client-airtable/src/client.ts:108

listRecords()

listRecords<Fields>(request): Promise<{offset: string;records: IndividualRecord<Fields> & {commentCount: number; }[]; }>

Search for records based on given criterias.

Type Parameters

Parameters