| Branch | Status | Runtime Version | Support level | Node.js Versions |
|---|---|---|---|---|
| v3.x (default) | 4 | GA | 26, 24, 22 |
NOTE: The branch corresponds to the worker version, which is intentionally decoupled from the runtime version.
- Clone the repository locally and open in VS Code
- Run "Extensions: Show Recommended Extensions" from the command palette and install all extensions listed under "Workspace Recommendations"
- Run
npm installandnpm run build - Create or open a local function app to test with
- In the local function app, add the following settings to your "local.settings.json" file or configure them directly as environment variables
-
languageWorkers__node__workerDirectory:<path to the root of this repository> -
languageWorkers__node__arguments:--inspect💡 Tip #1: Set
logging__logLevel__Workertodebugif you want to view worker-specific logs in the output offunc start💡 Tip #2: If you need to debug worker initialization, use
--inspect-brkinstead of--inspect. Just keep in mind you need to attach the debugger within 30 seconds or the host process will timeout.
-
- Start the local function app (i.e. run
func startor press F5) - Back in the worker repository, press F5 and select the process for your running function app
- Before you submit a PR, run
npm run lintandnpm testand fix any issues. If you want to debug the tests, switch your launch profile in VS Code to "Launch Unit Tests" and press F5.
When WorkerInitRequest.capabilities["HostConfiguration"] is exactly "1", the worker
captures host.json and attaches WorkerInitResponse.host_configuration. Root resolution uses
AzureWebJobsScriptRoot for a customer-configured custom root, or Linux-only /home/site/wwwroot when that setting
is missing or blank. Empty/whitespace-only values are blank; selected paths are preserved untrimmed.
Non-Linux has no hardcoded default: a missing or blank AzureWebJobsScriptRoot
returns AppDirectoryNotSet. File open/read errors never trigger fallback to another root. Neither the Host's
function_app_directory nor cwd is a root fallback; explicit relative paths use native filesystem resolution.
This resolution does not change the Host's function app startup behavior.
The snapshot is lazy and shared across concurrent/repeated initialization requests for the current app generation, including failures. Specialization creates a new generation. Unrequested initialization performs no configuration lookup or I/O. There are no live rereads or retries of cached failures.
Delivery converts strict UTF-8 (default) or BOM-marked UTF-8, UTF-16 LE/BE, or UTF-32
LE/BE incrementally to BOM-free UTF-8. Both the converted source (before parsing)
and normalized output are limited to 65,536 bytes. Input must contain one JSON object
root, with at most 64 nested containers including that root. Empty or BOM-only files,
non-object roots, whitespace/comment-only input, and malformed JSON return content-free
Error with reason InvalidJson. An empty object ({}) is valid, as are arrays and
scalars nested inside an object. Normalization removes // and /* */ comments and
trailing commas while preserving raw string/number tokens, escapes, duplicate keys,
and key order.
Missing files, acquisition/conversion/JSON errors, and oversized output have distinct
content-free outcomes. Each cached failure emits one system warning with a fixed
reason code, never a path, exception message, or file content. Available and Missing
outcomes and cache replays emit no warning. These outcomes do not replace the existing
worker-init result. The Host still owns settings validation, defaults, and
AzureFunctionsJobHost__ overrides. Node uses fatal decoders and accepts legitimately
encoded U+FFFD; it does not use replacement-character detection to infer encoding errors.
The vendored APP-01 fields and comments come from
Azure/azure-functions-language-worker-protobuf#103,
commit 313666583af4e97f0b534f1cbf61a3812f277c12; unrelated newer protocol fields are not
imported. The behavioral reference is
Azure/azure-functions-dotnet-worker#3522,
commit e7765e7201008340e4cc407486bbd31649abf162, including its object-root validation,
compact-normalization, and cached-failure diagnostic behavior. Regenerate the vendored bindings
with npm run gen (also run by npm run build); generated RPC files are not edited
manually. Integration requires the compatible Host receiver and an opaque proxy path.
These are the most important GitHub repositories that make up the Node.js experience on Azure Functions:
- azure-functions-nodejs-library: The
@azure/functionsnpm package that you include in your app. - azure-functions-nodejs-worker: The other half of the Node.js experience that ships directly in Azure.
- azure-functions-nodejs-e2e-tests: A set of automated end-to-end tests designed to run against prerelease versions of all Node.js components.
- azure-functions-host: The runtime shared by all languages in Azure Functions.
- azure-functions-core-tools: The CLI used to test Azure Functions locally.
This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.
The type definitions supplied by the @azure/functions npm package are located in the types folder. Any changes should be applied directly to ./types/index.d.ts. Please make sure to update the tests in ./types/index.test.ts as well.