Skip to content

Commit ff96a1d

Browse files
authored
docs: add notes on adding Background and Scheduled functions (#493)
1 parent 1c5c1e1 commit ff96a1d

File tree

1 file changed

+7
-1
lines changed

1 file changed

+7
-1
lines changed

README.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,7 @@ for more information, including optional plugin configuration.
6969
### Disabling Netlify functions
7070

7171
In order to support Gatsby Functions and DSG and SSR render modes, this plugin
72-
generates four Netlify Functions called `__api`, `__ssr`, `__dsg` and `_ipx`. If
72+
generates four Netlify Functions called `__api`, `__ssr`, `__dsg` and `_ipx`. If
7373
you are not using any of these modes, then you can disable the creation of these
7474
functions. If you are using the latest version of `gatsby-plugin-netlify` then
7575
this will be handled automatically, disabling functions if the site has no
@@ -101,3 +101,9 @@ When developing Gatsby Functions it is usually easier to use the built-in
101101
functions wrapper it will run via `netlify dev`. You should be sure to run
102102
`netlify build` first, so that the wrappers are generated and the functions
103103
copied across.
104+
105+
## Background and Scheduled Functions
106+
107+
In order to use [Background](https://docs.netlify.com/functions/background-functions/) or [Scheduled](https://docs.netlify.com/netlify-labs/experimental-features/scheduled-functions/) Functions in your Gatsby project, you will need to create a `netlify/functions` directory at the root of the project, and put the Functions in there.
108+
109+
Once that's completed, the Background or Scheduled Function can be invoked like an ordinary Gatsby function.

0 commit comments

Comments
 (0)