Class GCSStore

constructor

• new GCSStore(options?: GCSStoreOptions): GCSStore

  Parameters

  • options: GCSStoreOptions = {}

  Returns GCSStore

Readonlyname

Readonlylibrary

connect

• connect(): Promise<void>

  Returns Promise<void>

disconnect

• disconnect(): Promise<void>

  Returns Promise<void>

isConnected

• isConnected(): boolean

  Returns boolean

getClient

• getClient(): unknown

  Returns the underlying @google-cloud/storage Storage client for anything not wrapped here.

  Returns unknown

uploadObject

• uploadObject(
      bucket: string,
      key: string,
      data: string | Buffer<ArrayBufferLike>,
      options?: UploadObjectOptions,
  ): Promise<void>

  Upload (or overwrite) an object. data may be a Buffer or string; options is passed straight through to file.save() (e.g. { contentType, metadata, resumable }).

  Parameters

  • bucket: string
  • key: string
  • data: string | Buffer<ArrayBufferLike>
  • options: UploadObjectOptions = {}

  Returns Promise<void>

downloadObject

• downloadObject(bucket: string, key: string): Promise<Buffer<ArrayBufferLike>>

  Download an object's contents as a Buffer. Throws if the object does not exist.

  Parameters

  • bucket: string
  • key: string

  Returns Promise<Buffer<ArrayBufferLike>>

deleteObject

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

  Delete an object. Throws if the object does not exist.

  Parameters

  • bucket: string
  • key: string

  Returns Promise<void>

objectExists

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

  Returns whether an object exists.

  Parameters

  • bucket: string
  • key: string

  Returns Promise<boolean>

listObjects

• listObjects(bucket: string, prefix?: string): Promise<any[]>

  List objects in a bucket, optionally restricted to those whose name starts with prefix. Returns the raw File objects from the driver.

  Parameters

  • bucket: string
  • Optionalprefix: string

  Returns Promise<any[]>

getMetadata

• getMetadata(bucket: string, key: string): Promise<Record<string, unknown>>

  Fetch an object's metadata (size, contentType, updated, custom metadata, etc).

  Parameters

  • bucket: string
  • key: string

  Returns Promise<Record<string, unknown>>