typescriptify

README

Based on: https://github.com/tkrajina/typescriptify-golang-structs License: LICENSE.txt

Documentation

Index

• type EnumType
• type StructType
  • func NewStruct(i interface{}) *StructType
  • func (st *StructType) WithFieldOpts(i interface{}, opts TypeOptions) *StructType
• type TSNamer
• type TypeOptions
• type TypeScriptify
  • func New() *TypeScriptify
  • func (t *TypeScriptify) Add(obj interface{}) *TypeScriptify
  • func (t *TypeScriptify) AddEnum(values interface{}) *TypeScriptify
  • func (t *TypeScriptify) AddEnumValues(typeOf reflect.Type, values interface{}) *TypeScriptify
  • func (t *TypeScriptify) AddImport(i string)
  • func (t *TypeScriptify) AddType(typeOf reflect.Type) *TypeScriptify
  • func (t *TypeScriptify) Convert(customCode map[string]string) (string, error)
  • func (t TypeScriptify) ConvertToFile(fileName string, packageName string) error
  • func (t *TypeScriptify) GetGeneratedStructs() []string
  • func (t *TypeScriptify) ManageType(fld interface{}, opts TypeOptions) *TypeScriptify
  • func (t *TypeScriptify) WithBackupDir(b string) *TypeScriptify
  • func (t *TypeScriptify) WithConstructor(b bool) *TypeScriptify
  • func (t *TypeScriptify) WithCreateFromMethod(b bool) *TypeScriptify
  • func (t *TypeScriptify) WithIndent(i string) *TypeScriptify
  • func (t *TypeScriptify) WithInterface(b bool) *TypeScriptify
  • func (t *TypeScriptify) WithPrefix(p string) *TypeScriptify
  • func (t *TypeScriptify) WithSuffix(s string) *TypeScriptify

Types

type EnumType

type EnumType struct {
	Type reflect.Type
}

type StructType

type StructType struct {
	Type         reflect.Type
	FieldOptions map[reflect.Type]TypeOptions
}

StructType stores settings for transforming one Golang struct.

func NewStruct

func NewStruct(i interface{}) *StructType

func (*StructType) WithFieldOpts

func (st *StructType) WithFieldOpts(i interface{}, opts TypeOptions) *StructType

type TSNamer

type TSNamer interface {
	TSName() string
}

type TypeOptions

type TypeOptions struct {
	TSType      string
	TSTransform string
}

TypeOptions overrides options set by `ts_*` tags.

type TypeScriptify

type TypeScriptify struct {
	Prefix            string
	Suffix            string
	Indent            string
	CreateFromMethod  bool
	CreateConstructor bool
	BackupDir         string // If empty no backup
	DontExport        bool
	CreateInterface   bool

	Namespace    string
	KnownStructs *slicer.StringSlicer
	KnownEnums   *slicer.StringSlicer
	// contains filtered or unexported fields
}

func New

func New() *TypeScriptify

func (*TypeScriptify) Add

func (t *TypeScriptify) Add(obj interface{}) *TypeScriptify

func (*TypeScriptify) AddEnum

func (t *TypeScriptify) AddEnum(values interface{}) *TypeScriptify

func (*TypeScriptify) AddEnumValues

func (t *TypeScriptify) AddEnumValues(typeOf reflect.Type, values interface{}) *TypeScriptify

AddEnumValues is deprecated, use `AddEnum()`

func (*TypeScriptify) AddImport

func (t *TypeScriptify) AddImport(i string)

func (*TypeScriptify) AddType

func (t *TypeScriptify) AddType(typeOf reflect.Type) *TypeScriptify

func (*TypeScriptify) Convert

func (t *TypeScriptify) Convert(customCode map[string]string) (string, error)

func (TypeScriptify) ConvertToFile

func (t TypeScriptify) ConvertToFile(fileName string, packageName string) error

func (*TypeScriptify) GetGeneratedStructs

func (t *TypeScriptify) GetGeneratedStructs() []string

func (*TypeScriptify) ManageType

func (t *TypeScriptify) ManageType(fld interface{}, opts TypeOptions) *TypeScriptify

ManageType can define custom options for fields of a specified type.

This can be used instead of setting ts_type and ts_transform for all fields of a certain type.

func (*TypeScriptify) WithBackupDir

func (t *TypeScriptify) WithBackupDir(b string) *TypeScriptify

func (*TypeScriptify) WithConstructor

func (t *TypeScriptify) WithConstructor(b bool) *TypeScriptify

func (*TypeScriptify) WithCreateFromMethod

func (t *TypeScriptify) WithCreateFromMethod(b bool) *TypeScriptify

func (*TypeScriptify) WithIndent

func (t *TypeScriptify) WithIndent(i string) *TypeScriptify

func (*TypeScriptify) WithInterface

func (t *TypeScriptify) WithInterface(b bool) *TypeScriptify

func (*TypeScriptify) WithPrefix

func (t *TypeScriptify) WithPrefix(p string) *TypeScriptify

func (*TypeScriptify) WithSuffix

func (t *TypeScriptify) WithSuffix(s string) *TypeScriptify