Deprecated "posted".

ciscoheat · Aug 12, 2024 · 5279de0 · 5279de0
1 parent 5802d3e
commit 5279de0
Show file tree

Hide file tree

Showing 3 changed files with 10 additions and 0 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -7,6 +7,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## Unreleased
 
+### Deprecated
+
+- `posted` is deprecated, due to inconsistencies between server and client validation, and SPA mode. It will be removed in v3. Use a [status message](https://superforms.rocks/concepts/messages) or return your own data in the form action to handle form post status.
+
 ### Added
 
 - `descriptionAsErrors` option for the JSON Schema validator, so you can specify error messages directly in the schema with the `description` field.

diff --git a/src/lib/client/superForm.ts b/src/lib/client/superForm.ts
@@ -239,6 +239,9 @@ export type SuperForm<
 	submitting: Readable<boolean>;
 	delayed: Readable<boolean>;
 	timeout: Readable<boolean>;
+	/**
+	 * @deprecated posted is inconsistent between server and client validation, and SPA mode. Will be removed in v3. Use a status message or return your own data in the form action to handle form post status.
+	 */
 	posted: Readable<boolean>;
 
 	allErrors: Readable<{ path: string; messages: string[] }[]>;

diff --git a/src/lib/superValidate.ts b/src/lib/superValidate.ts
@@ -29,6 +29,9 @@ export type SuperValidated<
 > = {
 	id: string;
 	valid: boolean;
+	/**
+	 * @deprecated posted is inconsistent between server and client validation, and SPA mode. Will be removed in v3. Use a status message or return your own data in the form action to handle form post status.
+	 */
 	posted: boolean;
 	errors: ValidationErrors<Out>;
 	data: Out;