Update index.d.ts (#8956)

* Update index.d.ts Doc update attempt, following #8948 * Update index.d.ts Better formulation * Update packages/kit/types/index.d.ts * changeset --------- Co-authored-by: Rich Harris <hello@rich-harris.dev>
sveltejs · Feb 9, 2023 · 0abb8eb · 0abb8eb
1 parent 351af24
commit 0abb8eb
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 2 deletions.
diff --git a/.changeset/chilly-otters-act.md b/.changeset/chilly-otters-act.md
@@ -0,0 +1,5 @@
+---
+'@sveltejs/kit': patch
+---
+
+docs: clarify that `version.name` should be deterministic
diff --git a/packages/kit/types/index.d.ts b/packages/kit/types/index.d.ts
@@ -542,8 +542,7 @@ export interface KitConfig {
 	 */
 	version?: {
 		/**
-		 * The current app version string.
-		 * @default Date.now().toString()
+		 * The current app version string. If specified, this must be deterministic (e.g. a commit ref rather than `Math.random()` or Date.now().toString()`), otherwise defaults to a timestamp of the build
 		 */
 		name?: string;
 		/**