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

@profusion/json-schema-to-typescript-definitions

v0.2.1

Published

Automatic TypeScript definitions from JSON Schema7 (no code generation!)

Downloads

162

Readme

TypeScript from JSON Schema

This is a TypeScript definitions that can automatically generate TypeScript types given JSON Schema definitions without the need of any code generator.

The caveat is that the JSON Schema must be declared using string literals instead of generic strings, this is achieved by declaring the objects as const.

The associated helper files will aid that task with some constants and functions that returns properly typed constructions.

Install

yarn add @profusion/json-schema-to-typescript-definitions

If you don't use our commonSchemas or schemaHelpers, you can use it as a --dev dependency since the TypeScript checks are done only in compile time.

Usage

import type { TypeFromJSONSchema } from '@profusion/json-schema-to-typescript-definitions';

type MyObject = TypeFromJSONSchema<{
  type: 'object';
  properties: {
    a: { type: 'boolean' };
  };
  additionalProperties: false;
}>;
const o: MyObject = { a: true };

One can also use the function helpers to get properly typed objects:

import { commonSchemas, schemaHelpers } from '@profusion/json-schema-to-typescript-definitions';

// declares an actual schema object, you can use with Ajv and others
const schema = schemaHelpers.object({
  properties: {
    a: commonSchemas.boolean,
  },
});
const o: TypeFromJSONSchema<typeof schema> = { a: true };

Similar Packages

This package is similar to json-schema-to-typescript, however that one uses a code-generator that can work out JSON files.

This package requires as const so strings are kept as literals, but requires no code generation. If you define your JSON schemas using TypeScript, then you can avoid that code generation burden.

License

Open source - MIT.