Skip to content

docs(s3-utils): add comprehensive README with API reference#1032

Merged
pyramation merged 1 commit intomainfrom
devin/1777351297-s3-utils-readme
Apr 28, 2026
Merged

docs(s3-utils): add comprehensive README with API reference#1032
pyramation merged 1 commit intomainfrom
devin/1777351297-s3-utils-readme

Conversation

@pyramation
Copy link
Copy Markdown
Contributor

Summary

Adds full documentation to the @constructive-io/s3-utils README covering:

  • Package overview and feature list
  • Installation and quick-start example
  • Complete API reference for all exported functions: createS3Client, presignPutUrl, presignGetUrl, headObject, fileExists, upload, download, uploadThrough, createS3Bucket
  • StorageConnectionConfig options table with provider-specific behavior notes
  • Related packages table linking sibling uploads/ packages

Review & Testing Checklist for Human

  • Verify API signatures in the README match the actual source code
  • Confirm the related packages table links are correct

Notes

Documentation-only change — no code modifications.

Link to Devin session: https://app.devin.ai/sessions/c4e9279cd58d4ea0ab8c4c3d32ed00d7
Requested by: @pyramation

@devin-ai-integration
Copy link
Copy Markdown
Contributor

🤖 Devin AI Engineer

I'll be helping with this pull request! Here's what you should know:

✅ I will automatically:

  • Address comments on this PR. Add '(aside)' to your comment to have me ignore it.
  • Look at CI failures and help fix them

Note: I can only respond to comments from users who have write access to this repository.

⚙️ Control Options:

  • Disable automatic comment and CI monitoring

@pyramation pyramation merged commit 662e599 into main Apr 28, 2026
52 checks passed
@pyramation pyramation deleted the devin/1777351297-s3-utils-readme branch April 28, 2026 07:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant