From e8a6d28be861bc1ebe122590443372fdfb35e305 Mon Sep 17 00:00:00 2001 From: Darwin D Wu Date: Fri, 28 Jul 2023 01:45:12 -0700 Subject: [PATCH] docs: update `inngest` macro docs --- docs/development/serve-api.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/docs/development/serve-api.md b/docs/development/serve-api.md index 1727858..3415172 100644 --- a/docs/development/serve-api.md +++ b/docs/development/serve-api.md @@ -18,6 +18,18 @@ defmodule MyApp.Router do end ``` +Accepted arguments for the `inngest` macros are + +- `path` +- `opts` + +#### opts + +- `func` - the list of modules. e.g. `[MyApp.EventFn, MyApp.CronFn]` +- `path` - the path or paths to the inngest function modules. e.g. `path: "inngest/**/*.ex"` + +Among the options, `path` takes precedence. + There are 2 routers available based on what you're using for exposing HTTP endpoints for your apps: