# osk

> Exports a function that returns a function which oscillates between minimum and maximum values, with a specified step

Latest version **1.0.2** (published 2014-05-10) · MIT license · 0 weekly downloads

## Install

```sh
npm install osk
pnpm add osk
yarn add osk
bun add osk
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.2 |
| Published | 2014-05-10 |
| First published | 2014-04-06 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Dan Peddle |
| Maintainers | dazld |
| Keywords | oscillator, iterator |

## Links

- npm: https://www.npmjs.com/package/osk
- Repository: https://github.com/dazld/osk
- Issues: https://github.com/dazld/osk/issues
- npm.io page: https://npm.io/package/osk

## Recent versions

- 1.0.2 (latest) — 2014-05-10
- 1.0.1 — 2014-04-06
- 1.0.0 — 2014-04-06

## README

[![Build Status](https://travis-ci.org/dazld/osk.svg?branch=master)](https://travis-ci.org/dazld/osk)

osk
===

Exports a function that returns a function which oscillates between minimum and maximum values, with a specified step

```javascript

var osk = require('osk');

var myOsc = osk({
	min: 0,
	max: 3,
	inc: 1,
	reverse: false // default
});

myOsc(); // 0


var myOsc = osk({
	min: 0,
	max: 3,
	inc: 1,
	reverse: true // runs backwards
});

myOsc(); // 3

var myOsc = osk({
	min: 0,
	max: 3,
	inc: 1,
	reverse: true, // runs backwards
	start: 2

});

myOsc(); // 2, but running backwards now


```

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