metadata

Documentation

Index

• Constants
• type Docs
• type Field
• type Function
  • func (f *Function) String(m *Metadata) string
• type FunctionMap
  • func (m *FunctionMap) SortedKeys() []string
• type Metadata
  • func NewMetadata() *Metadata
  • func (m *Metadata) GetImports() map[string]string
• type Parameter
• type Result
• type TypeDefinition
  • func (t *TypeDefinition) String(m *Metadata) string
• type TypeMap
  • func (m *TypeMap) SortedKeys(mod string) []string

Constants

const MetadataVersion = 2

Types

type Docs

type Docs struct {
	Lines []string `json:"lines"`
}

type Field

type Field struct {
	Name string `json:"name"`
	Type string `json:"type"`
	Docs *Docs  `json:"docs,omitempty"`
}

type Function

type Function struct {
	Name       string       `json:"-"`
	Parameters []*Parameter `json:"parameters,omitempty"`
	Results    []*Result    `json:"results,omitempty"`
	Docs       *Docs        `json:"docs,omitempty"`
}

func (*Function) String

func (f *Function) String(m *Metadata) string

type FunctionMap

type FunctionMap map[string]*Function

func (*FunctionMap) SortedKeys

func (m *FunctionMap) SortedKeys() []string

type Metadata

type Metadata struct {
	Plugin    string      `json:"plugin"`
	Module    string      `json:"module"`
	SDK       string      `json:"sdk"`
	BuildId   string      `json:"buildId"`
	BuildTime string      `json:"buildTs"`
	GitRepo   string      `json:"gitRepo,omitempty"`
	GitCommit string      `json:"gitCommit,omitempty"`
	FnExports FunctionMap `json:"fnExports,omitempty"`
	FnImports FunctionMap `json:"fnImports,omitempty"`
	Types     TypeMap     `json:"types,omitempty"`
}

func NewMetadata

func NewMetadata() *Metadata

func (*Metadata) GetImports

func (m *Metadata) GetImports() map[string]string

type Parameter

type Parameter struct {
	Name     string `json:"name"`
	Type     string `json:"type"`
	Default  *any   `json:"default,omitempty"`
	Optional bool   `json:"-"` // deprecated
}

type Result

type Result struct {
	Name string `json:"name,omitempty"`
	Type string `json:"type"`
}

type TypeDefinition

type TypeDefinition struct {
	Id     uint32   `json:"id"`
	Name   string   `json:"-"`
	Fields []*Field `json:"fields,omitempty"`
	Docs   *Docs    `json:"docs,omitempty"`
}

func (*TypeDefinition) String

func (t *TypeDefinition) String(m *Metadata) string

type TypeMap

type TypeMap map[string]*TypeDefinition

func (*TypeMap) SortedKeys

func (m *TypeMap) SortedKeys(mod string) []string