diff --git a/wasm/follow.go b/wasm/follow.go index 7f573609e037aa3a7c78f286b3cb3e51de016bc5..dbff9722411ddac19999b28b137739ec31279a45 100644 --- a/wasm/follow.go +++ b/wasm/follow.go @@ -87,6 +87,21 @@ func (c *Cmix) StopNetworkFollower(js.Value, []js.Value) any { // SetTrackNetworkPeriod allows changing the frequency that follower threads // are started. // +// Note that the frequency of the follower threads affect the power usage +// of the device following the network. +// - Low period -> Higher frequency of polling -> Higher battery usage +// - High period -> Lower frequency of polling -> Lower battery usage +// +// This may be used to enable a low power (or battery optimization) mode +// for the end user. +// +// Suggested values are provided, however there are no guarantees that these +// values will perfectly fit what the end user's device would require to match +// the user's expectations: +// - Low Power Usage: 5000 milliseconds +// - High Power Usage: 1000 milliseconds (default, see +// [cmix.DefaultFollowPeriod] +// // Parameters: // - args[0] - The duration of the period, in milliseconds (int). func (c *Cmix) SetTrackNetworkPeriod(_ js.Value, args []js.Value) any {