API reference

Generated from the source. Every export, grouped by kind.

Functions

• Expandable - Decorator controller/expander method as expandable (for recursive expansion).
• Expander - Decorator function to mark a class as a standard expander for a specific DTO.
• ExpanderMethods - Decorator function to mark a class as containing reusable expansion methods.
• RegisterPgTableChangeListener - Decorator to register a PostgreSQL table change listener.
• Selectable - Decorator function to mark a controller endpoint response as selectable.
• UseExpansionMethod - Decorator function to link a field in an

Classes

• NestKitExpandModule
• PgLockService - PostgreSQL advisory lock service.
• PgPubSubModule
• PgPubSubService - Subscribes to PostgreSQL pub/sub triggers and handles table changes.

Interfaces

• ListenerDiscovery - Result of discovering and processing table change listeners.
• LockOptions - Options for acquiring an advisory lock.
• PgTableChangeContext - Context passed to a listener's process method.
• PgTableChangeListener - Type for a handler that listens to changes on a PostgreSQL table.
• PoolConfig - Configuration for the dedicated PG connection pool.
• QueueConfig - Queue processing configuration
• QueuedMessage - Representation of a message in the queue
• ResolvedListener - A discovered listener with its resolved metadata.
• TableListener - Describes a table and the events/fields a listener is interested in.
• TransactionAdapter - ORM-agnostic adapter for running listener logic inside a transaction.
• TriggerMetadata - Metadata describing a PostgreSQL trigger.

Type aliases

• DiscoveredPgTableChangeListener - Type representing a class discovered with metadata @RegisterPgTableChangeListener
• ExpandableParams - Represents parameters for making a controller/expander response expandable.
• ExpandConfig - Represents configuration for the ExpandModule.
• ExpandContext - Represents the context in which an expansion is performed.
• ExpanderMethodsParams - Parameters for the
• ExpandErrorPolicy - Error policy for expansion errors.
• ExpansionError - Represents error metadata for failed expansions.
• ExpansionErrorFormatter - Format function for expansion errors.
• ExpansionErrorHandlingConfig - Error handling configuration for expansions.
• PgPubSubConfig - Configuration for the PostgreSQL pubsub module.
• PgTableChangeErrorHandler - Type for a callback to handle errors when processing a change.
• PgTableChangePayload - Type for a PostgreSQL table change payload.
• PgTableChanges - Type for a batch of changes received for a PostgreSQL table.
• PgTableChangeType - Type for a PostgreSQL table change type.
• PgTableDeletePayload - Type for a PostgreSQL table DELETE payload.
• PgTableInsertPayload - Type for a PostgreSQL table INSERT payload.
• PgTableUpdatePayload - Type for a PostgreSQL table UPDATE payload.
• RegisterPgTableChangeListenerMetadata
• ReusableExpandMethod - Represents a method within a
• SelectableParams - Represents parameters for making a controller response selectable.
• StandardExpandMethod - Represents a standard method on an
• UseExpansionMethodConfig - Configuration for the
• UseExpansionMethodMetadata - Metadata stored by the

Variables

• DEFAULT_EXPAND_CONFIG
• EXPAND_CONFIG - Injection token for the ExpandConfig.
• EXPANDABLE_KEY - Symbol key for metadata associated with expandable parameters on controller/expander methods.
• EXPANDER_KEY - Symbol key for metadata associated with expanders.
• EXPANDER_METHODS_KEY - Symbol key for metadata associated with classes containing reusable expander methods.
• PG_PUBSUB_CONFIG - Symbol for the configuration of the PostgreSQL pubsub module.
• PG_PUBSUB_DRAIN_INTERVAL - Default delay in milliseconds between drain loop iterations.
• PG_PUBSUB_FALLBACK_POLLING_INTERVAL - Default fallback polling interval in milliseconds.
• PG_PUBSUB_LOCK_DURATION - Default advisory lock duration in milliseconds.
• PG_PUBSUB_POOL_MAX - Default maximum number of connections in the dedicated pool.
• PG_PUBSUB_QUEUE_BATCH_SIZE - Default batch size for fetching pending messages.
• PG_PUBSUB_QUEUE_CLEANUP_INTERVAL - Default cleanup interval in milliseconds.
• PG_PUBSUB_QUEUE_CONCURRENCY - Default maximum number of concurrent listener executions.
• PG_PUBSUB_QUEUE_MAX_RETRIES - Default max retries for a failed message.
• PG_PUBSUB_QUEUE_MESSAGE_TTL - Default message TTL in milliseconds.
• PG_PUBSUB_QUEUE_PROCESSING_TIMEOUT - Default processing timeout in milliseconds.
• PG_PUBSUB_QUEUE_SCHEMA - Default queue schema.
• PG_PUBSUB_QUEUE_TABLE - Default queue table name.
• PG_PUBSUB_TRIGGER_NAME - Trigger channel name and prefix for created triggers.
• PG_PUBSUB_TRIGGER_SCHEMA - Default schema for tables and triggers.
• RegisterPgTableChangeListenerMeta - Symbol for the metadata key used to register a PostgreSQL table change listener.
• SELECTABLE_KEY - Symbol key for metadata associated with selectable parameters.
• USE_EXPANSION_METHOD_KEY - Symbol key for metadata associated with linking reusable expander methods.