Add types for nodemailer-sendgrid (#44912)

This commit is contained in:
Luke Jones 2020-06-24 04:53:44 +10:00 committed by GitHub
parent b532f7a9b1
commit a28bee687a
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 57 additions and 0 deletions

17
types/nodemailer-sendgrid/index.d.ts vendored Normal file
View File

@ -0,0 +1,17 @@
// Type definitions for nodemailer-sendgrid 1.0
// Project: https://github.com/nodemailer/nodemailer-sendgrid
// Definitions by: Luke Jones <https://github.com/luke-j>
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
// TypeScript Version: 3.3
import { Transport } from 'nodemailer';
declare namespace nodemailerSendgrid {
interface SendgridOptions {
apiKey: string;
}
}
declare function nodemailerSendgrid(options: nodemailerSendgrid.SendgridOptions): Transport;
export = nodemailerSendgrid;

View File

@ -0,0 +1,16 @@
import nodemailerSendgrid = require('nodemailer-sendgrid');
import nodemailer = require('nodemailer');
const opts: nodemailerSendgrid.SendgridOptions = { apiKey: 'XXXXXXXXXXXXXXXX' };
const transport: nodemailer.Transporter = nodemailer.createTransport(nodemailerSendgrid(opts));
const mailOptions: nodemailer.SendMailOptions = {
from: 'Foo Bar ✔ <foo@bar.com>',
to: 'foo@baz.com, foo@baz.com',
subject: 'Hello world ✔',
text: 'Hello world ✔',
html: '<b>Hello world ✔</b>',
};
transport.sendMail(mailOptions, (error: Error | null, info: nodemailer.SentMessageInfo): void => {
// nothing
});

View File

@ -0,0 +1,23 @@
{
"compilerOptions": {
"module": "commonjs",
"lib": [
"es6"
],
"noImplicitAny": true,
"noImplicitThis": true,
"strictNullChecks": true,
"strictFunctionTypes": true,
"baseUrl": "../",
"typeRoots": [
"../"
],
"types": [],
"noEmit": true,
"forceConsistentCasingInFileNames": true
},
"files": [
"index.d.ts",
"nodemailer-sendgrid-tests.ts"
]
}

View File

@ -0,0 +1 @@
{ "extends": "dtslint/dt.json" }