npmpackage.info

Gathering detailed insights and metrics for openapi-ts-validator

Other packages similar to openapi-ts-validator

@oats-ts/openapi-validator

0.0.51

@openapi-ts/validator

1.0.1

OpenAPI validator helpers with TypeScript typings

@a-2-c-2-anpm/occaecati-omnis-dicta

1.0.0

TypeScript library to help building OpenAPI 3.x compliant API contracts.

@saoviettest/nobis-unde-inventore-repudiandae

1.0.0

![CI/CD](https://github.com/saoviettest/nobis-unde-inventore-repudiandae/actions/workflows/ci.yml/badge.svg) [![npm](https://img.shields.io/npm/v/@nahkies/openapi-code-generator.svg)](https://www.npmjs.com/package/@nahkies/openapi-code-generator)

openapi-ts-validator

1.7.1

34.59 kB

1,087

Installations

npm install openapi-ts-validator

Developer Guide

BETA

Typescript

No

Module System

CommonJS

Node Version

18.16.0

NPM Version

9.7.1 Releases

Unable to fetch releases

Contributors

validate.email 🚀

Verify real, reachable, and deliverable emails with instant MX records, SMTP checks, and disposable email detection.

Download Statistics

Total Downloads

1,087

Last Day

Last Week

Last Month

Last Year

208

Bundle Size

120.73 kB

Minified

34.59 kB

Minified + Gzipped

Bundlephobia

Maintainers

Package Meta Information

Latest Version

1.7.1

Package Id

openapi-ts-validator@1.7.1

Unpacked Size

25.73 kB

Size

7.59 kB

File Count

NPM Version

9.7.1

Node Version

18.16.0

Published on

Jul 17, 2023

Total Downloads

Cumulative downloads

Total Downloads

1,087

Last Day

Compared to previous day

Last Week

Compared to previous week

Last Month

35.7%

Compared to previous month

Last Year

-76.3%

208

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

@types/js-yaml @types/node ajv ajv-formats commander js-yaml ts-morph typescript

Dev Dependencies

@types/jest jest ts-jest

OpenAPI TS Validator

run openapi-ts-validator generate -i <input file> -o <output directory> to generate a TypeScript schema file to use for validation.

To validate an object pass the value and the schema to the function validate as follows:

import {schemas} from <output_path>;
import {validate, parseErrors} from 'openapi-ts-validator';

const errors = validate(value, schemas.Id.__schema__);
const message = parseErrors(errors);

This functions returns an ErrorObject list containing all errors if the value is invalid. It returns undefined if the value in valid.

The parseErrors function returns the errors as a string if an array is passed. Optionally it also takes a label of type string which will be prepended to the parsed error message.

The data structures must be defined inside the schemas, parameters or requestBodies sections to be considered during the generation.

No vulnerabilities found.

No security vulnerabilities found.