Sendgrid-ts-mail NPM

Sendgrid Typesafe Mail

A 100% typesafe library for sending mail using the Node.js Sendgrid SDK.

🔥 Never forget a variable in an email again.

How does it work ?

It runs in 3 steps:

Fetches your Sendgrid Templates using your own ApiKey
Detects and extracts the variables from the templates
Generate typings

There is no extra dependency, @sendgrid/mail is a peer-dependency. This package's purpose is only to add typings to the official SendGrid Library.

Getting started

1. Install dependencies

If you do not use the official Sendgrid Javascript SDK, you need to install it. (npm install --save @sendgrid/mail)

# For npm
npm install --save sendgrid-ts-mail
# For yarn
yarn add sendgrid-ts-mail
# For pnpm
pnpm add sendgrid-ts-mail
# For bun
bun add sendgrid-ts-mail

2. Generate your typings

# For npm & yarn
npx sendgrid-ts-mail generate
# For pnpm
pnpx sendgrid-ts-mail generate

Optional Parameters:

-h / --help: Display usage

-e / --env {path}: Path to .env file. Defaults to './.env'

-k / --key {variable_name}: Specify a custom key name for looking up the SENDGRID_API_KEY in the environment file. Defaults to 'SENDGRID_API_KEY'

When updating an email in Sendgrid's interface, it is advised to re-generate the typings if you added/removed variables.

3. Use in your app

import sgMail from 'sendgrid-ts-mail';

sgMail.send({
  from: 'hello@your-company.com',
  templateId: 'd-xxxxx', // Type-safe
  dynamicTemplateData: {
    firstname: 'John', // Type-safe
    lastname: 'Doe', // Type-safe
    business: 'Acme Corp' // Type-safe
  },
});