Options
All
  • Public
  • Public/Protected
  • All
Menu

Class AzureMiddleware<Input>

Type parameters

  • Input = any

Hierarchy

  • AzureMiddleware

Index

Constructors

Methods

Constructors

constructor

Methods

use

  • Adds a middleware layer to the AzureMiddleware object.

    example
    import azureMiddleware from '@polarpop/azure-middleware';
    import { HttpRequest } from '@azure/functions';

    const app = azureMiddleware<HttpRequest>();

    app.use((context, req) => {
    context.log.info(`Request started from ${req.body.user}`);
    context.done();
    })

    export default app.listen();

    Type parameters

    • ContextRecord: Record<string, unknown>

    Parameters

    Returns AzureMiddleware<Input>

    The app instance

  • Adds a chain of middleware layers together.

    example
    import azureMiddleware from '@polarpop/azure-middleware';
    import { HttpRequest } from '@azure/functions';

    const app = azureMiddleware<HttpRequest>();

    app.use((context, req) => {
    context.user = req.body.user;
    context.next(undefined, context);
    }, (context, req) => {
    context.log.info(`Context user passed to function ${context.user}`);
    context.done();
    })

    export default app.listen();

    Type parameters

    • ContextRecord: Record<string, unknown>

    Parameters

    Returns AzureMiddleware<Input>

    The app instance

listen

  • listen(): undefined | ((context: Context, input: Input, ...args: any[]) => Promise<void>)
  • Returns the Azure function handle. This is required to actually use all of the middleware.

    example
    import azureMiddleware from '@polarpop/azure-middleware';
    import { HttpRequest } from '@azure/functions';

    const app = azureMiddleware<HttpRequest>();

    app.use((context, req) => {
    context.log.info(`Request started from ${req.body.user}`);
    context.done();
    })

    // we are now connected to the azure function.
    export default app.listen();

    Returns undefined | ((context: Context, input: Input, ...args: any[]) => Promise<void>)

Generated using TypeDoc