A modern Couchbase SDK for Node.js & TypeScript.
Documentation | Getting Started | Why Cbjs?
## Getting started To get started with your new Couchbase Node.js SDK, uninstall the official library and install Cbjs : ```bash npm uninstall couchbase npm install @cbjsdev/cbjs ``` ## Compatibility Built on top of the official library, Cbjs is a drop-in replacement for the `couchbase` package. The package that is specific to your platform is downloaded during the install process. Cbjs is also full **ESM native**. ### Cross-platform install By default the native binary is selected from `process.platform` / `process.arch` of the machine running the install. When you bundle for a different target than your build machine — for example building a Linux/x64 AWS Lambda artifact from a darwin/arm64 Mac — set these environment variables so the matching binary is downloaded instead: ```bash COUCHBASE_BINARY_PLATFORM=linux COUCHBASE_BINARY_ARCH=x64 npm install ``` Cbjs is your new [Couchbase SDK for Node.js with TypeScript](https://cbjs.dev/guide/features.html#compatible-with-the-official-client). ## Exclusive Features Cbjs has been created to deliver a better DX. By making extensive usage of TypeScript, Cbjs is able to add some exclusive features. ### Inferred return type for KV operation Because Cbjs knows your documents, the return type of KV operations is inferred from the parameters. [](https://cbjs.dev/guide/features.html#inferred-return-type) Read more about [couchbase document path autocomplete](https://cbjs.dev/guide/features.html#inferred-return-type). ### Chainable sub-document operations Adopt a more elegant syntax by chaining sub-document operations. ```ts const result = await collection.lookupIn('book::001') .get('title') .exists('lastModifiedBy') .count('metadata.tags'); ``` Read more about [chainable lookupIn](https://cbjs.dev/guide/services/kv.html#chainable-sub-doc-operations). ### Path autocomplete for sub-document operation Because Cbjs knows your documents, autocompletion is offered when writing a document path. [](https://cbjs.dev/guide/features.html#ide-autocompletion) ### Improved types Great efforts have been made to improve function signatures and types in general. Here is an example that uses _discriminated unions_ to offer a natural type guard : ```ts const { content: [title] } = await collection.lookupIn(bookId).get('title'); // ^? LookupInResultEntry