phares3757/netlify-nuxt-toolbox
3
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs (#2): clarify the need for async keyword

Browse Source
This commit is contained in:
Ben Hong 2022-02-23 08:38:09 -08:00 committed by GitHub
parent 0168b22e4a
commit 79d504f3bb
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 13 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
README.md
View File

@ -141,15 +141,25 @@ There are many ways to use redirects. Check out the resouces below to learn more
- [Redirect by country or language](https://docs.netlify.com/routing/redirects/redirect-options/#redirect-by-country-or-language)
- [On-Demand Builders](https://docs.netlify.com/configure-builds/on-demand-builders/)
## Serverless Functions
## Netlify Functions
With Netlify, you can build out server-side code without having to setup and maintain a dedicated server. Inside of our default folder path, [`netlify/functions`](./netlify/functions) you can see an example of the format for JavaScript functions with the [`joke.js`](./netlify/functions/joke.js) file.
The function format expects a function named `handler` to be exported. This will be the function that will be invoked whenever a client makes a request to the generated endpoints. The endpoint's format is followed as `/.netlify/functions/joke`. So whenever the site is deployed, if you go to `https://<site base url>/.netlify/functions/joke` you will see a random joke!
The function format expects an `async` function named `handler` to be exported.*
```js
export const handler = async () => {
// Your code goes in here!
}
```
* *Note: ESLint may report that the async is unnecessary if there is no `await` code within the function, but the `async` is required. Do not delete it.*
This will be the function that will be invoked whenever a client makes a request to the generated endpoints. The endpoint's format is followed as `/.netlify/functions/joke`. So whenever the site is deployed, if you go to `https://<site base url>/.netlify/functions/joke` you will see a random joke!
> Side note: In our example, we're using `import` to include data from another location and `export const const handler` to let our function be consumed by Netlify. We're able to do this because of [esbuild](https://esbuild.github.io). This is a bundler configuration we set in our `netlify.toml` under `[functions]`.
### Serverless Functions Resources
### Netlify Functions Resources
There is quite a bit you can do with these functions, so here are some additional resources to learn more!