Documentation on node.js functions
See original GitHub issueFrom @cesarvarela on January 14, 2017 3:12
Can’t find where is the convention for how node.js based functions should be defined. Does the main entry point must be called index.js
? does it have to be specified in the package.json
’s main
entry? Is it possible to rename it or place it in another folder?
Copied from original issue: projectkudu/AzureFunctionsPortal#868
Issue Analytics
- State:
- Created 7 years ago
- Comments:11 (8 by maintainers)
Top Results From Across the Web
Documentation | Node.js
The API reference documentation provides detailed information about a function or object in Node.js. This documentation indicates what arguments a method ...
Read more >What's the best way to document JavaScript?
/** * Add two numbers together * @param {Number} num1 The first number * @param {Number} num2 The second number * @return {Number}...
Read more >JavaScript Documentation Standards
The following is a list of what should be documented in WordPress JavaScript files: Functions and class methods; Objects; Closures; Object properties; Requires ......
Read more >Azure Functions Node.js developer guide
Understand how to develop functions by using Node.js.
Read more >Documenting JavaScript Code With JSDocs
The main idea behind JSDocs is to generate documentation for functions, classes, and methods. The benefit of using JSDocs for your code is ......
Read more >Top Related Medium Post
No results found
Top Related StackOverflow Question
No results found
Troubleshoot Live Code
Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start FreeTop Related Reddit Thread
No results found
Top Related Hackernoon Post
No results found
Top Related Tweet
No results found
Top Related Dev.to Post
No results found
Top Related Hashnode Post
No results found
Top GitHub Comments
How timely 😃
PR #1132 is just out (wrapping up a couple of remaining items) dealing with that exact issue. The problem is with script files outside of the function folder. Different file names work as expected.
Closing this out, the only actionable piece here is adding package.json
main
to serve as ascriptFile
default, but I think that would be better addressed in #73 if we implement it