Struct TypeScriptRenderer

pub struct TypeScriptRenderer { /* private fields */ }

Renders TypeScript types from a schema.

Implementations

impl TypeScriptRenderer

pub fn new(options: TypeScriptOptions) -> Self

Trait Implementations

impl Default for TypeScriptRenderer

fn default() -> TypeScriptRenderer

Returns the “default value” for a type.

impl SchemaRenderer for TypeScriptRenderer

fn is_reference(&self, name: &str) -> bool

Return true of the provided name is a referenced type.

fn render_array(&mut self, array: &ArrayType, _schema: &Schema) -> RenderResult

Render an ArrayType to a string.

fn render_boolean( &mut self, _boolean: &BooleanType, _schema: &Schema, ) -> RenderResult

Render a boolean type to a string.

fn render_enum(&mut self, enu: &EnumType, schema: &Schema) -> RenderResult

Render an EnumType to a string.

fn render_float(&mut self, float: &FloatType, _schema: &Schema) -> RenderResult

Render a FloatType to a string.

fn render_integer( &mut self, integer: &IntegerType, _schema: &Schema, ) -> RenderResult

Render an IntegerType to a string.

fn render_literal( &mut self, literal: &LiteralType, _schema: &Schema, ) -> RenderResult

Render a LiteralType to a string.

fn render_null(&mut self, _schema: &Schema) -> RenderResult

Render a null type to a string.

fn render_object( &mut self, object: &ObjectType, _schema: &Schema, ) -> RenderResult

Render an ObjectType to a string.

fn render_reference( &mut self, reference: &str, _schema: &Schema, ) -> RenderResult

Render a referenced type to a string.

fn render_string( &mut self, string: &StringType, _schema: &Schema, ) -> RenderResult

Render a StringType to a string.

fn render_struct( &mut self, structure: &StructType, _schema: &Schema, ) -> RenderResult

Render a StructType to a string.

fn render_tuple(&mut self, tuple: &TupleType, _schema: &Schema) -> RenderResult

Render a TupleType to a string.

fn render_union(&mut self, uni: &UnionType, _schema: &Schema) -> RenderResult

Render a UnionType to a string.

fn render_unknown(&mut self, _schema: &Schema) -> RenderResult

Render an unknown type to a string.

fn render(&mut self, schemas: IndexMap<String, Schema>) -> RenderResult

Render the list of Schemas to a string, in the order they are listed. References between types can be resolved using the provided schemas map.

fn render_schema(&mut self, schema: &Schema) -> RenderResult<O>

Render all possible variants of the provided Schema to a string. If a variant has an explicit name, and that name is a reference, return the name instead of rendering the type.

fn render_schema_without_reference( &mut self, schema: &Schema, ) -> RenderResult<O>

Like [render_schema] but does not check for references.