@voltro/plugin-mail 0.33.0 → 0.34.0

package/dist/index.d.ts

@@ -247,6 +247,24 @@ export declare interface MailPluginOptions {
      *  messages. Default 1000. Ignored when the provider schedules natively. */
     readonly scheduleTickMs?: number;
     /** Disambiguates multiple instances of this plugin in one app. */
+    /**
+     * Namespace for this plugin's inspect endpoints. Default `mail`.
+     *
+     * Set it when your app already publishes under that name — an exact tag
+     * collision is fatal at codegen, and this is the way out. Orthogonal to
+     * `name` below: `alias` REPLACES the namespace, `name` distinguishes two
+     * installations within it.
+     *
+     * The cost, stated because nothing else states it: the local and cloud
+     * dashboards fetch this plugin's panel at the DEFAULT slug, so an aliased
+     * install keeps working while its dashboard panel 404s. Alias to escape a
+     * collision, not for taste.
+     */
+    readonly alias?: string;
+    /**
+     * Discriminator for a SECOND installation of this plugin, when one app runs
+     * two (`@voltro/plugin-mail#analytics`). Not a rename — for that use `alias`.
+     */
     readonly name?: string;
 }