search

lukemorales / query-key-factory

A library for creating typesafe standardized query keys, useful for cache management in @tanstack/query
https://www.npmjs.com/package/@lukemorales/query-key-factory
MIT License
1.16k stars 32 forks source link

docs: add documentation for optional `queryKey` #78

Closed jleem99 closed 9 months ago

jleem99 commented 1 year ago

Regarding the issue #75, I also had the confusion where typescript complains about queryKey being null when using function to create a query.

I added some documentation with an example under the 'Standardized keys' section. Hope this clears up the confusion :)

changeset-bot[bot] commented 1 year ago

⚠️ No Changeset found

Latest commit: 3514276efcd4f49be03532af0ea75673e03d7536

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR