javascript

package

v0.22.0 Latest Latest Go to latest Published: Dec 27, 2025 License: MIT Imports: 16 Imported by: 0

Details

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

Repository

github.com/daveshanley/vacuum

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
func BuildVM() *goja.Runtime
type CoreFunction
type JSEnabledRuleFunction
- func NewJSRuleFunction(ruleName, script string) JSEnabledRuleFunction
type JSRuleFunction

Constants ¶

View Source

const DefaultRuleTimeout = 5 * time.Second

DefaultRuleTimeout is the default timeout for JavaScript rule execution

Variables ¶

This section is empty.

Functions ¶

func BuildVM ¶ added in v0.14.2

func BuildVM() *goja.Runtime

BuildVM returns a new goja runtime, a VM if you will.

Types ¶

type CoreFunction ¶

type CoreFunction func(input any, context model.RuleFunctionContext) []model.RuleFunctionResult

type JSEnabledRuleFunction ¶

type JSEnabledRuleFunction interface {
	RunRule(nodes []*yaml.Node, context model.RuleFunctionContext) []model.RuleFunctionResult
	GetSchema() model.RuleFunctionSchema
	CheckScript() error
	RunScript() error
	RegisterCoreFunction(name string, function CoreFunction)
	GetCategory() string
}

func NewJSRuleFunction ¶

func NewJSRuleFunction(ruleName, script string) JSEnabledRuleFunction

type JSRuleFunction ¶

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

func (*JSRuleFunction) CheckScript ¶

func (j *JSRuleFunction) CheckScript() error

func (*JSRuleFunction) GetCategory ¶ added in v0.10.0

func (j *JSRuleFunction) GetCategory() string

func (*JSRuleFunction) GetSchema ¶

func (j *JSRuleFunction) GetSchema() model.RuleFunctionSchema

func (*JSRuleFunction) RegisterCoreFunction ¶

func (j *JSRuleFunction) RegisterCoreFunction(name string, function CoreFunction)

func (*JSRuleFunction) RunRule ¶

func (j *JSRuleFunction) RunRule(nodes []*yaml.Node, ruleContext model.RuleFunctionContext) []model.RuleFunctionResult

func (*JSRuleFunction) RunScript ¶

func (j *JSRuleFunction) RunScript() error

func (*JSRuleFunction) SetTimeout ¶ added in v0.22.0

func (j *JSRuleFunction) SetTimeout(timeout time.Duration)

SetTimeout sets the timeout for async rule execution. If not set, DefaultRuleTimeout (5 seconds) is used.

Source Files ¶

View all Source files

js_plugin.go

Directories ¶

Path	Synopsis
eventloop Package eventloop provides an event loop implementation for running asynchronous JavaScript code with Goja.	Package eventloop provides an event loop implementation for running asynchronous JavaScript code with Goja.
fetch Package fetch provides a Web Fetch API compliant implementation for use with Goja JavaScript runtime and the vacuum event loop.	Package fetch provides a Web Fetch API compliant implementation for use with Goja JavaScript runtime and the vacuum event loop.

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