Skip to main content
Home
Browse packagesDocsSign in
This release is 1 version behind 0.3.1 — the latest version of @upyo/plunk. Jump to latest

@upyo/plunk@0.3.0-dev.36+e7618f03
Built and signed on GitHub Actions

dahlia/upyo

Plunk transport for Upyo email library

This package works with Cloudflare Workers, Node.js, Deno, Bun, Browsers
This package works with Cloudflare Workers
This package works with Node.js
This package works with Deno
This package works with Bun
This package works with Browsers
JSR Score
100%
Published
2 months ago (0.3.0-dev.36+e7618f03)
interface PlunkConfig

Configuration interface for Plunk transport connection settings.

This interface defines all available options for configuring a Plunk API connection including authentication, HTTP options, and base URL for self-hosted instances.

Examples

Example 1

const config: PlunkConfig = {
  apiKey: 'your-api-key',
  baseUrl: 'https://api.useplunk.com', // or self-hosted URL
  timeout: 30000,
  retries: 3
};

Properties

readonly
apiKey: string

Your Plunk API key.

You can find your API key in your Plunk dashboard under Settings > API Keys. The key will be used as a Bearer token for authentication.

readonly
optional
baseUrl: string

Base URL for the Plunk API.

For Plunk's hosted service, use "https://api.useplunk.com" (default). For self-hosted instances, use your domain with "/api" path (e.g., "https://plunk.example.com/api").

readonly
optional
timeout: number

HTTP request timeout in milliseconds.

readonly
optional
retries: number

Number of retry attempts for failed requests.

readonly
optional
validateSsl: boolean

Whether to validate SSL certificates.

readonly
optional
headers: Record<string, string>

Additional HTTP headers to include with requests.

New Ticket: Report package

Please provide a reason for reporting this package. We will review your report and take appropriate action.

Please review the JSR usage policy before submitting a report.

Add Package

deno add jsr:@upyo/plunk

Import symbol

import { type PlunkConfig } from "@upyo/plunk";
or

Import directly with a jsr specifier

import { type PlunkConfig } from "jsr:@upyo/plunk";

Add Package

pnpm i jsr:@upyo/plunk
or (using pnpm 10.8 or older)
pnpm dlx jsr add @upyo/plunk

Import symbol

import { type PlunkConfig } from "@upyo/plunk";

Add Package

yarn add jsr:@upyo/plunk
or (using Yarn 4.8 or older)
yarn dlx jsr add @upyo/plunk

Import symbol

import { type PlunkConfig } from "@upyo/plunk";

Add Package

vlt install jsr:@upyo/plunk

Import symbol

import { type PlunkConfig } from "@upyo/plunk";

Add Package

npx jsr add @upyo/plunk

Import symbol

import { type PlunkConfig } from "@upyo/plunk";

Add Package

bunx jsr add @upyo/plunk

Import symbol

import { type PlunkConfig } from "@upyo/plunk";