Usage

As you might know, Bunicorn provides typed client for server which also does error handling.

Installation

Firstly, you have to install the @bunicorn/client package.

bun

$ bun add @bunicorn/client

npm

$ npm install @bunicorn/client

pnpm

$ pnpm install @bunicorn/client

yarn

$ yarn add @bunicorn/client

Create a client

import bunicornClient from "@bunicorn/client";
import { type AppType } from "./server.ts"; // This is exported from server, in next section, it shows how to do it.

// Simplest client
export const client = bunicornClient<AppType>({
  serverPath: "http://localhost:8000"
});

// Use it
// Url is typed
const createdTodo = await client.post("/api/todos", {
  // This is also typed.
  input: { title: "Hello world!" }
});

if (!createdTodo.success) {
  // We need to check if we have an error.
}

If you want to handle errors on a force way, you can do 'assert' to the response.

const createdTodo = await client
  .post("/api/todos", {
    // This is also typed.
    input: { title: "Hello world!" }
  })
  .assert();
const title = createdTodo.data.title; // This is typed as success result.

For error handling, you can check error handling section.

Use the data

if (createdTodo.success) {
  // Here data is typed as the output of validation schema of output.
  // If no validation schema is provided, it will be typed as return type of route.
  const title = createdTodo.data.title;
}

Sharing server types

// Add routes and create a new app with them.
const app = baseApp.addRoutes(todoRoutes).addRoute(helloRoute);

// Export the type of app to use on client.
export type AppType = typeof app;