Add AE getValue type (#410)

* Add AE getValue type * prettier and update comment * Add .then to test
stripe · Jan 17, 2023 · 3faf2a2 · 3faf2a2
1 parent c8af87f
commit 3faf2a2
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 0 deletions.
diff --git a/tests/types/src/valid.ts b/tests/types/src/valid.ts
@@ -596,6 +596,12 @@ addressElement.update({
   },
 });
 
+addressElement.getValue().then((res) => {
+  if (res.complete && res.isNewAddress) {
+    const value = res.value;
+  }
+});
+
 const retrievedAddressElement: StripeAddressElement | null = elements.getElement(
   'address'
 );

diff --git a/types/stripe-js/elements/address.d.ts b/types/stripe-js/elements/address.d.ts
@@ -119,6 +119,13 @@ export type StripeAddressElement = StripeElementBase & {
    * Updates are merged into the existing configuration.
    */
   update(options: Partial<StripeAddressElementOptions>): StripeAddressElement;
+
+  /**
+   * Validates and retrieves form values from the `AddressElement`.
+   */
+  getValue(): Promise<
+    Pick<StripeAddressElementChangeEvent, 'complete' | 'isNewAddress' | 'value'>
+  >;
 };
 
 export interface ContactOption {