# @pera-swarm/modes

> Mode configuration module for swarm operations

Latest version **1.0.4** (published 2020-11-10) · LGPL-2.1 license · 0 weekly downloads

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

## Install

```sh
npm install @pera-swarm/modes
pnpm add @pera-swarm/modes
yarn add @pera-swarm/modes
bun add @pera-swarm/modes
```

## Health

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

Negative: deprecated.

## Facts

| | |
|---|---|
| Version | 1.0.4 |
| Published | 2020-11-10 |
| First published | 2020-11-09 |
| Weekly downloads | 0 |
| License | LGPL-2.1 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 31.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Pera-Swarm |
| Maintainers | luk3sky |
| Keywords | Pera-Swarm, Swarm, Robotics, Virtual, Robotics, Swarm, Robotics, Controller, Modes |

## Links

- npm: https://www.npmjs.com/package/@pera-swarm/modes
- Repository: https://github.com/Pera-Swarm/modes
- Homepage: https://github.com/Pera-Swarm/modes#readme
- Issues: https://github.com/Pera-Swarm/modes/issues
- npm.io page: https://npm.io/package/@pera-swarm/modes

## Recent versions

- 1.0.4 (latest) — 2020-11-10
- 1.0.2 — 2020-11-10
- 1.0.1 — 2020-11-09
- 1.0.0 — 2020-11-09

## README

# @pera-swarm/modes

[![npm (scoped)](https://img.shields.io/npm/v/@pera-swarm/modes.svg)](https://github.com/Pera-Swarm/modes/)
[![GitHub issues](https://img.shields.io/github/issues/Pera-Swarm/modes)](https://github.com/Pera-Swarm/modes/issues)

# Install

```
$npm install --save @pera-swarm/modes
```

# Usage

```
const { Mode } = require('@pera-swarm/modes');

const exampleSetup = () => {
    console.log('setup fn');
};

const exampleFlow = () => {
    console.log('flow fn');
};

new Mode(exampleSetup, exampleFlow, 10000, 'server-mode').start();
```

or

```
const { defineBaseMode } = require('@pera-swarm/modes');

const exampleSetup = () => {
    console.log('setup fn');
};

const exampleFlow = () => {
    console.log('flow fn');
};

defineBaseMode(exampleSetup, exampleFlow);
```

or

```
const { start } = require('@pera-swarm/modes');

const exampleSetup = () => {
    console.log('setup fn');
};

const exampleFlow = () => {
    console.log('flow fn');
};

start(exampleSetup, exampleFlow, 1000, 'my-custom-mode');
```

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