k6

Documentation

Overview

Package k6 implements the module imported as 'k6' from inside k6.

Index

• Variables
• type K6
  • func (mi *K6) Check(arg0, checks goja.Value, extras ...goja.Value) (bool, error)
  • func (mi *K6) Exports() modules.Exports
  • func (*K6) Fail(msg string) (goja.Value, error)
  • func (mi *K6) Group(name string, val goja.Value) (goja.Value, error)
  • func (mi *K6) RandomSeed(seed int64)
  • func (mi *K6) Sleep(secs float64)
• type RootModule
  • func New() *RootModule
  • func (*RootModule) NewModuleInstance(vu modules.VU) modules.Instance

Variables

var (
	// ErrGroupInInitContext is returned when group() are using in the init context.
	ErrGroupInInitContext = common.NewInitContextError("Using group() in the init context is not supported")

	// ErrCheckInInitContext is returned when check() are using in the init context.
	ErrCheckInInitContext = common.NewInitContextError("Using check() in the init context is not supported")
)

Types

type K6

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

K6 represents an instance of the k6 module.

func (*K6) Check

func (mi *K6) Check(arg0, checks goja.Value, extras ...goja.Value) (bool, error)

Check will emit check metrics for the provided checks.

func (*K6) Exports

func (mi *K6) Exports() modules.Exports

Exports returns the exports of the k6 module.

func (*K6) Fail

func (*K6) Fail(msg string) (goja.Value, error)

Fail is a fancy way of saying `throw "something"`.

func (*K6) Group

func (mi *K6) Group(name string, val goja.Value) (goja.Value, error)

Group wraps a function call and executes it within the provided group name.

func (*K6) RandomSeed

func (mi *K6) RandomSeed(seed int64)

RandomSeed sets the seed to the random generator used for this VU.

func (*K6) Sleep

func (mi *K6) Sleep(secs float64)

Sleep waits the provided seconds before continuing the execution.

type RootModule

type RootModule struct{}

RootModule is the global module instance that will create module instances for each VU.

func New

func New() *RootModule

New returns a pointer to a new RootModule instance.

func (*RootModule) NewModuleInstance

func (*RootModule) NewModuleInstance(vu modules.VU) modules.Instance

NewModuleInstance implements the modules.Module interface to return a new instance for each VU.