Skip to content

🐞 Update types to prevent @typescript-eslint/unbound-method errors #360

@reify-tanner-stirrat

Description

@reify-tanner-stirrat

What happened?

const { activate } = useIdleTimer(config);

The above will throw:

@typescript-eslint/unbound-method: Avoid referencing unbound methods which may cause unintentional scoping of `this`. If your function does not access `this`, you can annotate it with `this: void`, or consider using an arrow function instead.

According to this stackoverflow post, it's because there's a meaningful difference between:

type IIdleTimer = {
  activate(): bool;
}
// and
type IIdleTimer = {
  activate: () => bool;
}

which is that the former is typed as a function() definition and carries the this weirdness, where the latter is not.

Reproduction Steps

See above

Relevant log output

N/A

Screenshots or Additional Context

No response

Module Version

5.7.2

What browsers are you seeing the problem on? Select all that apply.

No response

What devices are you seeing the problem on?

No response

Verification

  • I have checked for existing closed issues and discussions.

Activity

added
bugA verified and reproducible bug.
triageHas not been reviewed yet and should not be worked on.
on Jul 27, 2023
SupremeTechnopriest

SupremeTechnopriest commented on Jul 27, 2023

@SupremeTechnopriest
Owner

Nice catch! Out of curiosity, is this popping up for you because you are using class components?

reify-tanner-stirrat

reify-tanner-stirrat commented on Jul 28, 2023

@reify-tanner-stirrat
Author

Nope, normal functional components defined as arrow functions. To be honest I don't understand enough about typescript to understand why it's complaining about this.

SupremeTechnopriest

SupremeTechnopriest commented on Jul 28, 2023

@SupremeTechnopriest
Owner

Are you using this? No worries I'll look into it.

reify-tanner-stirrat

reify-tanner-stirrat commented on Jul 28, 2023

@reify-tanner-stirrat
Author

Nope. I also opened #361 to fix it.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Labels

bugA verified and reproducible bug.triageHas not been reviewed yet and should not be worked on.

Projects

No projects

Milestone

No milestone

Relationships

None yet

    Participants

    @SupremeTechnopriest@reify-tanner-stirrat

    Issue actions

      🐞 Update types to prevent @typescript-eslint/unbound-method errors · Issue #360 · SupremeTechnopriest/react-idle-timer