paraphrase 3.1.0-rc-dcd4648 → 3.1.1

package/index.js

@@ -47,10 +47,25 @@ var isObject = (obj) => `${obj}` === "[object Object]";
 
 // src/flavours/index.ts
 var flavours = {
+  /**
+   * Template: 'Hello, ${name}'
+   */
   dollar: /\${([^{}]*)}/gm,
+  /**
+   * Template: 'Hello, {{name}}'
+   */
   double: /{{([^{}]*)}}/gm,
+  /**
+   * Template: 'Hello, {name}'
+   */
   single: /{([^{}]*)}/gm,
+  /**
+   * Template: 'Hello, #{name}'
+   */
   hash: /#{([^{}]*)}/gm,
+  /**
+   * Template: 'Hello, %{name}'
+   */
   percent: /%{([^{}]*)}/gm
 };
 
@@ -59,15 +74,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") {
@@ -118,3 +134,4 @@ var loose = paraphrase(
   percent,
   single
 });
+//# sourceMappingURL=index.js.map

package/index.js.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["src/index.ts", "src/notate/index.ts", "src/isObject/index.ts", "src/flavours/index.ts"],
+  "sourcesContent": ["import { notate } from \"./notate/index\";\nimport { isObject } from \"./isObject/index\";\nimport { flavours } from \"./flavours/index\";\n\n/**\n * Valid types of results for the interpolated string\n */\nconst VALID_RESULT_TYPES: [\"string\", \"number\"] = Object.seal([\n  \"string\",\n  \"number\",\n]);\n\ninterface IParaphraseOptions {\n  /**\n   * Should continue to resolve result string until replacements have been exhausted\n   */\n  recursive?: boolean;\n  /**\n   * Should resolve dot notation within template\n   */\n  resolve?: boolean;\n  /**\n   * Should remove unmatched template instances\n   */\n  clean?: boolean;\n}\n\ninterface Phraser {\n  (\n    /**\n     * Template string to parse\n     */\n    string: string | undefined,\n    /**\n     * 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\n     */\n    ...data: (Record<string, any> | any)[]\n  ): string;\n  patterns: RegExp[];\n}\n\n/**\n * Create new paraphrase method instance\n * @param  {...RegExp[]} replacers[] One or more patterns to use for string replacement\n * @param  {IParaphraseOptions} [options] The last argument can be an options object\n * @returns {Phraser} phraser function instance\n *\n * @example const phraser = paraphrase(/\\${([^{}]*)}/gm);\n *\n * phraser('Hello, ${name}', {name: 'Martin'})\n */\nexport function paraphrase(\n  ...args: (RegExp | RegExp[] | IParaphraseOptions)[]\n): Phraser {\n  const options: IParaphraseOptions = {\n    recursive: true,\n    resolve: true,\n    clean: false,\n  };\n  if (args.length && isObject(args[args.length - 1])) {\n    Object.assign(options, args.pop() as IParaphraseOptions);\n  }\n  const patterns = args.flat().filter((arg) => arg instanceof RegExp);\n\n  Object.freeze(patterns);\n\n  /**\n   * phraser description\n   * @param  {string}                 string       Template\n   * @param  {Object|(string|number)} data         Data for filling\n   * @param  {...(string|number)}     replacements Replacement for filling\n   * @return {string}                              Result\n   */\n  function phraser(\n    string: string = \"\",\n    data: string | number | Record<string, any>,\n    ...replacements: (string | number)[]\n  ): string {\n    if (typeof string !== \"string\") {\n      throw new TypeError(\n        `paraphrase expects first argument to be a string, got a ${typeof string} (${string})`\n      );\n    }\n\n    if (!data) {\n      return string;\n    }\n\n    if (VALID_RESULT_TYPES.includes(typeof data as any)) {\n      data = [data, ...replacements];\n    }\n\n    /**\n     * Replace method build with internal reference to the passed in data structure\n     * @param  {string} haystack The full string match\n     * @param  {string} needle   The content to identify as data member\n     * @return {string}         Found value\n     */\n    function replace(haystack: string, needle: string): string {\n      const replacement = options.resolve\n        ? notate(data, needle.trim())\n        : data[needle.trim()];\n\n      return VALID_RESULT_TYPES.includes(typeof replacement as any)\n        ? replacement\n        : options.clean\n        ? \"\"\n        : haystack;\n    }\n\n    const result = (patterns as RegExp[]).reduce(\n      (string: string, pattern: RegExp): string =>\n        string.replace(pattern, replace),\n      string\n    );\n\n    return !options.recursive || string === result\n      ? result\n      : phraser(result, data, ...replacements);\n  }\n\n  Object.defineProperty(phraser, \"patterns\", {\n    get: () => patterns,\n  });\n\n  return phraser as Phraser;\n}\n\nexport const dollar = paraphrase(flavours.dollar);\nexport const double = paraphrase(flavours.double);\nexport const single = paraphrase(flavours.single);\nexport const percent = paraphrase(flavours.percent);\nexport const hash = paraphrase(flavours.hash);\nexport const loose = paraphrase(\n  flavours.dollar,\n  flavours.double,\n  flavours.percent,\n  flavours.hash,\n  flavours.single\n);\n", "/**\n * Resolve dot notation strings\n *\n * @param  {any} context Object to start notation search on (defaults to global scope)\n * @param  {string} [string=''] Dot notation representation\n * @return {any} Whatever it finds / undefined\n *\n * @example\n * const obj = {\n *   top_level: {\n *     nested: {\n *       value: 'My Value'\n *     }\n *   }\n * };\n *\n * notate(obj, 'top_level.nested.value');\n * // 'My Value'\n *\n * notate(obj, 'top_level.missing.value');\n * // undefined\n */\nexport function notate(source: any, string: string = \"\"): any {\n  if (typeof string !== \"string\") {\n    throw new TypeError(\n      `Expected notation query to be a string, instead got ${typeof string} (${string})`\n    );\n  }\n  return string\n    .split(\".\")\n    .reduce(\n      (previous, current) =>\n        typeof previous === \"object\" && previous ? previous[current] : previous,\n      source\n    );\n}\n", "/**\n * Is this a basic object?\n * @param  {any} obj Target to test\n * @return {boolean} true if object\n */\nexport const isObject = (obj: any): boolean => `${obj}` === \"[object Object]\";\n", "export const flavours: Record<string, RegExp> = {\n  /**\n   * Template: 'Hello, ${name}'\n   */\n  dollar: /\\${([^{}]*)}/gm,\n  /**\n   * Template: 'Hello, {{name}}'\n   */\n  double: /{{([^{}]*)}}/gm,\n  /**\n   * Template: 'Hello, {name}'\n   */\n  single: /{([^{}]*)}/gm,\n  /**\n   * Template: 'Hello, #{name}'\n   */\n  hash: /#{([^{}]*)}/gm,\n  /**\n   * Template: 'Hello, %{name}'\n   */\n  percent: /%{([^{}]*)}/gm,\n};\n"],
+  "mappings": ";;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;;;ACsBO,SAAS,OAAO,QAAa,SAAiB,IAAS;AAC5D,MAAI,OAAO,WAAW,UAAU;AAC9B,UAAM,IAAI;AAAA,MACR,uDAAuD,OAAO,WAAW;AAAA,IAC3E;AAAA,EACF;AACA,SAAO,OACJ,MAAM,GAAG,EACT;AAAA,IACC,CAAC,UAAU,YACT,OAAO,aAAa,YAAY,WAAW,SAAS,OAAO,IAAI;AAAA,IACjE;AAAA,EACF;AACJ;;;AC9BO,IAAM,WAAW,CAAC,QAAsB,GAAG,UAAU;;;ACLrD,IAAM,WAAmC;AAAA;AAAA;AAAA;AAAA,EAI9C,QAAQ;AAAA;AAAA;AAAA;AAAA,EAIR,QAAQ;AAAA;AAAA;AAAA;AAAA,EAIR,QAAQ;AAAA;AAAA;AAAA;AAAA,EAIR,MAAM;AAAA;AAAA;AAAA;AAAA,EAIN,SAAS;AACX;;;AHdA,IAAM,qBAA2C,OAAO,KAAK;AAAA,EAC3D;AAAA,EACA;AACF,CAAC;AAyCM,SAAS,cACX,MACM;AACT,QAAM,UAA8B;AAAA,IAClC,WAAW;AAAA,IACX,SAAS;AAAA,IACT,OAAO;AAAA,EACT;AACA,MAAI,KAAK,UAAU,SAAS,KAAK,KAAK,SAAS,CAAC,CAAC,GAAG;AAClD,WAAO,OAAO,SAAS,KAAK,IAAI,CAAuB;AAAA,EACzD;AACA,QAAM,WAAW,KAAK,KAAK,EAAE,OAAO,CAAC,QAAQ,eAAe,MAAM;AAElE,SAAO,OAAO,QAAQ;AAStB,WAAS,QACP,SAAiB,IACjB,SACG,cACK;AACR,QAAI,OAAO,WAAW,UAAU;AAC9B,YAAM,IAAI;AAAA,QACR,2DAA2D,OAAO,WAAW;AAAA,MAC/E;AAAA,IACF;AAEA,QAAI,CAAC,MAAM;AACT,aAAO;AAAA,IACT;AAEA,QAAI,mBAAmB,SAAS,OAAO,IAAW,GAAG;AACnD,aAAO,CAAC,MAAM,GAAG,YAAY;AAAA,IAC/B;AAQA,aAAS,QAAQ,UAAkB,QAAwB;AACzD,YAAM,cAAc,QAAQ,UACxB,OAAO,MAAM,OAAO,KAAK,CAAC,IAC1B,KAAK,OAAO,KAAK,CAAC;AAEtB,aAAO,mBAAmB,SAAS,OAAO,WAAkB,IACxD,cACA,QAAQ,QACR,KACA;AAAA,IACN;AAEA,UAAM,SAAU,SAAsB;AAAA,MACpC,CAACA,SAAgB,YACfA,QAAO,QAAQ,SAAS,OAAO;AAAA,MACjC;AAAA,IACF;AAEA,WAAO,CAAC,QAAQ,aAAa,WAAW,SACpC,SACA,QAAQ,QAAQ,MAAM,GAAG,YAAY;AAAA,EAC3C;AAEA,SAAO,eAAe,SAAS,YAAY;AAAA,IACzC,KAAK,MAAM;AAAA,EACb,CAAC;AAED,SAAO;AACT;AAEO,IAAM,SAAS,WAAW,SAAS,MAAM;AACzC,IAAM,SAAS,WAAW,SAAS,MAAM;AACzC,IAAM,SAAS,WAAW,SAAS,MAAM;AACzC,IAAM,UAAU,WAAW,SAAS,OAAO;AAC3C,IAAM,OAAO,WAAW,SAAS,IAAI;AACrC,IAAM,QAAQ;AAAA,EACnB,SAAS;AAAA,EACT,SAAS;AAAA,EACT,SAAS;AAAA,EACT,SAAS;AAAA,EACT,SAAS;AACX;",
+  "names": ["string"]
+}

