Add `.decorator()` method #61

Richienb · 2020-08-20T23:53:14Z

Fixes: #60

// @sindresorhus @fregante

Signed-off-by: Richie Bendall <richiebendall@gmail.com>

sindresorhus · 2020-08-21T00:09:17Z

It should be clearly documented that it's only for TypeScript consumers.

I'm also not sure about the "mixin" naming. "mixin" is a pretty overloaded term and it doesn't exactly fit here.

Richienb · 2020-08-21T00:11:37Z

@sindresorhus > I'm also not sure about the "mixin" naming.

See how it's done in emittery. What should we call it instead?

test.js

index.js

Co-authored-by: Sindre Sorhus <sindresorhus@gmail.com>

index.d.ts

sindresorhus · 2020-08-21T00:16:10Z

See how it's done in emittery.

It's called that there because the decorator actually "mixes in". That's not about the decorator itself.

What should we call it instead?

Any suggestions?

Signed-off-by: Richie Bendall <richiebendall@gmail.com>

…com/Richienb/mem into add-decorator

Richienb · 2020-08-21T00:29:51Z

@sindresorhus .decorator()?

index.d.ts

index.js

readme.md

sindresorhus · 2020-08-21T22:12:00Z

@sindresorhus .decorator()?

Yeah, I cannot think of something better than that.

Signed-off-by: Richie Bendall <richiebendall@gmail.com>

index.d.ts

test.js

readme.md

Signed-off-by: Richie Bendall <richiebendall@gmail.com>

Richienb · 2020-12-19T10:15:08Z

Where did the build statuses go?

sindresorhus · 2020-12-20T05:06:11Z

b1c65cd

Richienb · 2020-12-20T05:08:26Z

@sindresorhus Are you at the point of switching to Github Actions for all of your projects?

sindresorhus · 2021-03-07T11:10:19Z

@Richienb Still interested in finishing this? I noticed it's still marked as a draft PR and tests are failing.

Richienb · 2021-03-07T11:12:29Z

Yes - most the errors look to be TypeScript compilation errors so I'll get to fixing them

Signed-off-by: Richie Bendall <richiebendall@gmail.com>

Richienb · 2021-03-09T11:07:18Z

index.ts

