@bigcommerce/checkout-sdk › CheckoutStoreStatusSelector
Responsible for checking the statuses of various asynchronous actions related to checkout.
This object has a set of getters that return true if an action is in progress. For example, you can check whether a customer is submitting an order and waiting for the request to complete.
- CheckoutStoreStatusSelector
- isApplyingCoupon
- isApplyingGiftCertificate
- isApplyingStoreCredit
- isContinuingAsGuest
- isCreatingConsignments
- isCreatingCustomerAccount
- isCreatingCustomerAddress
- isCustomerStepPending
- isDeletingConsignment
- isDeletingInstrument
- isExecutingSpamCheck
- isFinalizingOrder
- isInitializingCustomer
- isInitializingPayment
- isInitializingShipping
- isLoadingBillingCountries
- isLoadingCart
- isLoadingCheckout
- isLoadingConfig
- isLoadingInstruments
- isLoadingOrder
- isLoadingPaymentMethod
- isLoadingPaymentMethods
- isLoadingShippingCountries
- isLoadingShippingOptions
- isPaymentStepPending
- isPending
- isRemovingCoupon
- isRemovingGiftCertificate
- isSelectingShippingOption
- isSendingSignInEmail
- isShippingStepPending
- isSigningIn
- isSigningOut
- isSubmittingOrder
- isUpdatingBillingAddress
- isUpdatingCheckout
- isUpdatingConsignment
- isUpdatingShippingAddress
- isUpdatingSubscriptions
▸ isApplyingCoupon(): boolean
Checks whether the current customer is applying a coupon code.
Returns: boolean
True if applying a coupon code, otherwise false.
▸ isApplyingGiftCertificate(): boolean
Checks whether the current customer is applying a gift certificate.
Returns: boolean
True if applying a gift certificate, otherwise false.
▸ isApplyingStoreCredit(): boolean
Checks whether the current customer is applying store credit.
Returns: boolean
True if applying store credit, otherwise false.
▸ isContinuingAsGuest(): boolean
Checks whether the shopper is continuing out as a guest.
Returns: boolean
True if continuing as guest, otherwise false.
▸ isCreatingConsignments(): boolean
Checks whether a given/any consignment is being updated.
A consignment ID should be provided when checking for a specific consignment, otherwise it will check for any consignment.
Returns: boolean
True if creating consignments, otherwise false.
▸ isCreatingCustomerAccount(): boolean
Checks whether a customer account is being created
Returns: boolean
True if creating, otherwise false.
▸ isCreatingCustomerAddress(): boolean
Checks whether a customer address is being created
Returns: boolean
True if creating, otherwise false.
▸ isCustomerStepPending(): boolean
Checks whether the customer step of a checkout is in a pending state.
The customer step is considered to be pending if it is in the process of initializing, signing in, signing out, and/or interacting with a customer widget.
Returns: boolean
True if the customer step is pending, otherwise false.
▸ isDeletingConsignment(consignmentId?: undefined | string): boolean
Checks whether a given/any consignment is being deleted.
A consignment ID should be provided when checking for a specific consignment, otherwise it will check for any consignment.
Parameters:
| Name | Type | Description |
|---|---|---|
consignmentId? |
undefined | string | The identifier of the consignment to be checked. |
Returns: boolean
True if deleting consignment(s), otherwise false.
▸ isDeletingInstrument(instrumentId?: undefined | string): boolean
Checks whether the current customer is deleting a payment instrument.
Parameters:
| Name | Type |
|---|---|
instrumentId? |
undefined | string |
Returns: boolean
True if deleting a payment instrument, otherwise false.
▸ isExecutingSpamCheck(): boolean
Checks whether spam check is executing.
Returns: boolean
True if the current checkout is being updated, otherwise false.
▸ isFinalizingOrder(): boolean
Checks whether the current order is finalizing.
Returns: boolean
True if the current order is finalizing, otherwise false.
▸ isInitializingCustomer(methodId?: undefined | string): boolean
Checks whether the customer step is initializing.
If an ID is provided, the method also checks whether the customer step is initializing using a specific customer method with the same ID.
Parameters:
| Name | Type | Description |
|---|---|---|
methodId? |
undefined | string | The identifier of the method used for initializing the customer step of checkout. |
Returns: boolean
True if the customer step is initializing, otherwise false.
▸ isInitializingPayment(methodId?: undefined | string): boolean
Checks whether a specific or any payment method is initializing.
The method returns true if no ID is provided and at least one payment method is initializing.
Parameters:
| Name | Type | Description |
|---|---|---|
methodId? |
undefined | string | The identifier of the payment method to check. |
Returns: boolean
True if the payment method is initializing, otherwise false.
▸ isInitializingShipping(methodId?: undefined | string): boolean
Checks whether the shipping step of a checkout process is initializing.
If an identifier is provided, the method also checks whether the shipping step is initializing using a specific shipping method with the same identifier.
Parameters:
| Name | Type | Description |
|---|---|---|
methodId? |
undefined | string | The identifer of the initialization method to check. |
Returns: boolean
True if the shipping step is initializing, otherwise false.
▸ isLoadingBillingCountries(): boolean
Checks whether billing countries are loading.
Returns: boolean
True if billing countries are loading, otherwise false.
▸ isLoadingCart(): boolean
Checks whether the current cart is loading.
Returns: boolean
True if the current cart is loading, otherwise false.
▸ isLoadingCheckout(): boolean
Checks whether the current checkout is loading.
Returns: boolean
True if the current checkout is loading, otherwise false.
▸ isLoadingConfig(): boolean
Checks whether the checkout configuration of a store is loading.
Returns: boolean
True if the configuration is loading, otherwise false.
▸ isLoadingInstruments(): boolean
Checks whether the current customer's payment instruments are loading.
Returns: boolean
True if payment instruments are loading, otherwise false.
▸ isLoadingOrder(): boolean
Checks whether the current order is loading.
Returns: boolean
True if the current order is loading, otherwise false.
▸ isLoadingPaymentMethod(methodId?: undefined | string): boolean
Checks whether a specific or any payment method is loading.
The method returns true if no ID is provided and at least one payment method is loading.
Parameters:
| Name | Type | Description |
|---|---|---|
methodId? |
undefined | string | The identifier of the payment method to check. |
Returns: boolean
True if the payment method is loading, otherwise false.
▸ isLoadingPaymentMethods(): boolean
Checks whether payment methods are loading.
Returns: boolean
True if payment methods are loading, otherwise false.
▸ isLoadingShippingCountries(): boolean
Checks whether shipping countries are loading.
Returns: boolean
True if shipping countries are loading, otherwise false.
▸ isLoadingShippingOptions(): boolean
Checks whether shipping options are loading.
Returns: boolean
True if shipping options are loading, otherwise false.
▸ isPaymentStepPending(): boolean
Checks whether the payment step of a checkout is in a pending state.
The payment step is considered to be pending if it is in the process of initializing, submitting an order, finalizing an order, and/or interacting with a payment widget.
Returns: boolean
True if the payment step is pending, otherwise false.
▸ isPending(): boolean
Checks whether any checkout action is pending.
Returns: boolean
True if there is a pending action, otherwise false.
▸ isRemovingCoupon(): boolean
Checks whether the current customer is removing a coupon code.
Returns: boolean
True if removing a coupon code, otherwise false.
▸ isRemovingGiftCertificate(): boolean
Checks whether the current customer is removing a gift certificate.
Returns: boolean
True if removing a gift certificate, otherwise false.
▸ isSelectingShippingOption(consignmentId?: undefined | string): boolean
Checks whether a shipping option is being selected.
A consignment ID should be provided when checking if a shipping option is being selected for a specific consignment, otherwise it will check for all consignments.
Parameters:
| Name | Type | Description |
|---|---|---|
consignmentId? |
undefined | string | The identifier of the consignment to be checked. |
Returns: boolean
True if selecting a shipping option, otherwise false.
▸ isSendingSignInEmail(): boolean
Checks whether a sign-in email is being sent.
Returns: boolean
True if sending a sign-in email, otherwise false
▸ isShippingStepPending(): boolean
Checks whether the shipping step of a checkout is in a pending state.
The shipping step is considered to be pending if it is in the process of initializing, updating address, selecting a shipping option, and/or interacting with a shipping widget.
Returns: boolean
True if the shipping step is pending, otherwise false.
▸ isSigningIn(methodId?: undefined | string): boolean
Checks whether the current customer is signing in.
If an ID is provided, the method also checks whether the customer is signing in using a specific customer method with the same ID.
Parameters:
| Name | Type | Description |
|---|---|---|
methodId? |
undefined | string | The identifier of the method used for signing in the current customer. |
Returns: boolean
True if the customer is signing in, otherwise false.
▸ isSigningOut(methodId?: undefined | string): boolean
Checks whether the current customer is signing out.
If an ID is provided, the method also checks whether the customer is signing out using a specific customer method with the same ID.
Parameters:
| Name | Type | Description |
|---|---|---|
methodId? |
undefined | string | The identifier of the method used for signing out the current customer. |
Returns: boolean
True if the customer is signing out, otherwise false.
▸ isSubmittingOrder(): boolean
Checks whether the current order is submitting.
Returns: boolean
True if the current order is submitting, otherwise false.
▸ isUpdatingBillingAddress(): boolean
Checks whether the billing address is being updated.
Returns: boolean
True if updating their billing address, otherwise false.
▸ isUpdatingCheckout(): boolean
Checks whether the current checkout is being updated.
Returns: boolean
True if the current checkout is being updated, otherwise false.
▸ isUpdatingConsignment(consignmentId?: undefined | string): boolean
Checks whether a given/any consignment is being updated.
A consignment ID should be provided when checking for a specific consignment, otherwise it will check for any consignment.
Parameters:
| Name | Type | Description |
|---|---|---|
consignmentId? |
undefined | string | The identifier of the consignment to be checked. |
Returns: boolean
True if updating consignment(s), otherwise false.
▸ isUpdatingShippingAddress(): boolean
Checks the shipping address is being updated.
Returns: boolean
True if updating their shipping address, otherwise false.
▸ isUpdatingSubscriptions(): boolean
Checks whether the subscriptions are being updated.
Returns: boolean
True if updating subscriptions, otherwise false.