Decide what to do with getQueriesForElement and within

[NMinhNguyen]

Describe the feature you'd like:

Decide whether to keep both getQueriesForElement and within. I spoke to @kentcdodds on Twitter and he thinks that perhaps we should keep both. He suggested that I create an issue to discuss.

If both are kept, perhaps the docs could be improved to help people decide between the two.

Suggested implementation:

Describe alternatives you've considered:

Teachability, Documentation, Adoption, Migration Strategy:

[kentcdodds]

I'd love to hear from other people. I'm not a fan of two ways to do the same thing (which is all aliases are), but I kind of like the way it reads in the different situations people use them in:

• getQueriesForElement: used by framework integration libraries
• within: used by users who want to scope some queries within an element (like a modal).

[NMinhNguyen]

What about the third though, bindElementToQueries? Or do you see value in it being used by framework integration libraries too?

[kentcdodds]

Oh, right, whoops, I honestly totally forgot about that and didn't even bother to read it because I assumed this was talking about the within alias.

Yeah, let's get rid of bindElementToQueries 💯

[NMinhNguyen]

Yeah, let's get rid of bindElementToQueries 💯

I can repurpose the issue description to talk about within and getQueriesForElement :)

Would you like to deprecate bindElementToQueries first or just remove it?

[kentcdodds]

It's not been documented for a long time so I doubt anyone would be mad if we removed it. And renaming would be really trivial anyway.