65 lines
1.6 KiB
Markdown
65 lines
1.6 KiB
Markdown
|
## API Report File for "@tldraw/sync"
|
||
|
|
|
||
|
|
> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
|
||
|
|
|
||
|
|
```ts
|
||
|
|
|
||
|
|
import { Editor } from 'tldraw';
|
||
|
|
import { Signal } from 'tldraw';
|
||
|
|
import { TLAssetStore } from 'tldraw';
|
||
|
|
import { TLSchema } from 'tldraw';
|
||
|
|
import { TLStoreWithStatus } from 'tldraw';
|
||
|
|
import { TLUserPreferences } from 'tldraw';
|
||
|
|
|
||
|
|
// @public (undocumented)
|
||
|
|
export type RemoteTLStoreWithStatus = Exclude<TLStoreWithStatus, {
|
||
|
|
status: 'not-synced';
|
||
|
|
} | {
|
||
|
|
status: 'synced-local';
|
||
|
|
}>;
|
||
|
|
|
||
|
|
// @public (undocumented)
|
||
|
|
export function useMultiplayerDemo(options: UseMultiplayerDemoOptions): RemoteTLStoreWithStatus;
|
||
|
|
|
||
|
|
// @public (undocumented)
|
||
|
|
export interface UseMultiplayerDemoOptions {
|
||
|
|
// @internal (undocumented)
|
||
|
|
host?: string;
|
||
|
|
// (undocumented)
|
||
|
|
roomId: string;
|
||
|
|
// (undocumented)
|
||
|
|
schema?: TLSchema;
|
||
|
|
// (undocumented)
|
||
|
|
userPreferences?: Signal<TLUserPreferences>;
|
||
|
|
}
|
||
|
|
|
||
|
|
// @public (undocumented)
|
||
|
|
export function useMultiplayerSync(opts: UseMultiplayerSyncOptions): RemoteTLStoreWithStatus;
|
||
|
|
|
||
|
|
// @public (undocumented)
|
||
|
|
export interface UseMultiplayerSyncOptions {
|
||
|
|
// (undocumented)
|
||
|
|
assets?: Partial<TLAssetStore>;
|
||
|
|
// (undocumented)
|
||
|
|
onEditorMount?: (editor: Editor) => void;
|
||
|
|
// (undocumented)
|
||
|
|
roomId?: string;
|
||
|
|
// (undocumented)
|
||
|
|
schema?: TLSchema;
|
||
|
|
// (undocumented)
|
||
|
|
trackAnalyticsEvent?(name: string, data: {
|
||
|
|
[key: string]: any;
|
||
|
|
}): void;
|
||
|
|
// (undocumented)
|
||
|
|
uri: string;
|
||
|
|
// (undocumented)
|
||
|
|
userPreferences?: Signal<TLUserPreferences>;
|
||
|
|
}
|
||
|
|
|
||
|
|
|
||
|
|
export * from "@tldraw/sync-core";
|
||
|
|
|
||
|
|
// (No @packageDocumentation comment for this package)
|
||
|
|
|
||
|
|
```
|