-
Notifications
You must be signed in to change notification settings - Fork 130
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[Draft] TS Client Migration Docs and Client Page updates. (#1933)
* added migration page * first shot at cleint page * fixed a broken link * added migration page * made changes * final client page * cleaned code examples * TSv3 content changes (#1992) * TSv3 client content pages * Intro * Spelling * Landing page, feedback * landing page * finish copy from 1967 * 1976 in progress * finish copy from 1976 * staging index * v2 v3 * v3 staging * intro * interact * staging * push * fixed merge issues * DR-291 TSv3 branch consolidation (#1995) * DR-291 TSv3 branch consolidation * titles * ts config * node support * async * v3 client pr 1967 * migrate pr1967 * rt nav * connect * ts client staging * migrate staging * Add link * Beta note --------- Co-authored-by: daveatweaviate <[email protected]> ------ From yarn verify-links 🏊♂️ crawling ./build.dev 🤖 Successfully scanned 0 links in 0.005 seconds. ************************************** Link Verification Complete
- Loading branch information
Showing
19 changed files
with
1,114 additions
and
762 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
The client uses a keep-alive header to maintain long-lived connections to Weaviate. | ||
|
||
After you establish the connection to your Weaviate instance, subsequent calls are faster. When you finish your client operations, close the connection to free server resources. | ||
|
||
Use the `client.close()` method to close the connection instead of waiting for the connection to time out. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
The Weaviate TypeScript client supports TypeScript and JavaScript. The TypeScript client v3 is currently in beta. | ||
|
||
The upcoming v3 client currently supports server side development (Node.js hosted). See [v3 packages](/developers/weaviate/client-libraries/typescript/v2_v3_migration#node-support-only) for details. If your application is browser based, consider using the TypeScript client v2. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,6 +1,6 @@ | ||
## Questions and feedback | ||
|
||
If you have any questions or feedback, please let us know [on our forum](https://forum.weaviate.io/). For example, you can: | ||
If you have any questions or feedback, let us know in our [user forum](https://forum.weaviate.io/). | ||
|
||
- [Provide feedback on the documentation](https://forum.weaviate.io/new-topic?title=%5BDocs%5D%20YOUR%20TOPIC&body=Details%20here&category=support&tags=documentation) | ||
- [Ask a technical question](https://forum.weaviate.io/new-topic?title=%5BQuestion%5D%20YOUR%20TOPIC&body=Details%20here&category=support&tags=technical) | ||
- [Technical questions](https://forum.weaviate.io/new-topic?title=%5BQuestion%5D%20YOUR%20TOPIC&body=Details%20here&category=support&tags=technical) | ||
- [Documentation feedback](https://forum.weaviate.io/new-topic?title=%5BDocs%5D%20YOUR%20TOPIC&body=Details%20here&category=support&tags=documentation) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
2 changes: 1 addition & 1 deletion
2
developers/weaviate/client-libraries/_components/client.auth.api.key.mdx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1 +1 @@ | ||
To authenticate against Weaviate using an API key, instantiate the client as follows: | ||
If you use an API key to authenticate, instantiate the client like this: |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.