Regrip API / session/replay/replaySession / createReplaySession
Function: createReplaySession()
createReplaySession(
contents,feed?):object
Defined in: packages/core/src/session/replay/replaySession.ts:505
Create a deterministic session facade driven by a JSONL capture.
Parameters
contents
string
feed?
ReplayFeed = 'connection'
Returns
session
session:
object
session.connect
connect: () =>
Promise<void>
Returns
Promise<void>
session.disconnect
disconnect: () =>
Promise<void>
Returns
Promise<void>
session.getState
getState: () =>
SmartCubeSessionState
Returns
session.resetGyro
resetGyro: () =>
void
Returns
void
session.sendCommand
sendCommand: (
command) =>Promise<void>
Parameters
command
Returns
Promise<void>
session.sendVendorCommand
sendVendorCommand: (
command) =>Promise<void>
Parameters
command
Returns
Promise<void>
session.syncFacelets
syncFacelets: () =>
Promise<SmartCubeFaceletsEvent>
Request an authoritative snapshot and resolve only when it arrives.
Returns
Promise<SmartCubeFaceletsEvent>
session.configureFeatures()
configureFeatures(
patch):void
Apply a runtime feature patch and reset any detector state it affects. Accumulates across calls and keeps applying on top of whichever profile is current, including one resolved later (e.g. after a HARDWARE event or a reconnect to a different device).
Parameters
patch
Returns
void
session.on()
on<
T>(type,listener): () =>void
Observe one event type without creating a parallel event channel.
Type Parameters
T
T extends "MOVE" | "FACELETS" | "GYRO" | "BATTERY" | "HARDWARE" | "DISCONNECT" | "REGRIP" | "CUSTOM_TRIGGER" | "SHAKE" | "MOVE_GAP"
Parameters
type
T
listener
(event) => void
Returns
() => void
session.subscribe()
subscribe(
listener): () =>void
Parameters
listener
(next) => void
Returns
() => void
session.subscribeDiagnostics()
subscribeDiagnostics(
listener): () =>void
Observe raw transport diagnostics without admitting them to the typed cube-state stream. A transport may omit this capability entirely.
Parameters
listener
(event) => void
Returns
() => void
session.subscribeEvents()
subscribeEvents(
listener): () =>void
Events remain owned by the session; consumers only observe them here.
Parameters
listener
(event) => void
Returns
() => void
done
Get Signature
get done():
boolean
Returns
boolean
feed
Get Signature
get feed():
ReplayFeed
Returns
identity
Get Signature
get identity():
JsonlMockIdentity
Returns
items
Get Signature
get items(): readonly
ReplayItem[]
Returns
readonly ReplayItem[]
length
Get Signature
get length():
number
Returns
number
position
Get Signature
get position():
number
Returns
number
virtualNowMs
Get Signature
get virtualNowMs():
number
Returns
number
advanceTo()
advanceTo(
targetMs):Promise<void>
Parameters
targetMs
number
Returns
Promise<void>
reset()
reset():
Promise<void>
Returns
Promise<void>
seekTo()
seekTo(
index):Promise<void>
Parameters
index
number
Returns
Promise<void>
seekToTimestamp()
seekToTimestamp(
timestamp):Promise<void>
Parameters
timestamp
number
Returns
Promise<void>
stepOne()
stepOne():
Promise<void>
Returns
Promise<void>
subscribeCursor()
subscribeCursor(
listener): () =>void
Parameters
listener
ReplayListener
Returns
() => void
subscribeRebuild()
subscribeRebuild(
listener): () =>void
Fires immediately before a backward seek reconstructs the session.
Parameters
listener
ReplayListener
Returns
() => void