# @asyncapi/fluffy-robot

> The asyncapi command line library to test your app at scale.

Latest version **0.3.0** (published 2021-08-02) · Apache-2.0 license · 0 weekly downloads

> **Deprecated.** This package is deprecated.

## Install

```sh
npm install @asyncapi/fluffy-robot
pnpm add @asyncapi/fluffy-robot
yarn add @asyncapi/fluffy-robot
bun add @asyncapi/fluffy-robot
```

Provides the command `simulator`.

## Health

**Score 10/100 (F)** — status: deprecated.

Negative: deprecated.

## Facts

| | |
|---|---|
| Version | 0.3.0 |
| Published | 2021-08-02 |
| First published | 2021-06-28 |
| Weekly downloads | 0 |
| License | Apache-2.0 |
| TypeScript types | none |
| Module format | CommonJS |
| Node | 14.15.5 |
| Dependencies | 6 |
| Unpacked size | 111 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | NektariosFifes |
| Maintainers | fmvilas, derberg, asyncapi-bot |
| Keywords | asyncapi, simulation |

## Links

- npm: https://www.npmjs.com/package/@asyncapi/fluffy-robot
- npm.io page: https://npm.io/package/@asyncapi/fluffy-robot

## Dependencies (6)

- [ajv](https://npm.io/package/ajv.md) ^8.6.0
- [chalk](https://npm.io/package/chalk.md) ^4.1.0
- [js-yaml](https://npm.io/package/js-yaml.md) ^3.14.1
- [commander](https://npm.io/package/commander.md) ^7.2.0
- [async-mqtt](https://npm.io/package/async-mqtt.md) ^2.6.1
- [@asyncapi/parser](https://npm.io/package/@asyncapi/parser.md) ^1.4.1

## Alternatives

- [promise-throttle](https://npm.io/package/promise-throttle.md) — 44.2K weekly downloads
- [@commercetools/sync-actions](https://npm.io/package/@commercetools/sync-actions.md) — 25.1K weekly downloads
- [cwait](https://npm.io/package/cwait.md) — 21.4K weekly downloads
- [@ledgerhq/hw-app-cosmos](https://npm.io/package/@ledgerhq/hw-app-cosmos.md) — 4.2K weekly downloads
- [@financial-times/o-loading](https://npm.io/package/@financial-times/o-loading.md) — 2.8K weekly downloads

## Recent versions

- 0.3.0 (latest) — 2021-08-02
- 0.2.0 — 2021-07-08
- 0.1.0 — 2021-06-28

## README

# AsyncApi Simulator
___

 In development
 
---

Ever wondered what it would feel like your application to 
be the center of interest?

Does it seem distant or difficult to switch from development mode
to production mode?

#### Define and simulate scenarios for your applications and create statistics.



Usage

```
simulator -f ./my_api.yaml -s ./scenario.yaml
simulator -f ../subdirectory/my_api.json -s ./scenario.json
```

Run sample application by specifying the corresponding 
AsyncApi and scenario files.
```
simulator -f ./example-projects/game-processor/asyncapi.yaml -s ./example-projects/game-processor/scenario.yaml
or
simulator -b ../ -f ./simulatorFolder/example-projects/game-processor/asyncapi.yaml -s ./simulatorFolder/example-projects/game-processor/scenario.yaml
```



### Cli

```
Options:
  -v                     AsyncApi simulator cli version.
  -f, --filepath <type>  The filepath of a AsyncAPI document, as either yaml or json file.
  -s, --scenario <type>  The filepath of a json or yaml file which defines a scenario based on the spec.
  -b, --basedir <type>   The basePath from which relative paths are computed.
                         Defaults to the directory where simulator.sh resides. (default: "./").
  -h, --help             Display help for flags and commands.

```

### Supported Protocols

- mqtt

### AsyncApi File

The file where the api you want to test is defined. By specifying the x-plot: {id} field
under a channel will automatically make the channel available for sending requests.



### Scenario File

Here with the plot-{id} (where id is the same as the x-plot: {id} in the field you specified in the AsyncAPI channel) field you:
- Connect your AsyncApi and scenario File.
- Specify the parameters for each channel and have the options for them to be randomly generated.
- Specify the payload you want to send.

---
_Source: https://npm.io/package/@asyncapi/fluffy-robot · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._