More explicit explanation of htmx.config.getCacheBusterParam

[lookbusy1344]

Description

The documentation for htmx.config.getCacheBusterParam can be confusing. Colleagues and I expected an ephemeral timestamp or random number, not the target element id. I have tried to clarify its behaviour in the docs:

Original text is "defaults to false, if set to true htmx will include a cache-busting parameter in GET requests to avoid caching partial responses by the browser"

New text is "defaults to false, if set to true htmx will append the target element to the GET request in the format org.htmx.cache-buster=targetElementId"

For reference the behaviour is implemented here

htmx/src/htmx.js

Line 3204 in ba2c30b

filteredParameters['org.htmx.cache-buster'] = getRawAttribute(target, "id") || "true";

Note the tests are well phrased in this regard

htmx/test/attributes/hx-get.js

Line 113 in ba2c30b

it('includes a cache-busting parameter when enabled w/ the id of the target if there is one', function () {

[alexpetros]

Great clarification, thank you!