mikel 0.28.0 → 0.29.0

package/README.md

@@ -433,10 +433,10 @@ const result = m(template, data, options);
 console.log(result); // Output: "Hello, World!"
 ```
 
-Custom helper functions receive a single object as argument, containing the following keys:
+Custom helper functions receive a single `params` object as argument, containing the following fields:
 
 - `args`: an array containing the variables with the helper is called in the template.
-- `opt`: an object containing the keyword arguments provided to the helper.
+- `options`: an object containing the keyword arguments provided to the helper.
 - `data`: the current data where the helper has been executed.
 - `variables`: an object containing the runtime variables available in the current context (e.g., `@root`, `@index`, etc.).
 - `fn`: a function that executes the template provided in the helper block and returns a string with the evaluated template in the provided context.
@@ -562,10 +562,10 @@ Mikel allows users to define custom functions that can be used within templates
 
 Functions should be provided in the `options.functions` field of the options object when rendering a template. Each function is defined by a name and a corresponding function that performs the desired operation.
 
-Functions will receive a single object as argument, containing the following keys:
+Functions will receive a single `params` object as argument, containing the following keys:
 
 - `args`: an array containing the variables with the function is called in the template.
-- `opt`: an object containing the keyword arguments provided to the function.
+- `options`: an object containing the keyword arguments provided to the function.
 - `data`: the current data object where the function has been executed.
 - `variables`: an object containing the runtime variables available in the current context (e.g., `@root`, `@index`, etc.).
 
@@ -632,7 +632,7 @@ const data = {
 const options = {
     functions: {
         fullName: params => {
-            return `${params.opt.firstName} ${params.opt.lastName}`;
+            return `${params.options.firstName} ${params.options.lastName}`;
         }
     },
 };

package/index.d.ts

@@ -1,6 +1,7 @@
 export type MikelHelper = (params: {
     args: any[];
-    opt: Record<string, any>;
+    opt?: Record<string, any>;
+    options: Record<string, any>;
     tokens: string[];
     data: Record<string, any>;
     variables: Record<string, any>;
@@ -14,7 +15,8 @@ export type MikelPartial = {
 
 export type MikelFunction = (params: {
     args: any[];
-    opt: Record<string, any>;
+    opt?: Record<string, any>;
+    options: Record<string,any>;
     data: Record<string, any>;
     variables: Record<string, any>;
 }) => string | void;

package/index.js

@@ -75,9 +75,17 @@ const findClosingToken = (tokens, i, token) => {
 const defaultHelpers = {
     "each": p => {
         const items = typeof p.args[0] === "object" ? Object.entries(p.args[0] || {}) : [];
-        const limit = Math.min(items.length - (p.opt.skip || 0), p.opt.limit || items.length);
-        return items.slice(p.opt.skip || 0, (p.opt.skip || 0) + limit)
-            .map((item, index) => p.fn(item[1], {index: index, key: item[0], value: item[1], first: index === 0, last: index === items.length - 1}))
+        const limit = Math.min(items.length - (p.options?.skip || 0), p.options?.limit || items.length);
+        return items.slice(p.options?.skip || 0, (p.options?.skip || 0) + limit)
+            .map((item, index) => {
+                return p.fn(item[1], {
+                    index: index, 
+                    key: item[0],
+                    value: item[1],
+                    first: index === 0,
+                    last: index === items.length - 1,
+                });
+            })
             .join("");
     },
     "if": p => !!p.args[0] ? p.fn(p.data) : "",
@@ -183,7 +191,7 @@ const create = (options = {}) => {
             else if (tokens[i].startsWith("=")) {
                 const [t, args, opt] = parseArgs(tokens[i].slice(1), data, vars);
                 if (typeof ctx.functions[t] === "function") {
-                    output.push(ctx.functions[t]({args, opt, data, variables: vars}) || "");
+                    output.push(ctx.functions[t]({args, opt, options: opt, data, variables: vars}) || "");
                 }
             }
             else if (tokens[i].startsWith("/")) {

package/package.json

@@ -1,7 +1,7 @@
 {
     "name": "mikel",
     "description": "Micro templating library with zero dependencies",
-    "version": "0.28.0",
+    "version": "0.29.0",
     "type": "module",
     "author": {
         "name": "Josemi Juanes",