fix: correct isDownloadable docs to match impl (#18748)

electron · Jun 13, 2019 · 0e0c3da · 0e0c3da
1 parent 63d9948
commit 0e0c3da
Show file tree

Hide file tree

Showing 4 changed files with 6 additions and 8 deletions.
diff --git a/atom/browser/api/atom_api_in_app_purchase.cc b/atom/browser/api/atom_api_in_app_purchase.cc
@@ -62,7 +62,7 @@ struct Converter<in_app_purchase::Product> {
     dict.Set("formattedPrice", val.formattedPrice);
 
     // Downloadable Content Information
-    dict.Set("isDownloadable", val.downloadable);
+    dict.Set("isDownloadable", val.isDownloadable);
 
     return dict.GetHandle();
   }

diff --git a/atom/browser/mac/in_app_purchase_product.h b/atom/browser/mac/in_app_purchase_product.h
@@ -29,7 +29,7 @@ struct Product {
   std::string formattedPrice;
 
   // Downloadable Content Information
-  bool downloadable = false;
+  bool isDownloadable = false;
 
   Product(const Product&);
   Product();

diff --git a/atom/browser/mac/in_app_purchase_product.mm b/atom/browser/mac/in_app_purchase_product.mm
@@ -141,15 +141,13 @@ - (NSString*)formatPrice:(NSDecimalNumber*)price
 
     if (product.priceLocale != nil) {
       productStruct.formattedPrice =
-          [[self formatPrice:product.price withLocal:product.priceLocale]
-              UTF8String];
+          [[self formatPrice:product.price
+                   withLocal:product.priceLocale] UTF8String];
     }
   }
 
   // Downloadable Content Information
-  if (product.downloadable == true) {
-    productStruct.downloadable = true;
-  }
+  productStruct.isDownloadable = [product downloadable];
 
   return productStruct;
 }

diff --git a/docs/api/structures/product.md b/docs/api/structures/product.md
@@ -7,4 +7,4 @@
 * `contentLengths` Number[] - The total size of the content, in bytes.
 * `price` Number - The cost of the product in the local currency.
 * `formattedPrice` String - The locale formatted price of the product.
-* `downloadable` Boolean - A Boolean value that indicates whether the App Store has downloadable content for this product.
+* `isDownloadable` Boolean - A Boolean value that indicates whether the App Store has downloadable content for this product. `true` if at least one file has been associated with the product.