Add a comment to specify that a condition is an invariant in init
Details
use typedoc for isDirty comment so that it actually appears in IDEs etc
and use @returns typedoc annotation for better specification
modify the comment a little for better grammar: 3 "or"s and no commas -> 1 "or" and commas
use more accurate terminology: "global types" -> "ambient types"
that's also more consistent in this codebase itself, where there's a legit function named checkAmbientTypes
in init, specify that the RollingCache error should never actually happen
I was a bit confused by when this would happen, then checked the constructor, and the answer is basically never: it's an invariant / redundant error-check
Summary
isDirtycomment to use typedocinitDetails
use typedoc for
isDirtycomment so that it actually appears in IDEs etc@returnstypedoc annotation for better specificationcheckAmbientTypesin
init, specify that theRollingCacheerror should never actually happen