Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: add ESM usage example in Getting Started #5294

Merged
merged 4 commits into from
Jan 28, 2024
Merged

docs: add ESM usage example in Getting Started #5294

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
edc7f50
Add ESM example and type module configuration
atilagulers Jan 26, 2024
945205b
Fix linting errors in Getting-Started.md
atilagulers Jan 27, 2024
4b6b18c
Apply suggestions from code review
atilagulers Jan 27, 2024
29ad595
Apply suggestion
atilagulers Jan 27, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
13 changes: 13 additions & 0 deletions docs/Guides/Getting-Started.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,14 @@ fastify.listen({ port: 3000 }, function (err, address) {
})
```

> If you are using ECMAScript Modules (ESM) in your project, be sure to
> include "type": "module" in your package.json.
>```js
>{
> "type": "module"
>}
>```

Do you prefer to use `async/await`? Fastify supports it out-of-the-box.

```js
Expand Down Expand Up @@ -172,6 +180,7 @@ fastify.listen({ port: 3000 }, function (err, address) {
})
```


```js
// our-first-route.js

Expand All @@ -186,6 +195,10 @@ async function routes (fastify, options) {
})
}

//ESM
export default routes;

// CommonJs
module.exports = routes
```
In this example, we used the `register` API, which is the core of the Fastify
Expand Down