Skip to content

Latest commit

 

History

History
46 lines (28 loc) · 1.56 KB

README.md

File metadata and controls

46 lines (28 loc) · 1.56 KB

Convert JSON Schema to Flow Type Definitions

Build Status NPM Dependencies License

APIs

type Imports = {
  [key: string]: Schema
}

simplifySchema(schema, Schema, imports: ?Imports): Schema

  • schema should have id for type alias identifier
  • outside $ref will be resolve the real schema instead of $ref;
  • imports with { #: schema } will have same rule as above;

convertSchema(schema: Schema): FlowSchema

convert schema to a flow schema

toFlow(flowSchema): AstObject

will export ast object export ${upperCamelCase(flowSchema.id)} == ${toFlowType(flowType)}

schemaToFlow(flowSchema): string

convert definitions and schema root by toFlow

parseSchema(schema: Schema, imports: ?Imports): string

pipe simplifySchema | convertSchema | schemaToFlow

Changelog

0.4.0

  • Support for string literal object type keys

0.3.0