Node.js Support

The default @jaredwray/fumanchu entry is the Node.js build. It registers every helper, including categories that depend on Node core modules such as fs and path.

Table of Contents

• Install
• Use Handlebars with all helpers
• Register helpers on an existing Handlebars instance
• Helper registry
• Caching
• Available helpers

Install

npm install @jaredwray/fumanchu --save

Use Handlebars with all helpers

fumanchu() returns a Handlebars instance with the full Node helper set already registered. Handlebars itself is included — you do not need to add it as a separate dependency.

import { fumanchu } from '@jaredwray/fumanchu';

const handlebars = fumanchu();
const template = handlebars.compile('{{#if (eq foo "bar")}}<p>Foo is bar</p>{{/if}}');
const html = template({ foo: 'bar' });
console.log(html); // <p>Foo is bar</p>

Register helpers on an existing Handlebars instance

If you already have a Handlebars instance, call helpers() to attach the Node registry to it:

import { helpers } from '@jaredwray/fumanchu';
import handlebars from 'handlebars';

helpers({ handlebars });
const template = handlebars.compile('{{#if (eq foo "bar")}}<p>Foo is bar</p>{{/if}}');
console.log(template({ foo: 'bar' }));

You can also import Handlebars from Fumanchu:

import { handlebars, helpers } from '@jaredwray/fumanchu';

helpers({ handlebars });
const template = handlebars.compile('{{uppercase name}}');
console.log(template({ name: 'hello' })); // HELLO

Helper registry

HelperRegistry loads the full Node helper set. Use it to register extra helpers or to load a filtered subset:

import { HelperRegistry, handlebars } from '@jaredwray/fumanchu';

const registry = new HelperRegistry();
registry.register('eq', (a, b) => a === b);
registry.load(handlebars, { names: ['eq'] });

Helpers also declare a compatibility flag such as HelperRegistryCompatibility.NODEJS or HelperRegistryCompatibility.BROWSER, so you can filter by environment.

Caching

When caching is enabled, Fumanchu wraps Handlebars compile() and stores compiled template functions in @cacheable/memory. Compiling the same template string again returns the cached function.

The caching option accepts a boolean, a CacheableMemory instance, or a CacheableMemoryOptions object (ttl, lruSize, checkInterval, and so on).

import { fumanchu } from '@jaredwray/fumanchu';

const handlebars = fumanchu({ caching: true });
const template = handlebars.compile('Hello {{name}}!');
template({ name: 'World' }); // compiles and caches
handlebars.compile('Hello {{name}}!'); // cached — no recompilation

import { fumanchu } from '@jaredwray/fumanchu';

const handlebars = fumanchu({
  caching: {
    ttl: '1h',
    lruSize: 500,
    checkInterval: 0,
  },
});

import { fumanchu, CacheableMemory } from '@jaredwray/fumanchu';

const cache = new CacheableMemory({ ttl: '1h', lruSize: 1000, useClone: false });
const hbs1 = fumanchu({ caching: cache });
const hbs2 = fumanchu({ caching: cache }); // shares the same cache as hbs1

Available helpers

The Node build registers every helper below. See the category pages for parameters and examples.