TiddlyWiki5/editions/tw5.com/tiddlers/mechanisms/RefreshThrottling.tid

created: 20191013095916159
modified: 20211117232644028
tags: RefreshMechanism Mechanisms
title: RefreshThrottling
type: text/vnd.tiddlywiki

The RefreshMechanism allows the refresh cycle to be throttled (or deferred) when rapid changes occur to the same tiddler. It is used to maintain responsiveness while editing a draft tiddler, but can also be used on other tiddlers.

The rules governing refresh throttling are:

* When a change notification occurs, throttling will only take place if all of the modified tiddlers meet at least one of these criteria:
** Has the field `draft.of`
** Has the field `throttle.refresh`
** Has a title prefixed with `$:/temp/volatile/`
* If the refresh cycle is to be throttled, a timer is set for the internal specified in [[$:/config/Drafts/TypingTimeout|Hidden Setting: Typing Refresh Delay]] (cancelling any previously set timer)
** When the timer fires, the refresh cycle is triggered, passing the aggregated titles of all the deferred refresh cycles
Extend refresh throttling to tiddlers having a "throttle.refresh" field See discussion here: https://groups.google.com/d/msgid/tiddlywiki/7738644f-b53f-4fb0-b0df-16243fe51795%40googlegroups.com 2019-10-14 09:42:14 +00:00			`created: 20191013095916159`
Tags related to Mechanisms for file path (#6237) 2021-11-18 08:48:16 +00:00			`modified: 20211117232644028`
			`tags: RefreshMechanism Mechanisms`
Extend refresh throttling to tiddlers having a "throttle.refresh" field See discussion here: https://groups.google.com/d/msgid/tiddlywiki/7738644f-b53f-4fb0-b0df-16243fe51795%40googlegroups.com 2019-10-14 09:42:14 +00:00			`title: RefreshThrottling`
			`type: text/vnd.tiddlywiki`

			`The RefreshMechanism allows the refresh cycle to be throttled (or deferred) when rapid changes occur to the same tiddler. It is used to maintain responsiveness while editing a draft tiddler, but can also be used on other tiddlers.`

			`The rules governing refresh throttling are:`

			`* When a change notification occurs, throttling will only take place if all of the modified tiddlers meet at least one of these criteria:`
			** Has the field `draft.of`
			** Has the field `throttle.refresh`
Add throttling for changed tiddlers prefixed with $:/temp/volatile/ (#5458) 2021-05-21 07:51:15 +00:00			** Has a title prefixed with `$:/temp/volatile/`
Update RefreshThrottling.tid (#8024) Change word "preciously" to "previously" as I believe was intend. 2024-03-02 20:03:59 +00:00			`* If the refresh cycle is to be throttled, a timer is set for the internal specified in [[$:/config/Drafts/TypingTimeout\|Hidden Setting: Typing Refresh Delay]] (cancelling any previously set timer)`
Extend refresh throttling to tiddlers having a "throttle.refresh" field See discussion here: https://groups.google.com/d/msgid/tiddlywiki/7738644f-b53f-4fb0-b0df-16243fe51795%40googlegroups.com 2019-10-14 09:42:14 +00:00			`** When the timer fires, the refresh cycle is triggered, passing the aggregated titles of all the deferred refresh cycles`