Interface HTTPContext

interface HTTPContext {
    executeInContext<T = any>(
        context: AppContext,
        callback: () => T | Promise<T>,
    ): Promise<T>;
    get(): AppContext;
    middleware(req: AppRequest, res: unknown, next: () => void): Promise<void>;
    set(context: AppContext): void;
}

Hierarchy (View Summary)

ServiceContext
- HTTPContext

Index

Methods

executeInContext get middleware set

Methods

executeInContext

executeInContext<T = any>(
context: AppContext,
callback: () => T | Promise<T>,
): Promise<T>
Base function where all code logic is executed
Type Parameters
- T = any
Parameters
- context: AppContext
- callback: () => T | Promise<T>
Returns Promise<T>
Inherited from ServiceContext.executeInContext
- Defined in packages/services/src/services/AppContext/ServiceContext.ts:19

get

get(): AppContext
Get the context within the execution

Returns AppContext
Inherited from ServiceContext.get
- Defined in packages/services/src/services/AppContext/ServiceContext.ts:7

middleware

middleware(req: AppRequest, res: unknown, next: () => void): Promise<void>
To set the context with the authenticated user and the data of the server request
Parameters
- req: AppRequest
- res: unknown
- next: () => void
Returns Promise<void>
- Defined in packages/services/src/services/AppContext/HTTPContext.ts:9

set

set(context: AppContext): void
Get the context within the execution
Parameters
- context: AppContext
Returns void
Inherited from ServiceContext.set
- Defined in packages/services/src/services/AppContext/ServiceContext.ts:12

Interface HTTPContext

Hierarchy (View Summary)

Index

Methods

Methods

executeInContext

Type Parameters

Parameters

Returns Promise<T>

get

Returns AppContext

middleware

Parameters

Returns Promise<void>

set

Parameters

Returns void

Settings

On This Page