Search.../
  1. APIs

validate( )

Deprecated: Validates form fields and values against the registration form as defined in the site Dashboard.

Description

Deprecation note: The validate() function of the RsvpForm object is being deprecated. Use the validate() function of the Form object instead.

The validate() function returns a Promise that resolves to {valid: true} if the fields and values in the RSVP form are valid or rejects if there are invalid fields or values.

You can validate your form explicitly using the validate() function. Validation is also implicitly performed when you call the submit() function. When the validate() function is called, explicitly or implicitly, the validateInput() function also runs for all your form fields.

The following are invalid when checked against the event's registration form as defined in the site Dashboard:

  • The specified form values contain a field that does not exist in the event's registration form.
  • The specified form values are missing a field that exists in the event's registration form. You must also include non-required fields even if their values are empty.

Note: To work with the Wix Events API, you need to publish your site.

Syntax

function validate(formValues: Array<FormValue>): Promise<ValidationResult>

validate Parameters

NAME
TYPE
DESCRIPTION
formValues
Array<FormValue>

Field names and values for an RSVP form.

Returns

Fulfilled - Validation result when validation passes. Rejected - FieldValidationError when validation fails.

Return Type:

Promise<ValidationResult>
NAME
TYPE
DESCRIPTION
valid
boolean

Indicates that the RSVP form fields are valid.

Was this helpful?

Validate an RSVP form

Copy Code
1import wixEventsFrontend from 'wix-events-frontend';
2

3// ...
4

5const eventId = // Get the event ID
6const form = wixEventsFrontend.createEventRsvpForm(eventId);
7

8// ...
9

10let formValues = // get form values
11

12form.validate(formValues)
13  .then((response) => {
14    // handle case where form is valid
15  })
16  .catch((error) => {
17    // handle case where form is not valid
18    let message = error.message; // "Following fields have invalid IDs: nonExistent1, nonExistent2"
19    let fields = error.fields; // ["nonExistent1", "nonExistent2"]
20  });