archive-gh-me/typeorm
1
0
Fork 0
mirror of https://github.com/typeorm/typeorm.git synced 2025-12-08 21:26:23 +00:00
Code Issues Projects Releases Wiki Activity

docs: Update QueryResultCache method descriptions (#11192)

Browse Source 
Correct the description for getFromCache,
matching the descriptions found on the redis and
db cache implementations. Also correct grammar
on the description of the synchronize method.
This commit is contained in:
Mike Guida 2024-12-29 08:25:19 -07:00 committed by GitHub
parent b2d26b07ec
commit 67c896ff11
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 4 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
src/cache/QueryResultCache.ts vendored
View File

@ -16,12 +16,14 @@ export interface QueryResultCache {
disconnect(): Promise<void>
/**
* Performs operations needs to be created during schema synchronization.
* Perform operations during schema synchronization.
*/
synchronize(queryRunner?: QueryRunner): Promise<void>
/**
* Caches given query result.
* Get data from cache.
* Returns cache result if found.
* Returns undefined if result is not cached.
*/
getFromCache(
options: QueryResultCacheOptions,