AddressSchemaclass

new AddressSchema({ one = "address", title = "Address", ...options }: AddressSchemaOptions = {})
ParamType
optionsAddressSchemaOptions
Allowed options for AddressSchema. Defaults to {}
    .valuePartial<AddressData>
Partial default value merged over the per-field defaults. readonly
Return
AddressSchema
Schema that validates a postal address.

Schema that validates a postal address.

  • Validates the address1, address2, city, state, postcode, and country fields as a single AddressData object.
  • Formats validated values into a human-readable address string via formatAddress().

Examples

ADDRESS.validate({ address1: "1 High St", city: "London", postcode: "SW1A 1AA", country: "GB" });