Skip to content

nestjs/azure-func-http

Repository files navigation

Nest Logo

A progressive Node.js framework for building efficient and scalable server-side applications.

NPM Version Package License NPM Downloads Coverage Discord Backers on Open Collective Sponsors on Open Collective

Description

Azure Functions HTTP module for Nest.

Installation

Using the Nest CLI:

$ nest add @nestjs/azure-func-http

Example output:

✔ Installation in progress... ☕
CREATE /.funcignore (66 bytes)
CREATE /host.json (23 bytes)
CREATE /local.settings.json (116 bytes)
CREATE /proxies.json (72 bytes)
CREATE /main/function.json (294 bytes)
CREATE /main/index.ts (287 bytes)
CREATE /main/sample.dat (23 bytes)
CREATE /src/main.azure.ts (321 bytes)
UPDATE /package.json (1827 bytes)

Tutorial

You can read more about this integration here.

Native routing

If you don't need the compatibility with express library, you can use a native routing instead:

const app = await NestFactory.create(AppModule, new AzureHttpRouter());

AzureHttpRouter is exported from @nestjs/azure-func-http. Since AzureHttpRouter doesn't use express underneath, the routing itself is much faster.

Additional options

You can pass additional flags to customize the post-install schematic. For example, if your base application directory is different than src, use --rootDir flag:

$ nest add @nestjs/azure-func-http --rootDir app

Other available flags:

  • rootModuleFileName - the name of the root module file, default: app.module
  • rootModuleClassName - the name of the root module class, default: AppModule
  • skipInstall - skip installing dependencies, default: false

Support

Nest is an MIT-licensed open source project. It can grow thanks to the sponsors and support by the amazing backers. If you'd like to join them, please read more here.

Stay in touch

License

Nest is MIT licensed.