replace-all-mustaches 0.0.3 → 0.0.5

package/README.md

@@ -4,3 +4,14 @@ Replace all mustache templates in a string, including recursive mustache values
 # install
 ``npm i replace-all-mustaches``
 
+# elements
+## VariableView
+A mustache view containing any number of [].
+
+All views are accessed are accessed during [replaceAllMustaches()](#replaceallmustaches), which looks at the base class's static collection.
+
+## Variable
+The variables that fill a [VariableView](#variableview), consisting of a key and a value
+
+## replaceAllMustaches
+The main function: iterates over the static collection of the [VariableView](#variableview) class, including all of the [Variables](#variable) created.

package/dist/index.cjs

@@ -34,7 +34,7 @@ __export(index_exports, {
   VariableView: () => VariableView,
   hasDuplicates: () => hasDuplicates,
   hasMustacheTags: () => hasMustacheTags,
-  renderUntilStable: () => renderUntilStable
+  replaceAllMustaches: () => replaceAllMustaches
 });
 module.exports = __toCommonJS(index_exports);
 
@@ -86,7 +86,7 @@ var VariableView = class _VariableView {
 };
 
 // src/nodes/replaceAllMustaches.ts
-function renderUntilStable(template, view, { maxPasses = 20, detectCycles = true } = {}) {
+function replaceAllMustaches(template, view, { maxPasses = 20, detectCycles = true } = {}) {
   let current = template;
   const seen = /* @__PURE__ */ new Set();
   let pass = 0;
@@ -131,5 +131,5 @@ var Variable = class {
   VariableView,
   hasDuplicates,
   hasMustacheTags,
-  renderUntilStable
+  replaceAllMustaches
 });

package/dist/index.d.cts

@@ -30,10 +30,10 @@ declare class VariableView {
     replace(variableKey: string, value: string | Function): void;
 }
 
-type replaceAllMustaches = {
+type MustacheIterationOptions = {
     maxPasses?: number;
     detectCycles?: boolean;
 };
-declare function renderUntilStable(template: string, view: VariableView, { maxPasses, detectCycles }?: replaceAllMustaches): string;
+declare function replaceAllMustaches(template: string, view: VariableView, { maxPasses, detectCycles }?: MustacheIterationOptions): string;
 
-export { type MustacheValue, Variable, VariableView, hasDuplicates, hasMustacheTags, renderUntilStable };
+export { type MustacheValue, Variable, VariableView, hasDuplicates, hasMustacheTags, replaceAllMustaches };

package/dist/index.d.ts

@@ -30,10 +30,10 @@ declare class VariableView {
     replace(variableKey: string, value: string | Function): void;
 }
 
-type replaceAllMustaches = {
+type MustacheIterationOptions = {
     maxPasses?: number;
     detectCycles?: boolean;
 };
-declare function renderUntilStable(template: string, view: VariableView, { maxPasses, detectCycles }?: replaceAllMustaches): string;
+declare function replaceAllMustaches(template: string, view: VariableView, { maxPasses, detectCycles }?: MustacheIterationOptions): string;
 
-export { type MustacheValue, Variable, VariableView, hasDuplicates, hasMustacheTags, renderUntilStable };
+export { type MustacheValue, Variable, VariableView, hasDuplicates, hasMustacheTags, replaceAllMustaches };

package/dist/index.js

@@ -46,7 +46,7 @@ var VariableView = class _VariableView {
 };
 
 // src/nodes/replaceAllMustaches.ts
-function renderUntilStable(template, view, { maxPasses = 20, detectCycles = true } = {}) {
+function replaceAllMustaches(template, view, { maxPasses = 20, detectCycles = true } = {}) {
   let current = template;
   const seen = /* @__PURE__ */ new Set();
   let pass = 0;
@@ -90,5 +90,5 @@ export {
   VariableView,
   hasDuplicates,
   hasMustacheTags,
-  renderUntilStable
+  replaceAllMustaches
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "replace-all-mustaches",
-  "version": "0.0.3",
+  "version": "0.0.5",
   "description": "Replace all mustache templates in a string, including recursive mustache values",
   "main": "./dist/index.js",
   "module": "./dist/index.mjs",

package/src/nodes/replaceAllMustaches.ts

@@ -2,15 +2,15 @@ import Mustache from "mustache";
 import { VariableView } from "./VariableView";
 import { hasMustacheTags } from "./helperFunctions";
 
-type replaceAllMustaches = {
+type MustacheIterationOptions = {
   maxPasses?: number;
   detectCycles?: boolean;
 };
 
-export function renderUntilStable(
+export function replaceAllMustaches(
     template: string,
     view: VariableView,
-    { maxPasses = 20, detectCycles = true }: replaceAllMustaches = {},
+    { maxPasses = 20, detectCycles = true }: MustacheIterationOptions = {},
     ): string {
         let current = template;
         const seen = new Set<string>();