@jaredwray/fumanchu 3.0.0 → 3.0.1

package/README.md

@@ -1,4 +1,4 @@
-![Fumanchu](logo.png "Fumanchu")
+![Fumanchu](site/logo.svg "Fumanchu")
 
 
 # fumanchu
@@ -14,11 +14,11 @@ Handlebars + Helpers Together
 
 We plan to make significant changes over time with this project such as the following:
 - **(Completed)** Remove all dependencies on `handlebars-helpers` and maintain all helpers in this project
+- **(Completed)** Migration to `vitest` as a testing framework
+- **(Completed)** Migration to `xo` as a linting framework
 - **(In Progress)** Migrate to Typescript with full typing support
 - **(In Progress)** Replace module dependencies that are no longer supported with supported ones
 - Migration to ESM and CJS support using cross compatible code
-- Migration to `vitest` as a testing framework
-- Migration to `xo` as a linting framework
 - Move to better documentation and examples where it makes sense
 - Add in browser support via CDN (this will remove the nodejs specific helpers)
 
@@ -3098,6 +3098,8 @@ Generate a random number
 ## How to Contribute
 clone the repository locally and run 'npm i' in the root. Now that you've set up your workspace, you're ready to contribute changes to the `fumanchu` repository you can refer to the [CONTRIBUTING](CONTRIBUTING.md) guide. If you have any questions please feel free to ask by creating an issue and label it `question`.
 
+To test the legacy helpers, you can run `npm run test:legacy` to run the tests. If you want to test the new helpers, you can run `npm run test`.
+
 ## License and Copyright
 [MIT](LICENSE) and codebase after 2023 will be copyright of Jared Wray.
 

package/dist/index.d.ts

@@ -1,5 +1,15 @@
 import * as HandlebarsLib from 'handlebars';
 
+declare enum HelperRegistryCompatibility {
+    NODEJS = "nodejs",
+    BROWSER = "browser"
+}
+type HelperFilter = {
+    name?: string;
+    category?: string;
+    compatibility?: HelperRegistryCompatibility;
+};
+
 /**
  * Handlebars library not initiated with helpers
  * @type {Handlebars}
@@ -22,5 +32,33 @@ declare const helpers: {
  * @returns {Promise<Handlebars>}
  */
 declare function createHandlebars(): Promise<typeof HandlebarsLib>;
+/**
+ * @typedef {Object} FumanchuCachingOptions
+ * @property {number|string} [ttl] - Time to Live - If you set a number it is miliseconds, if you set a string it is a human-readable
+ * format such as `1s` for 1 second or `1h` for 1 hour. Setting undefined means that it will use the default time-to-live. If both are
+ * undefined then it will not have a time-to-live.
+ * @property {boolean} [useClone] - If true, it will clone the value before returning it. If false, it will return the value directly. Default is true.
+ * @property {number} [lruSize] - The size of the LRU cache. If set to 0, it will not use LRU cache. Default is 0.
+ * @property {number} [checkInterval] - The interval to check for expired items. If set to 0, it will not check for expired items. Default is 0.
+ */
+type FumanchuCachingOptions = {
+    ttl?: number | string;
+    useClone?: boolean;
+    lruSize?: number;
+    checkInterval?: number;
+};
+type FumanchuOptions = {
+    handlebars?: typeof HandlebarsLib;
+    helpers?: Record<string, Function>;
+    name?: string | string[];
+    include?: HelperFilter[];
+    exclude?: HelperFilter[];
+    caching?: boolean | FumanchuCachingOptions;
+};
+/**
+ * Will return a Handlebars instance with Fumanchu helpers (experimental)
+ * @returns {Handlebars} Handlebars instance with helpers
+ */
+declare function fumanchu(options?: FumanchuOptions): typeof HandlebarsLib;
 
-export { Handlebars, createHandlebars, handlebars, helpers };
+export { type FumanchuCachingOptions, type FumanchuOptions, Handlebars, createHandlebars, fumanchu, handlebars, helpers };