Leahnaya/account
1
0
Fork 0
mirror of https://github.com/PretendoNetwork/account.git synced 2026-03-21 17:44:49 -05:00
Code Issues Actions Packages Projects Releases Wiki Activity

docs(mailer): fix error in comments, minor changes

Browse Source
This commit is contained in:
limes 2025-11-10 13:55:12 +01:00 committed by GitHub
parent bfbebed3c8
commit bb37ea5411
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 5 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
src/mailer.ts
View File

@ -42,7 +42,6 @@ interface buttonComponent {
link?: string;
primary?: boolean;
}
interface emailTextReplacements {
[key: string]: string;
}
@ -52,8 +51,8 @@ export class CreateEmail {
private readonly componentArray: (emailComponent | paddingComponent | buttonComponent)[] = [];
/**
* utility function which returns a table row of the specified height to use as padding.
*/
* adds padding of the specified height in px
*/
private addPadding(size: number): paddingComponent {
return {
type: 'padding',
@ -62,7 +61,7 @@ export class CreateEmail {
}
/**
* adds a header. for greetings, do addHeader("Hi {{pnid}}!", { pnid: "theUsername" }).
* adds a header. for greetings, do addHeader("Hi {{pnid}}!", { pnid: "theUsername" })
*/
public addHeader(text: string, replacements?: emailTextReplacements): this {
const component: emailComponent = { type: 'header', text, replacements };
@ -72,7 +71,7 @@ export class CreateEmail {
}
/**
* adds a paragraph. for links, do addParagraph("this is a [named link](https://example.org)."). for greetings, do addParagraph("Hi {pnid}!", { pnid: "theUsername" }).
* adds a paragraph. for links, do addParagraph("this is a [named link](https://example.org)."). for greetings, do addParagraph("Hi {{pnid}}!", { pnid: "theUsername" })
*/
public addParagraph(text: string, replacements?: emailTextReplacements): this {
const component: emailComponent = { type: 'paragraph', text, replacements };
@ -82,7 +81,7 @@ export class CreateEmail {
}
/**
* adds a button.
* adds a button
*
* @param {String} text the button text
* @param {String} [link] the link