go2ts

README

go2ts

An extremely simple and powerful Go to Typescript generator. It can handle all JSON serializable Go types and also has the ability to define TypeScript union types for your enum-like types.

Inspired by https://github.com/OneOfOne/struct2ts.

This module does not supply a command-line interface. Just write a short Go program like the example below to generate your TypeScript files.

Install

go get github.com/skia-dev/go2ts

Example

Input:

import (
	"image/color"
	"log"
	"os"

	"github.com/skia-dev/go2ts"
)

func main() {
	type Direction string

	const (
		Up    Direction = "up"
		Down  Direction = "down"
		Left  Direction = "left"
		Right Direction = "right"
	)

	AllDirections := []Direction{Up, Down, Left, Right}

	type Position struct {
		X int
		Y int
	}

	type Turtle struct {
		Position  `json:"Coordinates"`
		Color     color.Alpha
		Direction Direction
	}

	generator := go2ts.New()
	generator.Add(Turtle{})
	generator.AddUnion(AllDirections)
	generator.Render(os.Stdout)
}

Output:

// DO NOT EDIT. This file is automatically generated.

export interface Position {
  X: number;
  Y: number;
}

export interface Alpha {
  A: number;
}

export interface Turtle {
  Coordinates: Position;
  Color: Alpha;
  Direction: Direction;
}

export type Direction = 'up' | 'down' | 'left' | 'right';

Documentation

Overview

Package go2ts is an extremely simple and powerful Go to Typescript generator. It can handle all JSON serializable Go types and also has the ability to define TypeScript union types for your enum-like types.

Example

type Direction string

const (
	Up    Direction = "up"
	Down  Direction = "down"
	Left  Direction = "left"
	Right Direction = "right"
)

AllDirections := []Direction{Up, Down, Left, Right}

type Position struct {
	X int
	Y int
}

type Turtle struct {
	Position  Position `json:"Coordinates"`
	Color     color.Alpha
	Direction Direction
}

generator := New()
err := generator.Add(Turtle{})
if err != nil {
	log.Fatal(err)
}
err = generator.AddUnion(AllDirections)
if err != nil {
	log.Fatal(err)
}
err = generator.Render(os.Stdout)
if err != nil {
	log.Fatal(err)
}

Output:

// DO NOT EDIT. This file is automatically generated.

	X: number;
	Y: number;
}

	A: number;
}

	Coordinates: Position;
	Color: Alpha;
	Direction: Direction;
}

Index

• type Go2TS
  • func New() *Go2TS
  • func (g *Go2TS) Add(v interface{}) error
  • func (g *Go2TS) AddMultiple(values ...interface{}) error
  • func (g *Go2TS) AddMultipleUnion(values ...interface{}) error
  • func (g *Go2TS) AddUnion(v interface{}) error
  • func (g *Go2TS) AddUnionWithName(v interface{}, typeName string) error
  • func (g *Go2TS) AddWithName(v interface{}, interfaceName string) error
  • func (g *Go2TS) Render(w io.Writer) error

Examples

• Package

Types

type Go2TS

type Go2TS struct {
	// contains filtered or unexported fields
}

Go2TS writes TypeScript definitions for Go types.

func New

func New() *Go2TS

New returns a new *Go2TS.

func (*Go2TS) Add

func (g *Go2TS) Add(v interface{}) error

Add a type that needs a TypeScript definition.

See AddWithName() for more details.

func (*Go2TS) AddMultiple

func (g *Go2TS) AddMultiple(values ...interface{}) error

AddMultiple adds multiple types in a single call.

Will stop at the first type that fails.

func (*Go2TS) AddMultipleUnion

func (g *Go2TS) AddMultipleUnion(values ...interface{}) error

AddMultipleUnion adds multple union types.

Will stop at the first union type that fails.

func (*Go2TS) AddUnion

func (g *Go2TS) AddUnion(v interface{}) error

AddUnion adds a TypeScript definition for a union type of the values in 'v', which must be a slice or an array.

func (*Go2TS) AddUnionWithName

func (g *Go2TS) AddUnionWithName(v interface{}, typeName string) error

AddUnionWithName adds a TypeScript definition for a union type of the values in 'v', which must be a slice or an array.

If typeName is the empty string then the name of type of elements in the slice or array is used as the type name, otherwise the typeName supplied will be used as the TypeScript type name.

func (*Go2TS) AddWithName

func (g *Go2TS) AddWithName(v interface{}, interfaceName string) error

AddWithName adds a type that needs a TypeScript definition.

The value passed in can be an instance of a type, a reflect.Type, or a reflect.Value.

The 'name' supplied will be the TypeScript interface name. If 'interfaceName' is the empty string then the Go type name will be used. If the type is of a struct that is anonymous it will be given a name of the form "AnonymousN".

If the type is a struct, the fields of the struct will be named following the convention for json serialization, including using the json tag if supplied. Fields tagged with `json:",omitempty"` will have "| null" added to their type.

There is special handling of time.Time types to be TypeScript "string"s since time.Time implements MarshalJSON, see https://pkg.go.dev/time?tab=doc#Time.MarshalJSON.

func (*Go2TS) Render

func (g *Go2TS) Render(w io.Writer) error

Render the TypeScript definitions to the given io.Writer.