S3 Object Read
@mgreten/s3-object-readv2026.10.14.1
01README
Least-privilege, bounded reads from S3-compatible object storage.
02Behaviors
@mgreten/s3-object-readv2026.08.23.1s3_object_read.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| accessKeyId? | string | |
| secretAccessKey? | string | |
| endpoint | url | |
| region? | string | |
| bucket | string | |
| prefix? | string | |
| forcePathStyle? | boolean | |
| maximumListObjects? | number | |
| maximumObjectBytes? | number |
fn verifyReadAccess()
HEAD the bucket, list one prefix-scoped object, and range-read one byte when nonempty
fn listObjects(maximum?: number)
Persist a bounded, prefix-scoped listing of object metadata; never object contents
| Argument | Type | Description |
|---|---|---|
| maximum? | number |
fn downloadObject(key: string)
Download one explicitly named, prefix-scoped object as a bounded artifact; contents may be sensitive
| Argument | Type | Description |
|---|---|---|
| key | string |
Resources
verification(30d)— Read-access verification metadata
objectListing(30d)— Bounded object metadata listing; object names may be sensitive
downloadMetadata(30d)— Downloaded object metadata; object names may be sensitive
Files
object(application/octet-stream)— Bounded downloaded object; content may be sensitive
03Previous Versions
2026.08.23.1
04Stats
A
100 / 100
Downloads
28
Archive size
209.5 KB
- Has README or module doc2/2earned
- README has a code example1/1earned
- README is substantive1/1earned
- Most symbols documented1/1earned
- No slow types (deprecated)1/1earned
- Dependencies pass trust audit2/2earned
- Has description1/1earned
- Platform support declared (or universal)2/2earned
- License2/2earned
- Verified public repository2/2earned
05Platforms