createLiveServer
createLiveServer(
__namedParameters):object
Defined in: server/src/index.ts:151
Parameters
Section titled “Parameters”__namedParameters
Section titled “__namedParameters”address?
Section titled “address?”string
browserHistoryFrames?
Section titled “browserHistoryFrames?”number
browserProvider?
Section titled “browserProvider?”BrowserProvider | null = null
databaseUrl
Section titled “databaseUrl”string
decide?
Section titled “decide?”Decide = noOpinion
desktopProvider?
Section titled “desktopProvider?”DesktopProvider | null = null
jwtSecret
Section titled “jwtSecret”string
logger?
Section titled “logger?”Logger = ...
media?
Section titled “media?”{ speaker: MediaSpeaker | null; tokens: { mint(__namedParameters): Promise<string>; verify(token): Promise<MediaTokenClaims | null>; }; url: string; } | null = null
onSpoken?
Section titled “onSpoken?”((turn) => Promise<void>) | null = null
onStored?
Section titled “onStored?”((docName, document) => Promise<void>) | null = null
onTurn?
Section titled “onTurn?”((turn) => Promise<void>) | null = null
number
redisUrl?
Section titled “redisUrl?”string
turnSettleMs?
Section titled “turnSettleMs?”number
Returns
Section titled “Returns”object
hocuspocus
Section titled “hocuspocus”hocuspocus:
Hocuspocus<LiveConnectionContext> =server.hocuspocus
persistence
Section titled “persistence”persistence:
object
persistence.flush
Section titled “persistence.flush”flush: () =>
Promise<void>
Returns
Section titled “Returns”Promise<void>
persistence.stateAt
Section titled “persistence.stateAt”stateAt: (
docName,uptoId) =>Promise<Uint8Array<ArrayBufferLike> |null>
Parameters
Section titled “Parameters”docName
Section titled “docName”string
uptoId
Section titled “uptoId”string
Returns
Section titled “Returns”Promise<Uint8Array<ArrayBufferLike> | null>
persistence.append()
Section titled “persistence.append()”append(
docName,update,actor):void
Parameters
Section titled “Parameters”docName
Section titled “docName”string
update
Section titled “update”Uint8Array
color?
Section titled “color?”string = ...
string = ...
"human" | "agent" = ...
string = ...
onBehalfOf?
Section titled “onBehalfOf?”{ id: string; name: string; } = ...
onBehalfOf.id
Section titled “onBehalfOf.id”string = ...
onBehalfOf.name
Section titled “onBehalfOf.name”string = ...
Returns
Section titled “Returns”void
persistence.appendFrame()
Section titled “persistence.appendFrame()”appendFrame(
docName,url,actor,jpeg):Promise<void>
Parameters
Section titled “Parameters”docName
Section titled “docName”string
string
color?
Section titled “color?”string = ...
string = ...
"human" | "agent" = ...
string = ...
onBehalfOf?
Section titled “onBehalfOf?”{ id: string; name: string; } = ...
onBehalfOf.id
Section titled “onBehalfOf.id”string = ...
onBehalfOf.name
Section titled “onBehalfOf.name”string = ...
Buffer
Returns
Section titled “Returns”Promise<void>
persistence.close()
Section titled “persistence.close()”close():
Promise<void>
Returns
Section titled “Returns”Promise<void>
persistence.compactIfNeeded()
Section titled “persistence.compactIfNeeded()”compactIfNeeded(
docName,ydoc):Promise<void>
Parameters
Section titled “Parameters”docName
Section titled “docName”string
Doc
Returns
Section titled “Returns”Promise<void>
persistence.frame()
Section titled “persistence.frame()”frame(
docName,id):Promise<Buffer<ArrayBufferLike> |null>
Parameters
Section titled “Parameters”docName
Section titled “docName”string
string
Returns
Section titled “Returns”Promise<Buffer<ArrayBufferLike> | null>
persistence.history()
Section titled “persistence.history()”history(
docName,__namedParameters?):Promise<{events:HistoryEvent[];sessions:HistorySession[]; }>
Parameters
Section titled “Parameters”docName
Section titled “docName”string
__namedParameters?
Section titled “__namedParameters?”limit?
Section titled “limit?”number = 100
sessionGapSeconds?
Section titled “sessionGapSeconds?”number = 120
Returns
Section titled “Returns”Promise<{ events: HistoryEvent[]; sessions: HistorySession[]; }>
persistence.init()
Section titled “persistence.init()”init():
Promise<void>
Returns
Section titled “Returns”Promise<void>
persistence.lastEditors()
Section titled “persistence.lastEditors()”lastEditors(
docNames):Promise<Map<string, {actor: {color?:string;id:string;kind:"human"|"agent";name:string;onBehalfOf?: {id:string;name:string; }; };editedAt:string; }>>
Parameters
Section titled “Parameters”docNames
Section titled “docNames”string[]
Returns
Section titled “Returns”Promise<Map<string, { actor: { color?: string; id: string; kind: "human" | "agent"; name: string; onBehalfOf?: { id: string; name: string; }; }; editedAt: string; }>>
persistence.lastSeen()
Section titled “persistence.lastSeen()”lastSeen(
docNames,viewerId):Promise<Map<string,string>>
Parameters
Section titled “Parameters”docNames
Section titled “docNames”string[]
viewerId
Section titled “viewerId”string
Returns
Section titled “Returns”Promise<Map<string, string>>
persistence.listDecisions()
Section titled “persistence.listDecisions()”listDecisions(
docName,limit?):Promise<object[]>
Parameters
Section titled “Parameters”docName
Section titled “docName”string
limit?
Section titled “limit?”number = 50
Returns
Section titled “Returns”Promise<object[]>
persistence.listFrames()
Section titled “persistence.listFrames()”listFrames(
docName,limit?):Promise<object[]>
Parameters
Section titled “Parameters”docName
Section titled “docName”string
limit?
Section titled “limit?”number = 200
Returns
Section titled “Returns”Promise<object[]>
persistence.load()
Section titled “persistence.load()”load(
docName):Promise<Uint8Array<ArrayBufferLike> |null>
Parameters
Section titled “Parameters”docName
Section titled “docName”string
Returns
Section titled “Returns”Promise<Uint8Array<ArrayBufferLike> | null>
persistence.logEvent()
Section titled “persistence.logEvent()”logEvent(
docName,type,actor,payload?):Promise<void>
Parameters
Section titled “Parameters”docName
Section titled “docName”string
string
color?
Section titled “color?”string = ...
string = ...
"human" | "agent" = ...
string = ...
onBehalfOf?
Section titled “onBehalfOf?”{ id: string; name: string; } = ...
onBehalfOf.id
Section titled “onBehalfOf.id”string = ...
onBehalfOf.name
Section titled “onBehalfOf.name”string = ...
payload?
Section titled “payload?”Record<string, unknown> = {}
Returns
Section titled “Returns”Promise<void>
persistence.pendingSuggestions()
Section titled “persistence.pendingSuggestions()”pendingSuggestions(
workspaceId,docNames):Promise<Map<string,PendingSuggestionRow[]>>
Parameters
Section titled “Parameters”workspaceId
Section titled “workspaceId”string
docNames
Section titled “docNames”string[]
Returns
Section titled “Returns”Promise<Map<string, PendingSuggestionRow[]>>
persistence.reconcileSuggestions()
Section titled “persistence.reconcileSuggestions()”reconcileSuggestions(
docName,workspaceId,inDoc,statusOf,settledBy):Promise<SettledSuggestion[]>
Parameters
Section titled “Parameters”docName
Section titled “docName”string
workspaceId
Section titled “workspaceId”string
SuggestionInDoc[]
statusOf
Section titled “statusOf”(row) => "accepted" | "rejected"
settledBy
Section titled “settledBy”color?
Section titled “color?”string = ...
string = ...
"human" | "agent" = ...
string = ...
onBehalfOf?
Section titled “onBehalfOf?”{ id: string; name: string; } = ...
onBehalfOf.id
Section titled “onBehalfOf.id”string = ...
onBehalfOf.name
Section titled “onBehalfOf.name”string = ...
Returns
Section titled “Returns”Promise<SettledSuggestion[]>
persistence.recordDecision()
Section titled “persistence.recordDecision()”recordDecision(
record):Promise<void>
Parameters
Section titled “Parameters”record
Section titled “record”DecisionRecord & object
Returns
Section titled “Returns”Promise<void>
server
Section titled “server”server:
Server<LiveConnectionContext>
destroy()
Section titled “destroy()”destroy():
Promise<void>
Returns
Section titled “Returns”Promise<void>
listen()
Section titled “listen()”listen():
Promise<number>
Returns
Section titled “Returns”Promise<number>