​
PocketSyncOptions

final pocketSync = await PocketSync.initialize(
  options: PocketSyncOptions(
    projectId: 'your-project-id',
    authToken: 'your-auth-token',
    serverUrl: 'https://api.pocketsync.dev',
    changeLogRetentionDays: 30,
    syncExistingData: true,
    conflictResolutionStrategy: ConflictResolutionStrategy.lastWriteWins,
    customResolver: null,
    verbose: false,
  ),
  dbPath: dbPath,
  databaseOptions: databaseOptions,
);

​
Parameters

ParameterDescriptionRequiredDefault
projectIdYour project ID from the PocketSync dashboardYes-
authTokenAuthentication token from the PocketSync dashboardYes-
serverUrlPocketSync server URLNohttps://api.pocketsync.dev
changeLogRetentionDaysNumber of days to retain change logsNo30
syncExistingDataWhether to sync existing dataNotrue
conflictResolutionStrategyStrategy for resolving conflictsNolastWriteWins
customResolverCustom conflict resolver functionNonull
verboseEnable detailed loggingNofalse

​
DatabaseOptions

final databaseOptions = DatabaseOptions(
  
);

​
Parameters

ParameterDescriptionRequiredDefault
versionThe database version numberNo1
dbPathPath to the SQLite database fileYes-
onCreateCallback function called when database is first createdYes-
onConfigureCallback function to configure the databaseNonull
onUpgradeCallback function to handle database version upgradesNonull
onDowngradeCallback function to handle database version downgradesNonull
onOpenCallback function called when database is openedNonull