Class S3

constructor

• new S3(): S3

  Returns S3

client

copyObject

• copyObject(options: CopyObjectOptions): Promise<CopyObjectCommandOutput>

  Make a copy of an object of the bucket. In a versioned bucket, the output carries the version the copy created.

  Parameters

  • options: CopyObjectOptions

  Returns Promise<CopyObjectCommandOutput>

createDownloadURLFromData

• createDownloadURLFromData(
      data: string | Uint8Array<ArrayBufferLike>,
      options?: CreateDownloadURLFromDataOptions,
  ): Promise<SignedURL>

  Create a download link of a piece of data (through S3). Practically, it uploads the file on an S3 bucket, generating and returning a url to it. The data must be entirely in memory (a string or bytes): the upload is a single PutObject, which needs the content length up front, so streams aren't supported.

  Parameters

  • data: string | Uint8Array<ArrayBufferLike>
  • options: CreateDownloadURLFromDataOptions = {}

  Returns Promise<SignedURL>

deleteObject

• deleteObject(options: DeleteObjectOptions): Promise<PutObjectOutput>

  Delete an object from an S3 bucket.

  Parameters

  • options: DeleteObjectOptions

  Returns Promise<PutObjectOutput>

doesObjectExist

• doesObjectExist(options: HeadObjectOptions): Promise<boolean>

  Check whether an object exists in an S3 bucket.

  Parameters

  • options: HeadObjectOptions

  Returns Promise<boolean>

getObject

• getObject(options: GetObjectOptions): Promise<GetObjectCommandOutput>

  Get an object from a S3 bucket.

  Parameters

  • options: GetObjectOptions

  Returns Promise<GetObjectCommandOutput>

getObjectAsJSON

• getObjectAsJSON(options: GetObjectOptions): Promise<any>

  Get an object from a S3 bucket and parse the content as a JSON object.

  Parameters

  • options: GetObjectOptions

  Returns Promise<any>

getObjectAsText

• getObjectAsText(options: GetObjectOptions): Promise<string>

  Get an object from a S3 bucket and convert the content to string. If the object was stored with Content-Encoding: gzip, it is decompressed transparently.

  Parameters

  • options: GetObjectOptions

  Returns Promise<string>

headObject

• headObject(options: HeadObjectOptions): Promise<HeadObjectCommandOutput>

  Get the head of an object of an S3 bucket (its size, type and metadata, without the content). It fails when the object doesn't exist.

  Parameters

  • options: HeadObjectOptions

  Returns Promise<HeadObjectCommandOutput>

listObjects

• listObjects(options: ListObjectsOptions): Promise<ListObjectsOutput>

  List the objects of an S3 bucket.

  Parameters

  • options: ListObjectsOptions

  Returns Promise<ListObjectsOutput>

listObjectsKeys

• listObjectsKeys(options: ListObjectsOptions): Promise<string[]>

  List the objects keys of an S3 bucket.

  Parameters

  • options: ListObjectsOptions

  Returns Promise<string[]>

listObjectVersions

• listObjectVersions(options: ListObjectsOptions): Promise<ObjectVersions>

  List every version of the objects of a versioned S3 bucket (or of a prefix of it), and the delete markers left by the deletions: all of them, page after page.

  Parameters

  • options: ListObjectsOptions

  Returns Promise<ObjectVersions>

putObject

• putObject(options: PutObjectOptions): Promise<PutObjectOutput>

  Put an object in a S3 bucket.

  Parameters

  • options: PutObjectOptions

  Returns Promise<PutObjectOutput>

signedURLGet

• signedURLGet(
      bucket: string,
      key: string,
      options?: SignedURLGetOptions,
  ): Promise<SignedURL>

  Get a signed URL to get a file on a S3 bucket.

  Parameters

  • bucket: string
  • key: string
  • options: SignedURLGetOptions = {}

  Returns Promise<SignedURL>

signedURLPut

• signedURLPut(
      bucket: string,
      key: string,
      options?: SignedURLPutOptions,
  ): Promise<SignedURL>

  Get a signed URL to put a file on a S3 bucket.

  Parameters

  • bucket: string
  • key: string
  • options: SignedURLPutOptions = {}

  Returns Promise<SignedURL>