File tree Expand file tree Collapse file tree 1 file changed +8
-1
lines changed
Expand file tree Collapse file tree 1 file changed +8
-1
lines changed Original file line number Diff line number Diff line change @@ -936,7 +936,14 @@ export type EnqueueBackgroundActionOptions<Action extends AnyActionFunction> = {
936936 startAt ?: Date | string ;
937937
938938 /**
939- * The Shopify shop to enqueue the background action for. If not passed, the action will not be rate limited.
939+ * The Shopify shop ID to associate with this background action for intelligent rate limiting.
940+ *
941+ * When provided, Gadget will automatically manage the execution of enqueued background actions based on your app's
942+ * available Shopify API rate limit capacity. If your app is being rate limited by Shopify, Gadget will defer
943+ * execution and only process actions when there is sufficient rate limit headroom to complete them successfully.
944+ *
945+ * If not provided, the action will be executed immediately without any rate limit awareness, which may result
946+ * in Shopify API errors if your app is under heavy load.
940947 *
941948 * @example
942949 * shopifyShop: "82277368081"
You can’t perform that action at this time.
0 commit comments