6.3.4 • Published 4 months ago

prisma-generator-class-validator v6.3.4

Weekly downloads
-
License
MIT
Repository
github
Last release
4 months ago

Prisma Class Validator Generator

Automatically generate typescript models of your database with class validator validations ready, from your Prisma Schema. Updates every time npx prisma generate runs.

Table of Contents

Installation

 npm install prisma-generator-class-validator

Usage

1- Add the generator to your Prisma schema

generator class_validator {
  provider = "prisma-generator-class-validator"
}

3- Running npx prisma generate for the following schema.prisma

model User {
  id    Int     @id @default(autoincrement())
  email String  @unique
  name  String?
  posts Post[]
}

model Post {
  id        Int      @id @default(autoincrement())
  createdAt DateTime @default(now())
  updatedAt DateTime @updatedAt
  title     String
  content   String?
  published Boolean  @default(false)
  viewCount Int      @default(0)
  author    User?    @relation(fields: [authorId], references: [id])
  authorId  Int?
  rating    Float
}

will generate classes as follows:

User:

import { IsInt, IsDefined, IsString, IsOptional } from 'class-validator';
import { Post } from './';

export class User {
  @IsDefined()
  @IsInt()
  id!: number;

  @IsDefined()
  @IsString()
  email!: string;

  @IsOptional()
  @IsString()
  name?: string | null;

  @IsDefined()
  posts!: Post[];
}

Additional Options

Option DescriptionType Default
outputOutput directory for the generated modelsstring./generated

Use additional options in the schema.prisma

generator class_validator {
  provider   = "prisma-generator-class-validator"
  output     = "./generated-models"
}