8000 Incorrect return type for `TypedClient.getBucketVersioning()` · Issue #1296 · minio/minio-js · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

Incorrect return type for TypedClient.getBucketVersioning() #1296

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
Closed
SleepyLeslie opened this issue May 22, 2024 · 3 comments · Fixed by #1297
Closed

Incorrect return type for TypedClient.getBucketVersioning() #1296

SleepyLeslie opened this issue May 22, 2024 · 3 comments · Fixed by #1297

Comments

@SleepyLeslie
Copy link

The function here definitely returns something, so its return type shouldn't be Promise<void>.

minio-js/src/internal/client.ts

Line 2095 in 8633968

async getBucketVersioning(bucketName: string): Promise<void> {

Here is my suggestion. I didn't look very closely so I might have missed some fields.

type VersioningStatus = {
  "Status": "Enabled" | "Suspended",
  "ExcludeFolders": boolean,
  "ExcludedPrefixes": {"Prefix": string}[]
}

getBucketVersioning(bucketName: string): Promise<"" | VersioningStatus>;

Note that it currently returns an empty string when versioning has never been toggled on. It might be a good idea to return {Status: "Disabled"} instead.
@prakashsvmx
Copy link
Member

Yes. We will update it. Thank you for the feedback.

@prakashsvmx prakashsvmx mentioned this issue May 28, 2024
Merged
@SleepyLeslie
Copy link
Author
SleepyLeslie commented May 28, 2024 •
edited
Loading

Thanks @prakashsvmx for the fix. But the new typing still doesn't address the possible return value '' when versioning has never been enabled. Will that be fixed?

@SleepyLeslie SleepyLeslie mentioned this issue Jun 3, 2024
Merged
@fflorent fflorent mentioned this issue Jun 5, 2024
Open
@fflorent
Copy link
Contributor
fflorent commented Jun 5, 2024

Thanks @prakashsvmx for the fix. But the new typing still doesn't address the possible return value '' when versioning has never been enabled. Will that be fixed?

Opened #1303 to track your question.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

update types for bucket versioning prakashsvmx/minio-js
3 participants
@fflorent @prakashsvmx @SleepyLeslie
0