package/index.mjs

@@ -16,10 +16,25 @@ var isObject = (obj) => `${obj}` === "[object Object]";
 
 // src/flavours/index.ts
 var flavours = {
+  /**
+   * Template: 'Hello, ${name}'
+   */
   dollar: /\${([^{}]*)}/gm,
+  /**
+   * Template: 'Hello, {{name}}'
+   */
   double: /{{([^{}]*)}}/gm,
+  /**
+   * Template: 'Hello, {name}'
+   */
   single: /{([^{}]*)}/gm,
+  /**
+   * Template: 'Hello, #{name}'
+   */
   hash: /#{([^{}]*)}/gm,
+  /**
+   * Template: 'Hello, %{name}'
+   */
   percent: /%{([^{}]*)}/gm
 };
 
@@ -28,15 +43,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") {
@@ -86,3 +102,4 @@ export {
   percent,
   single
 };
+//# sourceMappingURL=index.mjs.map

package/index.mjs.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["src/notate/index.ts", "src/isObject/index.ts", "src/flavours/index.ts", "src/index.ts"],
+  "sourcesContent": ["/**\n * Resolve dot notation strings\n *\n * @param  {any} context Object to start notation search on (defaults to global scope)\n * @param  {string} [string=''] Dot notation representation\n * @return {any} Whatever it finds / undefined\n *\n * @example\n * const obj = {\n *   top_level: {\n *     nested: {\n *       value: 'My Value'\n *     }\n *   }\n * };\n *\n * notate(obj, 'top_level.nested.value');\n * // 'My Value'\n *\n * notate(obj, 'top_level.missing.value');\n * // undefined\n */\nexport function notate(source: any, string: string = \"\"): any {\n  if (typeof string !== \"string\") {\n    throw new TypeError(\n      `Expected notation query to be a string, instead got ${typeof string} (${string})`\n    );\n  }\n  return string\n    .split(\".\")\n    .reduce(\n      (previous, current) =>\n        typeof previous === \"object\" && previous ? previous[current] : previous,\n      source\n    );\n}\n", "/**\n * Is this a basic object?\n * @param  {any} obj Target to test\n * @return {boolean} true if object\n */\nexport const isObject = (obj: any): boolean => `${obj}` === \"[object Object]\";\n", "export const flavours: Record<string, RegExp> = {\n  /**\n   * Template: 'Hello, ${name}'\n   */\n  dollar: /\\${([^{}]*)}/gm,\n  /**\n   * Template: 'Hello, {{name}}'\n   */\n  double: /{{([^{}]*)}}/gm,\n  /**\n   * Template: 'Hello, {name}'\n   */\n  single: /{([^{}]*)}/gm,\n  /**\n   * Template: 'Hello, #{name}'\n   */\n  hash: /#{([^{}]*)}/gm,\n  /**\n   * Template: 'Hello, %{name}'\n   */\n  percent: /%{([^{}]*)}/gm,\n};\n", "import { notate } from \"./notate/index\";\nimport { isObject } from \"./isObject/index\";\nimport { flavours } from \"./flavours/index\";\n\n/**\n * Valid types of results for the interpolated string\n */\nconst VALID_RESULT_TYPES: [\"string\", \"number\"] = Object.seal([\n  \"string\",\n  \"number\",\n]);\n\ninterface IParaphraseOptions {\n  /**\n   * Should continue to resolve result string until replacements have been exhausted\n   */\n  recursive?: boolean;\n  /**\n   * Should resolve dot notation within template\n   */\n  resolve?: boolean;\n  /**\n   * Should remove unmatched template instances\n   */\n  clean?: boolean;\n}\n\ninterface Phraser {\n  (\n    /**\n     * Template string to parse\n     */\n    string: string | undefined,\n    /**\n     * 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\n     */\n    ...data: (Record<string, any> | any)[]\n  ): string;\n  patterns: RegExp[];\n}\n\n/**\n * Create new paraphrase method instance\n * @param  {...RegExp[]} replacers[] One or more patterns to use for string replacement\n * @param  {IParaphraseOptions} [options] The last argument can be an options object\n * @returns {Phraser} phraser function instance\n *\n * @example const phraser = paraphrase(/\\${([^{}]*)}/gm);\n *\n * phraser('Hello, ${name}', {name: 'Martin'})\n */\nexport function paraphrase(\n  ...args: (RegExp | RegExp[] | IParaphraseOptions)[]\n): Phraser {\n  const options: IParaphraseOptions = {\n    recursive: true,\n    resolve: true,\n    clean: false,\n  };\n  if (args.length && isObject(args[args.length - 1])) {\n    Object.assign(options, args.pop() as IParaphraseOptions);\n  }\n  const patterns = args.flat().filter((arg) => arg instanceof RegExp);\n\n  Object.freeze(patterns);\n\n  /**\n   * phraser description\n   * @param  {string}                 string       Template\n   * @param  {Object|(string|number)} data         Data for filling\n   * @param  {...(string|number)}     replacements Replacement for filling\n   * @return {string}                              Result\n   */\n  function phraser(\n    string: string = \"\",\n    data: string | number | Record<string, any>,\n    ...replacements: (string | number)[]\n  ): string {\n    if (typeof string !== \"string\") {\n      throw new TypeError(\n        `paraphrase expects first argument to be a string, got a ${typeof string} (${string})`\n      );\n    }\n\n    if (!data) {\n      return string;\n    }\n\n    if (VALID_RESULT_TYPES.includes(typeof data as any)) {\n      data = [data, ...replacements];\n    }\n\n    /**\n     * Replace method build with internal reference to the passed in data structure\n     * @param  {string} haystack The full string match\n     * @param  {string} needle   The content to identify as data member\n     * @return {string}         Found value\n     */\n    function replace(haystack: string, needle: string): string {\n      const replacement = options.resolve\n        ? notate(data, needle.trim())\n        : data[needle.trim()];\n\n      return VALID_RESULT_TYPES.includes(typeof replacement as any)\n        ? replacement\n        : options.clean\n        ? \"\"\n        : haystack;\n    }\n\n    const result = (patterns as RegExp[]).reduce(\n      (string: string, pattern: RegExp): string =>\n        string.replace(pattern, replace),\n      string\n    );\n\n    return !options.recursive || string === result\n      ? result\n      : phraser(result, data, ...replacements);\n  }\n\n  Object.defineProperty(phraser, \"patterns\", {\n    get: () => patterns,\n  });\n\n  return phraser as Phraser;\n}\n\nexport const dollar = paraphrase(flavours.dollar);\nexport const double = paraphrase(flavours.double);\nexport const single = paraphrase(flavours.single);\nexport const percent = paraphrase(flavours.percent);\nexport const hash = paraphrase(flavours.hash);\nexport const loose = paraphrase(\n  flavours.dollar,\n  flavours.double,\n  flavours.percent,\n  flavours.hash,\n  flavours.single\n);\n"],
+  "mappings": ";AAsBO,SAAS,OAAO,QAAa,SAAiB,IAAS;AAC5D,MAAI,OAAO,WAAW,UAAU;AAC9B,UAAM,IAAI;AAAA,MACR,uDAAuD,OAAO,WAAW;AAAA,IAC3E;AAAA,EACF;AACA,SAAO,OACJ,MAAM,GAAG,EACT;AAAA,IACC,CAAC,UAAU,YACT,OAAO,aAAa,YAAY,WAAW,SAAS,OAAO,IAAI;AAAA,IACjE;AAAA,EACF;AACJ;;;AC9BO,IAAM,WAAW,CAAC,QAAsB,GAAG,UAAU;;;ACLrD,IAAM,WAAmC;AAAA;AAAA;AAAA;AAAA,EAI9C,QAAQ;AAAA;AAAA;AAAA;AAAA,EAIR,QAAQ;AAAA;AAAA;AAAA;AAAA,EAIR,QAAQ;AAAA;AAAA;AAAA;AAAA,EAIR,MAAM;AAAA;AAAA;AAAA;AAAA,EAIN,SAAS;AACX;;;ACdA,IAAM,qBAA2C,OAAO,KAAK;AAAA,EAC3D;AAAA,EACA;AACF,CAAC;AAyCM,SAAS,cACX,MACM;AACT,QAAM,UAA8B;AAAA,IAClC,WAAW;AAAA,IACX,SAAS;AAAA,IACT,OAAO;AAAA,EACT;AACA,MAAI,KAAK,UAAU,SAAS,KAAK,KAAK,SAAS,CAAC,CAAC,GAAG;AAClD,WAAO,OAAO,SAAS,KAAK,IAAI,CAAuB;AAAA,EACzD;AACA,QAAM,WAAW,KAAK,KAAK,EAAE,OAAO,CAAC,QAAQ,eAAe,MAAM;AAElE,SAAO,OAAO,QAAQ;AAStB,WAAS,QACP,SAAiB,IACjB,SACG,cACK;AACR,QAAI,OAAO,WAAW,UAAU;AAC9B,YAAM,IAAI;AAAA,QACR,2DAA2D,OAAO,WAAW;AAAA,MAC/E;AAAA,IACF;AAEA,QAAI,CAAC,MAAM;AACT,aAAO;AAAA,IACT;AAEA,QAAI,mBAAmB,SAAS,OAAO,IAAW,GAAG;AACnD,aAAO,CAAC,MAAM,GAAG,YAAY;AAAA,IAC/B;AAQA,aAAS,QAAQ,UAAkB,QAAwB;AACzD,YAAM,cAAc,QAAQ,UACxB,OAAO,MAAM,OAAO,KAAK,CAAC,IAC1B,KAAK,OAAO,KAAK,CAAC;AAEtB,aAAO,mBAAmB,SAAS,OAAO,WAAkB,IACxD,cACA,QAAQ,QACR,KACA;AAAA,IACN;AAEA,UAAM,SAAU,SAAsB;AAAA,MACpC,CAACA,SAAgB,YACfA,QAAO,QAAQ,SAAS,OAAO;AAAA,MACjC;AAAA,IACF;AAEA,WAAO,CAAC,QAAQ,aAAa,WAAW,SACpC,SACA,QAAQ,QAAQ,MAAM,GAAG,YAAY;AAAA,EAC3C;AAEA,SAAO,eAAe,SAAS,YAAY;AAAA,IACzC,KAAK,MAAM;AAAA,EACb,CAAC;AAED,SAAO;AACT;AAEO,IAAM,SAAS,WAAW,SAAS,MAAM;AACzC,IAAM,SAAS,WAAW,SAAS,MAAM;AACzC,IAAM,SAAS,WAAW,SAAS,MAAM;AACzC,IAAM,UAAU,WAAW,SAAS,OAAO;AAC3C,IAAM,OAAO,WAAW,SAAS,IAAI;AACrC,IAAM,QAAQ;AAAA,EACnB,SAAS;AAAA,EACT,SAAS;AAAA,EACT,SAAS;AAAA,EACT,SAAS;AAAA,EACT,SAAS;AACX;",
+  "names": ["string"]
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "paraphrase",
-  "version": "3.1.0-rc-dcd4648",
+  "version": "3.1.1",
   "description": "🧩 Create flavoured string template interpolation",
   "keywords": [
     "string",
@@ -40,6 +40,13 @@
     }
   },
   "types": "./types/index.d.ts",
