HashMap Class for JavaScript

Description

This project provides a HashMap class that works both on NodeJS and the browser. HashMap instances store key/value pairs allowing keys of any type.

Unlike regular objects, keys won't not be stringified. For example numbers and strings won't be mixed, you can pass Date's, RegExp's, DOM Elements, anything! (even null and undefined)

Examples

Assume this for all examples below

var map = new HashMap();

If you're using this within Node, you first need to import the class

var HashMap = require('hashmap').HashMap;

Basic use case

map.set("some_key", "some value");
map.get("some_key"); // --> "some value"

No stringification

map.set("1", "string one");
map.set(1, "number one");
map.get("1"); // --> "string one"

A regular Object used as a map would yield "number one"

Objects as keys

var key = {};
var key2 = {};
map.set(key, 123);
map.set(key2, 321);
map.get(key); // --> 123

A regular Object used as a map would yield 321

Check the tests for some more real code.

TODO's

This project is in early development, so any feedback/changes are specially appreciated.

• (?) Allow extending the hashing function in a AOP way or by passing a service
• Implement iteration (map.each())
• Fix: The hashmap will expose an enumerable expando when Object.defineProperty doesn't exist maybe use a different hashing approach for this case like Array.indexOf
• Use a real test framework
• Make tests work on the browser
• Document the public API of HashMap's

License

(The MIT License)

Copyright (c) 2012 Ariel Flesler <[email protected]>

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.