typescript-client
typescript-client copied to clipboard
Need explicit documentation for the JavaScript client methods
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
.graphqlmember 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 whatwith...methods are available. client.graphql.raw()and.get()should be documented.
TypeScript definitions would've been another solution.
👍 x 💯
Thanks for sharing.
@dirkkul, can you please pick this up with @sebawita and co?
Hi Bob, I already talked with Dan last week and we'll come up with something