@my-swu/simulator-client

---

@my-swu/simulator-client / syncRequestMessage

Function: syncRequestMessage()

syncRequestMessage(): ClientMessage

Defined in: packages/ts-sdk/src/messages.ts:114

Builds one syncRequest socket message.

Example:

import { syncRequestMessage } from '@my-swu/simulator-client'

// Sync frames ask the server to resend the latest snapshot.
const clientMessage = syncRequestMessage()

console.log(clientMessage.type)

Returns

ClientMessage

Example

import { syncRequestMessage } from '@my-swu/simulator-client'

const clientMessage = syncRequestMessage()
console.log(clientMessage.type)

See

https://simulator-sdk.my-swu.com/guide/websocket