@nest-boot/auth-rls

Classes

AuthRlsContext

Defined in: packages/auth-rls/src/auth-rls.context.ts:48

Constructors

Constructor

new AuthRlsContext(): AuthRlsContext;

Returns

AuthRlsContext

Methods

entries()

entries(): [string, string][];

Defined in: packages/auth-rls/src/auth-rls.context.ts:61

Returns

[string, string][]

set()

set<S>(key, value): AuthRlsContext;

Defined in: packages/auth-rls/src/auth-rls.context.ts:51

Type Parameters

Type Parameter
S extends string

Parameters

Parameter	Type
key	SnakeCase<S>
value	string

Returns

AuthRlsContext

toSQL()

toSQL(): string;

Defined in: packages/auth-rls/src/auth-rls.context.ts:65

Returns

string

---

AuthRlsMiddleware

Defined in: packages/auth-rls/src/auth-rls.middleware.ts:15

Implements

• NestMiddleware

Constructors

Constructor

new AuthRlsMiddleware(em, authRlsService): AuthRlsMiddleware;

Defined in: packages/auth-rls/src/auth-rls.middleware.ts:16

Parameters

Parameter	Type
em	EntityManager
authRlsService	AuthRlsService

Returns

AuthRlsMiddleware

Properties

authRlsService

protected readonly authRlsService: AuthRlsService;

Defined in: packages/auth-rls/src/auth-rls.middleware.ts:18

Methods

use()

use(
   _req, 
   _res, 
next): Promise<void>;

Defined in: packages/auth-rls/src/auth-rls.middleware.ts:21

Parameters

Parameter	Type
_req	Request
_res	Response
next	NextFunction

Returns

Promise<void>

Implementation of

NestMiddleware.use

---

AuthRlsModule

Defined in: packages/auth-rls/src/auth-rls.module.ts:20

Extends

• ConfigurableModuleClass

Indexable

[key: string]: any

Constructors

Constructor

new AuthRlsModule(
   middlewareManager, 
   authRlsMiddleware, 
   options?): AuthRlsModule;

Defined in: packages/auth-rls/src/auth-rls.module.ts:21

Parameters

Parameter	Type
middlewareManager	MiddlewareManager
authRlsMiddleware	AuthRlsMiddleware
options?	AuthRlsModuleOptions

Returns

AuthRlsModule

Overrides

ConfigurableModuleClass.constructor

Properties

forRoot()

static forRoot: (options) => DynamicModule;

Parameters

Parameter	Type
options	AuthRlsModuleOptions & Partial<{ }>

Returns

DynamicModule

Inherited from

ConfigurableModuleClass.forRoot

forRootAsync()

static forRootAsync: (options) => DynamicModule;

Parameters

Parameter	Type
options	ConfigurableModuleAsyncOptions<AuthRlsModuleOptions, "create"> & Partial<{ }>

Returns

DynamicModule

Inherited from

ConfigurableModuleClass.forRootAsync

---

AuthRlsService

Defined in: packages/auth-rls/src/auth-rls.service.ts:11

Constructors

Constructor

new AuthRlsService(options?): AuthRlsService;

Defined in: packages/auth-rls/src/auth-rls.service.ts:12

Parameters

Parameter	Type
options?	AuthRlsModuleOptions

Returns

AuthRlsService

Properties

options?

protected readonly optional options: AuthRlsModuleOptions;

Defined in: packages/auth-rls/src/auth-rls.service.ts:15

Methods

setRlsContext()

setRlsContext(em, user?): Promise<void>;

Defined in: packages/auth-rls/src/auth-rls.service.ts:18

Parameters

Parameter	Type
em	EntityManager
user?	BaseUser

Returns

Promise<void>

Interfaces

AuthRlsModuleMiddlewareOptions

Defined in: packages/auth-rls/src/auth-rls-module-options.interface.ts:5

Properties

excludeRoutes?

optional excludeRoutes: (string | RouteInfo)[];

Defined in: packages/auth-rls/src/auth-rls-module-options.interface.ts:8

includeRoutes?

optional includeRoutes: (string | RouteInfo | Type<any>)[];

Defined in: packages/auth-rls/src/auth-rls-module-options.interface.ts:7

register?

optional register: boolean;

Defined in: packages/auth-rls/src/auth-rls-module-options.interface.ts:6

---

AuthRlsModuleOptions

Defined in: packages/auth-rls/src/auth-rls-module-options.interface.ts:11

Properties

context()?

optional context: (ctx) => 
  | AuthRlsContext
| Promise<AuthRlsContext>;

Defined in: packages/auth-rls/src/auth-rls-module-options.interface.ts:12

Parameters

Parameter	Type
ctx	AuthRlsContext

Returns

| AuthRlsContext | Promise<AuthRlsContext>

middleware?

optional middleware: AuthRlsModuleMiddlewareOptions;

Defined in: packages/auth-rls/src/auth-rls-module-options.interface.ts:14