Giter Site home page Giter Site logo

weighted-array's Introduction

๐ŸŽฒ Weighted Map

NPM version NPM downloads Build status Dependencies Coverage Status FOSSA Status

Select a random element from a weighted array.

๐Ÿ’พ Installation

The package is on the NPM registry as weighted-map. Simply install it with your NPM client of choice.

๐Ÿ”ง Usage

First, import the module:

const weightedMap = require('weighted-map')

The select() function takes a Map. Maps should be of type Map<T, number> where key T is your object, and value number is the relative weight for that key.

There is also the selectUnique*() ES6 generator which will return randomly but without sequential repeats.

Both return one object from the array, with the whole object intact.

๐Ÿ“ Example

// Import the module
const { select } = require('weighted-map')

const map = new Map()
  .set('ben', 1)
  .set('jerry', 2)

console.log(select(map)) // -> Will return 'jerry' twice as often as 'ben'

โค Thanks

License

FOSSA Status

weighted-array's People

Contributors

fossabot avatar lolpants avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.