tsgen

Documentation

Index

• func GenerateTSContent(opts Opts) (string, error)
• func GenerateTSToFile(opts Opts) error
• type AdHocType
• type ArbitraryProperty
• type Item
• type Opts
• type PhantomType

Functions

func GenerateTSContent

func GenerateTSContent(opts Opts) (string, error)

GenerateTSContent generates TypeScript content from the given options

func GenerateTSToFile

func GenerateTSToFile(opts Opts) error

GenerateTSToFile generates a TypeScript file from the provided Opts.

Types

type AdHocType

type AdHocType struct {
	// Instance of the struct to generate TypeScript for
	Struct any

	// Name is required only if struct is anonymous, otherwise optional override
	TSTypeName string
}

type ArbitraryProperty

type ArbitraryProperty struct {
	Name  string
	Value any
}

Anything you'd like to add to a TypeScript type object, other than the phantom types. Value must be JSON-serializable.

type Item

type Item struct {
	ArbitraryProperties []ArbitraryProperty
	PhantomTypes        []PhantomType
}

Item represents a TypeScript object type with arbitrary properties and phantom types. It will be added to a constant array in the generated TypeScript file with the name assigned to ItemsArrayVarName in Opts.

type Opts

type Opts struct {
	// Path, including filename, where the resulting TypeScript file will be written
	OutPath           string
	Items             []Item
	AdHocTypes        []AdHocType
	ExtraTSCode       string
	ItemsArrayVarName string // Defaults to "tsgenItems"
	ExportItemsArray  bool
}

type PhantomType

type PhantomType struct {
	PropertyName string
	TSTypeName   string
	TypeInstance any
}