Built and signed on GitHub ActionsBuilt and signed on GitHub Actions
PostgreSQL drivers for Fedify
Classes
A key–value store that uses PostgreSQL as the underlying storage.
- delete(key: KvKey): Promise<void>No documentation available
- drop(): Promise<void>
Drops the table used by the key–value store. Does nothing if the table does not exist.
- get<T = unknown>(key: KvKey): Promise<T | undefined>No documentation available
- initialize(): Promise<void>
Creates the table used by the key–value store if it does not already exist. Does nothing if the table already exists.
- list(prefix?: KvKey): AsyncIterable<KvStoreListEntry>
{@inheritDoc KvStore.list}
- set(): Promise<void>key: KvKey,value: unknown,options?: KvStoreSetOptions | undefinedNo documentation available
A message queue that uses PostgreSQL as the underlying storage.
- drop(): Promise<void>
Drops the message queue table if it exists.
- enqueue(): Promise<void>message: any,options?: MessageQueueEnqueueOptionsNo documentation available
- enqueueMany(): Promise<void>messages: readonly any[],options?: MessageQueueEnqueueOptionsNo documentation available
- initialize(): Promise<void>
Initializes the message queue table if it does not already exist.
- listen(): Promise<void>handler: (message: any) => void | Promise<void>,options?: MessageQueueListenOptionsNo documentation available
Interfaces
Options for the PostgreSQL key–value store.
- initialized: boolean
Whether the table has been initialized.
falseby default. - tableName: string
The table name to use for the key–value store.
"fedify_kv_v2"by default.
Options for the PostgreSQL message queue.
- channelName: string
The channel name to use for the message queue.
"fedify_channel"by default. - handlerTimeout: Temporal.Duration | Temporal.DurationLike
The maximum time to wait for a message handler to complete before considering it hung. When a handler exceeds this timeout, it is treated as an error and the poll loop moves on to the next message, preventing a single hung handler from permanently blocking the queue.
- initialized: boolean
Whether the table has been initialized.
falseby default. - pollInterval: Temporal.Duration | Temporal.DurationLike
The poll interval for the message queue. 5 seconds by default.
- tableName: string
The table name to use for the message queue.
"fedify_message_v2"by default.