Merge pull request #9 from pavlikm/2.0.0

2.0.0
pavlikm · Nov 8, 2021 · 994a309 · 994a309
2 parents c5200bb + e977a77
commit 994a309
Show file tree

Hide file tree

Showing 34 changed files with 1,802 additions and 23 deletions.
diff --git a/README.md b/README.md
@@ -3,13 +3,24 @@
 
 **cache-html-part** saves your bandwidth and reduce load speed with caching some parts of rendered html.
 
+**This package is experimental**
 ## install
 ```javascript
 npm install cache-html-part
 ```
+As parameter to this middleware enters filter function for elements, which should be cached and count, how many rendering times this element should be rendered before apply cache.
+```javascript
+function (filterFunction: Function = (e: HTMLElement) => false, renderedCount: number = 1)
+```
+For example, for caching all divs bigger than 200 characters:
+````javascript
+(e) => {
+    return (e.toString().length >= 200 && e.tagName == 'div')
+}
+````
 
 ## use
-Use cache-html-part as express middleware:
+Use cache-html-part as express middleware that will cache footer:
 ```javascript
 const express = require('express');
 const http = require('http');
@@ -18,7 +29,9 @@ const server = http.createServer(app);
 const fs = require('fs');
 const cacheHtmlPart = require('cache-html-part');
 
-app.use(cacheHtmlPart);
+app.use(cacheHtmlPart((e) => {
+    return (e.classNames.toString().toLowerCase().indexOf('footer') >= 0)
+}));
 
 //send html from file
 app.get("/test", (req, res) => {
@@ -36,21 +49,7 @@ app.get('/twig', function(req, res){
 server.listen(8080, () => {});
 
 ```
-and mark any static part of your page with html comment `<!-- static -->` and `<!-- static-end -->`:
-```html
-<html>
-<head></head>
-<body>
-
-<div>This div will be transfered from server again and again and again... even if is still the same...</div>
 
-<!-- static -->
-<div>But this div will be transfered only once! Next time browser will render it by self.</div>
-<!-- static-end -->
-
-</body>
-</html>
-```
 
 ## cache-html-part and SEO
 **cache-html-part** will not affect any SEO bots and crawlers. It use html comments which are "invisible" for bots.
diff --git a/lib/analyze.d.ts b/lib/analyze.d.ts
@@ -0,0 +1,3 @@
+import { Record } from "./record";
+export declare function analyze(html: string, filterFunction: Function | undefined, records: Record[]): void;
+//# sourceMappingURL=analyze.d.ts.map
diff --git a/lib/analyze.d.ts.map b/lib/analyze.d.ts.map
diff --git a/lib/analyze.js b/lib/analyze.js
diff --git a/lib/analyze.js.map b/lib/analyze.js.map
diff --git a/lib/apply.d.ts b/lib/apply.d.ts
@@ -0,0 +1,3 @@
+import { Record } from "./record";
+export declare function apply(html: string, records: Record[], renderedCount: number): string;
+//# sourceMappingURL=apply.d.ts.map
diff --git a/lib/apply.d.ts.map b/lib/apply.d.ts.map
diff --git a/lib/apply.js b/lib/apply.js
diff --git a/lib/apply.js.map b/lib/apply.js.map
diff --git a/lib/const.d.ts b/lib/const.d.ts
@@ -0,0 +1,3 @@
+export declare const START_TAG = "<!-- static -->";
+export declare const END_TAG = "<!-- static-end -->";
+//# sourceMappingURL=const.d.ts.map
diff --git a/lib/const.d.ts.map b/lib/const.d.ts.map
diff --git a/lib/const.js b/lib/const.js
diff --git a/lib/const.js.map b/lib/const.js.map
diff --git a/lib/cookie.d.ts b/lib/cookie.d.ts
@@ -0,0 +1,3 @@
+import express from "express";
+export declare function getCookie(req: express.Request, name: string): string[];
+//# sourceMappingURL=cookie.d.ts.map
diff --git a/lib/cookie.d.ts.map b/lib/cookie.d.ts.map
diff --git a/lib/cookie.js b/lib/cookie.js
diff --git a/lib/cookie.js.map b/lib/cookie.js.map
diff --git a/lib/index.d.ts b/lib/index.d.ts
@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=index.d.ts.map
diff --git a/lib/index.d.ts.map b/lib/index.d.ts.map
diff --git a/lib/index.js b/lib/index.js
diff --git a/lib/index.js.map b/lib/index.js.map
diff --git a/lib/record.d.ts b/lib/record.d.ts
@@ -0,0 +1,7 @@
+export declare class Record {
+    count: number;
+    hash: string;
+    html: string;
+    constructor(hash: string, html: string);
+}
+//# sourceMappingURL=record.d.ts.map
diff --git a/lib/record.d.ts.map b/lib/record.d.ts.map
diff --git a/lib/record.js b/lib/record.js
diff --git a/lib/record.js.map b/lib/record.js.map
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,2 @@
		export {};
		//# sourceMappingURL=index.d.ts.map