docs: explain how to add ambient typings (#8558)

* docs: explain how to add ambient typings closes #8527 * Update packages/kit/types/ambient.d.ts Co-authored-by: Rich Harris <richard.a.harris@gmail.com>
sveltejs · Jan 17, 2023 · 0523ab9 · 0523ab9
1 parent 1f3e1f1
commit 0523ab9
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 1 deletion.
diff --git a/.changeset/curvy-chefs-design.md b/.changeset/curvy-chefs-design.md
@@ -0,0 +1,5 @@
+---
+'@sveltejs/kit': patch
+---
+
+docs: explain how to add ambient typings
diff --git a/packages/kit/types/ambient.d.ts b/packages/kit/types/ambient.d.ts
@@ -11,9 +11,12 @@
  * 	}
  * }
  *
- * export default undefined;
+ * export {};
  * ```
  *
+ * The `export {}` line exists because without it, the file would be treated as an _ambient module_ which prevents you from adding `import` declarations.
+ * If you need to add ambient `declare module` declarations, do so in a separate file like `src/ambient.d.ts`.
+ *
  * By populating these interfaces, you will gain type safety when using `event.locals`, `event.platform`, and `data` from `load` functions.
  */
 declare namespace App {