npm

npm’s 2019 JavaScript ecosystem survey analysis is now available! Get your copy here »

schema-dts-gen

0.3.3 • Public • Published

Build Status schema-dts npm version schema-dts-gen version

schema-dts

JSON-LD TypeScript types for Schema.org vocabulary.

schema-dts provides TypeScript definitions for Schema.org vocabulary in JSON-LD format. The typings are exposed as complete sets of discriminated type unions, allowing for easy completions and stricter validation.

Example of Code Completion using schema-dts

This repository contains two NPM packages:

  • schema-dts-gen Providing a command-line tool to generate TypeScript files based on a specific Schema version and layer.
  • schema-dts Pre-packaged TypeScript typings of latest Schema.org schema, without pending and other non-core layers.

Note: This is not an officially supported Google product.

Usage

To use the typings for your project, simply add the schema-dts NPM package to your project:

npm install schema-dts

Then you can use it by importing "schema-dts".

Schema Typings Generator

The Schema Typings Generator is available in the schema-dts-gen package.

npm install schema-dts-gen
npx schema-dts-gen --schema=3.4

Command line usage:

  • schema and layer: Used to load the actual Schema definition:

    https://schema.org/version/${schema}/${layer}.nt
    
  • context: Defaults to https://schema.org, the value or values to be used with the "@context" property.

    Can be either a single URL, or a comma separated list of two or more name:URL pairs.

    The context affects names of string properties in types, as well as the values of an object's "@type".

  • deprecated/nodeprecated: Whether or not to include deprecated Schema.org types and properties. When included, these types will still be marked with @deprecated JSDOC tags.

Developers

Use NPM to install dependencies:

npm install

Use Gulp to build the package:

gulp generate-ts

or simply build the schema-dts generator:

gulp build-generator

To contribute changes, see the CONTRIBUTING.md file.

install

npm i schema-dts-gen

Downloadsweekly downloads

15

version

0.3.3

license

Apache-2.0

homepage

github.com

repository

Gitgithub

last publish

collaborators

  • avatar
Report a vulnerability