@ztimson/momentum 0.52.0 → 0.52.1

package/dist/email.d.ts

@@ -1,19 +1,30 @@
 import { PathEventEmitter } from '@ztimson/utils';
 import { Api } from './api';
-export type MailTemplate = {
-    template: string;
-    data?: any;
-};
+/** Email model */
 export type Mail = {
+    /** Sending mailing list */
     to: string | string[];
+    /** CSS mailing list */
     cc?: string[];
+    /** BCC mailing list */
     bcc?: string[];
+    /** Email subject */
     subject?: string;
-    body?: string | MailTemplate;
+    /** Email text or template rendering data */
+    body?: string | {
+        template: string;
+        data?: any;
+    };
 };
+/** Send Emails */
 export declare class Email extends PathEventEmitter {
     private readonly api;
     constructor(api: Api | string);
+    /**
+     * Send Email
+     * @param {Mail} email Email to send
+     * @return {Promise<any>} Response
+     */
     send(email: Mail): import('@ztimson/utils').PromiseProgress<any>;
 }
 //# sourceMappingURL=email.d.ts.map

package/dist/email.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"email.d.ts","sourceRoot":"","sources":["../src/email.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,gBAAgB,EAAM,MAAM,gBAAgB,CAAC;AACrD,OAAO,EAAC,GAAG,EAAC,MAAM,OAAO,CAAC;AAE1B,MAAM,MAAM,YAAY,GAAG;IAAC,QAAQ,EAAE,MAAM,CAAC;IAAC,IAAI,CAAC,EAAE,GAAG,CAAA;CAAC,CAAC;AAC1D,MAAM,MAAM,IAAI,GAAG;IAClB,EAAE,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;IACtB,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC;IACd,GAAG,CAAC,EAAE,MAAM,EAAE,CAAC;IACf,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,IAAI,CAAC,EAAE,MAAM,GAAG,YAAY,CAAC;CAC7B,CAAA;AAED,qBAAa,KAAM,SAAQ,gBAAgB;IAC1C,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAO;gBAEf,GAAG,EAAE,GAAG,GAAG,MAAM;IAK7B,IAAI,CAAC,KAAK,EAAE,IAAI;CAOhB"}
+{"version":3,"file":"email.d.ts","sourceRoot":"","sources":["../src/email.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,gBAAgB,EAAM,MAAM,gBAAgB,CAAC;AACrD,OAAO,EAAC,GAAG,EAAC,MAAM,OAAO,CAAC;AAE1B,kBAAkB;AAClB,MAAM,MAAM,IAAI,GAAG;IAClB,2BAA2B;IAC3B,EAAE,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;IACtB,uBAAuB;IACvB,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC;IACd,uBAAuB;IACvB,GAAG,CAAC,EAAE,MAAM,EAAE,CAAC;IACf,oBAAoB;IACpB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,4CAA4C;IAC5C,IAAI,CAAC,EAAE,MAAM,GAAG;QAAC,QAAQ,EAAE,MAAM,CAAC;QAAC,IAAI,CAAC,EAAE,GAAG,CAAA;KAAC,CAAC;CAC/C,CAAA;AAED,kBAAkB;AAClB,qBAAa,KAAM,SAAQ,gBAAgB;IAC1C,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAO;gBAEf,GAAG,EAAE,GAAG,GAAG,MAAM;IAK7B;;;;OAIG;IACH,IAAI,CAAC,KAAK,EAAE,IAAI;CAOhB"}