+>(
+	options: Options<FunctionToMemoize, CacheKeyType> = {}
+) => (
+	target: any,


I don't think there's a way to avoid this being any.

Shouldn't it be:

Suggested change

target: any,

target: FunctionToMemoize,

?

target refers to the object that the function lives in. const input: FunctionToMemoize = target[propertyKey].

Shouldn't it at least be object then to ensure undefined and null are not the target? Also, I generally prefer unknown over any whenever possible.

object isn't allowed by xo which wants it to be Record<string, unknown> which doesn't work either because a class is not an plain object.

Not using object is just a general rule. You shouldn't use any either, ideally. But sometimes we need exceptions. Just use an eslint-ignore comment.

As soon as I change any to object, the compiler throws because {} can't be indexed by a string.

If I try to use generics with {target: Target, propertyKey: keyof Target}, the compiler (possible due to a bug) is instead unable to resolve a target properly so it always falls back to unknown, making propertyKey resolve to never.

It looks like setting it to anything else, is nearly impossible.

index.ts

readme.md

sindresorhus · 2021-03-10T07:57:45Z

index.ts

+>(
+	options: Options<FunctionToMemoize, CacheKeyType> = {}
+) => (
+	target: any,


Shouldn't it be:

Suggested change

target: any,

target: FunctionToMemoize,

?

index.ts

Co-authored-by: Sindre Sorhus <sindresorhus@gmail.com>

Signed-off-by: Richie Bendall <richiebendall@gmail.com>

sindresorhus · 2021-03-18T12:04:56Z

#61 (comment)

Richienb added 3 commits August 21, 2020 11:51

Add .mixin()

6438d9b

Signed-off-by: Richie Bendall <richiebendall@gmail.com>

Update index.d.ts

5be90de

Update index.d.ts

d3d5df0

sindresorhus reviewed Aug 21, 2020

View reviewed changes

test.js Outdated Show resolved Hide resolved

sindresorhus reviewed Aug 21, 2020

View reviewed changes

index.js Outdated Show resolved Hide resolved

Update index.js

7fe63b4

Co-authored-by: Sindre Sorhus <sindresorhus@gmail.com>

sindresorhus reviewed Aug 21, 2020

View reviewed changes

index.d.ts Outdated Show resolved Hide resolved

Richienb added 2 commits August 21, 2020 12:22

Fix formatting

16ecd9d

Signed-off-by: Richie Bendall <richiebendall@gmail.com>

Merge branches 'add-decorator' and 'add-decorator' of https://github.…

45b358b

…com/Richienb/mem into add-decorator

fregante requested changes Aug 21, 2020

View reviewed changes

index.d.ts Outdated Show resolved Hide resolved

index.js Outdated Show resolved Hide resolved

fregante reviewed Aug 21, 2020

View reviewed changes

readme.md Outdated Show resolved Hide resolved

Richienb added 2 commits August 22, 2020 12:09

Remove colon

782abbd

Signed-off-by: Richie Bendall <richiebendall@gmail.com>

Rename to .decorator

a5eee78

Signed-off-by: Richie Bendall <richiebendall@gmail.com>

Richienb changed the title ~~Add .mixin()~~ Add .decorator() Aug 22, 2020

Richienb requested review from fregante and sindresorhus August 22, 2020 00:16

sindresorhus reviewed Aug 22, 2020

View reviewed changes

index.d.ts Outdated Show resolved Hide resolved

sindresorhus reviewed Aug 22, 2020

View reviewed changes

index.d.ts Outdated Show resolved Hide resolved

sindresorhus reviewed Aug 22, 2020

View reviewed changes

index.d.ts Outdated Show resolved Hide resolved

sindresorhus reviewed Aug 22, 2020

View reviewed changes

index.d.ts Outdated Show resolved Hide resolved

sindresorhus changed the title ~~Add .decorator()~~ Add .decorator() method Aug 22, 2020

fregante reviewed Aug 22, 2020

View reviewed changes

test.js Outdated Show resolved Hide resolved

Extend tests

ed5547a

fregante reviewed Aug 22, 2020

View reviewed changes

readme.md Show resolved Hide resolved

Properly indent typings

2307895

Signed-off-by: Richie Bendall <richiebendall@gmail.com>

fregante added the enhancement label Oct 10, 2020

Richienb and others added 4 commits October 11, 2020 11:39

Merge remote-tracking branch 'upstream/master' into add-decorator

2ae22a8

Move tests to main test file

19a6598

Signed-off-by: Richie Bendall <richiebendall@gmail.com>

Lint

ba89249

Fix options typings

914506a

Signed-off-by: Richie Bendall <richiebendall@gmail.com>

Merge remote-tracking branch 'upstream/master' into add-decorator

28bae9a

Richienb added 2 commits December 20, 2020 18:09

Merge remote-tracking branch 'upstream/master' into add-decorator

5a9ea93

Update test.ts

31735fd

Base automatically changed from master to main January 23, 2021 17:35

Fix tests

97a358a

Signed-off-by: Richie Bendall <richiebendall@gmail.com>

Richienb commented Mar 9, 2021

View reviewed changes

Richienb marked this pull request as ready for review March 9, 2021 11:07

Richienb requested review from fregante and sindresorhus March 9, 2021 11:07

Update index.ts

7a8b838

Richienb commented Mar 9, 2021

View reviewed changes

index.ts Outdated Show resolved Hide resolved

sindresorhus requested changes Mar 10, 2021

View reviewed changes

Richienb and others added 4 commits March 10, 2021 23:00

Update index.ts

cf406a3

Co-authored-by: Sindre Sorhus <sindresorhus@gmail.com>

Update readme.md

a34fcf1

Co-authored-by: Sindre Sorhus <sindresorhus@gmail.com>

Update readme.md

1119f2e

Co-authored-by: Sindre Sorhus <sindresorhus@gmail.com>

Minor tweaks

f782bce

Signed-off-by: Richie Bendall <richiebendall@gmail.com>

Richienb requested a review from sindresorhus March 10, 2021 10:24

sindresorhus merged commit 528fa42 into sindresorhus:main Mar 18, 2021

fregante mentioned this pull request Mar 18, 2021

💯 Minor codebase updates and fixes refined-github/refined-github#4008

Closed

1 task

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add `.decorator()` method #61

Add `.decorator()` method #61

Richienb commented Aug 20, 2020 •

edited

Loading

sindresorhus commented Aug 21, 2020

Richienb commented Aug 21, 2020 •

edited

Loading

sindresorhus commented Aug 21, 2020

Richienb commented Aug 21, 2020

sindresorhus commented Aug 21, 2020

Richienb commented Dec 19, 2020

sindresorhus commented Dec 20, 2020

Richienb commented Dec 20, 2020

sindresorhus commented Mar 7, 2021

Richienb commented Mar 7, 2021

Richienb Mar 9, 2021

sindresorhus Mar 10, 2021

Richienb Mar 10, 2021

sindresorhus Mar 18, 2021

Richienb Mar 18, 2021

sindresorhus Mar 18, 2021

Richienb Mar 18, 2021 •

edited

Loading

sindresorhus Mar 10, 2021

sindresorhus commented Mar 18, 2021

Add .decorator() method #61

Add .decorator() method #61

Conversation

Richienb commented Aug 20, 2020 • edited Loading

sindresorhus commented Aug 21, 2020

Richienb commented Aug 21, 2020 • edited Loading

sindresorhus commented Aug 21, 2020

Richienb commented Aug 21, 2020

sindresorhus commented Aug 21, 2020

Richienb commented Dec 19, 2020

sindresorhus commented Dec 20, 2020

Richienb commented Dec 20, 2020

sindresorhus commented Mar 7, 2021

Richienb commented Mar 7, 2021

Richienb Mar 9, 2021

Choose a reason for hiding this comment

sindresorhus Mar 10, 2021

Choose a reason for hiding this comment

Richienb Mar 10, 2021

Choose a reason for hiding this comment

sindresorhus Mar 18, 2021

Choose a reason for hiding this comment

Richienb Mar 18, 2021

Choose a reason for hiding this comment

sindresorhus Mar 18, 2021

Choose a reason for hiding this comment

Richienb Mar 18, 2021 • edited Loading

Choose a reason for hiding this comment

sindresorhus Mar 10, 2021

Choose a reason for hiding this comment

sindresorhus commented Mar 18, 2021

Add `.decorator()` method #61

Add `.decorator()` method #61

Richienb commented Aug 20, 2020 •

edited

Loading

Richienb commented Aug 21, 2020 •

edited

Loading

Richienb Mar 18, 2021 •

edited

Loading