Improvemed function naming (#8)

* bumped version number

* leafNodeMap -> mapLeafNodes

README.md

@@ -23,22 +23,22 @@ For example:
 
 ```typescript
 const addOne = (num) => num + 1
-const curried = leafNodeMap(addOne)(1)
-const uncurried = _leafNodeMap(addOne, 1)
+const curried = mapLeafNodes(addOne)(1)
+const uncurried = _mapLeafNodes(addOne, 1)
 const sameResult = curried === uncurried
 console.log(sameResult)
 // true
 ```
 
 ## Highlights
 
-### [leafNodeMap](https://github.com/taylorsweetman/taydash/blob/main/src/functions/leafNodeMap.ts)
+### [mapLeafNodes](https://github.com/taylorsweetman/taydash/blob/main/src/functions/mapLeafNodes.ts)
 
 - Curried function which iterates over a `JSONValue` (JSON style object, array, or primitive) and applies a passed function to each leaf node of the value.
 
 ```typescript
 const addOne = (num) => num + 1
-const result = leafNodeMap(addOne)({ num: 0, arr: [1, 2, 3] })
+const result = mapLeafNodes(addOne)({ num: 0, arr: [1, 2, 3] })
 console.log(result)
 // { num: 1, arr: [ 2, 3, 4 ] }
 ```

package.json

@@ -1,6 +1,6 @@
 {
   "name": "taydash",
-  "version": "1.1.0",
+  "version": "2.0.0",
   "description": "Helpful utility functions",
   "keywords": [
     "utility functions",

src/functions/leafNodeMap.test.ts → src/functions/mapLeafNodes.test.ts

@@ -1,8 +1,8 @@
 import { JSONArray, JSONLeaf, JSONObject, JSONValue } from '../types'
 import { identity } from 'lodash/fp'
-import { _leafNodeMap, leafNodeMap } from './leafNodeMap'
+import { _mapLeafNodes, mapLeafNodes } from './mapLeafNodes'
 
-describe('leafNodeMap', () => {
+describe('mapLeafNodes', () => {
   describe('with identity function', () => {
     it.each([
       [1, 1],
@@ -12,8 +12,8 @@ describe('leafNodeMap', () => {
     ])(
       'should apply function on leaf iterables correctly: %s -> %s',
       (iter: JSONLeaf, expected: JSONLeaf) => {
-        expect(leafNodeMap(identity)(iter)).toBe(expected)
-        expect(_leafNodeMap(identity, iter)).toBe(expected)
+        expect(mapLeafNodes(identity)(iter)).toBe(expected)
+        expect(_mapLeafNodes(identity, iter)).toBe(expected)
       }
     )
 
@@ -23,8 +23,8 @@ describe('leafNodeMap', () => {
     ])(
       'should return empty object or list when receiving empty object or list: %s -> %s',
       (iter: JSONObject | JSONArray, expected: JSONObject | JSONArray) => {
-        expect(leafNodeMap(identity)(iter)).toEqual(expected)
-        expect(_leafNodeMap(identity, iter)).toEqual(expected)
+        expect(mapLeafNodes(identity)(iter)).toEqual(expected)
+        expect(_mapLeafNodes(identity, iter)).toEqual(expected)
       }
     )
 
@@ -40,8 +40,8 @@ describe('leafNodeMap', () => {
     ])(
       'should correctly use applied functions on deeply nested JSONValue: %j -> %j',
       (iter: JSONValue, expected: JSONValue) => {
-        expect(leafNodeMap(identity)(iter)).toEqual(expected)
-        expect(_leafNodeMap(identity, iter)).toEqual(expected)
+        expect(mapLeafNodes(identity)(iter)).toEqual(expected)
+        expect(_mapLeafNodes(identity, iter)).toEqual(expected)
       }
     )
   })
@@ -57,8 +57,8 @@ describe('leafNodeMap', () => {
     ])(
       'should apply function on leaf iterables correctly: %s -> %s',
       (iter: JSONLeaf, expected: JSONLeaf) => {
-        expect(leafNodeMap(toOne)(iter)).toBe(expected)
-        expect(_leafNodeMap(toOne, iter)).toBe(expected)
+        expect(mapLeafNodes(toOne)(iter)).toBe(expected)
+        expect(_mapLeafNodes(toOne, iter)).toBe(expected)
       }
     )
 
@@ -68,8 +68,8 @@ describe('leafNodeMap', () => {
     ])(
       'should return empty object or list when receiving empty object or list: %s -> %s',
       (iter: JSONObject | JSONArray, expected: JSONObject | JSONArray) => {
-        expect(leafNodeMap(toOne)(iter)).toEqual(expected)
-        expect(_leafNodeMap(toOne, iter)).toEqual(expected)
+        expect(mapLeafNodes(toOne)(iter)).toEqual(expected)
+        expect(_mapLeafNodes(toOne, iter)).toEqual(expected)
       }
     )
 
@@ -82,8 +82,8 @@ describe('leafNodeMap', () => {
     ])(
       'should correctly use applied functions on deeply nested JSONValue: %j -> %j',
       (iter: JSONValue, expected: JSONValue) => {
-        expect(leafNodeMap(toOne)(iter)).toEqual(expected)
-        expect(_leafNodeMap(toOne, iter)).toEqual(expected)
+        expect(mapLeafNodes(toOne)(iter)).toEqual(expected)
+        expect(_mapLeafNodes(toOne, iter)).toEqual(expected)
       }
     )
   })

src/functions/leafNodeMap.ts → src/functions/mapLeafNodes.ts

@@ -4,20 +4,20 @@ import { isPlainObject, isArray, entries, pipe, reduce, map } from 'lodash/fp'
 const mapArray =
   (func: (a: JSONValue) => JSONValue) =>
   (iterable: JSONArray): JSONArray =>
-    map(leafNodeMap(func))(iterable)
+    map(mapLeafNodes(func))(iterable)
 
 const mapObject =
   (func: (a: JSONValue) => JSONValue) =>
   (iterable: JSONObject): JSONObject =>
     pipe(
       entries,
       reduce(
-        (accum, [key, val]) => ({ ...accum, [key]: leafNodeMap(func)(val) }),
+        (accum, [key, val]) => ({ ...accum, [key]: mapLeafNodes(func)(val) }),
         {} as JSONObject
       )
     )(iterable)
 
-export const leafNodeMap =
+export const mapLeafNodes =
   (func: (a: JSONValue) => JSONValue) =>
   (iterable: JSONValue): JSONValue => {
     if (isLeaf(iterable)) return func(iterable)
@@ -29,7 +29,7 @@ export const leafNodeMap =
     return null
   }
 
-export const _leafNodeMap = (
+export const _mapLeafNodes = (
   func: (a: JSONValue) => JSONValue,
   iterable: JSONValue
-): JSONValue => leafNodeMap(func)(iterable)
+): JSONValue => mapLeafNodes(func)(iterable)

src/index.ts

@@ -1,4 +1,4 @@
-export { leafNodeMap, _leafNodeMap } from './functions/leafNodeMap'
+export { mapLeafNodes, _mapLeafNodes } from './functions/mapLeafNodes'
 export {
   type JSONArray,
   type JSONLeaf,