schematype

Documentation

Index

• type AnyType
  • func (*AnyType) Kind() Kind
  • func (*AnyType) TypeDefTo(w io.Writer)
• type ArrayType
  • func (*ArrayType) Kind() Kind
  • func (t *ArrayType) TypeDefTo(w io.Writer)
• type BoolType
  • func (BoolType) Kind() Kind
  • func (BoolType) TypeDefTo(w io.Writer)
• type IntersectionType
  • func (*IntersectionType) Kind() Kind
  • func (t *IntersectionType) TypeDefTo(w io.Writer)
• type JSONSchemaOptions
• type Kind
• type NamedType
  • func (t *NamedType) Kind() Kind
  • func (t *NamedType) TypeDefTo(w io.Writer)
• type NumberType
  • func (t *NumberType) Kind() Kind
  • func (t *NumberType) TypeDefTo(w io.Writer)
• type ObjectType
  • func (ObjectType) Kind() Kind
  • func (t *ObjectType) PropRequired(prop string) bool
  • func (t *ObjectType) TypeDefTo(w io.Writer)
• type StringType
  • func (t *StringType) Kind() Kind
  • func (t *StringType) TypeDefTo(w io.Writer)
• type Type
• type TypeSystem
  • func NewTypeSystem() *TypeSystem
  • func (ts *TypeSystem) FromJSONSchema(schema *jsonschema.Schema, opts *JSONSchemaOptions) (tpe Type)
• type UnionType
  • func (*UnionType) Kind() Kind
  • func (t *UnionType) TypeDefTo(w io.Writer)

Types

type AnyType

type AnyType struct {
}

func (*AnyType) Kind

func (*AnyType) Kind() Kind

func (*AnyType) TypeDefTo

func (*AnyType) TypeDefTo(w io.Writer)

type ArrayType

type ArrayType struct {
	Elem Type
}

func (*ArrayType) Kind

func (*ArrayType) Kind() Kind

func (*ArrayType) TypeDefTo

func (t *ArrayType) TypeDefTo(w io.Writer)

type BoolType

type BoolType struct {
}

func (BoolType) Kind

func (BoolType) Kind() Kind

func (BoolType) TypeDefTo

func (BoolType) TypeDefTo(w io.Writer)

type IntersectionType

type IntersectionType struct {
	AllOf []Type
}

func (*IntersectionType) Kind

func (*IntersectionType) Kind() Kind

func (*IntersectionType) TypeDefTo

func (t *IntersectionType) TypeDefTo(w io.Writer)

type JSONSchemaOptions

type JSONSchemaOptions struct {
	Resolve func(ref string) *jsonschema.Schema
}

type Kind

type Kind int

const (
	Unknown Kind = iota
	Any
	String
	Number
	Bool
	Object
	Array
	Union
	Intersection
	Ref
)

type NamedType

type NamedType struct {
	Name       string
	Underlying Type
}

func (*NamedType) Kind

func (t *NamedType) Kind() Kind

func (*NamedType) TypeDefTo

func (t *NamedType) TypeDefTo(w io.Writer)

type NumberType

type NumberType struct {
	Format string
	Enum   []any
}

func (*NumberType) Kind

func (t *NumberType) Kind() Kind

func (*NumberType) TypeDefTo

func (t *NumberType) TypeDefTo(w io.Writer)

type ObjectType

type ObjectType struct {
	Embeds         []Type
	Props          map[string]Type
	Required       []string
	AdditionalProp Type
}

func (ObjectType) Kind

func (ObjectType) Kind() Kind

func (*ObjectType) PropRequired

func (t *ObjectType) PropRequired(prop string) bool

func (*ObjectType) TypeDefTo

func (t *ObjectType) TypeDefTo(w io.Writer)

type StringType

type StringType struct {
	Format string
	Enum   []any
}

func (*StringType) Kind

func (t *StringType) Kind() Kind

func (*StringType) TypeDefTo

func (t *StringType) TypeDefTo(w io.Writer)

type Type

type Type interface {
	Kind() Kind
	TypeDefTo(w io.Writer)
}

type TypeSystem

type TypeSystem struct {
	Defs map[string]*NamedType
}

func NewTypeSystem

func NewTypeSystem() *TypeSystem

func (*TypeSystem) FromJSONSchema

func (ts *TypeSystem) FromJSONSchema(schema *jsonschema.Schema, opts *JSONSchemaOptions) (tpe Type)

type UnionType

type UnionType struct {
	OneOf []Type
}

func (*UnionType) Kind

func (*UnionType) Kind() Kind

func (*UnionType) TypeDefTo

func (t *UnionType) TypeDefTo(w io.Writer)