Skip to content

Commit 28c19f3

Browse files
committed
bug: Update DataStore comment for syncInterval
1 parent 9fdb722 commit 28c19f3

File tree

1 file changed

+5
-1
lines changed

1 file changed

+5
-1
lines changed

AmplifyPlugins/DataStore/AWSDataStoreCategoryPlugin/DataStoreConfiguration.swift

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,11 @@ public struct DataStoreConfiguration {
5050
/// A callback called when a conflict could not be resolved by the service
5151
public let conflictHandler: DataStoreConflictHandler
5252

53-
/// How often the sync engine will run (in seconds)
53+
/// The maximum interval (in seconds) the system will continue to perform delta queries.
54+
/// After this interval expires, the system performs a base query to retrieve all data.
55+
/// This defaults to 24 hours, and developers should rarely need to customize this.
56+
/// More information can be found here:
57+
/// https://docs.amplify.aws/lib/datastore/how-it-works/q/platform/ios#sync-data-to-cloud
5458
public let syncInterval: TimeInterval
5559

5660
/// The number of records to sync per execution

0 commit comments

Comments
 (0)