TimestampProvider class

Package:

@microsoft/live-share

Default ITimestampProvider implementation.

Properties

isRunning

Returns true if the provider has been started.

Methods

getMaxTimestampError()	Returns the maximum amount of error, in milliseconds.
getTimestamp()	Returns the current server time as a UTC tick.
start()	Starts the provider.
stop()	Stops the provider if its running.

Property Details

isRunning

Returns true if the provider has been started.

boolean isRunning

Property Value

boolean

Method Details

getMaxTimestampError()

Returns the maximum amount of error, in milliseconds.

function getMaxTimestampError(): number

Returns

number

getTimestamp()

Returns the current server time as a UTC tick.

function getTimestamp(): number

Returns

number

start()

Starts the provider.

function start(): Promise<void>

Returns

Promise<void>

stop()

Stops the provider if its running.

function stop()