Marcello Curto

Easy Airtable API

This is intended as a more accessible and user-friendly alternative to the official Airtable Node.js library.

My focus has been on delivering an enhanced experience by utilizing types and simplifying the process of retrieving and modifying records through some helpful functions.

Currently, this project is in its early stages and requires significant development. Nonetheless, most methods to retrieve and update records have already been implemented.

Install

npm install easy-airtable-api

bun add easy-airtable-api

How to Use

Get a Single Record

import { getRecord } from "easy-airtable-api";

type Fields = {
  Name?: string;
  Notes?: string;
  Status?: string;
};

const record = await getRecord<Fields>({
  apiKey: "apiKey",
  baseId: "baseId",
  tableId: "tableId",
  recordId: "recordId",
});

Get Multiple Records

import { getRecords } from "easy-airtable-api";

type Fields = {
  Name?: string;
  Notes?: string;
  Status?: string;
};

const records = await getRecords<Fields>({
  apiKey: "apiKey",
  baseId: "baseId",
  tableId: "tableId",
  options: {
    maxRecords: 500,
  },
});

Changelog

0.0.10

  1. Fixed deleteRecords implementation errors.

0.0.9

  1. Implemented the deleteRecords method.

0.0.8

  1. Implemented the updateRecords method.
  2. Implemented the updateRecordsUpsert method.
  3. Added a delay when executing many requests in succession.
  4. Fixed the updateRecord and updateRecords methods to return correct field types.

0.0.7

  1. Added all available options for updateRecords.
  2. Modified the getRecords function to automatically retrieve all records.

0.0.6

  1. Added all available options for updateRecord.
  2. Corrected the path to index.d.ts.

0.0.5

  1. Discontinued CJS build, supporting only ESM for now.

0.0.4

  1. Exported all available methods.
  2. Restructured the lib folder to eliminate duplicate types.

0.0.3

  1. Supported both ESM & CJS builds.
  2. Enhanced server error handling.
  3. Introduced generic field types.

0.0.2

  1. Developed basic request functions to retrieve or update records.
  2. Added type definitions for requests and fields.
  3. Conducted basic tests to verify the core functionality of the library.

0.0.1

  1. Initial project setup with no real functionality implemented.

Links

GitHub
Issues
npm