feat: add render hook support for multiple arguments

[imevanc]

What: Add render hook support for multiple arguments

Why: renderHook only supports a single argument via initialProps, making it hard to test hooks with multiple parameters. This PR introduces initialArgs to allow passing multiple arguments directly, improving flexibility and reducing workarounds.

How:

1. Added initialArgs support → Spreads arguments into the hook.
2. Updated rerender → Now accepts multiple parameters.
3. Ensured backward compatibility → initialProps remains unchanged.
4. Throws an error if both initialProps and initialArgs are used.
5. Added tests & updated docs → Validates behavior and documents usage.

Issue: #1350

Checklist:

• Documentation added to the
  docs site
• Tests
• TypeScript definitions updated
• Ready to be merged
  

[codesandbox-ci]

This pull request is automatically built and testable in CodeSandbox.

To see build info of the built libraries, click here or the icon next to each commit SHA.

Latest deployment of this branch, based on commit 42c12ac:

Sandbox	Source
react-testing-library-examples	Configuration

[imevanc]

@eps1lon - awaiting your feedback 🧑‍💻

[imevanc]

@danielrentz - anything to add ?

[danielrentz]

TS typings

[imevanc]

@Hardanish-Singh - just rebased, can you please thumb it again?

[danielrentz]

@imevanc @Hardanish-Singh the typings are still broken