Document new FetchState methods

[matthewp]

Description (required)

Documents new FetchState methods added in withastro/astro#17708

References

withastro/astro#17708

[astrobot-houston]

Lunaria Status Overview

🌕 This pull request will trigger status changes.

Learn more

By default, every PR changing files present in the Lunaria configuration's files property will be considered and trigger status changes accordingly.

You can change this by adding one of the keywords present in the ignoreKeywords property in your Lunaria configuration file in the PR's title (ignoring all files) or by including a tracker directive in the merged commit's description.

Tracked Files

File	Note
en/reference/modules/astro-fetch.mdx	Source changed, localizations will be marked as outdated.

Warnings reference

Icon	Description
🔄️	The source for this localization has been updated since the creation of this pull request, make sure all changes in the source have been applied.

[github-actions]

Preview deployment

✅ Deployment complete!

• Latest commit: 788fd1d
• Preview: https://fetch-state-docs.previews.docs.astro.build
• Workflow run: View logs

[ArmandPhilippot]

Thanks, Matthew! I left a few nits, but otherwise this looks good to me. I'm only confused with state.finalize() (see my comment).

[ArmandPhilippot]

The description seems okay to me, but then I'm confused looking at the code snippet: you say "Applies the response finalizers registered with state.addResponseFinalizer()" but the code snippet doesn't show that.

So I wonder: does state.finalize() work without addResponseFinalizer()? Or should the code snippet include addResponseFinalizer() to better illustrate the use of finalize()?

[matthewp]

It just returns the same response if you don't have any finalizers. But the idea is that anything that has the FetchState can add a finalizer, so you want to run this even if you didn't add one yourself. I can add an one to the example of that helps to clarify though.

[ArmandPhilippot]

Ah, thanks for the explanation!

If finalize() is useless without addResponseFinalizer() (ie. same response), I think the description is fine (no need to say they can call it, but it does nothing...). But, yes, I think it might be helpful for users to see a "real" use case with addResponseFinalizer().

[ArmandPhilippot]

So, apart from my last nit and the code snippet which I think could be improved to help users (still a nit that said: better to have one than nothing at all), everything LGTM! Thanks, again.