@cbnsndwch/zero-sources

SyncedQueriesModule.forRoot() method

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

SyncedQueriesModule.forRoot() method

Configure the synced queries module with options.

Signature:

static forRoot(options?: SyncedQueriesModuleOptions): DynamicModule;

Parameters

Parameter

Type

Description

options

SyncedQueriesModuleOptions

(Optional) Configuration options

Returns:

DynamicModule

A dynamic module with all synced query infrastructure

Example

// Basic usage with defaults
SyncedQueriesModule.forRoot();

// Custom path
SyncedQueriesModule.forRoot({
    path: 'zero/get-queries'
});

How was this page?