Allow cache to be async #26

Richienb · 2021-09-24T06:09:35Z

Fixes #3, Fixes #14, Closes #19

Fixes sindresorhus#3, Fixes sindresorhus#14 Signed-off-by: Richie Bendall <[email protected]>

Signed-off-by: Richie Bendall <[email protected]>

index.ts

Signed-off-by: Richie Bendall <[email protected]>

index.ts

Signed-off-by: Richie Bendall <[email protected]>

readme.md

index.ts

Signed-off-by: Richie Bendall <[email protected]>

…nto async-cache

Co-authored-by: Sindre Sorhus <[email protected]>

index.ts

package.json

readme.md

test-d/index.test-d.ts

sindresorhus · 2021-10-04T09:29:53Z

CI is failing.

Co-authored-by: Sindre Sorhus <[email protected]>

Signed-off-by: Richie Bendall <[email protected]>

sindresorhus · 2021-10-09T09:40:45Z

For future reference, it would have been better if this pull request was split into a separate pull request for each issue it fixed. Massive pull requests are a pain to review.

sindresorhus · 2021-10-09T09:40:55Z

Does this introduce any breaking changes other than removal of maxAge? Would you be able to list the changes in this PR which can be used for the release notes?

index.ts

test.ts

readme.md

Signed-off-by: Richie Bendall <[email protected]>

Richienb · 2021-10-09T16:01:44Z

Allow .get() and .has() cache methods to return a promise
Remove maxAge option. This means instead of .set() being provided an object with the properties value and maxAge, it will only be provided value as the first argument.
Promises returned from a memoized function will be cached internally and take priority over cache. The promise cache does not persist outside of the current instance and properties assigned to a returned promise will not be kept.
cache will be provided the values of resolved promises instead of the promises themselves.

Signed-off-by: Richie Bendall <[email protected]>

sindresorhus · 2021-10-13T09:34:16Z

@Richienb Thanks for working on this. This is ready to be released right? There are no more planned breaking changes?

Richienb · 2021-10-13T09:38:38Z

@sindresorhus Nothing else from me - it's good to go.

JaneJeon · 2021-10-13T14:49:12Z

Hallelujah! Thanks for working on this @Richienb

futpib · 2021-11-07T00:50:01Z

index.ts

+	has: (key: KeyType) => Promise<boolean> | boolean;
+	get: (key: KeyType) => Promise<ValueType | undefined> | ValueType | undefined;
+	set: (key: KeyType, value: ValueType) => void;
+	delete: (key: KeyType) => void;
+	clear?: () => void;


Seems unreasonable to expect an async cache to have async has and get but synchronous set, delete and clear.

This was made with the intention that set, delete and clear could return promises but we don't care about waiting for them. We could add support for asynchronous functions as a mostly non-breaking change however.

See #3 (comment)

futpib · 2021-11-07T00:52:31Z

index.ts

+	has: (key: KeyType) => Promise<boolean> | boolean;
+	get: (key: KeyType) => Promise<ValueType | undefined> | ValueType | undefined;
+	set: (key: KeyType, value: ValueType) => void;
+	delete: (key: KeyType) => void;


cache.delete is never called. It should either be used or not required by this interface.

Richienb added 3 commits September 24, 2021 18:08

Allow .get() and .has() to return a promise

55ee9c8

Fixes sindresorhus#3, Fixes sindresorhus#14 Signed-off-by: Richie Bendall <[email protected]>

Fixed Gitignore

4360b2c

Meta tweak

05f6f01

Signed-off-by: Richie Bendall <[email protected]>

Richienb mentioned this pull request Sep 24, 2021

Discard cache after resolution #20

Closed

fregante reviewed Sep 24, 2021

View reviewed changes

index.ts Outdated Show resolved Hide resolved

fregante reviewed Sep 24, 2021

View reviewed changes

index.ts Outdated Show resolved Hide resolved

Richienb added 3 commits September 24, 2021 19:06

Remove moot test

49fb57f

Signed-off-by: Richie Bendall <[email protected]>

Document reason for needing promiseCache

6756627

Signed-off-by: Richie Bendall <[email protected]>

Minor tweaks

2f61c2b

Signed-off-by: Richie Bendall <[email protected]>

