post-postgres

Import

Import

import * as api from "@fungi.computer/carrier/post-postgres";

Exports

Kind	Export	Description
Ttype alias	PostgresPost	Post on PostgreSQL; the producer retains ownership of BEGIN and COMMIT.
Ttype alias	PostgresPostErasureStatement	Parameterized native erasure; the producer controls BEGIN and COMMIT.
constconstant	postPostgresSchema	Carrier-owned PostgreSQL schema, applied by the deployment migration owner.
fnfunction	createPostgresPost()	Bind the Post registry to PostgreSQL; route deadlines are rejected with PostError.
fnfunction	purgePostgresPost()	Purge selected recipient queues, including all envelopes and attempts. The trusted SELECT yields queue_name from producer/envelope facts, not job state.

PostgresPostTtype alias

Signature

type PostgresPost = SqlPostRuntime &
  Readonly<{
    send: (client, envelope) => Promise<void>;
  }>;

Post on PostgreSQL; the producer retains ownership of BEGIN and COMMIT.

---

PostgresPostErasureStatementTtype alias

Signature

type PostgresPostErasureStatement = Readonly<{
  text: string;
  values: readonly (string | number | null)[];
}>;

Parameterized native erasure; the producer controls BEGIN and COMMIT.

postPostgresSchemaconstconstant

Signature

const postPostgresSchema: readonly string[];

Carrier-owned PostgreSQL schema, applied by the deployment migration owner.

createPostgresPost()fnfunction

Signature

function createPostgresPost<R>(options): PostgresPost;

Bind the Post registry to PostgreSQL; route deadlines are rejected with PostError.

Type Parameters

Type Parameter

R extends Record<string, Readonly<{ addressKind: string; deadlineMs?: number; address: Codec<unknown, unknown>; event: Codec<unknown, unknown>; encodeEnvelope: (envelope) => object; parseDelivery: (envelope) => object; prepareEnvelope?: (envelope, signal) => Promise<{ key: string; kind: string; address: unknown; event: unknown; }>; recordDelivered?: (envelope) => void; nameOf: (envelope) => string; namespace: Readonly<{ getByName: (name) => Readonly<{ deliver: (envelope) => Promise<PostDeliveryResult>; }>; }>; recordCursor?: (envelope, cursor) => void; recordRefused?: (envelope) => void; }>>

Parameters

Parameter	Type
options	Readonly<{ routes: R; failureDetail?: (cause) => string; retry?: Readonly<{ maxAttempts: number; baseDelayMs: number; maxDelayMs: number; }>; now: () => number; scheduleWake: (at) => Promise<void>; }> & Readonly<{ database: Pick<Pool, "query" | "connect">; watchdog: PostgresWatchdog; }>

Returns

PostgresPost

---

purgePostgresPost()fnfunction

Signature

function purgePostgresPost(source): readonly Readonly<{
  text: string;
  values: readonly (string | number | null)[];
}>[];

Purge selected recipient queues, including all envelopes and attempts. The trusted SELECT yields queue_name from producer/envelope facts, not job state.

Parameters

Parameter	Type
source	PostgresPostErasureStatement

Returns

readonly Readonly<{ text: string; values: readonly (string | number | null)[]; }>[]

References

SqlPostOptions

Re-exports SqlPostOptions

---

SqlPostRuntime

Re-exports SqlPostRuntime