Merge 7910eb8 into d64044a

CHANGELOG

@@ -1,8 +1,19 @@
+# v1.2.1
+
+Fixed:
+
+- Fix `mergeForEach` documentation
+- Export proper TypeScript definitions
+
+# v1.2.0
+
+Ported to Typescript.
+
 # v1.1.2
 
 Fixes:
 
-- Fix mapNonNil require path in fromPairsMapNonNil file
+- Fix `mapNonNil` require path in `fromPairsMapNonNil` file
 
 # v1.1.1
 

docs/fromPairsMap.ts.html

@@ -87,7 +87,7 @@ <h1 class="page-title">
 
 <section>
   <article>
-    <pre class="prettyprint source linenums"><code>import _ from 'lodash'
+    <pre class="prettyprint source linenums"><code>import * as _ from 'lodash'
 
 export default fromPairsMap
 

docs/fromPairsMapNonNil.ts.html

@@ -87,7 +87,7 @@ <h1 class="page-title">
 
 <section>
   <article>
-    <pre class="prettyprint source linenums"><code>import _, { ObjectIterator } from 'lodash'
+    <pre class="prettyprint source linenums"><code>import * as _ from 'lodash'
 
 import mapNonNil from './mapNonNil'
 
@@ -108,7 +108,7 @@ <h1 class="page-title">
   TResult
 > (
   collection: Collection,
-  iteratee: ObjectIterator&lt;CollectionItem, [PropertyName, TResult] | null | undefined>
+  iteratee: _.ObjectIterator&lt;CollectionItem, [PropertyName, TResult] | null | undefined>
 ) {
   return _.fromPairs(mapNonNil(collection, iteratee) as any) // Cast to any since this typecheck is user's responsibility
 }

docs/getTruthyKeys.ts.html

@@ -87,7 +87,7 @@ <h1 class="page-title">
 
 <section>
   <article>
-    <pre class="prettyprint source linenums"><code>import _ from 'lodash'
+    <pre class="prettyprint source linenums"><code>import * as _ from 'lodash'
 
 export default getTruthyKeys
 

docs/index.ts.html

@@ -116,6 +116,17 @@ <h1 class="page-title">
 
   return _
 }
+
+export {
+  fromPairsMap,
+  fromPairsMapNonNil,
+  getTruthyKeys,
+  hasTruthyValues,
+  mapNonNil,
+  mergeForEach,
+  mGet,
+  shortcuttedReduce
+}
 </code></pre>
   </article>
 </section>

docs/mGet.ts.html

@@ -87,7 +87,7 @@ <h1 class="page-title">
 
 <section>
   <article>
-    <pre class="prettyprint source linenums"><code>import _ from 'lodash'
+    <pre class="prettyprint source linenums"><code>import * as _ from 'lodash'
 
 export default mGet
 

docs/mapNonNil.ts.html

@@ -87,7 +87,7 @@ <h1 class="page-title">
 
 <section>
   <article>
-    <pre class="prettyprint source linenums"><code>import _, { ObjectIterator, Dictionary } from 'lodash'
+    <pre class="prettyprint source linenums"><code>import * as _ from 'lodash'
 
 export default mapNonNil
 
