common

Documentation

Index

• Variables
• func Bind(rt *goja.Runtime, v interface{}, ctxPtr *context.Context) map[string]interface{}
• func BindToGlobal(rt *goja.Runtime, data map[string]interface{}) func()
• func FieldName(t reflect.Type, f reflect.StructField) string
• func GetRuntime(ctx context.Context) *goja.Runtime
• func MethodName(t reflect.Type, m reflect.Method) string
• func MustCompile(filename, src string, strict bool) *goja.Program
• func NewRandSource() goja.RandSource
• func RunString(rt *goja.Runtime, src string) (goja.Value, error)
• func Throw(rt *goja.Runtime, err error)
• func WithRuntime(ctx context.Context, rt *goja.Runtime) context.Context
• func WithState(ctx context.Context, state *State) context.Context
• type FieldNameMapper
  • func (FieldNameMapper) FieldName(t reflect.Type, f reflect.StructField) string
  • func (FieldNameMapper) MethodName(t reflect.Type, m reflect.Method) string
• type State
  • func GetState(ctx context.Context) *State

Variables

var DefaultRandSource = NewRandSource()

Functions

func Bind

func Bind(rt *goja.Runtime, v interface{}, ctxPtr *context.Context) map[string]interface{}

func BindToGlobal

func BindToGlobal(rt *goja.Runtime, data map[string]interface{}) func()

Binds an object's members to the global scope. Returns a function that un-binds them. Note that this will panic if passed something that isn't a struct; please don't do that.

func FieldName

func FieldName(t reflect.Type, f reflect.StructField) string

Returns the JS name for an exported struct field. The name is snake_cased, with respect for certain common initialisms (URL, ID, HTTP, etc).

func GetRuntime

func GetRuntime(ctx context.Context) *goja.Runtime

func MethodName

func MethodName(t reflect.Type, m reflect.Method) string

Returns the JS name for an exported method. The first letter of the method's name is lowercased, otherwise it is unaltered.

func MustCompile

func MustCompile(filename, src string, strict bool) *goja.Program

Panic if the provided source can't be compiled.

func NewRandSource

func NewRandSource() goja.RandSource

func RunString

func RunString(rt *goja.Runtime, src string) (goja.Value, error)

Runs an ES6 string in the given runtime. Use this rather than writing ES5 in tests.

func Throw

func Throw(rt *goja.Runtime, err error)

Throws a JS error; avoids re-wrapping GoErrors.

func WithRuntime

func WithRuntime(ctx context.Context, rt *goja.Runtime) context.Context

func WithState

func WithState(ctx context.Context, state *State) context.Context

Types

type FieldNameMapper

type FieldNameMapper struct{}

FieldNameMapper for goja.Runtime.SetFieldNameMapper()

func (FieldNameMapper) FieldName

func (FieldNameMapper) FieldName(t reflect.Type, f reflect.StructField) string

func (FieldNameMapper) MethodName

func (FieldNameMapper) MethodName(t reflect.Type, m reflect.Method) string

type State

type State struct {
	// Global options.
	Options lib.Options

	// Logger. Avoid using the global logger.
	Logger *log.Logger

	// Current group; all emitted metrics are tagged with this.
	Group *lib.Group

	// Networking equipment.
	HTTPTransport http.RoundTripper
	Dialer        *netext.Dialer
	CookieJar     *cookiejar.Jar

	// Sample buffer, emitted at the end of the iteration.
	Samples []stats.Sample

	// Bytes sent and received during this iteration. Use `sync/atomic`.
	BytesRead, BytesWritten int64
}

Provides volatile state for a VU.

func GetState

func GetState(ctx context.Context) *State