feat(maps): Add append

Add Maps.append to match other modules. Add TypeDoc comments for all append functions.

Author: danielrbradley

src/arrays.ts

@@ -100,7 +100,17 @@ export function collect<T, U>(a: any, b?: any): any {
   return partial ? exec : exec(a)
 }
 
+/**
+ * Wraps the two given arrays as a single concatenated array.
+ * @param second The second array.
+ * @param first The first array.
+ */
 export function append<T>(second: T[]): (first: T[]) => T[]
+/**
+ * Wraps the two given arrays as a single concatenated array.
+ * @param first The first array.
+ * @param second The second array.
+ */
 export function append<T>(first: T[], second: T[]): T[]
 export function append<T>(a: any, b?: any): any {
   const partial = b === undefined

src/iterables.ts

@@ -109,6 +109,7 @@ export function collect<T, U>(a: any, b?: any): any {
 /**
  * Wraps the two given iterables as a single concatenated iterable.
  * @param second The second iterable.
+ * @param first The first iterable.
  */
 export function append<T>(second: Iterable<T>): (first: Iterable<T>) => Iterable<T>
 /**

src/maps.ts

@@ -122,6 +122,27 @@ export function choose<Key, T, U>(a: any, b?: any): any {
   return partial ? exec : exec(a)
 }
 
+/**
+ * Wraps the two given maps as a single concatenated map.
+ * @param second The second map.
+ * @param first The first map.
+ */
+export function append<Key, T>(second: Map<Key, T>): (first: Map<Key, T>) => Map<Key, T>
+/**
+ * Wraps the two given maps as a single concatenated map.
+ * @param first The first map.
+ * @param second The second map.
+ */
+export function append<Key, T>(first: Map<Key, T>, second: Map<Key, T>): Map<Key, T>
+export function append<Key, T>(a: any, b?: any): any {
+  const partial = b === undefined
+  const second: Map<Key, T> = partial ? a : b
+  function exec(first: Map<Key, T>): Map<Key, T> {
+    return new Map<Key, T>(Iterables.append(first, second))
+  }
+  return partial ? exec : exec(a)
+}
+
 export function get<Key, T>(key: Key): (source: Map<Key, T>) => T
 export function get<Key, T>(source: Map<Key, T>, key: Key): T
 export function get<Key, T>(a: any, b?: any): any {

src/sets.ts

@@ -120,7 +120,17 @@ export function collect<T, U>(a: any, b?: any): any {
   return partial ? exec : exec(a)
 }
 
+/**
+ * Wraps the two given sets as a single concatenated set.
+ * @param second The second set.
+ * @param first The first set.
+ */
 export function append<T>(second: Set<T>): (first: Set<T>) => Set<T>
+/**
+ * Wraps the two given sets as a single concatenated set.
+ * @param first The first set.
+ * @param second The second set.
+ */
 export function append<T>(first: Set<T>, second: Set<T>): Set<T>
 export function append<T>(a: any, b?: any): any {
   const partial = b === undefined

test/maps.test.ts

@@ -76,6 +76,22 @@ describe('choose', () => {
   })
 })
 
+describe('append', () => {
+  test('immediate', () => {
+    expect(Maps.append(new Map([['a', 1], ['b', 2]]), new Map([['b', 2], ['c', 3]]))).toEqual(
+      new Map([['a', 1], ['b', 2], ['c', 3]])
+    )
+  })
+  test('piped', () => {
+    expect(
+      pipe(
+        new Map([['a', 1], ['b', 2], ['c', 3]]),
+        Maps.append(new Map([['a', 1], ['b', 2], ['c', 3]]))
+      )
+    ).toEqual(new Map([['a', 1], ['b', 2], ['c', 3]]))
+  })
+})
+
 describe('get', () => {
   test('immediate', () => {
     expect(Maps.get(new Map([['a', 1], ['b', 2]]), 'b')).toEqual(2)