Skip to content

Class: ODataModule

Defined in: packages/core/src/odata.module.ts:129

Core OData module — ORM-agnostic.

Usage: // Root module: ODataModule.forRoot({ serviceRoot: '/odata' }) ODataModule.forRootAsync({ useFactory: () => ({ serviceRoot: '/odata' }) })

// Feature modules: ODataModule.forFeature([myEdmEntityConfig])

Zero TypeORM imports — per PKG-01 architecture constraint.

Extends

  • ConfigurableModuleClass

Indexable

[key: string]: any

Constructors

Constructor

new ODataModule(): ODataModule

Defined in: node_modules/.pnpm/@nestjs+common@11.1.18_reflect-metadata@0.2.2_rxjs@7.8.2/node_modules/@nestjs/common/module-utils/interfaces/configurable-module-cls.interface.d.ts:12

Returns

ODataModule

Inherited from

ConfigurableModuleClass.constructor

Accessors

registeredServiceRoot

Get Signature

get static registeredServiceRoot(): string

Defined in: packages/core/src/odata.module.ts:134

Returns the serviceRoot registered via forRoot(). Used by adapter modules (e.g. ODataTypeOrmModule).

Returns

string

Methods

forFeature()

static forFeature(entityConfigs): DynamicModule

Defined in: packages/core/src/odata.module.ts:205

Register EDM entity configurations from a feature module. Entities provided here are available via the EDM_ENTITY_CONFIGS injection token.

Parameters

entityConfigs

EdmEntityConfig[]

Returns

DynamicModule


forRoot()

static forRoot(options): DynamicModule

Defined in: packages/core/src/odata.module.ts:139

Override forRoot to inject the resolved-options provider into the dynamic module.

Parameters

options

ODataModuleOptions

Returns

DynamicModule

Overrides

ConfigurableModuleClass.forRoot


forRootAsync()

static forRootAsync(options): DynamicModule

Defined in: packages/core/src/odata.module.ts:181

Override forRootAsync to inject the resolved-options provider into the dynamic module.

Parameters

options

ConfigurableModuleAsyncOptions<ODataModuleOptions>

Returns

DynamicModule

Overrides

ConfigurableModuleClass.forRootAsync