https://github.com/szkiba/xk6-yaml

A k6 extension enables to encode and decode YAML values
https://github.com/szkiba/xk6-yaml

xk6 xk6-javascript-k6-x-yaml

Last synced: 5 days ago
JSON representation

A k6 extension enables to encode and decode YAML values

• Host: GitHub
• URL: https://github.com/szkiba/xk6-yaml
• Owner: szkiba
• License: mit
• Created: 2021-05-12T12:58:04.000Z (over 3 years ago)
• Default Branch: master
• Last Pushed: 2024-09-13T13:05:40.000Z (about 2 months ago)
• Last Synced: 2024-10-24T13:58:27.425Z (10 days ago)
• Topics: xk6, xk6-javascript-k6-x-yaml
• Language: JavaScript
• Homepage:
• Size: 59.6 KB
• Stars: 5
• Watchers: 3
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# xk6-yaml

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

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

Built for [k6](https://go.k6.io/k6) using [xk6](https://github.com/grafana/xk6).

## Usage

Import an entire module's contents:

```JavaScript

import * as YAML from "k6/x/yaml";

```

Import a single export from a module:

```JavaScript

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

```

## API

Functions:

- [parse](docs/README.md#parse)

- [stringify](docs/README.md#stringify)

For complete API documentation click [here](docs/README.md)!

## Build

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

- [Go toolchain](https://go101.org/article/go-toolchain.html)

- Git

Then:

1. Install `xk6`:

  ```bash

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

  ```

2. Build the binary:

  ```bash

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

  ```