-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathliveblocks.config.ts
69 lines (60 loc) · 2.06 KB
/
liveblocks.config.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
import { createClient } from "@liveblocks/client";
import { createRoomContext } from "@liveblocks/react";
const client = createClient({
publicApiKey: "pk_dev_mbLkkkKgqclCHRxmp6UiOOlzRJwUjPdpASPo6mzdsiaRZezFoZYriwBapaobZDUo",
// authEndpoint: "/api/liveblocks-auth",
// throttle: 100,
});
// Presence represents the properties that exist on every user in the Room
// and that will automatically be kept in sync. Accessible through the
// `user.presence` property. Must be JSON-serializable.
type Presence = {
// cursor: { x: number, y: number } | null,
// ...
};
// Optionally, Storage represents the shared document that persists in the
// Room, even after all users leave. Fields under Storage typically are
// LiveList, LiveMap, LiveObject instances, for which updates are
// automatically persisted and synced to all connected clients.
type Storage = {
// animals: LiveList<string>,
// ...
};
// type User = {
// id: string;
// // Example, use any JSON-compatible data in your metadata
// info: {
// name: string;
// avatar: string;
// colors: string[];
// };
// };
// Optionally, UserMeta represents static/readonly metadata on each user, as
// provided by your own custom auth back end (if used). Useful for data that
// will not change during a session, like a user's name or avatar.
// type UserMeta = {
// id?: string, // Accessible through `user.id`
// info?: Json, // Accessible through `user.info`
// };
// Optionally, the type of custom events broadcast and listened to in this
// room. Use a union for multiple events. Must be JSON-serializable.
// type RoomEvent = {};
// Optionally, when using Comments, ThreadMetadata represents metadata on
// each thread. Can only contain booleans, strings, and numbers.
// export type ThreadMetadata = {
// resolved: boolean;
// quote: string;
// time: number;
// };
export const {
RoomProvider,
useMyPresence,
useStorage,
useRoom,
/* ...all the other hooks you’re using... */
} = createRoomContext<
Presence,
Storage
// User
/* UserMeta, RoomEvent, ThreadMetadata */
>(client);