Class S3FileSystem

constructor

• new S3FileSystem(options: S3DriverOptions): S3FileSystem

  Parameters

  • options: S3DriverOptions

    The S3 disk options.

  Returns S3FileSystem

Readonlyname

copy

• copy(source: string, destination: string): Promise<void>

  Parameters

  • source: string
  • destination: string

  Returns Promise<void>

  Inherit Doc

delete

• delete(path: string): Promise<boolean>

  Parameters

  • path: string

  Returns Promise<boolean>

  Inherit Doc

exists

• exists(path: string): Promise<boolean>

  Parameters

  • path: string

  Returns Promise<boolean>

  Inherit Doc

files

• files(directory?: string, recursive?: boolean): Promise<string[]>

  Parameters

  • directory: string = ''
  • recursive: boolean = true

  Returns Promise<string[]>

  Inherit Doc

get

• get(path: string): Promise<Buffer<ArrayBufferLike>>

  Parameters

  • path: string

  Returns Promise<Buffer<ArrayBufferLike>>

  Inherit Doc

getText

• getText(path: string, encoding?: BufferEncoding): Promise<string>

  Parameters

  • path: string
  • encoding: BufferEncoding = 'utf-8'

  Returns Promise<string>

  Inherit Doc

lastModified

• lastModified(path: string): Promise<number>

  Parameters

  • path: string

  Returns Promise<number>

  Inherit Doc

makeDirectory

• makeDirectory(_path: string): Promise<void>

  No-op for object stores: prefixes are implicit and created on write. Present to satisfy the FileSystem contract.

  Parameters

  • _path: string

  Returns Promise<void>

mimeType

• mimeType(path: string): Promise<string>

  Parameters

  • path: string

  Returns Promise<string>

  Inherit Doc

move

• move(source: string, destination: string): Promise<void>

  Parameters

  • source: string
  • destination: string

  Returns Promise<void>

  Inherit Doc

put

• put(path: string, content: string | Buffer<ArrayBufferLike>): Promise<void>

  Parameters

  • path: string
  • content: string | Buffer<ArrayBufferLike>

  Returns Promise<void>

  Inherit Doc

readStream

• readStream(path: string): Promise<Readable>

  Parameters

  • path: string

  Returns Promise<Readable>

  Inherit Doc

size

• size(path: string): Promise<number>

  Parameters

  • path: string

  Returns Promise<number>

  Inherit Doc

stat

• stat(path: string): Promise<StorageStat>

  Parameters

  • path: string

  Returns Promise<StorageStat>

  Inherit Doc

temporaryUploadUrl

• temporaryUploadUrl(
      path: string,
      options?: TemporaryUploadUrlOptions,
  ): Promise<SignedUpload>

  Mint a short-lived signed target to upload to path (direct-to-storage PUT).

  Parameters

  • path: string

    The destination object path.

  • options: TemporaryUploadUrlOptions = {}

    Expiry and the content type to bind into the signature.

  Returns Promise<SignedUpload>

  The signed upload target.

temporaryUrl

• temporaryUrl(path: string, options?: TemporaryUrlOptions): Promise<string>

  Mint a short-lived signed URL to download path.

  Parameters

  • path: string

    The object path.

  • options: TemporaryUrlOptions = {}

    Expiry and response-header overrides.

  Returns Promise<string>

  The signed download URL.

url

• url(path: string): Promise<string>

  Parameters

  • path: string

  Returns Promise<string>

  Inherit Doc

writeStream

• writeStream(path: string, stream: Readable): Promise<void>

  Parameters

  • path: string
  • stream: Readable

  Returns Promise<void>

  Inherit Doc

Staticcreate

• create(options: S3DriverOptions): S3FileSystem

  Create an S3 driver.

  Parameters

  • options: S3DriverOptions

    The S3 disk options.

  Returns S3FileSystem

  A new driver.