SyncedQueriesModule class

Copy as MarkdownOpen in...

Home > @cbnsndwch/nest-zero-synced-queries > SyncedQueriesModule

SyncedQueriesModule class

Dynamic module for Zero Synced Queries infrastructure.

This module provides all the plumbing needed for Zero synced queries: - Automatic discovery of @SyncedQuery methods in controllers and providers - HTTP endpoint for query transformation requests from Zero cache - Query execution and AST conversion service - Error handling per Zero protocol

## Usage

Import this module in your app module using forRoot() to configure:

Signature:

export declare class SyncedQueriesModule

Example

@Module({
    imports: [
        SyncedQueriesModule.forRoot({
            path: 'api/zero/get-queries'
        }),
        ChatModule // Has @SyncedQuery methods in controllers
    ]
})
export class AppModule {}

## What You Get

After importing this module: 1. **Automatic Discovery**: All @SyncedQuery decorated methods are found 2. **HTTP Endpoint**: POST endpoint at your configured path 3. **Transform Service**: Executes queries and converts to AST 4. **No Boilerplate**: Just decorate your methods, everything else is handled

## Architecture

The module uses NestJS's DiscoveryModule to scan for decorated methods: - At startup, scans all controllers and providers - Registers handlers in a Map for O(1) lookup - Handles authentication, execution, and error responses

Methods

Method

Modifiers

Description

forRoot(options)

static

Configure the synced queries module with options.