Improve API for LoadParams #347
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
README.md
Outdated
|
|
||
| Loader provides following methods: | ||
|
|
||
| - `invalidateCacheFor(key: string): Promise<void>` - expunge all entries for given key from all caches of this Loader; | ||
| - `invalidateCacheForMany(keys: string[]): Promise<void>` - expunge all entries for given keys from all caches of this Loader; | ||
| - `invalidateCache(): Promise<void>` - expunge all entries from all caches of this Loader; | ||
| - `get(key: string, loadParams?: P): Promise<T>` - sequentially attempt to retrieve data for specified key from all caches and loaders, in an order in which those data sources passed to the Loader constructor. | ||
| - `get(loadParams: LoadParams = string): Promise<T>` - sequentially attempt to retrieve data for specified key from all caches and loaders, in an order in which those data sources passed to the Loader constructor. | ||
| - `getMany(keys: string[], idResolver: (entity: T) => string, loadParams?: P): Promise<T>` - sequentially attempt to retrieve data for specified keys from all caches and data sources, in an order in which those data sources were passed to the Loader constructor. Note that this retrieval mode doesn't support neither fetch deduplication nor the preemptive background refresh. |
There was a problem hiding this comment.
Is it intentional to use string keys in getMany?
There was a problem hiding this comment.
yes, primarily for perf and memory reasons. e. g. if you are resolving 1k entries, you do not need to pass same JWT key 1k times
There was a problem hiding this comment.
I guess I need to document it better
kamilwylegala
approved these changes
Jan 3, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Old API was pretty confusing, it was not clear when to use the key and when to use loadParams, and how much overlap should be between the two.
Now the two concepts are merged.