@@ -102,12 +102,12 @@ <h1 class="page-title">
   CollectionItem extends any,
   Collection extends (
     ArrayLike&lt;CollectionItem | null | undefined> |
-    Dictionary&lt;CollectionItem | null | undefined>
+    _.Dictionary&lt;CollectionItem | null | undefined>
   ),
   ResultValue
 > (
   collection: Collection,
-  iteratee: ObjectIterator&lt;CollectionItem, ResultValue | null | undefined>
+  iteratee: _.ObjectIterator&lt;CollectionItem, ResultValue | null | undefined>
 ) {
   return _.filter(_.map(collection, iteratee), isNotNil)
 

docs/mergeForEach.ts.html

@@ -87,7 +87,7 @@ <h1 class="page-title">
 
 <section>
   <article>
-    <pre class="prettyprint source linenums"><code>import _ from 'lodash'
+    <pre class="prettyprint source linenums"><code>import * as _ from 'lodash'
 import { SORTING_ORDER } from './constants'
 import { ValueOf } from './types'
 
@@ -255,13 +255,13 @@ <h1 class="page-title">
      * @param options.rightCallback Callback called when there are elements in
      * the right-hand-side collection which cannot be matched with any element
      * of the left-hand-side collection.
-     * @param comparator Function used to compare an item of `lhs` collection
-     * against an item of `rhs` collection. Negative values mean that `lhs` item
-     * is **before** `rhs` item, positive values that `lhs` item is **after**
-     * `rhs` item and `0` that both items are equivalent in terms of sorting.
-     * Default implementation is equivalent to `&lt;` operator. Will receive as 3rd
-     * and 4th parameters the iteratees used to get sorting value for `lhs` and
-     * `rhs`.
+     * @param options.comparator Function used to compare an item of `lhs`
+     * collection against an item of `rhs` collection. Negative values mean that
+     * `lhs` item is **before** `rhs` item, positive values that `lhs` item is
+     * **after** `rhs` item and `0` that both items are equivalent in terms of
+     * sorting. Default implementation is equivalent to `&lt;` operator. Will
+     * receive as 3rd and 4th parameters the iteratees used to get sorting value
+     * for `lhs` and `rhs`.
      */
     mergeForEach&lt;
       L extends any,

docs/shortcuttedReduce.ts.html

@@ -87,7 +87,7 @@ <h1 class="page-title">
 
 <section>
   <article>
-    <pre class="prettyprint source linenums"><code>import _ from 'lodash'
+    <pre class="prettyprint source linenums"><code>import * as _ from 'lodash'
 import { ValueOf } from './types'
 
 export default shortcuttedReduce

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@geoblink/lodash-mixins",
-  "version": "1.2.0",
+  "version": "1.2.1-beta.2",
   "description": "A collection of useful functions built on top of Lodash",
   "main": "dist/index.js",
   "files": [

src/fromPairsMap.ts

@@ -1,4 +1,4 @@
-import _ from 'lodash'
+import * as _ from 'lodash'
 
 export default fromPairsMap
 

src/fromPairsMapNonNil.ts

@@ -1,4 +1,4 @@
-import _, { ObjectIterator } from 'lodash'
+import * as _ from 'lodash'
 
 import mapNonNil from './mapNonNil'
 
@@ -19,7 +19,7 @@ export function fromPairsMapNonNil <
   TResult
 > (
   collection: Collection,
-  iteratee: ObjectIterator<CollectionItem, [PropertyName, TResult] | null | undefined>
+  iteratee: _.ObjectIterator<CollectionItem, [PropertyName, TResult] | null | undefined>
 ) {
   return _.fromPairs(mapNonNil(collection, iteratee) as any) // Cast to any since this typecheck is user's responsibility
 }

src/getTruthyKeys.ts

@@ -1,4 +1,4 @@
-import _ from 'lodash'
+import * as _ from 'lodash'
 
 export default getTruthyKeys
 

src/index.ts

@@ -27,3 +27,14 @@ export default function (_: LoDashStatic) {
 
   return _
 }
+
+export {
+  fromPairsMap,
+  fromPairsMapNonNil,
+  getTruthyKeys,
+  hasTruthyValues,
+  mapNonNil,
+  mergeForEach,
+  mGet,
+  shortcuttedReduce
+}

src/mGet.ts

@@ -1,4 +1,4 @@
-import _ from 'lodash'
+import * as _ from 'lodash'
 
 export default mGet
 

src/mapNonNil.ts

@@ -1,4 +1,4 @@
-import _, { ObjectIterator, Dictionary } from 'lodash'
+import * as _ from 'lodash'
 
 export default mapNonNil
 
@@ -13,12 +13,12 @@ function mapNonNil<
   CollectionItem extends any,
   Collection extends (
     ArrayLike<CollectionItem | null | undefined> |
-    Dictionary<CollectionItem | null | undefined>
+    _.Dictionary<CollectionItem | null | undefined>
   ),
   ResultValue
 > (
   collection: Collection,
-  iteratee: ObjectIterator<CollectionItem, ResultValue | null | undefined>
+  iteratee: _.ObjectIterator<CollectionItem, ResultValue | null | undefined>
 ) {
   return _.filter(_.map(collection, iteratee), isNotNil)
 

src/mergeForEach.ts

@@ -1,4 +1,4 @@
-import _ from 'lodash'
+import * as _ from 'lodash'
 import { SORTING_ORDER } from './constants'
 import { ValueOf } from './types'
 
@@ -166,13 +166,13 @@ declare module 'lodash' {
      * @param options.rightCallback Callback called when there are elements in
      * the right-hand-side collection which cannot be matched with any element
      * of the left-hand-side collection.
-     * @param comparator Function used to compare an item of `lhs` collection
-     * against an item of `rhs` collection. Negative values mean that `lhs` item
-     * is **before** `rhs` item, positive values that `lhs` item is **after**
-     * `rhs` item and `0` that both items are equivalent in terms of sorting.
-     * Default implementation is equivalent to `<` operator. Will receive as 3rd
-     * and 4th parameters the iteratees used to get sorting value for `lhs` and
-     * `rhs`.
+     * @param options.comparator Function used to compare an item of `lhs`
+     * collection against an item of `rhs` collection. Negative values mean that
+     * `lhs` item is **before** `rhs` item, positive values that `lhs` item is
+     * **after** `rhs` item and `0` that both items are equivalent in terms of
+     * sorting. Default implementation is equivalent to `<` operator. Will
+     * receive as 3rd and 4th parameters the iteratees used to get sorting value
+     * for `lhs` and `rhs`.
      */
     mergeForEach<
       L extends any,

src/shortcuttedReduce.ts

@@ -1,4 +1,4 @@
-import _ from 'lodash'
+import * as _ from 'lodash'
 import { ValueOf } from './types'
 
 export default shortcuttedReduce

test/e2e/index.spec.ts

@@ -1,4 +1,4 @@
-import _ from 'lodash'
+import * as _ from 'lodash'
 import lodashMixins from '../..'
 import { expect } from 'chai'
 
@@ -15,7 +15,7 @@ describe('Exported package', function () {
 
   describe('When loading exported package', function () {
     before('Load mixins', function () {
-      lodashMixins(_)
+      lodashMixins(_ as unknown as _.LoDashStatic)
     })
 
     for (const method of injectedMethods) {

test/integration/index.spec.ts

@@ -1,10 +1,18 @@
-import _ from 'lodash'
-import lodashMixins from '../../src/index'
+import * as _ from 'lodash'
+import lodashMixins, * as namedExports from '../../src/index'
 import { expect } from 'chai'
 
 import injectedMethods from '../exportedMethods'
 
 describe('Exported package', function () {
+  describe('Named exports', function () {
+    for (const method of injectedMethods) {
+      it(`Should export have named export «${method}»`, function () {
+        expect(namedExports).to.have.property(method).that.is.a('function')
+      })
+    }
+  })
+
   describe('Before loading mixins', function () {
     for (const method of injectedMethods) {
       it(`Should not have «${method}» present`, function () {
@@ -15,7 +23,7 @@ describe('Exported package', function () {
 
   describe('When loading exported package', function () {
     before('Load mixins', function () {
-      lodashMixins(_)
+      lodashMixins(_ as unknown as _.LoDashStatic)
     })
 
     for (const method of injectedMethods) {