Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func GetJSModules ¶
func GetJSModules() map[string]interface{}
GetJSModules returns a map of all registered js modules
Types ¶
type Exports ¶
type Exports struct {
// Default is what will be the `default` export of a module
Default interface{}
// Named is the named exports of a module
Named map[string]interface{}
}
Exports is representation of ESM exports of a module
type Instance ¶
type Instance interface {
Exports() Exports
}
Instance is what a module needs to return
type Module ¶
type Module interface {
// NewModuleInstance will get modules.VU that should provide the module with a way to interact with the VU
// This method will be called for *each* require/import and should return an unique instance for each call
NewModuleInstance(VU) Instance
}
Module is the interface js modules should implement in order to get access to the VU
type VU ¶
type VU interface {
// Context return the context.Context about the current VU
Context() context.Context
// InitEnv returns common.InitEnvironment instance if present
InitEnv() *common.InitEnvironment
// State returns lib.State if any is present
State() *lib.State
// Runtime returns the goja.Runtime for the current VU
Runtime() *goja.Runtime
// RegisterCallback lets a JS module declare that it wants to run a function
// on the event loop *at a later point in time*. See the documentation for
// `EventLoop.RegisterCallback()` in the `k6/js/eventloop` Go module for
// the very important details on its usage and restrictions.
//
// Notice: This API is EXPERIMENTAL and may be changed, renamed or
// completely removed in a later k6 release.
RegisterCallback() (enqueueCallback func(func() error))
}
VU gives access to the currently executing VU to a module Instance
Directories
¶
| Path | Synopsis |
|---|---|
|
Package k6 implements the module imported as 'k6' from inside k6.
|
Package k6 implements the module imported as 'k6' from inside k6. |
|
experimental
Package experimental includes experimental module features
|
Package experimental includes experimental module features |
|
html
generated by js/modules/k6/html/gen/gen_elements.go; DO NOT EDIT
|
generated by js/modules/k6/html/gen/gen_elements.go; DO NOT EDIT |
|
html/gen
command
|
|
Click to show internal directories.
Click to hide internal directories.