add deprecation notice

sveltejs · May 16, 2023 · 8e22421 · 8e22421
1 parent 7f50d7d
commit 8e22421
Showing 1 changed file with 16 additions and 0 deletions.
diff --git a/packages/kit/types/ambient.d.ts b/packages/kit/types/ambient.d.ts
@@ -80,8 +80,16 @@ declare module '$app/forms' {
 		Invalid extends Record<string, unknown> | undefined = Record<string, any>
 	> = (input: {
 		action: URL;
+		/**
+		 * use `formData` instead of `data`
+		 * @deprecated
+		 */
 		data: FormData;
 		formData: FormData;
+		/**
+		 * use `formElement` instead of `form`
+		 * @deprecated
+		 */
 		form: HTMLFormElement;
 		formElement: HTMLFormElement;
 		controller: AbortController;
@@ -90,8 +98,16 @@ declare module '$app/forms' {
 	}) => MaybePromise<
 		| void
 		| ((opts: {
+				/**
+				 * use `formData` instead of `data`
+				 * @deprecated
+				 */
 				data: FormData;
 				formData: FormData;
+				/**
+				 * use `formElement` instead of `form`
+				 * @deprecated
+				 */
 				form: HTMLFormElement;
 				formElement: HTMLFormElement;
 				action: URL;