Add a comment about updateDeviceState

This commit is contained in:
Pagan Gazzard 2015-03-11 15:09:41 +00:00 committed by Pablo Carranza Vélez
parent 48c21e9275
commit 82873d2ef2

View File

@ -303,6 +303,9 @@ getDeviceID = do ->
throw new Error('Could not find this device?!')
return devices[0].id
# Calling this function updates the local device state, which is then used to synchronise
# the remote device state, repeating any failed updates until successfully synchronised.
# This function will also optimise updates by merging multiple updates and only sending the latest state.
exports.updateDeviceState = updateDeviceState = do ->
applyPromise = Promise.resolve()
targetState = {}