Skip to content

bevry-archive/tiered-map

Repository files navigation

Tiered Map

Travis CI Build Status NPM version NPM downloads Dependency Status Dev Dependency Status
GitHub Sponsors donate button Patreon donate button Flattr donate button Liberapay donate button Buy Me A Coffee donate button Open Collective donate button crypto donate button PayPal donate button Wishlist browse button

A simple map of key value pairs with support for tiers (e.g. defaults go at tier 25, standards go at 50, and overrides go at tier 75)

Usage

var TieredMap = require('tiered-map')

var m = new TieredMap({
	tiers: {
		'high': 75
	}
	onChangeListener: function(key, newValue, oldValue){
		console.log('The key', key, 'changed from', oldValue, 'to', newValue)
	}
})

m.set('name', 'ben')  // name defaults to ben (default level is 50)
m.set('name', 'bob', 25)  // name will stay bob
m.set('name', null)  // name will become bob
m.set('name', 'john', 'high')  // name will become john

console.log(m.get('name', 75))  // will output john
console.log(m.get('name'))  // will output nothing
console.log(m.get('name', 25))  // will output bob

console.log(m.getTier('high'))  // will output 75

Very useful for having multiple tiers of data attributes with different priorities. For example, you could have default values at tier 25, adjusted values at tier 50, and override values at tier 75.

Install

npm

  • Install: npm install --save tiered-map
  • Import: import * as pkg from ('tiered-map')
  • Require: const pkg = require('tiered-map')

jspm

<script type="module">
    import * as pkg from '//dev.jspm.io/[email protected]'
</script>

This package is published with the following editions:

  • tiered-map aliases tiered-map/source/index.js
  • tiered-map/source/index.js is ESNext source code for Node.js 10 || 12 || 13 || 14 with Require for modules
  • tiered-map/edition-browsers/index.js is ESNext compiled for web browsers with Require for modules

History

Discover the release history by heading on over to the HISTORY.md file.

Contribute

Discover how you can contribute by heading on over to the CONTRIBUTING.md file.

Backers

Maintainers

These amazing people are maintaining this project:

Sponsors

No sponsors yet! Will you be the first?

GitHub Sponsors donate button Patreon donate button Flattr donate button Liberapay donate button Buy Me A Coffee donate button Open Collective donate button crypto donate button PayPal donate button Wishlist browse button

Contributors

These amazing people have contributed code to this project:

Discover how you can contribute by heading on over to the CONTRIBUTING.md file.

License

Unless stated otherwise all works are:

and licensed under: