Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Doc / Type mismatch: getFile returns contentType instead of mimeType #1310

Open
upepo-mwindaji opened this issue Feb 1, 2024 · 0 comments
Open

Doc / Type mismatch: getFile returns contentType instead of mimeType #1310

upepo-mwindaji opened this issue Feb 1, 2024 · 0 comments
Labels
docs good first issue A good issue for first-time contributors

Comments

@upepo-mwindaji
Copy link

The getFile implementation:

remotestorage.js/src/baseclient.ts

Line 152 in e91c5f5

contentType: r.contentType,

Does not match:

  1. the type definition

    remotestorage.js/release/types/baseclient.d.ts

    Line 67 in e91c5f5

    * @param {string} mimeType - MIME media type of the data being stored
  2. the doc reference

    remotestorage.js/doc/js-api/base-client.rst

    Line 202 in e91c5f5

    ``mimeType`` String representing the MIME Type of the document.

I assume better to update the doc and type rather than the interface even though mimeType is mostly used elsewhere ?
@raucao raucao added docs good first issue A good issue for first-time contributors labels Feb 2, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
docs good first issue A good issue for first-time contributors
Milestone
No milestone
Development

No branches or pull requests
2 participants
@raucao @upepo-mwindaji