diff options
| author | Ruben Beltran del Rio <ruben@unlimited.pizza> | 2022-05-01 15:10:56 +0200 |
|---|---|---|
| committer | Ruben Beltran del Rio <ruben@unlimited.pizza> | 2022-05-01 15:10:56 +0200 |
| commit | e8fcef96681425d431d03fa323747d7d6e61257c (patch) | |
| tree | 0646922304ac38721b2f53485d1c1106d6c300d5 /doc/interfaces | |
| parent | 3260d5e90a30bbf57e3e5822aa84c23cee0411be (diff) | |
Add typedoc
Diffstat (limited to 'doc/interfaces')
| -rw-r--r-- | doc/interfaces/App.Locals.md | 7 | ||||
| -rw-r--r-- | doc/interfaces/App.Platform.md | 7 | ||||
| -rw-r--r-- | doc/interfaces/App.Session.md | 7 | ||||
| -rw-r--r-- | doc/interfaces/App.Stuff.md | 7 |
4 files changed, 28 insertions, 0 deletions
diff --git a/doc/interfaces/App.Locals.md b/doc/interfaces/App.Locals.md new file mode 100644 index 0000000..4f4f400 --- /dev/null +++ b/doc/interfaces/App.Locals.md @@ -0,0 +1,7 @@ +[forum](../README.md) / [Exports](../modules.md) / [App](../modules/App.md) / Locals + +# Interface: Locals + +[App](../modules/App.md).Locals + +The interface that defines `event.locals`, which can be accessed in [hooks](/docs/hooks) (`handle`, `handleError` and `getSession`) and [endpoints](/docs/routing#endpoints). diff --git a/doc/interfaces/App.Platform.md b/doc/interfaces/App.Platform.md new file mode 100644 index 0000000..dc29fdc --- /dev/null +++ b/doc/interfaces/App.Platform.md @@ -0,0 +1,7 @@ +[forum](../README.md) / [Exports](../modules.md) / [App](../modules/App.md) / Platform + +# Interface: Platform + +[App](../modules/App.md).Platform + +If your adapter provides [platform-specific context](/docs/adapters#supported-environments-platform-specific-context) via `event.platform`, you can specify it here. diff --git a/doc/interfaces/App.Session.md b/doc/interfaces/App.Session.md new file mode 100644 index 0000000..600a72b --- /dev/null +++ b/doc/interfaces/App.Session.md @@ -0,0 +1,7 @@ +[forum](../README.md) / [Exports](../modules.md) / [App](../modules/App.md) / Session + +# Interface: Session + +[App](../modules/App.md).Session + +The interface that defines `session`, both as an argument to [`load`](/docs/loading) functions and the value of the [session store](/docs/modules#$app-stores). diff --git a/doc/interfaces/App.Stuff.md b/doc/interfaces/App.Stuff.md new file mode 100644 index 0000000..14f9d50 --- /dev/null +++ b/doc/interfaces/App.Stuff.md @@ -0,0 +1,7 @@ +[forum](../README.md) / [Exports](../modules.md) / [App](../modules/App.md) / Stuff + +# Interface: Stuff + +[App](../modules/App.md).Stuff + +The interface that defines `stuff`, as input or output to [`load`](/docs/loading) or as the value of the `stuff` property of the [page store](/docs/modules#$app-stores). |