scripting

Documentation

Overview

Package scripting provides a generic abstraction layer for running scripts at runtime.

Index

• Variables
• type AheadOfTimeEngine
• type Engine
• type Options

Variables

var DefaultOptions = Options{
	StackDepthLimit: 32,
	Timeout:         100 * time.Millisecond,
}

DefaultOptions are the default Options.

Types

type AheadOfTimeEngine

type AheadOfTimeEngine interface {
	Engine

	Compile(ctx context.Context, script string) (run func(context.Context, string, ...any) (func(any) error, error), err error)
}

AheadOfTimeEngine extends Engine with the capability of compiling the script ahead of time.

type Engine

type Engine interface {
	Run(ctx context.Context, script, fn string, params ...any) (func(target any) error, error)
}

Engine represents a scripting engine.

type Options

type Options struct {
	StackDepthLimit int
	Timeout         time.Duration
}

Options contains engine options.