Module airtable

Manage Airtable data.

Example:

await select({ app: '', key: '' }, 'Blogposts') => Load blogposts

Index

Interfaces

Type aliases

Functions

Type aliases

AirtableData

AirtableData: undefined | string | AirtableAttachment[]

Unpacked

Unpacked<T>: T & { _id: string }

Type parameters

T: FieldSet

Functions

app

app(app: string): string

- Defined in src/airtable.ts:14
Parameters
- app: string
Returns string

byIds

byIds(ids: string[]): { filterByFormula: string }

- Defined in src/airtable.ts:189
Parameters
- ids: string[]
Returns { filterByFormula: string }
- filterByFormula: string

create

create<T>(environment: Environment, tableName: string, fields: T): Promise<Unpacked<T>>

- Defined in src/airtable.ts:29
Type parameters
- T: FieldSet
Parameters
- environment: Environment
- tableName: string
- fields: T
Returns Promise<Unpacked<T>>

find

find<T>(environment: Environment, tableName: string, id: string): Promise<Unpacked<T>>

- Defined in src/airtable.ts:46
Type parameters
- T: FieldSet
Parameters
- environment: Environment
- tableName: string
- id: string
Returns Promise<Unpacked<T>>

first

first<T>(environment: Environment, tableName: string, filter?: SelectOptions): Promise<Unpacked<T> | null>

- Defined in src/airtable.ts:61
Type parameters
- T: FieldSet
Parameters
- environment: Environment
- tableName: string
- filter: SelectOptions = {}
Returns Promise<Unpacked<T> | null>

headers

headers(key: any): { Accept: string; Authorization: string; Content-Type: string }

- Defined in src/airtable.ts:18
Parameters
- key: any
Returns { Accept: string; Authorization: string; Content-Type: string }
- Accept: string
- Authorization: string
- Content-Type: string

pack

pack<T>(fields: Unpacked<T>): Packed<FieldSet>

- Defined in src/airtable.ts:165
Type parameters
- T: FieldSet & { _id: string }
Parameters
- fields: Unpacked<T>
Returns Packed<FieldSet>

remove

remove<T>(environment: Environment, tableName: string, id: string): Promise<Unpacked<T>>

- Defined in src/airtable.ts:147
Type parameters
- T: FieldSet
Parameters
- environment: Environment
- tableName: string
- id: string
Returns Promise<Unpacked<T>>

select

select<T>(environment: Environment, tableName: string, filter?: SelectOptions): Promise<Unpacked<T>[]>

- Defined in src/airtable.ts:71
Type parameters
- T: FieldSet
Parameters
- environment: Environment
- tableName: string
- filter: SelectOptions = {}
Returns Promise<Unpacked<T>[]>

selectAll

selectAll<T>(environment: Environment, tableName: string, filter?: SelectOptions, prepend?: Packed<T>[]): Promise<Unpacked<T>[]>

- Defined in src/airtable.ts:94
Type parameters
- T: FieldSet
Parameters
- environment: Environment
- tableName: string
- filter: SelectOptions = {}
- prepend: Packed<T>[] = []
Returns Promise<Unpacked<T>[]>

unpack

unpack<T>(__namedParameters: Packed<T>): Unpacked<T>

- Defined in src/airtable.ts:175
Type parameters
- T: FieldSet
Parameters
- __namedParameters: Packed<T>
Returns Unpacked<T>

update

update<T>(environment: Environment, tableName: string, id: string, fields: T): Promise<Unpacked<T>>

- Defined in src/airtable.ts:129
Type parameters
- T: FieldSet
Parameters
- environment: Environment
- tableName: string
- id: string
- fields: T
Returns Promise<Unpacked<T>>

where

where(field: string, value: any): { filterByFormula: string }

- Defined in src/airtable.ts:195
Parameters
- field: string
- value: any
Returns { filterByFormula: string }
- filterByFormula: string

Generated using TypeDoc