remove is default, delete is aliased (with caveats). Thanks @mathiasbynens. Closes #1

Author: olov

README.md

@@ -3,6 +3,12 @@ A fast and robust stringmap implementation that can hold any string keys,
 including `__proto__`, with minimal overhead compared to a plain object.
 Works in node and browsers.
 
+The API is created to be as close to the ES6 Map API as possible. Prefer
+`sm.remove("key")` for deleting a key. ES6 Map uses `map.delete("key")`
+instead and for that reason `sm['delete']("key")` is available as a
+stringmap alias as well. Never do `sm.delete("key")` unless you're
+certain to be in the land of ES5 or later.
+
 
 
 ## Examples
@@ -17,7 +23,7 @@ sm1.set("check", true);
 sm1.set("__proto__", -1);
 console.log(sm1.has("greeting")); // true
 console.log(sm1.get("__proto__")); // -1
-sm1.delete("greeting");
+sm1.remove("greeting");
 console.log(sm1.keys()); // [ 'check', '__proto__' ]
 console.log(sm1.values()); // [ true, -1 ]
 console.log(sm1.items()); // [ [ 'check', true ], [ '__proto__', -1 ] ]

examples.js

@@ -6,7 +6,7 @@ sm1.set("check", true);
 sm1.set("__proto__", -1);
 console.log(sm1.has("greeting")); // true
 console.log(sm1.get("__proto__")); // -1
-sm1.delete("greeting");
+sm1.remove("greeting");
 console.log(sm1.keys()); // [ 'check', '__proto__' ]
 console.log(sm1.values()); // [ true, -1 ]
 console.log(sm1.items()); // [ [ 'check', true ], [ '__proto__', -1 ] ]

stringmap.js

@@ -106,7 +106,7 @@ var StringMap = (function() {
         }
     };
 
-    stringmap.prototype['delete'] = function(key) {
+    stringmap.prototype.remove = function(key) {
         if (typeof key !== "string") {
             throw new Error("StringMap expected string key");
         }
@@ -120,6 +120,12 @@ var StringMap = (function() {
         return didExist;
     };
 
+    // alias remove to delete but beware:
+    // sm.delete("key"); // OK in ES5 and later
+    // sm['delete']("key"); // OK in all ES versions
+    // sm.remove("key"); // OK in all ES versions
+    stringmap.prototype['delete'] = stringmap.prototype.remove;
+
     stringmap.prototype.isEmpty = function() {
         for (var key in this.obj) {
             if (hasOwnProperty.call(this.obj, key)) {