GoogleCloudPlatform / GoogleCloudPlatform/functions-framework-nodejs

esm and typescript documentation

Open
#520 0 comments 2 reactions 0 assignees View on GitHub
enhancement P3
Dominant language
TypeScript
Stars
1.4k
Forks
181
PR merge metrics
No merged PRs in 30d

Description

there exists docs for esm and typescript separately, both nothing on how to use them together.

A best practice documentation for this would be very helpful.

In tsconfig.json should for example `"module": "NodeNext",` be used?

Contributor guide

Open the contributing guide

Research direction

Start by reading the existing ESM and TypeScript documentation and checking how this Node.js framework currently describes module configuration. Define the supported combination and recommended tsconfig.json settings, then add an example explaining how to use ESM and TypeScript together. Done means the guidance covers the relevant setup without leaving the configuration question unresolved.

Written by the indexing model from the issue text.

Assessment

Tech stack
node.js, typescript
Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.