Socket
Socket
Sign inDemoInstall

@types/json-schema

Package Overview
Dependencies
0
Maintainers
1
Versions
19
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

    @types/json-schema

TypeScript definitions for json-schema


Version published
Weekly downloads
34M
decreased by-1.42%
Maintainers
1
Install size
31.0 kB
Created
Weekly downloads
 

Package description

What is @types/json-schema?

The @types/json-schema package provides TypeScript type definitions for JSON Schema. It allows developers to use JSON Schema in TypeScript projects with type checking, enabling them to define valid JSON structures more accurately and with the benefits of autocompletion and compile-time validation. This package does not include functionality to validate JSON data against schemas but rather provides types to assist in writing code that can create, manipulate, or understand JSON Schemas.

What are @types/json-schema's main functionalities?

Defining a JSON Schema

This code sample demonstrates how to define a simple JSON Schema for an object with required 'name' (string) and 'age' (number) properties using TypeScript. The @types/json-schema package provides types that make it easier to define such schemas with the benefits of type checking.

{"$schema": "http://json-schema.org/draft-07/schema#","type": "object","properties": {"name": {"type": "string"},"age": {"type": "number"}},"required": ["name", "age"]}

Using JSON Schema with TypeScript interfaces

This example shows how to define a TypeScript interface and a corresponding JSON Schema. The @types/json-schema package allows the use of JSONSchema7 (or other version-specific types) to ensure the schema definition is type-safe.

interface Person {name: string; age: number;}; const personSchema: JSONSchema7 = {type: 'object', properties: {name: {type: 'string'}, age: {type: 'number'}}, required: ['name', 'age']};

Other packages similar to @types/json-schema

Readme

Source

Installation

npm install --save @types/json-schema

Summary

This package contains type definitions for json-schema (https://github.com/kriszyp/json-schema).

Details

Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/json-schema.

Additional Details

  • Last updated: Tue, 07 Nov 2023 03:09:37 GMT
  • Dependencies: none

Credits

These definitions were written by Boris Cherny, Lucian Buzzo, Roland Groza, and Jason Kwok.

FAQs

Last updated on 07 Nov 2023

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc