Hacktoberfest 2026: the issues maintainers tagged for October, open and beginner-friendly. Browse Hacktoberfest issues

Improve docs on passing args to node process

Open
#648 6 comments 5 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
3/5
Estimated time
1-2 days
Newbie friendliness
25/100
Issue type
Documentation
Clarity
Needs clarification
Activity status
Stale
Tech stack
node.js, typescript
Domain
documentation

Research direction

Start with the func start argument behavior and the local.settings.json NODE_OPTIONS example described in the issue. Clarify how Node.js profiling arguments are passed, where the resulting .log file is written, and whether the documentation should explain the NODE_OPTIONS restriction; done means the documented workflow works or its limitation is explicit.

Written by the indexing model from the issue text.

Description

area:nodejs-functions docs enhancement

func start with -- "--prof" seems to do nothing. I, at least, can't find the resulting *.log file anywhere on my system.

Adding --prof to NODE_OPTIONS in local.settings.json results in an error message.

Relevant output snippet:

Azure Functions Core Tools
Core Tools Version:       4.0.4865 Commit hash: N/A  (64-bit)
Function Runtime Version: 4.12.2.19454

[2022-12-01T13:39:27.380Z] Language Worker Process exited. Pid=14562.
[2022-12-01T13:39:27.380Z] node exited with code 9 (0x9). .
[2022-12-01T13:39:27.390Z] node: --prof is not allowed in NODE_OPTIONS

Easy profiling of Node.js apps (https://nodejs.org/en/docs/guides/simple-profiling/) seems impossible, unless I'm missing something.

Please allow us to profile Node.js apps run with func start.

Dominant language
TypeScript
Stars
110
Forks
52
Avg merge
7h 33m
Merged PRs (30d)
1

Getting set up

This project ships no dev container, Dockerfile or contributing guide, so setting up is up to you: start from its README, and see our first-contribution guide for the general steps.

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from Azure/azure-functions-nodejs-worker

All issues in Azure/azure-functions-nodejs-worker

Similar issues

More TypeScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.