Skip to content

Outdated API reference and code samples #1944

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
crlhrtmnn opened this issue May 11, 2025 · 1 comment · May be fixed by #1943
Open

Outdated API reference and code samples #1944

crlhrtmnn opened this issue May 11, 2025 · 1 comment · May be fixed by #1943
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@crlhrtmnn
Copy link

Description
In the Javascript SDK API reference it is written that one can get a list of all global Tasks with client.getTasks(). This however does not work as the getTasks() function is part of the TaskClient Class whom is an attribute of the MeiliSearch Class.
This error is also apparent in meilisearchs Documentation.
The documentation and reference for all other task functions are incorrect as well.

In meilisearch-js version v0.50.0 all global Tasks can be retrieved with client.tasks.getTasks()

Expected behavior
The Documentation and the API Reference should be correct.

Environment (please complete the following information):

  • Meilisearch version: 1.14.0
  • meilisearch-js version: v0.50.0
@flevi29 flevi29 added the documentation Improvements or additions to documentation label May 11, 2025
@flevi29
Copy link
Collaborator

flevi29 commented May 11, 2025

Thanks! Will be fixed.

@Strift Strift changed the title API reference and documentation for JavaScript SDK partly incorrect Outdated API reference and code samples May 14, 2025
@Strift Strift self-assigned this May 14, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants