Foo is bar
{{/if}}');\nconst html = template({foo: 'bar'});\nconsole.log(html); //Foo is bar
\n```\n\nIt's just that easy! No need to add Handlebars to your project, it's already included.\n\n# Usage in the Browser\n\nFumanchu ships a browser-safe build that excludes Node-only helpers (`fs`, `path`, `logging`, `embed`, `css`, `js`, `escape`, `urlResolve`, `urlParse`, `stripProtocol`). Import it directly via the `/browser` subpath:\n\n```javascript\nimport { fumanchu } from '@jaredwray/fumanchu/browser';\nconst handlebars = fumanchu();\nconst template = handlebars.compile('{{uppercase name}}');\nconsole.log(template({ name: 'hello' })); // HELLO\n```\n\nThe package also sets the `browser` export condition on the main entry, so webpack, Vite, esbuild, Rollup, and other browser-aware bundlers automatically pick up the browser build when you `import '@jaredwray/fumanchu'` from a browser target — no code change required. The public API (`fumanchu`, `helpers`, `HelperRegistry`) is identical to Node; only the set of registered helpers differs.\n\nYou can also load the browser build directly from a CDN such as [jsDelivr](https://www.jsdelivr.com/package/npm/@jaredwray/fumanchu) — no bundler required:\n\n```html\n\n```\n\n# Using Handlebars Helpers\n\nIf you only want to use handlebar helpers you can easily do that by doing the following:\n\n```javascript\nimport {helpers} from '@jaredwray/fumanchu';\nimport handlebars from 'handlebars';\nconst helpersFunction = await helpers();\nhelpersFunction({ handlebars: handlebars });\nconst template = handlebars.compile('{{#if (eq foo \"bar\")}}Foo is bar
{{/if}}');\nconst html = template({foo: 'bar'});\nconsole.log(html); //Foo is bar
\n```\n\nIf using it with es6 you can access `handlebars` and `helpers`:\n\n```javascript\nimport {handlebars, helpers} from '@jaredwray/fumanchu';\nhelpers({ handlebars: handlebars });\nconst template = handlebars.compile('{{#if (eq foo \"bar\")}}Foo is bar
{{/if}}');\nconst html = template({foo: 'bar'});\nconsole.log(html);\n```\n\n# Using the Helper Registry\n\nThe helper registry allows you to manage and use Handlebars helpers more easily. You can register new helpers, filter existing ones, and access them in your templates.\n\n```js\nimport { HelperRegistry, handlebars } from '@jaredwray/fumanchu';\n\nconst registry = new HelperRegistry();\nregistry.register('eq', (a, b) => a === b);\nregistry.register('if', (condition, template) => condition ? template() : '');\nconst hbs = handlebars;\nregistry.load(hbs); // Load all helpers into Handlebars\n```\n\nIf you want to do filtering you can use the `HelperFilter` on `load`:\n\n```js\nimport { HelperRegistry, handlebars } from '@jaredwray/fumanchu';\n\nconst registry = new HelperRegistry();\nregistry.register('eq', (a, b) => a === b);\nregistry.register('if', (condition, template) => condition ? template() : '');\nconst hbs = handlebars;\nregistry.load(hbs, { names: ['if']}); // Load the helpers into Handlebars\n```\n\nIn addition, we have made the helper functions have a compatibility such as `HelperRegistryCompatibility.NODEJS` or `HelperRegistryCompatibility.BROWSER`. This will allow you to filter out based on your environment!\n\n# Caching\n\nWhen caching is enabled, Fumanchu wraps the Handlebars `compile()` method to cache compiled template functions using [@cacheable/memory](https://github.com/jaredwray/cacheable/tree/main/packages/memory). If you compile the same template string multiple times, the cached version is returned instead of recompiling. The returned Handlebars instance is fully compatible -- caching is transparent to your existing code.\n\nThe `caching` option accepts three types:\n- `boolean` -- `true` enables caching with defaults, `false` disables it\n- `CacheableMemory` -- a pre-configured instance from `@cacheable/memory`\n- `CacheableMemoryOptions` -- an options object passed to `CacheableMemory` (supports `ttl`, `lruSize`, `checkInterval`, etc.)\n\nHere is an quick benchmark showing the performance advantage:\n\n| name | summary | ops/sec | time/op | margin | samples |\n|------------------------------------|:---------:|----------:|----------:|:--------:|----------:|\n| compile+render cached (v4.6.0) | 🥇 | 45K | 39µs | ±0.32% | 25K |\n| compile+render no-cache (v4.6.0) | -83% | 8K | 166µs | ±0.62% | 10K |\n\n## Enable caching with default settings\n\n```javascript\nimport { fumanchu } from '@jaredwray/fumanchu';\nconst handlebars = fumanchu({ caching: true });\n\nconst template = handlebars.compile('Hello {{name}}!');\ntemplate({ name: 'World' }); // compiles and caches\n\nconst template2 = handlebars.compile('Hello {{name}}!');\n// returns the cached compiled function -- no recompilation\n```\n\n## Pass caching options\n\n```javascript\nimport { fumanchu } from '@jaredwray/fumanchu';\nconst handlebars = fumanchu({\n caching: {\n ttl: '1h', // Time-to-live in ms or human-readable string like '1h'\n lruSize: 500, // LRU cache size limit (0 = unlimited)\n checkInterval: 0, // Interval to check for expired items in ms (0 = disabled)\n },\n});\n```\n\n## Pass a pre-configured `CacheableMemory` instance\n\nThis is useful if you want to share a cache across multiple Fumanchu instances or manage the cache lifecycle yourself:\n\n```javascript\nimport { fumanchu, CacheableMemory } from '@jaredwray/fumanchu';\nconst cache = new CacheableMemory({ ttl: '1h', lruSize: 1000, useClone: false });\n\nconst hbs1 = fumanchu({ caching: cache });\nconst hbs2 = fumanchu({ caching: cache }); // shares the same cache as hbs1\n```\n\n## How to Contribute\nClone the repository locally 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`.\n\n## License and Copyright\n[MIT](LICENSE) and codebase after 2023 will be copyright of Jared Wray.\n\nThis is a fork of [handlebars-helpers]() which is licensed under MIT. Initial copyright of handlebars-helpers: `2013-2015, 2017, Jon Schlinkert, Brian Woodward`. Thank you so much for your effort and building this! We have also continued to list all contributors in `package.json` to ensure that they are recognized.\n","readmeFilename":""}