+  "files": [
+    "index.js",
+    "index.js.map",
+    "index.mjs",
+    "index.mjs.map",
+    "types/index.d.ts"
+  ],
   "scripts": {
     "test": "jest",
     "format": "prettier --write .",
@@ -47,13 +54,10 @@
     "prepublishOnly": "npm run build"
   },
   "devDependencies": {
-    "@types/jest": "^29.2.3",
-    "esbuild": "^0.15.16",
-    "jest": "^29.3.1",
-    "prettier": "^2.8.0",
-    "ts-jest": "^29.0.3"
-  },
-  "publishConfig": {
-    "tag": "typescript"
+    "@types/jest": "^29.4.0",
+    "esbuild": "^0.17.4",
+    "jest": "^29.4.0",
+    "prettier": "^2.8.3",
+    "ts-jest": "^29.0.5"
   }
 }

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/CHANGELOG.md

@@ -1,25 +0,0 @@
-# 3.0.0 2021-09-21
-
-## Breaking change
-
-### All exports are named
-
-```js
-import { paraphrase } from "paraphrase";
-```
-
-### Flavoured imports included
-
-Flavoured pre-made versions should be imported from main entry and not from directory.
-
-```js
-import { dollar } from "paraphrase";
-```
-
-# 2.0.0 2021-05-11
-
-## Breaking change
-
-### Remove compiled version.
-
-If you are using a bundler with babel, make sure you transpile this package to your liking

package/types/flavours/index.d.ts

@@ -1 +0,0 @@
-export declare const flavours: Record<string, RegExp>;

package/types/isObject/index.d.ts

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

package/types/notate/index.d.ts

@@ -1,23 +0,0 @@
-/**
- * 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
- *
- * @example
- * const obj = {
- *   top_level: {
- *     nested: {
- *       value: 'My Value'
- *     }
- *   }
- * };
- *
- * notate(obj, 'top_level.nested.value');
- * // 'My Value'
- *
- * notate(obj, 'top_level.missing.value');
- * // undefined
- */
-export declare function notate(source: any, string?: string): any;