reference-map

This is a simple determinstic map that maps POJOs to an integer

Usage no npm install needed!

<script type="module">
  import referenceMap from 'https://cdn.skypack.dev/reference-map';
</script>

README

NPM Package Build Status Coverage Status

js-standard-style

install

npm install referanceMap

SYNOPSIS

This is a simple determinstic map that maps POJOs to an integer.

API

constructor

index.js:5-7

Handle mapping arbitary JS object to ints

add

index.js:16-18

Adds an object to the referance map returning an int to be used as a referance

Parameters

  • obj any
  • type any optional

Returns integer

get

index.js:26-32

gets a POJO given a refernce as an int

Parameters

  • ref integer
  • typeCheck
  • type Object optional

Returns any

delete

index.js:39-41

deletes an object given a referance as an int

Parameters

  • ref
  • integer

Returns boolean whether or not the object was deleted

clear

index.js:46-48

clears the referance map of a objects

size

index.js:54-56

returns the number of items in the refernace map

Returns integer

has

index.js:62-65

tests wether a given referance is valid or not

Parameters

  • ref

Returns boolean

LICENSE

MPL-2.0