experimental

README

Experimental Modules

This folder are here as a documentation and reference point for k6's experimental modules.

Although accessible in k6 scripts under the k6/experimental import path, those modules implementations live in their own repository and are not part of the k6 stable release yet:

• k6/experimental/k6-redis
• k6/experimental/k6-websockets
• k6/experimental/k6-timers

While we intend to keep these modules as stable as possible, we may need to add features or introduce breaking changes. This could happen at any time until we release the module as stable. use them at your own risk.

Documentation

Overview

Package experimental includes experimental module features

Index

• type ModuleInstance
  • func (mi *ModuleInstance) Exports() modules.Exports
• type RootModule
  • func New() *RootModule
  • func (*RootModule) NewModuleInstance(m modules.VU) modules.Instance

Types

type ModuleInstance

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

ModuleInstance represents an instance of the experimental module

func (*ModuleInstance) Exports

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

Exports returns the exports of the experimental module

type RootModule

type RootModule struct{}

RootModule is the root experimental module

func New

func New() *RootModule

New returns a new RootModule.

func (*RootModule) NewModuleInstance

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

NewModuleInstance implements modules.Module interface