typescript-client icon indicating copy to clipboard operation
typescript-client copied to clipboard

Need explicit documentation for the JavaScript client methods

Open dandv opened this issue 3 years ago • 3 comments

I'm trying to build a demo app using the JS client, and the documentation at https://weaviate.io/developers/weaviate/current/client-libraries/javascript.html barely scratches the surface. While it correctly directs the developer to the REST and GraphQL reference pages, it would be very helpful if it clarified the link between those and the builder pattern calling convention used by the client.

More specifically,

  • there's no mention of the .graphql member of the client. I only saw that in passing in this tutorial
  • the with... methods should be explicitly documented. A stop-gap measure would be to link to test files so the developer could see what with... methods are available.
  • client.graphql.raw() and .get() should be documented.

TypeScript definitions would've been another solution.

dandv avatar Oct 06 '22 12:10 dandv

👍 x 💯

travis-jm avatar Nov 09 '22 15:11 travis-jm

Thanks for sharing.

@dirkkul, can you please pick this up with @sebawita and co?

bobvanluijt avatar Nov 14 '22 10:11 bobvanluijt

Hi Bob, I already talked with Dan last week and we'll come up with something

dirkkul avatar Nov 16 '22 14:11 dirkkul