fregante reviewed Sep 24, 2021

View reviewed changes

index.ts Outdated Show resolved Hide resolved

Remove ESLint ignore statement

ca9f607

Signed-off-by: Richie Bendall <[email protected]>

Richienb requested a review from fregante September 24, 2021 08:18

Remove type assertions

dd51838

Signed-off-by: Richie Bendall <[email protected]>

sindresorhus reviewed Sep 25, 2021

View reviewed changes

readme.md Show resolved Hide resolved

sindresorhus reviewed Sep 25, 2021

View reviewed changes

index.ts Outdated Show resolved Hide resolved

sindresorhus reviewed Sep 25, 2021

View reviewed changes

index.ts Outdated Show resolved Hide resolved

Richienb and others added 4 commits September 26, 2021 04:08

Fix documentation

c7fa0e7

Signed-off-by: Richie Bendall <[email protected]>

Merge branch 'async-cache' of https://github.com/Richienb/p-memoize i…

7f27a9b

…nto async-cache

Update index.ts

3fe75f6

Co-authored-by: Sindre Sorhus <[email protected]>

Update tsconfig.json

efc3700

sindresorhus requested changes Oct 4, 2021

View reviewed changes

index.ts Outdated Show resolved Hide resolved

index.ts Outdated Show resolved Hide resolved

package.json Show resolved Hide resolved

readme.md Outdated Show resolved Hide resolved

readme.md Show resolved Hide resolved

test-d/index.test-d.ts Outdated Show resolved Hide resolved

Richienb and others added 3 commits October 5, 2021 14:43

Apply suggestions from code review

a07c869

Co-authored-by: Sindre Sorhus <[email protected]>

Minor tweaks

7d0a9c6

Fix lint

8dedc94

Signed-off-by: Richie Bendall <[email protected]>

Richienb requested a review from sindresorhus October 5, 2021 01:55

Merge remote-tracking branch 'upstream/main' into async-cache

653ca8f

sindresorhus requested changes Oct 9, 2021

View reviewed changes

index.ts Show resolved Hide resolved

test.ts Outdated Show resolved Hide resolved

readme.md Outdated Show resolved Hide resolved

Tweaks

e6174ff

Signed-off-by: Richie Bendall <[email protected]>

Linkify

788d551

Signed-off-by: Richie Bendall <[email protected]>

Richienb requested a review from sindresorhus October 9, 2021 16:03

sindresorhus changed the title ~~Allow .get() and .has() to return a promise~~ Allow cache to be async Oct 13, 2021

sindresorhus merged commit 19b418e into sindresorhus:main Oct 13, 2021

AmrSaber mentioned this pull request Oct 17, 2021

Feature request: Return stale value while revalidating #19

Closed

futpib reviewed Nov 7, 2021

View reviewed changes

fregante mentioned this pull request Jul 20, 2022

cache.function permanently memoizes the value of functions fregante/webext-storage-cache#34

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Allow cache to be async #26

Allow cache to be async #26

Richienb commented Sep 24, 2021 •

edited

Loading

sindresorhus commented Oct 4, 2021

sindresorhus commented Oct 9, 2021

sindresorhus commented Oct 9, 2021 •

edited

Loading

Richienb commented Oct 9, 2021

sindresorhus commented Oct 13, 2021

Richienb commented Oct 13, 2021

JaneJeon commented Oct 13, 2021

futpib Nov 7, 2021

Richienb Nov 7, 2021

futpib Nov 7, 2021

Allow cache to be async #26

Allow cache to be async #26

Conversation

Richienb commented Sep 24, 2021 • edited Loading

sindresorhus commented Oct 4, 2021

sindresorhus commented Oct 9, 2021

sindresorhus commented Oct 9, 2021 • edited Loading

Richienb commented Oct 9, 2021

sindresorhus commented Oct 13, 2021

Richienb commented Oct 13, 2021

JaneJeon commented Oct 13, 2021

futpib Nov 7, 2021

Choose a reason for hiding this comment

Richienb Nov 7, 2021

Choose a reason for hiding this comment

futpib Nov 7, 2021

Choose a reason for hiding this comment

Richienb commented Sep 24, 2021 •

edited

Loading

sindresorhus commented Oct 9, 2021 •

edited

Loading