Meridian JavaScript SDK 3.0

Every method now returns a promise, results are typed from your schema, and the browser build is 40% smaller. Callbacks are gone, so read the upgrade steps before you update.

This release has 3 breaking changes

Callbacks are removed and Node.js 20 is the new minimum. Most apps upgrade in under an hour with the codemod.

Go to the upgrade steps

Highlights

New

Promises everywhere. Every method returns a promise and works with await, in Node.js, Deno, Bun and the browser.
Typed results. Run meridian types and search results carry the types of your collection’s fields.
A smaller browser build. 18 KB gzipped, down from 31 KB, and unused methods are left out of your bundle.

Breaking changes

Breaking

Callbacks are removed. Methods no longer take a callback as their last argument; await the result instead.
Node.js 18 is no longer supported. 3.0 needs Node.js 20 or later.
client.index() is now client.collection(). The old name throws an error that names the new one.

Improvements

Improved

Failed requests retry up to 3 times with growing, jittered waits. Change it with maxRetries.
Every error carries the requestId to quote when you contact support.

Fixes

Fixed

search() no longer drops results when offset is above 1,000.
Requests with a timeout no longer hang in Deno and Bun.

Upgrade steps

1
Update the package

Check that your app runs on Node.js 20 or later, then install 3.0.
Terminal
```
npm install @meridian/sdk@3.0.0
```

Replace callbacks with await

Run npx @meridian/codemod v3 ./src to rewrite most calls for you, or change them by hand:

search.js

− removed+ added

  const client = new Meridian(process.env.MERIDIAN_KEY);
- client.search('running shoes', (err, results) => render(results));
+ const results = await client.search('running shoes');
+ render(results);

Rename index() to collection()

Search your code for .index( and rename each call. The arguments stay the same.
Check the result

Run npx meridian doctor. It lists any call the codemod missed, with its file and line.

Highlights

Breaking changes

Improvements

Fixes

Upgrade steps

Update the package

Replace callbacks with await

Rename index() to collection()

Check the result

Release Notes Page

More in this category