Skip to main content

Installation

Prerequisites

  • Node.js 18.0 or higher
  • TypeScript 5.0 or higher (optional but recommended)

Install UltraFastBuilder

npm install @noony-serverless/type-builder zod

Peer Dependencies

UltraFastBuilder requires Zod for schema validation and supports both Zod v3 and v4:

npm install zod

Version Compatibility:

  • ✅ Zod v4.0.0+ (Recommended for new projects)
  • ✅ Zod v3.22.0+ (Fully supported for existing projects)

See Zod Version Compatibility for detailed information about version support and migration.

TypeScript Support

UltraFastBuilder is written in TypeScript and provides full type safety:

npm install -D typescript @types/node

Package Managers

npm

npm install @noony-serverless/type-builder zod

yarn

yarn add @noony-serverless/type-builder zod

pnpm

pnpm add @noony-serverless/type-builder zod

Verify Installation

Create a simple test file to verify everything is working:

// test.ts
import { builder } from '@noony-serverless/type-builder';
import { z } from 'zod';

const UserSchema = z.object({
name: z.string(),
email: z.string().email(),
});

const createUser = builder(UserSchema);

const user = createUser().withName('Test User').withEmail('test@example.com').build();

console.log('✅ UltraFastBuilder is working!', user);

Run it with:

npx tsx test.ts

You should see the user object printed to the console.

Next Steps