rpc

Documentation

Index

• Constants
• func BuildFromCategories(categories []CategorySpecificOptions) string
• func GenerateTypeScript(opts Opts) error
• type ActionType
• type AdHocType
• type BaseOptions
• type CategorySpecificOptions
• type Opts
• type RouteDef

Constants

const CollectionVarName = "routes"

Functions

func BuildFromCategories

func BuildFromCategories(categories []CategorySpecificOptions) string

func GenerateTypeScript

func GenerateTypeScript(opts Opts) error

Types

type ActionType

type ActionType = string

const (
	ActionTypeQuery    ActionType = "query"
	ActionTypeMutation ActionType = "mutation"
)

type AdHocType

type AdHocType = tsgen.AdHocType

type BaseOptions

type BaseOptions struct {
	CollectionVarName    string
	DiscriminatorStr     string
	CategoryPropertyName string
}

type CategorySpecificOptions

type CategorySpecificOptions struct {
	BaseOptions
	CategoryValue        string
	ItemTypeNameSingular string
	ItemTypeNamePlural   string
	KeyUnionTypeName     string
	InputUnionTypeName   string
	OutputUnionTypeName  string
	SkipInput            bool
	SkipOutput           bool
}

type Opts

type Opts struct {
	// Path, including filename, where the resulting TypeScript file will be written
	OutPath           string
	RouteDefs         []RouteDef
	AdHocTypes        []*AdHocType
	ExportRoutesArray bool
	ExtraTSCode       string
}

type RouteDef

type RouteDef = struct {
	Key        string
	ActionType ActionType
	Input      any
	Output     any
}