@stephansama/typed-nocodb-api

@stephansama / typed-nocodb-api

standard schema compatible nocodb api

Table of contents

Open Table of contents

• Installation
• Usage

Installation

pnpm install @stephansama/typed-nocodb-api

Usage

import * as z from "zod";

import { createApi } from "@stephansama/typed-nocodb-api";

const api = createApi({
  baseId: process.env.NOCODB_BASE!,
  origin: "https://nocodb.com",
  schema: z.object({
    column1: z.string().trim(),
    column2: z.enum(["optionOne", "optionTwo", "optionThree"]),
    column3: z.number(),
    column4: z.boolean(),
  }),
  tableId: process.env.NOCODB_TABLE!,
  token: process.env.NOCODB_TOKEN,
});

export async function callApi() {
  const response = await api.fetch({
    action: "LIST",
  });

  return response;
}

Type Aliases

Type Alias	Description
ACTION	‐

Variables

Variable	Description
ACTIONS	‐

Functions

Function	Description
createApi	‐