InterfaceSDK v0.3.0

PushConfig

import type { PushConfig } from '@usepapier/client/base';

Declaration #

types.tsTypeScript
export interface PushConfig {
    delivery?: "papier";
    adapters?: PushAdapter[];
    routing?: (input: PushAdapterInput & {
        templateSlug: string;
    }) => string;
    fetchTimeoutMs?: number;
}

Source: packages/client/src/push/types.ts:55

Members 4

delivery

Optional

`"papier"` delivers through Papier instead of local adapters (web push to registered devices).

delivery?: "papier";

packages/client/src/push/types.ts:57

adapters

Optional
adapters?: PushAdapter[];

packages/client/src/push/types.ts:58

routing

Optional

Select exactly one adapter. No implicit retries or fallback after submission errors.

routing?: (input: PushAdapterInput & {
    templateSlug: string;
}) => string;

Parameters

input
PushAdapterInput & { templateSlug: string }

packages/client/src/push/types.ts:60

fetchTimeoutMs?: number;

packages/client/src/push/types.ts:61

Generated from TypeScript source.b1e9ee529902