jsonschema

Documentation

Overview

Package jsonschema generates TypeScript schema declarations from JSON Schema.

Index

• func Declarations(ctx context.Context, config Config) (string, error)
• func WriteDeclarations(ctx context.Context, config Config, output string) error
• type Config
  • func (c Config) Validate() error

Functions

func Declarations

func Declarations(ctx context.Context, config Config) (string, error)

Declarations renders the types the configured schemas describe as one TypeScript declaration file for the configured module.

func WriteDeclarations

func WriteDeclarations(ctx context.Context, config Config, output string) error

WriteDeclarations renders the declarations for config into the file at output.

Types

type Config

type Config struct {
	// Module names the declared module, which scripts import the types from.
	Module string `required:"" placeholder:"NAME" help:"Name of the TypeScript module to declare the types in."`
	// Schemas are JSON Schema files whose titled roots and definitions become types.
	Schemas []string `` /* 142-byte string literal not displayed */
}

Config selects the JSON Schema files declared as one TypeScript module.

func (Config) Validate

func (c Config) Validate() error

Validate checks that the configuration names a module and at least one schema.