Class DataFunctionService

Defines service that access AirTable's data

Export

DataFunctionService

Hierarchy (View Summary)

Constructors

constructor

Properties

baseId token

Methods

delete deleteData get getData save saveData update updateData

Constructors

constructor

  • new DataFunctionService(token: string, baseId: string): DataFunctionService

  • Creates an instance of DataFunctionService. Stores the provided token and base ID for subsequent API calls.

    Parameters

    • token: string

      The Airtable Personal Access Token. This will be used for all operations performed by this instance.

    • baseId: string

      The ID of the Airtable base this instance will interact with.

    Returns DataFunctionService

Properties

baseId

baseId: string

The ID of the Airtable base this instance will interact with.

token

token: string

The Airtable Personal Access Token. This will be used for all operations performed by this instance.

Methods

Protecteddelete

  • delete<T extends BaseModel>(
        token: string,
        baseId: string,
        tableName: string,
        model: T,
    ): Promise<AirtableDeletion>
  • Protected

    Deletes a single record from the specified Airtable table using its record ID.

    Type Parameters

    • T extends BaseModel

      The type extending BaseModel representing the record to delete. Must include the id property.

    Parameters

    • token: string

      The Airtable Personal Access Token for authentication.

    • baseId: string

      The ID of the target Airtable base.

    • tableName: string

      The name or ID of the target table.

    • model: T

      The object representing the record to delete. It must include the id property.

    Returns Promise<AirtableDeletion>

    A promise that resolves to the Airtable API response confirming the deletion.

    Memberof

    BaseService

deleteData

  • deleteData<T extends BaseModel>(
        tableName: string,
        model: T,
    ): Promise<AirtableDeletion>

  • Deletes a record from the specified table within the configured base. Uses the token and baseId provided during instantiation.

    Type Parameters

    • T extends BaseModel

      The type extending BaseModel representing the record to delete (must include id).

    Parameters

    • tableName: string

      The name or ID of the target table.

    • model: T

      An object containing the id of the record to delete.

    Returns Promise<AirtableDeletion>

    A promise resolving to the Airtable API response.

    Memberof

    DataFunctionService

Protectedget

  • get<T extends BaseModel>(
        token: string,
        baseId: string,
        tableName: string,
        options?: SelectOptions,
    ): Promise<T[]>
  • Protected

    Retrieves multiple records from a specified Airtable table, optionally applying query parameters. Maps the Airtable record structure to the provided generic type T.

    Type Parameters

    • T extends BaseModel

      The type extending BaseModel that represents the structure of the records.

    Parameters

    • token: string

      The Airtable Personal Access Token for authentication.

    • baseId: string

      The ID of the target Airtable base.

    • tableName: string

      The name or ID of the target table within the base.

    • Optionaloptions: SelectOptions

      Optional parameters for filtering, sorting, pagination, etc. See Airtable API documentation for details.

    Returns Promise<T[]>

    A promise that resolves to an array of records matching the query, cast to type T.

    Memberof

    BaseService

getData

  • getData<T extends BaseModel>(
        tableName: string,
        options?: SelectOptions,
    ): Promise<T[]>

  • Retrieves records from a specified table within the configured base. Uses the token and baseId provided during instantiation.

    Type Parameters

    • T extends BaseModel

      The type extending BaseModel representing the record structure.

    Parameters

    • tableName: string

      The name or ID of the target table.

    • Optionaloptions: SelectOptions

      Optional query parameters.

    Returns Promise<T[]>

    A promise resolving to an array of records.

    Memberof

    DataFunctionService

Protectedsave

  • save<T extends BaseModel>(
        token: string,
        baseId: string,
        tableName: string,
        model: T,
    ): Promise<AirtableResult>
  • Protected

    Creates a single new record in the specified Airtable table.

    Type Parameters

    • T extends BaseModel

      The type extending BaseModel representing the record to create.

    Parameters

    • token: string

      The Airtable Personal Access Token for authentication.

    • baseId: string

      The ID of the target Airtable base.

    • tableName: string

      The name or ID of the target table.

    • model: T

      The data object representing the record to be created. The id property, if present, will be ignored by Airtable.

    Returns Promise<AirtableResult>

    A promise that resolves to the Airtable API response for the created record.

    Memberof

    BaseService

saveData

  • saveData<T extends BaseModel>(
        tableName: string,
        model: T,
    ): Promise<AirtableResult>

  • Creates a new record in the specified table within the configured base. Uses the token and baseId provided during instantiation.

    Type Parameters

    • T extends BaseModel

      The type extending BaseModel representing the record to create.

    Parameters

    • tableName: string

      The name or ID of the target table.

    • model: T

      The data for the new record.

    Returns Promise<AirtableResult>

    A promise resolving to the Airtable API response.

    Memberof

    DataFunctionService

Protectedupdate

  • update<T extends BaseModel>(
        token: string,
        baseId: string,
        tableName: string,
        model: T,
    ): Promise<AirtableUpdateResult>
  • Protected

    Updates an existing record in the specified Airtable table using its record ID.

    Type Parameters

    • T extends BaseModel

      The type extending BaseModel representing the record to update. Must include the id property.

    Parameters

    • token: string

      The Airtable Personal Access Token for authentication.

    • baseId: string

      The ID of the target Airtable base.

    • tableName: string

      The name or ID of the target table.

    • model: T

      The data object containing the fields to update. It must include the id property of the record to update.

    Returns Promise<AirtableUpdateResult>

    A promise that resolves to the Airtable API response for the updated record.

    Memberof

    BaseService

updateData

  • updateData<T extends BaseModel>(
        tableName: string,
        model: T,
    ): Promise<AirtableUpdateResult>

  • Updates an existing record in the specified table within the configured base. Uses the token and baseId provided during instantiation.

    Type Parameters

    • T extends BaseModel

      The type extending BaseModel representing the record to update (must include id).

    Parameters

    • tableName: string

      The name or ID of the target table.

    • model: T

      The data containing updates, including the record id.

    Returns Promise<AirtableUpdateResult>

    A promise resolving to the Airtable API response.

    Memberof

    DataFunctionService

Settings

Member Visibility

On This Page

Constructors
Properties
Methods