Zod

zod is a TypeScript-first schema declaration and validation library. It is used to validate the request body, query, and params.

Install

You can install the @nixle/zod package using npm, pnpm, yarn, or bun:

npm

npm i @nixle/zod

pnpm

pnpm add @nixle/zod

yarn

yarn add @nixle/zod

bun

bun i @nixle/zod

Setup

To use zod validation, you need to add the zodPlugin to the plugins array when creating the app.

import { createApp } from 'nixle';
import { zodPlugin } from '@nixle/zod';

const app = createApp({
  plugins: [zodPlugin],
});

Usage

To use zod validation, you can use the zodObject parameter.

Routers

In the router, you can use the zodObject parameter to validate the request information.

import { createRouter } from 'nixle';

const usersRouter = createRouter('/users', ({ route, zodObject }) => [
  route.post('/:id', {
    paramsValidation: zodObject((z) => ({
      id: z.string(),
    })).validate,
    queryValidation: zodObject((z) => ({
      page: z.string(),
    })).validate,
    bodyValidation: zodObject((z) => ({
      name: z.string(),
    })).validate,
    handler: ({ params, query, body }) => 'Hello World!',
  }),
]);

Services

In the service, you can use the zodObject parameter to validate any object.

import { createService } from 'nixle';

const usersService = createService('users', ({ zodObject }) => {
  const updateUser = async (user) => {
    const { validate } = zodObject((z) => ({
      id: z.string(),
      name: z.string(),
    }));

    const validatedUser = await validate(user);

    // Save the user to the database

    return validatedUser;
  };

  return {
    updateUser,
  };
});

TypeScript

To get the type of the validated object, you can use the $infer property.

import { createRouter } from 'nixle';
import { zodObject } from '@nixle/zod';

const user = zodObject((z) => ({
  id: z.string(),
  name: z.string(),
}));

type User = typeof user.$infer;

// { id: string; name: string; }