Diapio

Diapio is a simple and easy-to-use library to help you get around Diapi's api's.

Installation

bun install diapio

Usage

Create a type and pass it to the Diapi constructor.

Get your API key from the Diapi website and the base url of the instance you are using.

  import {Diapi} from 'diapio';

  type Api = {
    avatar: string;
    birthday: string;
    email: string;
    firstName: string;
    id: number;
    index: string;
    lastName: string;
    sex: string;
    subscriptionTier: string;
  }

  const diapi = new Diapi<Api>({
    apiKey: "diapi-d9cd4bfb-da10-4595-8106-46f89f4e1e39-8oFZpMQe5CzJLmVHDsdw19",
    baseUrl: "http://localhost:3002/api/v1",
  })

  // ex: const diapi = new Diapi<Api>(
  // "diapi-d9cd4bfb-da10-4595-8106-46f89f4e1e39-8oFZpMQe5CzJLmVHDsdw19",
  // "http://localhost:3002/api/v1 || Copy it from the Diapio website.",
  )

  const {content, message} = diapi.getAll()

What can it do?

• Get all data from your book:

const { content, message } = diapi.getAll();

• Query data from your book:

const { content, message } = diapi.queryIt({
  key: "name", // Type safety based on the type you passed to the constructor.
  value: "John big boy",
});

• Get one by id

const { content, message } = diapi.getOne({
  id: urId,
});

• Update one by id:

const { content, message } = await diapi.updateOne({
  id: "",
  data: {
    key: "name", // Type safety based on the type you passed to constructor.
    value: "new name",
  },
});

• Add a new entry:

const { content, message } = await diapi.addNew({
  data: [{}] || {}, // Type safety based on the type you passed to constructor.
  // You can add an array of objects and it will add them all spreaded into your current data or only one object.
});

• Add and replace

  Whatever you push with this method will replace the current data in your book.

const { content, message } = await diapi.addAndReplace({
  data: [
    {
      avatar: "something",
      birthday: "something",
      email: "something",
      firstName: "something",
      id: 1,
      index: "something",
      lastName: "something",
      sex: "something",
      subscriptionTier: "something",
    },
  ], // This should match the type you passed to the constructor.
});

• Delete by key-value:

Deleting by id is simplified so you can delete by any key you want. This will delete all the occurences of the key-value pair you are looking for.

const { content, message } = await diapi.removeOne({
  key: "name", // Type safety based on the type you passed to the constructor.
  value: "John big boy",
});