npmpackage.info

Gathering detailed insights and metrics for typed-json-schema

Other packages similar to typed-json-schema

json-schema-typed

8.0.1

JSON Schema TypeScript definitions with complete inline documentation.

as-typed

1.3.2

Static TypeScript types from a literal JSONSchema type

json-schema-strictly-typed

0.0.14

[![CircleCI](https://circleci.com/gh/unmock/json-schema-fast-check.svg?style=svg)](https://circleci.com/gh/unmock/json-schema-fast-check) [![codecov](https://codecov.io/gh/unmock/json-schema-fast-check/branch/master/graph/badge.svg)](https://codecov.io/g

typed-validators

4.5.1

complex type validators that generate TypeScript and Flow types for you

Gathering detailed insights and metrics for typed-json-schema

typed-json-schema - 4.0.5 | npmpackage.info

typed-json-schema

TypeScript-Friendly JSON-Schema Definitions

4.0.5

TypeScript

29.74 kB

1.3

Installations

npm install typed-json-schema

Developer Guide

BETA

Typescript

No

Module System

CommonJS

Node Version

14.9.0

NPM Version

6.14.8 Pull Requests

Open

8

Total

20

Closed

5

Merged

7

Issues

Open

0

Total

0

Closed

0

Releases

Unable to fetch releases

Languages

TypeScript

TypeScript (100%)

Developer

sberan

Download Statistics

Total Downloads

Last Day

Last Week

Last Month

Last Year

GitHub Statistics

19 Stars

45 Commits

1 Forks

4 Watchers

10 Branches

5 Contributors

Updated on Jan 31, 2023

Maintainers

View All 5 Contributors

Package Meta Information

Latest Version

4.0.5

Package Id

typed-json-schema@4.0.5

Unpacked Size

29.74 kB

Size

7.09 kB

File Count

NPM Version

6.14.8

Node Version

14.9.0

Total Downloads

Cumulative downloads

Total Downloads

NaN

Last Day

NaN

Compared to previous day

Last Week

NaN

Compared to previous week

Last Month

NaN

Compared to previous month

Last Year

NaN

Compared to previous year

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

ajv

Dev Dependencies

@types/chai @types/mocha chai cross-env mocha ts-node tslint typescript typings-checker

Typed-JSON-Schema

TypeScript-Friendly JSON-Schema Definitions

This library is able to validate JSON-Schema at runtime, and also emit type definitions for the validated data. This means that if you define your data using our JSON-schema builder, you automatically get TypeScript safety on those types.

Examples

Schema generation:

1await validator.validate(string.minLength(3), 'asdf') // type: string
2
3await validator.validate(array(string.pattern(/\w+/))) // result type: string[]
4
5await validator.validate(object.required('a', 'b').properties({
6  a: string,
7  b: array(number) 
8}) // result type: {a: string, b: number[] }
9

Validation

1import { schema, string, Validator } from 'typed-json-schema'
2
3const validator = new Validator()
4
5const StringOrNull = schema.type(['string', 'null'])
6
7const result = await validator.validate(StringOrNull, 'Hello'),
8
9result.toFixed(1) // error: Property 'toFixed' does not exist on type 'string'.
10result.toLowerCase() //error: object is possibly null
11result && validation.result.toLowerCase() //success!
12

Usage

Schema Creation

In general, all JSON-Schema keywords can be used as builders on the schema object.

For example:

1import { schema } from 'typed-json-schema'
2
3const mySchema = schema
4  .type('string')
5  .minLength(3)
6  .pattern(/regex/)

Refer to JSON-Schema keywords for a list of available keywords.

Shortcuts:

1import { string, boolean, number, array, object }
2
3const mySchema = string //same as schema.type('string')
4const mySchema = number //same as schema.type('number')
5const mySchema = boolean //same as schema.type('boolean')
6const mySchema = array(string) //same as schema.type('array').items(string)
7const mySchema = object({ a: string, b: array(number) }) //same as schema.type('object').properties({ a: string, b: array(number) })

Validation:

Use a Validator to validate a json schema:

1import { schema, Validator }
2
3const validator = new Validator({ coerceTypes: true }) //any AJV options can be supplied
4const result = await validator.validate(schema.type('number')) //result is a number
5
6

see AJV for a list of options that can be passed to the validator.

No vulnerabilities found.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

0

SAST

Determines if the project uses static code analysis.

0

Maintained

Determines if the project is "actively maintained".

0

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Security-Policy

Determines if the project has published a security policy.

0

Fuzzing

Determines if the project uses fuzzing.

0

License

Determines if the project has defined a license.

0

Branch-Protection

Determines if the default and release branches are protected with GitHub's branch protection settings.

0

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

Score

1.3

/10

Last Scanned on 2025-06-30

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More