Skip to content

pinecone-js/nest

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

88 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Pinecone JS Nest

A library for defining request/response schemas and handling result responses in NestJS using Zod.

Installation

npm install @pinecone-js/nest

Usage

Example controller with input/output validation schemas:

import { Controller, Get } from '@nestjs/common';
import {
  RequestSchema,
  ResponseSchema,
  HttpResult,
  type HttpResponse,
} from '@pinecone-js/nest';
import { z } from 'zod';

const inputSchema = z.object({
  name: z.string(),
  age: z.number(),
});

const outputSchema = z.object({
  name: z.string(),
  age: z.number(),
  success: z.boolean(),
});

@Controller('users')
export class UserController {
  @Get()
  @ResponseSchema(outputSchema)
  getUsers(
    @RequestSchema(inputSchema) input,
  ): HttpResponse<any> {
    return HttpResult.success({
      name: 'John Doe',
      age: 20,
      success: true,
    });
  }
}

Exports

  • RequestSchema, ResponseSchema: Decorators for validating schemas.
  • AppResult, HttpResult: Helpers to format result responses.
  • Works seamlessly with Zod for data validation.

Build

npm run build && npm version patch && npm publish

License

MIT

About

PineconeJS — NestJS extensions that keep devs focused on business logic

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published