npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@outofsync/mail-template-helper

v1.1.1

Published

Simple tools to merge data with email templates during run-time

Downloads

6

Readme

mail-template-helper

NPM

Actual version published on npm Travis build status Total npm module downloads Package Quality Codacy Badge Codacy Coverage  Badge Dependencies badge

mail-template-helper is a helper module to assist with compilation of email templates.

Installation

npm install @outofsync/mail-template-helper

Usage

const MailTemplatesHelper = require('@outofsync/mail-template-helper');

const templates = {
  ['Test2']: {
    subject: '{testData1} {testData2}',
    template: '{bodyData} - {testData2} -- {embedded.value}'
  }
};

const mailTemplateHelper = new MailTemplatesHelper(templates);

console.log(mailTemplateHelper.getFilledTemplate('Test2', {
  testData1: 'a',
  testData2: 'b',
  bodyData: 'test',
  embedded: {
    value: 'qwerty'
  }
}));

API Reference

MailTemplatesHelper constructor(templates) ⟾ instanceof MailTemplatesHelper

Create an instance of MailTemplatesHelper with the templates collection provided.

MailTemplatesHelper.getTemplate(templateName) ⟾ object(mail template) / null

Returns the template with the templateName provided or null if the template does not exist

MailTemplatesHelper.getFilledSubject(templateName, data) ⟾ string / null

Returns the template subject from the templateName provided, using the data to fill any {} placeholders, or null if no template by that name exists.

MailTemplatesHelper.getFilledBody(templateName, data) ⟾ string / null

Returns the template body from the templateName provided, using the data to fill any {} placeholders, or null if no template by that name exists.

MailTemplatesHelper.getCustomFilled(template, data) ⟾ string / null

Returns custom template filled using the data to fill any {} placeholders, or null if the template is null or undefined

Templates and Collections

Template

A template is just a string with {} placeholders for data in data dictionary. The placeholders can reference nested data objects and array indices.

const template = 'This is a template with { data }. Hello { name }.';

Mail Template

A mail template is an object which contains two template strings labelled body and subject.

const mailTemplate = {
  subject: 'Mail Subject -- { data1 }',
  body: 'This is a template with { data }. Hello { name }.'
};

Template Collection

A template collection is an object with named indices which each contain a Mail Template.

const templates = {
  ['Test1']: {
    subject: 'Mail Subject -- { data1 }',
    body: 'This is a template with { data }. Hello { name }.'
  },
  ['Test2']: {
    subject: 'Mail Subject -- { data1 }',
    body: 'This is a template with { data }. Hello { name }.'
  }
};

License

Copyright (c) 2018, 2019 Jay Reardon Copyright (c) 2019 Out of Sync Studios LLC -- Licensed under the MIT license.