Endpoints

Small library for creating endpoints and executing fetch requests to them using Zod type safety.

Usage

1import { Endpoint } from "@patrick115/endpoints"
2import z from "zod"
3
4//schema for the response
5const schema = z.object({
6    status: z.literal(true),
7    data: z.object({
8        id: z.number(),
9        name: z.string(),
10    })
11})
12
13//creating endpoint
14const endpoint = new Endpoint("/api/path/to/endpoint", "POST", {
15    username: "patrick115",
16    password: "example123",
17}, schema)
18
19//fetch endpoint and return Promise, that can be fullfilled with our data, or rejected with error
20endpoint.fetch()
21
22/*
23fetch endpoint and return object
24{
25    status: true,
26    data: {
27        id: 1,
28        name: "patrick115"
29    }
30}
31or if api sends error, which match error schema, it will return
32{
33    status: true,
34    errorSchema: true,
35    data: {
36        //error from api
37        status: false,
38        error: "Invalid password"
39    }
40}
41or if fetch fails
42{
43    status: false,
44    error: "Text error" // or error can be object
45}
46*/
47endpoint.fetchSafe()