Skip to content

Commit

Permalink
Generated Flare Swift DocC
Browse files Browse the repository at this point in the history
  • Loading branch information
github-actions[bot] committed Sep 4, 2024
1 parent c7f1c6c commit e34e7ea
Show file tree
Hide file tree
Showing 329 changed files with 326 additions and 322 deletions.
2 changes: 1 addition & 1 deletion flare/data/documentation/flare.json

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion flare/data/documentation/flare/caching.json
Original file line number Diff line number Diff line change
@@ -1 +1 @@
{"primaryContentSections":[{"kind":"content","content":[{"anchor":"Overview","level":2,"type":"heading","text":"Overview"},{"type":"paragraph","inlineContent":[{"type":"text","text":"Caching products can improve the performance and user experience of your app by reducing the need to fetch product information from the App Store. In this guide, we’ll explore how to cache products efficiently in your app."}]},{"anchor":"Implementing-Product-Caching","level":2,"type":"heading","text":"Implementing Product Caching"},{"type":"paragraph","inlineContent":[{"type":"text","text":"By default, Flare uses cached data if available; otherwise, it fetches the products. If you want to change this behavior, you need to configure Flare with a custom caching policy. For this, Flare provides two options "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Flare\/documentation\/Flare\/FetchCachePolicy\/fetch"},{"type":"text","text":" and "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Flare\/documentation\/Flare\/FetchCachePolicy\/cachedOrFetch"},{"type":"text","text":"."}]},{"type":"paragraph","inlineContent":[{"type":"text","text":"You can override the default behaviour passing a "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Flare\/documentation\/Flare\/FetchCachePolicy\/fetch"},{"type":"text","text":" with a configuration."}]},{"type":"codeListing","syntax":"swift","code":["Flare.default.configure(with: .init(Configuration(username: \"username\", fetchCachePolicy: .fetch)))"]},{"type":"paragraph","inlineContent":[{"type":"text","text":"This configuration tells Flare to always fetch the latest data, ignoring any cached data. You can adjust this behavior as needed for your app."}]}]}],"schemaVersion":{"major":0,"minor":3,"patch":0},"sections":[],"variants":[{"paths":["\/documentation\/flare\/caching"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/Flare\/documentation\/Flare\/caching","interfaceLanguage":"swift"},"abstract":[{"type":"text","text":"Learn how to cache products."}],"kind":"article","metadata":{"roleHeading":"Article","title":"Caching Products","role":"article","modules":[{"name":"Flare"}]},"hierarchy":{"paths":[["doc:\/\/Flare\/documentation\/Flare"]]},"references":{"doc://Flare/documentation/Flare/FetchCachePolicy/cachedOrFetch":{"role":"symbol","title":"FetchCachePolicy.cachedOrFetch","fragments":[{"kind":"keyword","text":"case"},{"kind":"text","text":" "},{"kind":"identifier","text":"cachedOrFetch"}],"abstract":[{"type":"text","text":"Use the cached data if available; otherwise, fetch the data."}],"identifier":"doc:\/\/Flare\/documentation\/Flare\/FetchCachePolicy\/cachedOrFetch","kind":"symbol","type":"topic","url":"\/documentation\/flare\/fetchcachepolicy\/cachedorfetch"},"doc://Flare/documentation/Flare/FetchCachePolicy/fetch":{"role":"symbol","title":"FetchCachePolicy.fetch","fragments":[{"kind":"keyword","text":"case"},{"kind":"text","text":" "},{"kind":"identifier","text":"fetch"}],"abstract":[{"type":"text","text":"Fetch the current data without using the cache."}],"identifier":"doc:\/\/Flare\/documentation\/Flare\/FetchCachePolicy\/fetch","kind":"symbol","type":"topic","url":"\/documentation\/flare\/fetchcachepolicy\/fetch"},"doc://Flare/documentation/Flare":{"role":"collection","title":"Flare","abstract":[{"type":"text","text":"Flare provides an elegant interface for In-App Purchases, supporting non-consumable and consumable purchases as well as subscriptions."}],"identifier":"doc:\/\/Flare\/documentation\/Flare","kind":"symbol","type":"topic","url":"\/documentation\/flare"}}}
{"primaryContentSections":[{"kind":"content","content":[{"anchor":"Overview","level":2,"type":"heading","text":"Overview"},{"type":"paragraph","inlineContent":[{"type":"text","text":"Caching products can improve the performance and user experience of your app by reducing the need to fetch product information from the App Store. In this guide, we’ll explore how to cache products efficiently in your app."}]},{"anchor":"Implementing-Product-Caching","level":2,"type":"heading","text":"Implementing Product Caching"},{"type":"paragraph","inlineContent":[{"type":"text","text":"By default, Flare uses cached data if available; otherwise, it fetches the products. If you want to change this behavior, you need to configure Flare with a custom caching policy. For this, Flare provides two options "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Flare\/documentation\/Flare\/FetchCachePolicy\/fetch"},{"type":"text","text":" and "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Flare\/documentation\/Flare\/FetchCachePolicy\/cachedOrFetch"},{"type":"text","text":"."}]},{"type":"paragraph","inlineContent":[{"type":"text","text":"You can override the default behaviour passing a "},{"type":"reference","isActive":true,"identifier":"doc:\/\/Flare\/documentation\/Flare\/FetchCachePolicy\/fetch"},{"type":"text","text":" with a configuration."}]},{"type":"codeListing","syntax":"swift","code":["Flare.default.configure(with: .init(Configuration(username: \"username\", fetchCachePolicy: .fetch)))"]},{"type":"paragraph","inlineContent":[{"type":"text","text":"This configuration tells Flare to always fetch the latest data, ignoring any cached data. You can adjust this behavior as needed for your app."}]}]}],"schemaVersion":{"major":0,"minor":3,"patch":0},"sections":[],"variants":[{"paths":["\/documentation\/flare\/caching"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/Flare\/documentation\/Flare\/caching","interfaceLanguage":"swift"},"abstract":[{"type":"text","text":"Learn how to cache products."}],"kind":"article","metadata":{"roleHeading":"Article","title":"Caching Products","role":"article","modules":[{"name":"Flare"}]},"hierarchy":{"paths":[["doc:\/\/Flare\/documentation\/Flare"]]},"references":{"doc://Flare/documentation/Flare/FetchCachePolicy/fetch":{"role":"symbol","title":"FetchCachePolicy.fetch","fragments":[{"kind":"keyword","text":"case"},{"kind":"text","text":" "},{"kind":"identifier","text":"fetch"}],"abstract":[{"type":"text","text":"Fetch the current data without using the cache."}],"identifier":"doc:\/\/Flare\/documentation\/Flare\/FetchCachePolicy\/fetch","kind":"symbol","type":"topic","url":"\/documentation\/flare\/fetchcachepolicy\/fetch"},"doc://Flare/documentation/Flare/FetchCachePolicy/cachedOrFetch":{"role":"symbol","title":"FetchCachePolicy.cachedOrFetch","fragments":[{"kind":"keyword","text":"case"},{"kind":"text","text":" "},{"kind":"identifier","text":"cachedOrFetch"}],"abstract":[{"type":"text","text":"Use the cached data if available; otherwise, fetch the data."}],"identifier":"doc:\/\/Flare\/documentation\/Flare\/FetchCachePolicy\/cachedOrFetch","kind":"symbol","type":"topic","url":"\/documentation\/flare\/fetchcachepolicy\/cachedorfetch"},"doc://Flare/documentation/Flare":{"role":"collection","title":"Flare","abstract":[{"type":"text","text":"Flare provides an elegant interface for In-App Purchases, supporting non-consumable and consumable purchases as well as subscriptions."}],"identifier":"doc:\/\/Flare\/documentation\/Flare","kind":"symbol","type":"topic","url":"\/documentation\/flare"}}}
2 changes: 1 addition & 1 deletion flare/data/documentation/flare/closure.json
Original file line number Diff line number Diff line change
@@ -1 +1 @@
{"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"typealias"},{"kind":"text","text":" "},{"kind":"identifier","text":"Closure"},{"kind":"text","text":"<"},{"kind":"genericParameter","text":"T"},{"kind":"text","text":"> = ("},{"kind":"typeIdentifier","text":"T"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Void","preciseIdentifier":"s:s4Voida"}],"languages":["swift"],"platforms":["macOS"]}]}],"schemaVersion":{"major":0,"minor":3,"patch":0},"sections":[],"variants":[{"paths":["\/documentation\/flare\/closure"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/Flare\/documentation\/Flare\/Closure","interfaceLanguage":"swift"},"kind":"symbol","metadata":{"fragments":[{"kind":"keyword","text":"typealias"},{"kind":"text","text":" "},{"kind":"identifier","text":"Closure"}],"title":"Closure","roleHeading":"Type Alias","role":"symbol","symbolKind":"typealias","externalID":"s:5Flare7Closurea","modules":[{"name":"Flare"}],"navigatorTitle":[{"kind":"identifier","text":"Closure"}]},"hierarchy":{"paths":[["doc:\/\/Flare\/documentation\/Flare"]]},"references":{"doc://Flare/documentation/Flare":{"role":"collection","title":"Flare","abstract":[{"type":"text","text":"Flare provides an elegant interface for In-App Purchases, supporting non-consumable and consumable purchases as well as subscriptions."}],"identifier":"doc:\/\/Flare\/documentation\/Flare","kind":"symbol","type":"topic","url":"\/documentation\/flare"},"doc://Flare/documentation/Flare/Closure":{"role":"symbol","title":"Closure","fragments":[{"kind":"keyword","text":"typealias"},{"kind":"text","text":" "},{"kind":"identifier","text":"Closure"}],"abstract":[],"identifier":"doc:\/\/Flare\/documentation\/Flare\/Closure","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"Closure"}],"url":"\/documentation\/flare\/closure"}}}
{"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"typealias"},{"kind":"text","text":" "},{"kind":"identifier","text":"Closure"},{"kind":"text","text":"<"},{"kind":"genericParameter","text":"T"},{"kind":"text","text":"> = ("},{"kind":"typeIdentifier","text":"T"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Void","preciseIdentifier":"s:s4Voida"}],"languages":["swift"],"platforms":["macOS"]}]}],"schemaVersion":{"major":0,"minor":3,"patch":0},"sections":[],"variants":[{"paths":["\/documentation\/flare\/closure"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/Flare\/documentation\/Flare\/Closure","interfaceLanguage":"swift"},"kind":"symbol","metadata":{"fragments":[{"kind":"keyword","text":"typealias"},{"kind":"text","text":" "},{"kind":"identifier","text":"Closure"}],"title":"Closure","roleHeading":"Type Alias","role":"symbol","symbolKind":"typealias","externalID":"s:5Flare7Closurea","modules":[{"name":"Flare"}],"navigatorTitle":[{"kind":"identifier","text":"Closure"}]},"hierarchy":{"paths":[["doc:\/\/Flare\/documentation\/Flare"]]},"references":{"doc://Flare/documentation/Flare/Closure":{"role":"symbol","title":"Closure","fragments":[{"kind":"keyword","text":"typealias"},{"kind":"text","text":" "},{"kind":"identifier","text":"Closure"}],"abstract":[],"identifier":"doc:\/\/Flare\/documentation\/Flare\/Closure","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"Closure"}],"url":"\/documentation\/flare\/closure"},"doc://Flare/documentation/Flare":{"role":"collection","title":"Flare","abstract":[{"type":"text","text":"Flare provides an elegant interface for In-App Purchases, supporting non-consumable and consumable purchases as well as subscriptions."}],"identifier":"doc:\/\/Flare\/documentation\/Flare","kind":"symbol","type":"topic","url":"\/documentation\/flare"}}}
2 changes: 1 addition & 1 deletion flare/data/documentation/flare/closure2.json
Original file line number Diff line number Diff line change
@@ -1 +1 @@
{"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"typealias"},{"kind":"text","text":" "},{"kind":"identifier","text":"Closure2"},{"kind":"text","text":"<"},{"kind":"genericParameter","text":"T"},{"kind":"text","text":", "},{"kind":"genericParameter","text":"U"},{"kind":"text","text":"> = ("},{"kind":"typeIdentifier","text":"T"},{"kind":"text","text":", "},{"kind":"typeIdentifier","text":"U"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Void","preciseIdentifier":"s:s4Voida"}],"languages":["swift"],"platforms":["macOS"]}]}],"schemaVersion":{"major":0,"minor":3,"patch":0},"sections":[],"variants":[{"paths":["\/documentation\/flare\/closure2"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/Flare\/documentation\/Flare\/Closure2","interfaceLanguage":"swift"},"kind":"symbol","metadata":{"fragments":[{"kind":"keyword","text":"typealias"},{"kind":"text","text":" "},{"kind":"identifier","text":"Closure2"}],"title":"Closure2","roleHeading":"Type Alias","role":"symbol","symbolKind":"typealias","externalID":"s:5Flare8Closure2a","modules":[{"name":"Flare"}],"navigatorTitle":[{"kind":"identifier","text":"Closure2"}]},"hierarchy":{"paths":[["doc:\/\/Flare\/documentation\/Flare"]]},"references":{"doc://Flare/documentation/Flare/Closure2":{"role":"symbol","title":"Closure2","fragments":[{"kind":"keyword","text":"typealias"},{"kind":"text","text":" "},{"kind":"identifier","text":"Closure2"}],"abstract":[],"identifier":"doc:\/\/Flare\/documentation\/Flare\/Closure2","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"Closure2"}],"url":"\/documentation\/flare\/closure2"},"doc://Flare/documentation/Flare":{"role":"collection","title":"Flare","abstract":[{"type":"text","text":"Flare provides an elegant interface for In-App Purchases, supporting non-consumable and consumable purchases as well as subscriptions."}],"identifier":"doc:\/\/Flare\/documentation\/Flare","kind":"symbol","type":"topic","url":"\/documentation\/flare"}}}
{"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"typealias"},{"kind":"text","text":" "},{"kind":"identifier","text":"Closure2"},{"kind":"text","text":"<"},{"kind":"genericParameter","text":"T"},{"kind":"text","text":", "},{"kind":"genericParameter","text":"U"},{"kind":"text","text":"> = ("},{"kind":"typeIdentifier","text":"T"},{"kind":"text","text":", "},{"kind":"typeIdentifier","text":"U"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Void","preciseIdentifier":"s:s4Voida"}],"languages":["swift"],"platforms":["macOS"]}]}],"schemaVersion":{"major":0,"minor":3,"patch":0},"sections":[],"variants":[{"paths":["\/documentation\/flare\/closure2"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/Flare\/documentation\/Flare\/Closure2","interfaceLanguage":"swift"},"kind":"symbol","metadata":{"fragments":[{"kind":"keyword","text":"typealias"},{"kind":"text","text":" "},{"kind":"identifier","text":"Closure2"}],"title":"Closure2","roleHeading":"Type Alias","role":"symbol","symbolKind":"typealias","externalID":"s:5Flare8Closure2a","modules":[{"name":"Flare"}],"navigatorTitle":[{"kind":"identifier","text":"Closure2"}]},"hierarchy":{"paths":[["doc:\/\/Flare\/documentation\/Flare"]]},"references":{"doc://Flare/documentation/Flare":{"role":"collection","title":"Flare","abstract":[{"type":"text","text":"Flare provides an elegant interface for In-App Purchases, supporting non-consumable and consumable purchases as well as subscriptions."}],"identifier":"doc:\/\/Flare\/documentation\/Flare","kind":"symbol","type":"topic","url":"\/documentation\/flare"},"doc://Flare/documentation/Flare/Closure2":{"role":"symbol","title":"Closure2","fragments":[{"kind":"keyword","text":"typealias"},{"kind":"text","text":" "},{"kind":"identifier","text":"Closure2"}],"abstract":[],"identifier":"doc:\/\/Flare\/documentation\/Flare\/Closure2","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"Closure2"}],"url":"\/documentation\/flare\/closure2"}}}
Loading

0 comments on commit e34e7ea

Please sign in to comment.