typescript

Documentation

Index

• Constants
• func NewGen(env *typecheck.Data) *typescriptGen
• type API
  • func (a *API) String() string
• type Array
  • func (arr *Array) String() string
• type Base
  • func (b *Base) String() string
• type Client
  • func (c *Client) String() string
• type Decl
• type Def
  • func (d *Def) String() string
• type Field
  • func (f *Field) String() string
• type File
  • func (f *File) Gen() string
  • func (f *File) Path() string
  • func (f *File) String() string
• type FuncSig
  • func (f *FuncSig) String() string
• type Import
  • func (i *Import) String() string
• type JSONTags
  • func (j *JSONTags) String() string
• type Map
  • func (m *Map) String() string
• type Message
  • func (m *Message) String() string
• type Metadata
• type Oneof
  • func (o *Oneof) String() string
• type OneofField
• type Package
  • func (p *Package) String() string
• type Pointer
  • func (p *Pointer) String() string
• type Serialize
  • func (*Serialize) String() string
• type StreamType
• type Type

Constants

const (
	BYTE_KIND int = iota
	UINT32_KIND
	UINT64_KIND
	UINT128_KIND
	INT32_KIND
	INT64_KIND
	INT128_KIND
	FLOAT32_KIND
	FLOAT64_KIND
	BOOL_KIND
	STRING_KIND
	UUID_KIND
)

Base types.

const (
	MRPC_PATH string = "mrpc-ts/mrpc"
)

Fixed paths.

Functions

func NewGen

func NewGen(
	env *typecheck.Data,
) *typescriptGen

Return a new Golang code generator.

Types

type API

type API struct {
	Doc        string     // Documentation, if any.
	Recv       *Field     // Receiver.
	Name       string     // The name of the API.
	Type       *FuncSig   // API signature.
	Parent     Decl       // The declaration to which the API belongs to.
	Stream     StreamType // Streaming type.
	Package    *Package   // The package to which the API belongs to.
	ParentPath string     // The parent path of the API.
	Path       string     // The full path of the API.
	Public     bool       // Set if the API is exposed.
}

APIs.

func (*API) String

func (a *API) String() string

type Array

type Array struct {
	Elem Type
}

Array type.

func (*Array) String

func (arr *Array) String() string

type Base

type Base struct {
	Kind int
}

Base type.

var (
	BYTE    *Base = &Base{BYTE_KIND}
	UINT32  *Base = &Base{UINT32_KIND}
	UINT64  *Base = &Base{UINT64_KIND}
	UINT128 *Base = &Base{UINT128_KIND}
	INT32   *Base = &Base{INT32_KIND}
	INT64   *Base = &Base{INT64_KIND}
	INT128  *Base = &Base{INT128_KIND}
	FLOAT32 *Base = &Base{FLOAT32_KIND}
	FLOAT64 *Base = &Base{FLOAT64_KIND}
	BOOL    *Base = &Base{BOOL_KIND}
	STRING  *Base = &Base{STRING_KIND}
	UUID    *Base = &Base{UUID_KIND}
)

func (*Base) String

func (b *Base) String() string

type Client

type Client struct {
	Doc      string   // Documentation, if any.
	Name     string   // The name of the client.
	Protocol string   // The protocol for the client.
	APIs     []*API   // A list of APIs for the client.
	Package  *Package // The package to which the client belongs to.
	Path     string   // The full path of the client.
}

Client declaration.

Clients are translated to classes in Typescript.

func (*Client) String

func (c *Client) String() string

type Decl

type Decl interface {
	codegen.Node
	// contains filtered or unexported methods
}

All declaration nodes implement this interface.

type Def

type Def struct {
	Name string
}

Defined type.

func (*Def) String

func (d *Def) String() string

type Field

type Field struct {
	Doc  string // Documentation, if any.
	Name string // The name of the field.
	Tag  string // Tag used for JSON.
	Type Type   // The type of the field.
}

Fields.

func (*Field) String

func (f *Field) String() string

type File

type File struct {
	Package  *Package   // The package to which the file belongs to.
	Imports  []*Import  // Packages imported by the file.
	Decls    []Decl     // A list of declarations in the file.
	Metadata []Metadata // List of file-specific metadata.
	// contains filtered or unexported fields
}

This file includes any messages or servers exported by the protocol file.

func (*File) Gen

func (f *File) Gen() string

func (*File) Path

func (f *File) Path() string

func (*File) String

func (f *File) String() string

type FuncSig

type FuncSig struct {
	Param  *Field
	Return *Field
}

Function signature.

func (*FuncSig) String

func (f *FuncSig) String() string

type Import

type Import struct {
	Doc  string // Documentation, if any.
	Name string // The name of the import, if any.
	Path string // The corresponding path.
}

Golang import.

func (*Import) String

func (i *Import) String() string

type JSONTags

type JSONTags struct {
	Tags map[string]string
}

JSON tags.

func (*JSONTags) String

func (j *JSONTags) String() string

type Map

type Map struct {
	Key   Type
	Value Type
}

Map type.

func (*Map) String

func (m *Map) String() string

type Message

type Message struct {
	Doc     string   // Documentation, if any.
	Name    string   // The name of the message.
	Fields  []*Field // A list of fields.
	Package *Package // The package to which the message belongs to.
	Path    string   // The full path of the message.
}

Message declaration.

Messages are translated to classes in Typescript.

func (*Message) String

func (m *Message) String() string

type Metadata

type Metadata interface {
	codegen.Node
	// contains filtered or unexported methods
}

Metadata.

type Oneof

type Oneof struct {
	Doc    string
	Name   string
	Fields []*OneofField
}

Oneof declaration.

func (*Oneof) String

func (o *Oneof) String() string

type OneofField

type OneofField struct {
	Doc       string
	Name      string
	FieldName string
	Tag       string
	Type      Type
}

Oneof field.

type Package

type Package struct {
	Name    string     // The name of the package.
	Path    string     // The path of the package.
	Files   []*File    // A list of files.
	Imports []*Package // A list of packages imported (dependencies).
}

`Package` defines the overall Typescript group that defines the entire package.

func (*Package) String

func (p *Package) String() string

type Pointer

type Pointer struct {
	Base Type
}

Pointer type.

func (*Pointer) String

func (p *Pointer) String() string

type Serialize

type Serialize struct{}

Serialize and deserialize functions.

func (*Serialize) String

func (*Serialize) String() string

type StreamType

type StreamType int

Streaming types.

const (
	NONE StreamType = iota
	SERVER
	CLIENT
	BOTH
)

type Type

type Type interface {
	codegen.Node
	// contains filtered or unexported methods
}

All type nodes implement this interface.