Skip to content

v0.24.0 ๐ŸŒป

Compare
Choose a tag to compare
@meili-bot meili-bot released this 12 Jan 16:05
· 1216 commits to main since this release
fbc87a4

This package version is compatible with MeiliSearch v0.25.0 ๐ŸŽ‰

โš ๏ธ Breaking changes

  • This package is only compatible with MeiliSearch v0.25.0 and later, but not with v0.24.0 and older. Be sure you are using at least MeiliSearch v0.24.0 or newer before doing the upgrade.
    Why isn't it compatible?
    • MeiliSearch v0.25.0 uses Authorization header instead of X-Meili-API-Key
    • MeiliSearch v0.25.0 has a new API regarding the updates that have been renamed into tasks. More details in the following points
  • Changes related to the new task API (#1123) @bidoubiwa Check out the task API references and the asynchronous tasks guide
    • createIndex, updateIndex and deleteIndex are now asynchrone regarding MeiliSearch and do not return a Index instance anymore, but a task object. Please use index() method instead.
    • Rename index.getAllUpdateStatus into index.getTasks
    • Rename index.getUpdateStatus into index.getTask
    • waitForPendingUpdate is renamed into waitForTask and is accessible from index and from client
  • Remove getOrCreateIndex method (#1125) @bidoubiwa
  • Remove deleteIndexIfExists method (#1124) @bidoubiwa
  • client.getKeys() does not return an object of keys, but an array of keys. Check out keys API references.

๐Ÿš€ Enhancements

  • Add API keys methods (#1123) @bidoubiwa
    • client.createKey()
    • client.updateKey()
    • client.deleteKey()
    • client.getKey()

Check out the documentation guide.

  • Add new methods client.getTasks() and client.getTask()

Thanks again to @bidoubiwa, @alallema and @curquiza ! ๐ŸŽ‰