paraphrase 3.1.0-rc-dcd4648 → 3.1.0

package/CHANGELOG.md

@@ -1,8 +1,18 @@
+# 3.1.0 2022-11-29
+
+## Features
+
+Add type definitions for TypeScript.
+
+## Internal
+
+Move to TypeScript.
+
 # 3.0.0 2021-09-21
 
 ## Breaking change
 
-### All exports are named
+- All exports are named.
 
 ```js
 import { paraphrase } from "paraphrase";
@@ -20,6 +30,4 @@ import { dollar } from "paraphrase";
 
 ## Breaking change
 
-### Remove compiled version.
-
-If you are using a bundler with babel, make sure you transpile this package to your liking
+- Remove compiled version: If you are using a bundler with babel, make sure you transpile this package to your liking.

package/index.js

@@ -59,15 +59,16 @@ var VALID_RESULT_TYPES = Object.seal([
   "string",
   "number"
 ]);
-function paraphrase(...patterns) {
+function paraphrase(...args) {
   const options = {
     recursive: true,
     resolve: true,
     clean: false
   };
-  if (patterns.length && isObject(patterns[patterns.length - 1])) {
-    Object.assign(options, patterns.pop());
+  if (args.length && isObject(args[args.length - 1])) {
+    Object.assign(options, args.pop());
   }
+  const patterns = args.flat().filter((arg) => arg instanceof RegExp);
   Object.freeze(patterns);
   function phraser(string = "", data, ...replacements) {
     if (typeof string !== "string") {

package/index.mjs

@@ -28,15 +28,16 @@ var VALID_RESULT_TYPES = Object.seal([
   "string",
   "number"
 ]);
-function paraphrase(...patterns) {
+function paraphrase(...args) {
   const options = {
     recursive: true,
     resolve: true,
     clean: false
   };
-  if (patterns.length && isObject(patterns[patterns.length - 1])) {
-    Object.assign(options, patterns.pop());
+  if (args.length && isObject(args[args.length - 1])) {
+    Object.assign(options, args.pop());
   }
+  const patterns = args.flat().filter((arg) => arg instanceof RegExp);
   Object.freeze(patterns);
   function phraser(string = "", data, ...replacements) {
     if (typeof string !== "string") {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "paraphrase",
-  "version": "3.1.0-rc-dcd4648",
+  "version": "3.1.0",
   "description": "🧩 Create flavoured string template interpolation",
   "keywords": [
     "string",
@@ -52,8 +52,5 @@
     "jest": "^29.3.1",
     "prettier": "^2.8.0",
     "ts-jest": "^29.0.3"
-  },
-  "publishConfig": {
-    "tag": "typescript"
   }
 }

package/types/index.d.ts

@@ -12,25 +12,33 @@ interface IParaphraseOptions {
      */
     clean?: boolean;
 }
-interface Parser {
-    (string: string | undefined, ...data: (Record<string, any> | string | number)[]): string;
+interface Phraser {
+    (
+    /**
+     * Template string to parse
+     */
+    string: string | undefined, 
+    /**
+     * Data to use for interpolation, preferrably an object, but an array will work too, and a primitive values will be treated as an array of "...rest" arguments
+     */
+    ...data: (Record<string, any> | any)[]): string;
     patterns: RegExp[];
 }
 /**
  * Create new paraphrase method instance
- * @param  {...RegExp[]} replacers
- * @param  {IParaphraseOptions} [options]
- * @returns {Function} phraser function instance
+ * @param  {...RegExp[]} replacers[] One or more patterns to use for string replacement
+ * @param  {IParaphraseOptions} [options] The last argument can be an options object
+ * @returns {Phraser} phraser function instance
  *
  * @example const phraser = paraphrase(/\${([^{}]*)}/gm);
  *
  * phraser('Hello, ${name}', {name: 'Martin'})
  */
-export declare function paraphrase(...patterns: (RegExp | IParaphraseOptions)[]): Parser;
-export declare const dollar: Parser;
-export declare const double: Parser;
-export declare const single: Parser;
-export declare const percent: Parser;
-export declare const hash: Parser;
-export declare const loose: Parser;
+export declare function paraphrase(...args: (RegExp | RegExp[] | IParaphraseOptions)[]): Phraser;
+export declare const dollar: Phraser;
+export declare const double: Phraser;
+export declare const single: Phraser;
+export declare const percent: Phraser;
+export declare const hash: Phraser;
+export declare const loose: Phraser;
 export {};

package/types/isObject/index.d.ts

@@ -1,6 +1,6 @@
 /**
  * Is this a basic object?
- * @param  {any} obj
- * @return {boolean}
+ * @param  {any} obj Target to test
+ * @return {boolean} true if object
  */
 export declare const isObject: (obj: any) => boolean;

package/types/notate/index.d.ts

@@ -1,9 +1,9 @@
 /**
  * Resolve dot notation strings
  *
- * @param  {Object} context Object to start notation search (defaults to global scope)
- * @param  {String} [string=''] Dot notation representation
- * @return {Any} Whatever it finds / undefined
+ * @param  {any} context Object to start notation search on (defaults to global scope)
+ * @param  {string} [string=''] Dot notation representation
+ * @return {any} Whatever it finds / undefined
  *
  * @example
  * const obj = {