ghtml 3.0.2 → 3.0.3

package/package.json

@@ -3,7 +3,7 @@
   "description": "Replace your template engine with fast JavaScript by leveraging the power of tagged templates.",
   "author": "Gürgün Dayıoğlu",
   "license": "MIT",
-  "version": "3.0.2",
+  "version": "3.0.3",
   "type": "module",
   "bin": "./bin/src/index.js",
   "main": "./src/index.js",
@@ -27,8 +27,8 @@
   "devDependencies": {
     "@fastify/pre-commit": "^2.1.0",
     "c8": "^10.1.2",
-    "grules": "^0.23.0",
-    "tinybench": "^2.8.0",
+    "grules": "^0.23.3",
+    "tinybench": "^2.9.0",
     "typescript": ">=5.5.4"
   },
   "repository": {

package/src/html.d.ts

@@ -1,24 +1,3 @@
-/**
- * @param {{ raw: Readonly<string[]> }} literals Tagged template literals.
- * @param {...any} expressions Expressions to interpolate.
- * @returns {string} The HTML string.
- */
-export function html({ raw: literals }: {
-    raw: Readonly<string[]>;
-}, ...expressions: any[]): string;
-/**
- * @param {{ raw: Readonly<string[]> }} literals Tagged template literals.
- * @param {...any} expressions Expressions to interpolate.
- * @yields {string} The HTML strings.
- */
-export function htmlGenerator({ raw: literals }: {
-    raw: Readonly<string[]>;
-}, ...expressions: any[]): {};
-/**
- * @param {{ raw: Readonly<string[]> }} literals Tagged template literals.
- * @param {...any} expressions Expressions to interpolate.
- * @yields {string} The HTML strings.
- */
-export function htmlAsyncGenerator({ raw: literals }: {
-    raw: Readonly<string[]>;
-}, ...expressions: any[]): {};
+export function html({ raw: literals }: TemplateStringsArray, ...expressions: any[]): string;
+export function htmlGenerator({ raw: literals }: TemplateStringsArray, ...expressions: any[]): Generator<string, void, void>;
+export function htmlAsyncGenerator({ raw: literals }: TemplateStringsArray, ...expressions: any[]): AsyncGenerator<string, void, void>;

package/src/html.js

@@ -39,11 +39,11 @@ const escapeFunction = (string) => {
 };
 
 /**
- * @param {{ raw: Readonly<string[]> }} literals Tagged template literals.
+ * @param {TemplateStringsArray} literals Tagged template literals.
  * @param {...any} expressions Expressions to interpolate.
- * @returns {string} The HTML string.
+ * @returns {string} The processed HTML string.
  */
-const html = ({ raw: literals }, ...expressions) => {
+export const html = ({ raw: literals }, ...expressions) => {
   let accumulator = "";
 
   for (let i = 0; i !== expressions.length; ++i) {
@@ -72,11 +72,12 @@ const html = ({ raw: literals }, ...expressions) => {
 };
 
 /**
- * @param {{ raw: Readonly<string[]> }} literals Tagged template literals.
+ * @param {TemplateStringsArray} literals Tagged template literals.
  * @param {...any} expressions Expressions to interpolate.
- * @yields {string} The HTML strings.
+ * @yields Processed HTML strings.
+ * @returns {Generator<string, void, void>} The HTML generator.
  */
-const htmlGenerator = function* ({ raw: literals }, ...expressions) {
+export const htmlGenerator = function* ({ raw: literals }, ...expressions) {
   for (let i = 0; i !== expressions.length; ++i) {
     let expression = expressions[i];
     let literal = literals[i];
@@ -166,11 +167,15 @@ const htmlGenerator = function* ({ raw: literals }, ...expressions) {
 };
 
 /**
- * @param {{ raw: Readonly<string[]> }} literals Tagged template literals.
+ * @param {TemplateStringsArray} literals Tagged template literals.
  * @param {...any} expressions Expressions to interpolate.
- * @yields {string} The HTML strings.
+ * @yields Processed HTML strings.
+ * @returns {AsyncGenerator<string, void, void>} The HTML generator.
  */
-const htmlAsyncGenerator = async function* ({ raw: literals }, ...expressions) {
+export const htmlAsyncGenerator = async function* (
+  { raw: literals },
+  ...expressions
+) {
   for (let i = 0; i !== expressions.length; ++i) {
     let expression = await expressions[i];
     let literal = literals[i];
@@ -261,5 +266,3 @@ const htmlAsyncGenerator = async function* ({ raw: literals }, ...expressions) {
     yield literals[expressions.length];
   }
 };
-
-export { html, htmlGenerator, htmlAsyncGenerator };

package/src/includeFile.d.ts

@@ -1,5 +1 @@
-/**
- * @param {string} path The path to the file to render.
- * @returns {string} The cached content of the file.
- */
 export function includeFile(path: string): string;

package/src/includeFile.js

@@ -4,9 +4,9 @@ const cache = new Map();
 
 /**
  * @param {string} path The path to the file to render.
- * @returns {string} The cached content of the file.
+ * @returns {string} The content of the file.
  */
-const includeFile = (path) => {
+export const includeFile = (path) => {
   let file = cache.get(path);
 
   if (file === undefined) {
@@ -16,5 +16,3 @@ const includeFile = (path) => {
 
   return file;
 };
-
-export { includeFile };