Nested Docs plugin callback signatures do not match current type hints

[ItsFrankieD]

Documentation Issue

The current documentation for Nested Docs shows generateLabel: (_, doc) and generateURL: (docs), while the type hint in the current version at the time of writing (3.44.0) shows generateLabel: (docs: Array<Record<string, unknown>>, currentDoc: Record<string, unknown>) and generateURL: (docs: Array<Record<string, unknown>>, currentDoc: Record<string, unknown>).

When I attempt to return something like currentDoc.title, I am given a TypeScript error as it assume I am returning unknown as opposed to a string.

The documentation needs to be updated, as in its current state it's unusable.

[JessRynkar]

Hi @ItsFrankieD, thanks for raising this and apologies for the delayed response.

The types here are intentionally generic and technically correct, users need to narrow or assert the value before returning it (for example String(doc.title)), otherwise TypeScript will throw an error as expected.

I agree, this is not made clear in the docs and of course any examples should be working as-is, we will get this updated.

@zubricks on this page in our docs, we need to update the generateLabel and generateURL examples to always wrap returned values in String(). Should I leave it to you or do you want me to take care of it?

[github-actions]

🚀 This is included in version v3.79.1

[github-actions]

This issue has been automatically locked.
Please open a new issue if this issue persists with any additional detail.