Type Alias GenerateRequestOptions

type GenerateRequestOptions = {
    allowMultipleRecords?: boolean;
    contentEncoding?: SupportedContentEncoding;
    finalRecordPadding?: number;
    gcmAPIKey?: string | null;
    headers?: Record<string, string>;
    rs?: number;
    topic?: string;
    TTL?: number;
    urgency?: SupportedUrgency;
    vapidDetails?: WebPushConfig["vapid"] | null;
}

Index

Properties

allowMultipleRecords? contentEncoding? finalRecordPadding? gcmAPIKey? headers? rs? topic? TTL? urgency? vapidDetails?

Properties

`Optional`allowMultipleRecords

allowMultipleRecords?: boolean

RFC8188 compliance knob:

Web Push RFC8291 requires a single record; this stays false by default.
Set to true only if you intentionally want multi-record RFC8188 payload bodies.

`Optional`contentEncoding

contentEncoding?: SupportedContentEncoding

`Optional`finalRecordPadding

finalRecordPadding?: number

Optional number of 0x00 bytes inserted after the padding delimiter in the final record. Usually 0 for Web Push.

`Optional`gcmAPIKey

gcmAPIKey?: string | null

`Optional`headers

headers?: Record<string, string>

`Optional`rs

rs?: number

RFC8188 record size (rs) in octets (ciphertext record size). Must be >= 18.

`Optional`topic

topic?: string

`Optional`TTL

TTL?: number

`Optional`urgency

urgency?: SupportedUrgency

`Optional`vapidDetails

vapidDetails?: WebPushConfig["vapid"] | null