0.0.1 • Published 8 years ago

index-store v0.0.1

Weekly downloads
1
License
ISC
Repository
github
Last release
8 years ago

Index Store

usage

var IndexStore = require("index-store");
var store = new IndexStore();

methods

  • getIndex
    • returns an unused index. If no valid values under max are available, returns -1
  • setMax
    • sets max index value. default max is 1073741823
  • isValid
    • returns true if supplied arg is an active index (a value returned by getIndex which has not been released)
  • releaseIndex
    • marks returned index as free for reuse

private properties

Property names starting with an underscore (_i, _key, _max) are meant to be private. There isn't anything keeping them from being read/written directly; the underscores are just meant to signify intended use.