feat: export defaults

codsen · Apr 10, 2022 · 89a0431 · 89a0431
1 parent 4bc7c0f
commit 89a0431
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 6 deletions.
diff --git a/packages/object-all-values-equal-to/README.md b/packages/object-all-values-equal-to/README.md
@@ -26,12 +26,14 @@
 
 ## Install
 
-The latest version is **ESM only**: Node 12+ is needed to use it and it must be `import`ed instead of `require`d. If your project is not on ESM yet and you want to use `require`, use an older version of this program, `2.1.0`.
+This package is ESM only: Node 12+ is needed to use it and it must be imported instead of required:
 
 ```bash
 npm i object-all-values-equal-to
 ```
 
+If you need a legacy version which works with `require`, use version 2.1.0
+
 ## Quick Take
 
 ```js

diff --git a/packages/object-all-values-equal-to/src/main.ts b/packages/object-all-values-equal-to/src/main.ts
@@ -10,6 +10,9 @@ const version: string = v;
 interface Opts {
   arraysMustNotContainPlaceholders: boolean;
 }
+const defaults: Opts = {
+  arraysMustNotContainPlaceholders: true,
+};
 
 // T H E   M A I N   F U N C T I O N   T H A T   D O E S   T H E   J O B
 // -----------------------------------------------------------------------------
@@ -81,13 +84,10 @@ function allEq(
   }
 
   // prep opts
-  let defaults: Opts = {
-    arraysMustNotContainPlaceholders: true,
-  };
   let opts: Opts = { ...defaults, ...originalOpts };
 
   // and finally,
   return allValuesEqualTo(inputOriginal, valueOriginal, opts);
 }
 
-export { allEq, version };
+export { allEq, defaults, version };
diff --git a/packages/object-all-values-equal-to/types/index.d.ts b/packages/object-all-values-equal-to/types/index.d.ts
@@ -2,10 +2,11 @@ declare const version: string;
 interface Opts {
   arraysMustNotContainPlaceholders: boolean;
 }
+declare const defaults: Opts;
 declare function allEq(
   inputOriginal: any,
   valueOriginal: any,
   originalOpts?: Partial<Opts>
 ): boolean;
 
-export { allEq, version };
+export { allEq, defaults, version };