toml

README

xk6-toml

A k6 extension enables k6 tests to comfortably encode and decode TOML values.

The underlying implementation is https://github.com/pelletier/go-toml

Built for k6 using xk6.

Usage

Import an entire module's contents:

import * as TOML from "k6/x/toml";

Import a single export from a module:

import { parse } from "k6/x/toml";

API

Functions:

• parse
• stringify

For complete API documentation click here!

Build

To build a k6 binary with this extension, first ensure you have the prerequisites:

• Go toolchain
• Git

Then:

1. Install xk6:

$ go install go.k6.io/xk6/cmd/xk6@latest

1. Build the binary:

$ xk6 build --with github.com/szkiba/xk6-toml@latest

Documentation

Index

• type Module
  • func New() *Module
  • func (m *Module) Parse(text string) (interface{}, error)
  • func (m *Module) Stringify(value interface{}) (string, error)

Types

type Module

type Module struct{}

func New

func New() *Module

func (*Module) Parse

func (m *Module) Parse(text string) (interface{}, error)

func (*Module) Stringify

func (m *Module) Stringify(value interface{}) (string, error)