Skip to content
Files SDK
Esc
navigateopen⌘Jpreview
On this page

Google Cloud Storage

Google Cloud Storage via the official @google-cloud/storage SDK. Application Default Credentials by default, resumable uploads when onProgress is passed.

Installation

@google-cloud/storage is an optional peer dependency of files-sdk - install alongside the SDK so the adapter’s imports resolve at runtime.

npm install files-sdk @google-cloud/storage
pnpm add files-sdk @google-cloud/storage
yarn add files-sdk @google-cloud/storage
bun add files-sdk @google-cloud/storage

Usage

import { Files } from "files-sdk";
import { gcs } from "files-sdk/gcs";

const files = new Files({
  adapter: gcs({
    bucket: "uploads",
    // No credentials needed in most setups - the @google-cloud/storage
    // SDK auto-discovers Application Default Credentials from
    // GOOGLE_APPLICATION_CREDENTIALS, gcloud auth, or the runtime
    // service account on Cloud Run / GKE / GCE.
  }),
});

upload reports true byte-level progress via onProgress. Uploads default to a single simple request; when onProgress is passed, the adapter switches to a resumable upload (the only path that emits progress), which adds one round trip.

Options

Could not generate a type table for GCSAdapterOptions: Cannot read properties of undefined (reading 'ESNext')

Compatibility

Method Status Notes
upload
download
delete
list
search
head
exists
copy
url
signedUploadUrl

Was this page helpful?