# chancify

> a simple api for running javascript functions based upon percentage chance

Latest version **1.1.0** (published 2017-08-04) · ISC license · 0 weekly downloads

## Install

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

## 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.1.0 |
| Published | 2017-08-04 |
| First published | 2017-08-03 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | danmakenoise |
| Maintainers | danmakenoise |
| Keywords | javascript, chance, percentage, random, functions |

## Links

- npm: https://www.npmjs.com/package/chancify
- Repository: https://github.com/danmakenoise/chancify
- Homepage: https://github.com/danmakenoise/chancify#readme
- Issues: https://github.com/danmakenoise/chancify/issues
- npm.io page: https://npm.io/package/chancify

## Alternatives

- [jsforce](https://npm.io/package/jsforce.md) — 851.2K weekly downloads
- [react-native-qrcode-svg](https://npm.io/package/react-native-qrcode-svg.md) — 693.5K weekly downloads
- [@salesforce/plugin-data](https://npm.io/package/@salesforce/plugin-data.md) — 394.9K weekly downloads
- [@backstage/plugin-search-common](https://npm.io/package/@backstage/plugin-search-common.md) — 308.5K weekly downloads
- [@chain-registry/types](https://npm.io/package/@chain-registry/types.md) — 38.4K weekly downloads

## Recent versions

- 1.1.0 (latest) — 2017-08-04
- 1.0.0 — 2017-08-04
- 0.1.1 — 2017-08-03
- 0.1.0 — 2017-08-03

## README

# Chancify the Wrapper [![Build Status](https://travis-ci.org/danmakenoise/chancify.svg?branch=master)](https://travis-ci.org/danmakenoise/chancify)

A simple API for wrapping javascript functions so they only run occasionally based upon percentage chance. Arguments will pass through!


## Syntax
`chancify(func, percentChance)`


## Arguments
`func` : A function you only want to run part of the time.

`percentChance` : A decimal value between 0 and 1 indicating the percentage chance you would like the function to run with.


## Return
Chancify returns a function. Call it with the same arguments as you would your original one and it will only run part of the time, based upon the chance you passed in.


## Examples

```javascript
const chancify = require('chancify');

function _foo(string) {
  console.log(string);
}

const foo = chancify(_foo, 1 / 10);

foo('hello world'); // 1 in 10 chance it will actually console log 'hello world'
```

```javascript
const chancify = require('chancify');

function bar(a, b) {
  return a + b;
}

module.exports = chancify(bar, 50 / 100); // exported function will only run 50% of the time
```

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