Class S3Store

constructor

• new S3Store(options?: S3StoreOptions): S3Store

  Parameters

  • options: S3StoreOptions = {}

  Returns S3Store

Readonlyname

Readonlylibrary

connect

• connect(): Promise<void>

  Returns Promise<void>

disconnect

• disconnect(): Promise<void>

  Returns Promise<void>

isConnected

• isConnected(): boolean

  Returns boolean

getClient

• getClient(): S3ClientLike

  Returns the underlying S3Client (loosely typed) for anything not wrapped here.

  Returns S3ClientLike

putObject

• putObject(
      bucket: string,
      key: string,
      body: unknown,
      options?: PutObjectOptions,
  ): Promise<PutObjectResult>

  PutObject — store an object's body (and optional metadata) under bucket/key.

  Parameters

  • bucket: string
  • key: string
  • body: unknown
  • options: PutObjectOptions = {}

  Returns Promise<PutObjectResult>

getObject

• getObject(bucket: string, key: string): Promise<GetObjectResult>

  GetObject — fetch an object's body and metadata.

  Parameters

  • bucket: string
  • key: string

  Returns Promise<GetObjectResult>

deleteObject

• deleteObject(bucket: string, key: string): Promise<void>

  DeleteObject — remove an object. Succeeds even if the key doesn't exist.

  Parameters

  • bucket: string
  • key: string

  Returns Promise<void>

listObjects

• listObjects(bucket: string, prefix?: string): Promise<ListObjectsResult>

  ListObjectsV2 — list objects in bucket, optionally restricted to those whose key starts with prefix. A single call returns at most 1000 objects; use result.nextContinuationToken (via the raw client) to page beyond that.

  Parameters

  • bucket: string
  • Optionalprefix: string

  Returns Promise<ListObjectsResult>

headObject

• headObject(bucket: string, key: string): Promise<HeadObjectResult>

  HeadObject — fetch an object's metadata without its body. Throws (NotFound) if the object doesn't exist.

  Parameters

  • bucket: string
  • key: string

  Returns Promise<HeadObjectResult>

objectExists

• objectExists(bucket: string, key: string): Promise<boolean>

  Whether an object exists, implemented via HeadObject. Returns false when S3 reports the object is missing (a NotFound / 404 error) rather than throwing; any other error (e.g. access denied) is re-thrown.

  Parameters

  • bucket: string
  • key: string

  Returns Promise<boolean>

copyObject

• copyObject(
      srcBucket: string,
      srcKey: string,
      destBucket: string,
      destKey: string,
  ): Promise<CopyObjectResult>

  CopyObject — server-side copy from srcBucket/srcKey to destBucket/destKey.

  Parameters

  • srcBucket: string
  • srcKey: string
  • destBucket: string
  • destKey: string

  Returns Promise<CopyObjectResult>