<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [git-documentdb](./git-documentdb.md) &gt; [RemoteOptions](./git-documentdb.remoteoptions.md)

## RemoteOptions type

Options for Sync class

<b>Signature:</b>

```typescript
export declare type RemoteOptions = {
    remote_url?: string;
    sync_direction?: SyncDirection;
    connection?: ConnectionSettings;
    live?: boolean;
    interval?: number;
    retry?: number;
    retry_interval?: number;
    conflict_resolve_strategy?: ConflictResolutionStrategies;
    combine_db_strategy?: CombineDbStrategies;
    diff_options?: JsonDiffOptions;
    include_commits?: boolean;
};
```
<b>References:</b> [SyncDirection](./git-documentdb.syncdirection.md)<!-- -->, [ConnectionSettings](./git-documentdb.connectionsettings.md)<!-- -->, [ConflictResolutionStrategies](./git-documentdb.conflictresolutionstrategies.md)<!-- -->, [CombineDbStrategies](./git-documentdb.combinedbstrategies.md)<!-- -->, [JsonDiffOptions](./git-documentdb.jsondiffoptions.md)

## Remarks

\[network\]

- remote\_url: Connection destination

- sync\_direction: Default is 'both'.

- connection: Authentication and other settings on remote site

\[automation\]

- live: Synchronization repeats automatically if true.

- interval: Synchronization interval (milliseconds)

- retry: Number of network retries

- retry\_interval: Retry interval (milliseconds)

\[merge\]

- conflict\_resolve\_strategy: Default is 'ours'.

- combine\_db\_strategy:

\[result\]

- include\_commits: (Beta version: It will leak memory if true.) Whether SyncResult includes 'commits' property or not. Default is false.

