{"id":20313606,"url":"https://github.com/weaviate/typescript-embedded","last_synced_at":"2025-04-11T17:15:39.061Z","repository":{"id":157326275,"uuid":"630988343","full_name":"weaviate/typescript-embedded","owner":"weaviate","description":"An embedded Weaviate database with TypeScript client interface","archived":false,"fork":false,"pushed_at":"2024-06-26T15:43:38.000Z","size":261,"stargazers_count":11,"open_issues_count":2,"forks_count":2,"subscribers_count":9,"default_branch":"main","last_synced_at":"2025-03-25T13:11:21.460Z","etag":null,"topics":["embedded-database","typescript","vector-search","weaviate"],"latest_commit_sha":null,"homepage":"https://www.npmjs.com/package/weaviate-ts-embedded","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-3-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/weaviate.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-04-21T16:21:55.000Z","updated_at":"2024-09-14T07:47:31.000Z","dependencies_parsed_at":"2024-06-26T19:15:06.013Z","dependency_job_id":null,"html_url":"https://github.com/weaviate/typescript-embedded","commit_stats":null,"previous_names":[],"tags_count":4,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/weaviate%2Ftypescript-embedded","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/weaviate%2Ftypescript-embedded/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/weaviate%2Ftypescript-embedded/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/weaviate%2Ftypescript-embedded/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/weaviate","download_url":"https://codeload.github.com/weaviate/typescript-embedded/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248447595,"owners_count":21105140,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["embedded-database","typescript","vector-search","weaviate"],"created_at":"2024-11-14T18:11:59.635Z","updated_at":"2025-04-11T17:15:39.034Z","avatar_url":"https://github.com/weaviate.png","language":"TypeScript","readme":"# Weaviate TypeScript EmbeddedDB \u003cimg alt='Weaviate logo' src='https://weaviate.io/img/site/weaviate-logo-light.png' width='148' align='right' /\u003e\n\nAn embedded Weaviate database with TypeScript client interface, available for Linux and Mac\n\n## Documentation\n\n- [Documentation](https://weaviate.io/developers/weaviate/installation/embedded).\n\n## Examples\n\n### With default options\n\nDefaults:\n- Host: `127.0.0.1`\n- Port: `6666`\n- Weaviate version: `latest`\n\n```ts\nimport weaviate, { EmbeddedClient, EmbeddedOptions } from 'weaviate-ts-embedded';\n\nconst client: EmbeddedClient = weaviate.client(new EmbeddedOptions());\nawait client.embedded.start();\n// use the client to interact with embedded Weaviate\nclient.embedded.stop();\n```\n\n### With custom options\n\n```ts\nimport weaviate, { EmbeddedClient, EmbeddedOptions } from 'weaviate-ts-embedded';\n\nconst client: EmbeddedClient = weaviate.client(\n  new EmbeddedOptions({\n    port: 7878,\n    version: '1.18.1',\n    env: {\n      QUERY_DEFAULTS_LIMIT: 50,\n      DEFAULT_VECTORIZER_MODULE: 'text2vec-openai',\n    },\n  }),\n  // weaviate-ts-client ConnectionParams\n  {\n    scheme: 'http',\n    host: '127.0.0.1:7878',\n  }\n);\nawait client.embedded.start();\n// use the client to interact with embedded Weaviate\nclient.embedded.stop();\n```\n\n### With direct binary url\n\n```ts\nimport weaviate, { EmbeddedClient, EmbeddedOptions } from 'weaviate-ts-embedded';\n\nconst binaryUrl = 'https://some-link-to-weaviate-binary';\nconst client: EmbeddedClient = weaviate.client(\n  new EmbeddedOptions({\n    binaryUrl: binaryUrl,\n  })\n);\nawait client.embedded.start();\n// use the client to interact with embedded Weaviate\nclient.embedded.stop();\n```\n\n## Support\n\n- [Stackoverflow for questions](https://stackoverflow.com/questions/tagged/weaviate).\n- [Github for issues](https://github.com/weaviate/typescript-embedded/issues).\n\n## Contributing\n\n- [How to Contribute](https://github.com/weaviate/typescript-embedded/blob/main/CONTRIBUTE.md).\n\n## Build Status\n\n[![Build Status](https://github.com/weaviate/typescript-embedded/actions/workflows/.github/workflows/main.yaml/badge.svg?branch=main)](https://github.com/weaviate/typescript-embedded/actions/workflows/.github/workflows/main.yaml)\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fweaviate%2Ftypescript-embedded","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fweaviate%2Ftypescript-embedded","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fweaviate%2Ftypescript-embedded/lists"}