Google Cloud Storage: Node.js Client

release level npm version codecov

Node.js idiomatic client for Cloud Storage.

Cloud Storage allows world-wide storage and retrieval of any amount of data at any time. You can use Google Cloud Storage for a range of scenarios including serving website content, storing data for archival and disaster recovery, or distributing large data objects to users via direct download.

A comprehensive list of changes in each version may be found in the CHANGELOG.

Read more about the client libraries for Cloud APIs, including the older Google APIs Client Libraries, in Client Libraries Explained.

Table of contents:

Quickstart

Before you begin

  1. Select or create a Cloud Platform project.
  2. Enable billing for your project.
  3. Enable the Google Cloud Storage API.
  4. Set up authentication with a service account so you can access the API from your local workstation.

Installing the client library

npm install @google-cloud/storage

Using the client library

// Imports the Google Cloud client library
const {Storage} = require('@google-cloud/storage');

// For more information on ways to initialize Storage, please see
// https://googleapis.dev/nodejs/storage/latest/Storage.html

// Creates a client using Application Default Credentials
const storage = new Storage();

// Creates a client from a Google service account key
// const storage = new Storage({keyFilename: 'key.json'});

/**
 * TODO(developer): Uncomment these variables before running the sample.
 */
// The ID of your GCS bucket
// const bucketName = 'your-unique-bucket-name';

async function createBucket() {
  // Creates the new bucket
  await storage.createBucket(bucketName);
  console.log(`Bucket ${bucketName} created.`);
}

createBucket().catch(console.error);

Samples

Samples are in the samples/ directory. Each sample's README.md has instructions for running its sample.

Sample Source Code Try it
Add Bucket Conditional Binding source code Open in Cloud Shell
Add Bucket Default Owner Acl source code Open in Cloud Shell
Add Bucket Iam Member source code Open in Cloud Shell
Storage Add Bucket Label. source code Open in Cloud Shell
Add Bucket Owner Acl source code Open in Cloud Shell
Bucket Website Configuration. source code Open in Cloud Shell
Add File Owner Acl source code Open in Cloud Shell
Storage Get Bucket Metadata. source code Open in Cloud Shell
Change Bucket's Default Storage Class. source code Open in Cloud Shell
Storage File Convert CSEK to CMEK. source code Open in Cloud Shell
Storage Combine files. source code Open in Cloud Shell
Storage Configure Bucket Cors. source code Open in Cloud Shell
Copy File source code Open in Cloud Shell
Copy Old Version Of File. source code Open in Cloud Shell
Create Bucket With Storage Class and Location. source code Open in Cloud Shell
Create New Bucket source code Open in Cloud Shell
Create Notification source code Open in Cloud Shell
Delete Bucket source code Open in Cloud Shell
Delete File source code Open in Cloud Shell
Delete Notification source code Open in Cloud Shell
Delete Old Version Of File. source code Open in Cloud Shell
Disable Bucket Lifecycle Management source code Open in Cloud Shell
Storage Disable Bucket Versioning. source code Open in Cloud Shell
Disable Default Event Based Hold source code Open in Cloud Shell
Disable Requester Pays source code Open in Cloud Shell
Disable Uniform Bucket Level Access source code Open in Cloud Shell
Download Encrypted File source code Open in Cloud Shell
Download File source code Open in Cloud Shell
Download File Using Requester Pays source code Open in Cloud Shell
Storage Download Public File. source code Open in Cloud Shell
Enable Bucket Lifecycle Management source code Open in Cloud Shell
Storage Enable Bucket Versioning. source code Open in Cloud Shell
Enable Default Event Based Hold source code Open in Cloud Shell
Enable Default KMS Key source code Open in Cloud Shell
Enable Requester Pays source code Open in Cloud Shell
Enable Uniform Bucket Level Access source code Open in Cloud Shell
Change File's Storage Class. source code Open in Cloud Shell
Storage Set File Metadata. source code Open in Cloud Shell
Generate Encryption Key source code Open in Cloud Shell
Generate Signed Url source code Open in Cloud Shell
Generate V4 Read Signed Url source code Open in Cloud Shell
Generate V4 Signed Policy source code Open in Cloud Shell
Generate V4 Upload Signed Url source code Open in Cloud Shell
Get Default Event Based Hold source code Open in Cloud Shell
Get Metadata source code