docs

package

v3.0.0 Latest Latest Go to latest Published: Oct 11, 2026 License: MIT Imports: 4 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/hilthontt/luascript

Links

Open Source Insights

Documentation ¶

Index ¶

func Lookup(query string) (*Topic, *Entry, bool)
func LookupEntry(qualified string) (*Topic, *Entry, bool)
func LookupMember(ns, member string) (*Topic, *Entry, bool)
func RenderAll(o Options) string
func RenderEntry(t *Topic, e *Entry, o Options) string
func RenderIndex(o Options) string
func RenderSearch(results []Result, o Options) string
func RenderTopic(t *Topic, o Options) string
func Suggest(query string) []string
func TopicNames() []string
type Entry
type EntryKind
type Kind
type Options
type Result
- func Search(q string) []Result
- func (r Result) Name() string
- func (r Result) Summary() string
type Topic
- func All() []Topic
- func LookupTopic(name string) (*Topic, bool)
- func Topics(k Kind) []Topic
- func (t *Topic) Constants() []Entry
- func (t *Topic) Functions() []Entry
- func (t *Topic) Keywords() []Entry

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func Lookup ¶

func Lookup(query string) (*Topic, *Entry, bool)

func LookupEntry ¶

func LookupEntry(qualified string) (*Topic, *Entry, bool)

func LookupMember ¶

func LookupMember(ns, member string) (*Topic, *Entry, bool)

func RenderAll ¶

func RenderAll(o Options) string

func RenderEntry ¶

func RenderEntry(t *Topic, e *Entry, o Options) string

func RenderIndex ¶

func RenderIndex(o Options) string

func RenderSearch ¶

func RenderSearch(results []Result, o Options) string

func RenderTopic ¶

func RenderTopic(t *Topic, o Options) string

func Suggest ¶

func Suggest(query string) []string

func TopicNames ¶

func TopicNames() []string

Types ¶

type Entry ¶

type Entry struct {
	Name      string
	Signature string
	Summary   string
	Detail    string
	Kind      EntryKind
}

type EntryKind ¶

type EntryKind string

const (
	EntryFunction EntryKind = "function"
	EntryMethod   EntryKind = "method"
	EntryConstant EntryKind = "constant"
	EntryField    EntryKind = "field"
	EntryKeyword  EntryKind = "keyword"
)

type Kind ¶

type Kind string

const (
	KindCore    Kind = "core"
	KindLibrary Kind = "library"
	KindModule  Kind = "module"
	KindObject  Kind = "object"
)

type Options ¶

type Options struct {
	Width int
	Color bool
}

type Result ¶

type Result struct {
	Topic *Topic
	Entry *Entry
}

func Search ¶

func Search(q string) []Result

func (Result) Name ¶

func (r Result) Name() string

func (Result) Summary ¶

func (r Result) Summary() string

type Topic ¶

type Topic struct {
	Name          string
	Kind          Kind
	Aliases       []string
	Title         string
	Synopsis      string
	Detail        string
	Entries       []Entry
	Example       string
	SeeAlso       []string
	RuntimeModule string
	RuntimeGlobal string
	Requireable   bool
}

func All ¶

func All() []Topic

func LookupTopic ¶

func LookupTopic(name string) (*Topic, bool)

func Topics ¶

func Topics(k Kind) []Topic

func (*Topic) Constants ¶

func (t *Topic) Constants() []Entry

func (*Topic) Functions ¶

func (t *Topic) Functions() []Entry

func (*Topic) Keywords ¶

func (t *Topic) Keywords() []Entry

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL