54c143a1b4
refs https://jsdoc.app/tags-param.html#optional-parameters-and-default-values - using an equals sign in the type definition is part of the Google Closure syntax but we use the JSDoc syntax in all other places, and tsc detects the different syntax - this commit standardizes the syntax ahead of enforcing a certain style down the line |
||
---|---|---|
.. | ||
lib | ||
test | ||
.eslintrc.js | ||
index.js | ||
package.json | ||
README.md |
Magic Link
Usage
const crypto = require('crypto');
const nodemailer = require('nodemailer');
const MagicLink = require('@tryghost/magic-link');
async function main() {
const jwtSecret = crypto.randomBytes(16).toString('hex');
// https://nodemailer.com/about/#example
const testAccount = await nodemailer.createTestAccount();
const transporter = nodemailer.createTransport({
host: 'smtp.ethereal.email',
port: 587,
secure: false, // true for 465, false for other ports
auth: {
user: testAccount.user, // generated ethereal user
pass: testAccount.pass // generated ethereal password
}
}, {
from: '"Your App" <signin@example.com>',
subject: 'Whatever'
});
const service = MagicLink({
tokenProvider: new MagicLink.JWTTokenProvider(jwtSecret),
transporter,
getSigninURL(token) {
return `http://example.com/signin?token=${token}`
}
});
/**
* POST /signin
*/
const {url, info} = await service.sendMagicLink({
email: 'test@example.com',
tokenData: {
id: 'some-id'
}
});
// https://nodemailer.com/about/#example
// Preview only available when sending through an Ethereal account
console.log('Preview URL: %s', nodemailer.getTestMessageUrl(info));
// Preview URL: https://ethereal.email/message/WaQKMgKddxQDoou...
/**
* GET /signin
*/
const data = await service.getDataFromToken(token);
// createSomeKindOfSession(user);
}
main();