doc: Merged old docs for Hash#merge, updated example.

This commit is contained in:
tjcrowder 2009-09-10 15:07:28 +01:00
parent 305e79e5d3
commit ab5a19a1c1
1 changed files with 13 additions and 1 deletions

View File

@ -176,10 +176,22 @@ var Hash = Class.create(Enumerable, (function() {
/**
* Hash#merge(object) -> Hash
* - object (Object | Hash): The object to merge with this hash to produce
* the resulting hash.
*
* Returns a new `Hash` instance with `object`'s key/value pairs merged in;
* this hash remains unchanged.
*
* Returns a new hash with `object`'s key/value pairs merged in.
* To modify the original hash in place, use [[Hash#update]].
*
* ### Example
*
* var h = $H({one: "uno", two: "due"});
* var h2 = h.merge({three: "tre"});
* h.keys();
* // -> ["one", "two"] (unchanged)
* h2.keys();
* // -> ["one", "two", "three"] (has merged contents)
**/
function merge(object) {
return this.clone().update(object);