complete

Documentation

Overview

Package complete provides types to aid with auto-completion of Flux scripts in editors.

Index

• type Completer
  • func DefaultCompleter() Completer
  • func NewCompleter(scope values.Scope) Completer
  • func (c Completer) FunctionNames() []string
  • func (c Completer) FunctionSuggestion(name string) (FunctionSuggestion, error)
  • func (c Completer) Names() []string
  • func (c Completer) Value(name string) (values.Value, error)
• type FunctionSuggestion

Types

type Completer

type Completer struct {
	// contains filtered or unexported fields
}

Completer provides methods for suggestions in Flux queries.

func DefaultCompleter

func DefaultCompleter() Completer

DefaultCompleter creates a completer with builtin scope

func NewCompleter

func NewCompleter(scope values.Scope) Completer

NewCompleter creates a new completer from scope.

func (Completer) FunctionNames

func (c Completer) FunctionNames() []string

FunctionNames returns the names of all function.

func (Completer) FunctionSuggestion

func (c Completer) FunctionSuggestion(name string) (FunctionSuggestion, error)

FunctionSuggestion returns information needed for autocomplete suggestions for the function with the given name.

func (Completer) Names

func (c Completer) Names() []string

Names returns the slice of names in scope.

func (Completer) Value

func (c Completer) Value(name string) (values.Value, error)

Value returns a value based on the expression name, if one exists.

type FunctionSuggestion

type FunctionSuggestion struct {
	Params map[string]string
}

FunctionSuggestion provides suggestion information about a function.