npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

json-schema-service

v1.0.3

Published

handling typescript types <-> json schemas by decorators or declarative

Downloads

12

Readme

json-schema-service

json-schema-service is a TypeScript library that handles TypeScript types and JSON schemas using decorators or a declarative approach. It allows you to define JSON schemas with minimal boilerplate and provides powerful schema validation capabilities.

Installation

Install the package via npm:

```sh npm install json-schema-service ```

Usage

Defining Schemas

Use decorators to define your schema:

```typescript import { JsonSchemaObject, JsonSchemaProperty } from 'json-schema-service';

@JsonSchemaObject({ description: 'A sample user object' }) class User { @JsonSchemaProperty({ required: true, description: 'User name' }) name: string;

@JsonSchemaProperty({ required: true, description: 'User age' }) age: number; } ```

Creating and Validating JSON Schemas

You can create a JSON schema from your TypeScript classes:

```typescript import { JsonSchemaService } from 'json-schema-service';

const schemaService = new JsonSchemaService(); const userSchema = schemaService.createJsonSchema(User);

// Validate data const { valid, errors } = schemaService.validate(userSchema, { name: 'John', age: 30 });

if (valid) { console.log('Data is valid'); } else { console.error('Data is invalid', errors); } ```

Features

  • Decorators for defining JSON schemas directly in TypeScript.
  • Validation using Ajv, a fast JSON schema validator.
  • Support for oneOf and complex schema types.
  • Flexible schema generation for various use cases.

Contributing

Contributions are welcome! Please check the issues and feel free to submit a pull request.

License

This project is licensed under the ISC License.