Skip to content
master
Switch branches/tags
Code

Latest commit

gcr.io/repo-automation-bots/owlbot-nodejs:latest@sha256:b94b09fb24bf804090b8cc60ee726ca161d5e5915151e417f8ef5d8bcfe73cbc
db6f6d8

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
 
 
bin
 
 
 
 
src
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Google Cloud Platform logo

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 Open in Cloud Shell
Get Metadata Notifications source code Open in Cloud Shell
Get Requester Pays Status source code Open in Cloud Shell
Get Retention Policy source code Open in Cloud Shell
Storage Get Service Account. source code Open in Cloud Shell
Get Uniform Bucket Level Access source code Open in Cloud Shell
Activate HMAC SA Key. source code Open in Cloud Shell
Create HMAC SA Key. source code Open in Cloud Shell
Deactivate HMAC SA Key. source code Open in Cloud Shell
Delete HMAC SA Key. source code Open in Cloud Shell
Get HMAC SA Key Metadata. source code Open in Cloud Shell
List HMAC SA Keys Metadata. source code Open in Cloud Shell
List Buckets source code Open in Cloud Shell
List Files source code Open in Cloud Shell
List Files By Prefix source code Open in Cloud Shell
List Files Paginate source code Open in Cloud Shell
List Files with Old Versions. source code Open in Cloud Shell
List Notifications source code Open in Cloud Shell
Lock Retention Policy source code Open in Cloud Shell
Storage Make Bucket Public. source code Open in Cloud Shell
Make Public source code Open in Cloud Shell
Move File source code Open in Cloud Shell
Print Bucket Acl source code Open in Cloud Shell
Print Bucket Acl For User source code Open in Cloud Shell
Print File Acl source code Open in Cloud Shell
Print File Acl For User source code Open in Cloud Shell
Quickstart source code Open in Cloud Shell
Release Event Based Hold source code Open in Cloud Shell
Release Temporary Hold source code Open in Cloud Shell
Remove Bucket Conditional Binding source code Open in Cloud Shell
Storage Remove Bucket Cors Configuration. source code Open in Cloud Shell
Remove Bucket Default Owner source code Open in Cloud Shell
Remove Bucket Iam Member source code Open in Cloud Shell
Storage Remove Bucket Label. source code Open in Cloud Shell
Remove Bucket Owner Acl source code Open in Cloud Shell
Remove Default KMS Key. source code Open in Cloud Shell
Remove File Owner Acl source code Open in Cloud Shell
Remove Retention Policy source code Open in Cloud Shell
Rename File source code Open in Cloud Shell
Rotate Encryption Key source code Open in Cloud Shell
Set Event Based Hold source code Open in Cloud Shell
Set Retention Policy source code Open in Cloud Shell
Set Temporary Hold source code Open in Cloud Shell
Upload a directory to a bucket. source code Open in Cloud Shell
Upload Encrypted File source code Open in Cloud Shell
Upload File source code Open in Cloud Shell
Upload File With Kms Key source code Open in Cloud Shell
View Bucket Iam Members source code Open in Cloud Shell

The Google Cloud Storage Node.js Client API Reference documentation also contains samples.

Supported Node.js Versions

Our client libraries follow the Node.js release schedule. Libraries are compatible with all current active and maintenance versions of Node.js.

Client libraries targeting some end-of-life versions of Node.js are available, and can be installed via npm dist-tags. The dist-tags follow the naming convention legacy-(version).

Legacy Node.js versions are supported as a best effort:

  • Legacy versions will not be tested in continuous integration.
  • Some security patches may not be able to be backported.
  • Dependencies will not be kept up-to-date, and features will not be backported.

Legacy tags available

  • legacy-8: install client libraries from this dist-tag for versions compatible with Node.js 8.

Versioning

This library follows Semantic Versioning.

This library is considered to be General Availability (GA). This means it is stable; the code surface will not change in backwards-incompatible ways unless absolutely necessary (e.g. because of critical security issues) or with an extensive deprecation period. Issues and requests against GA libraries are addressed with the highest priority.

More Information: Google Cloud Platform Launch Stages

Contributing

Contributions welcome! See the Contributing Guide.

Please note that this README.md, the samples/README.md, and a variety of configuration files in this repository (including .nycrc and tsconfig.json) are generated from a central template. To edit one of these files, make an edit to its template in this directory.

License

Apache Version 2.0

See LICENSE

About

Node.js client for Google Cloud Storage: unified object storage for developers and enterprises, from live data serving to data analytics/ML to data archiving.

Topics

Resources

License

Packages

No packages published

Languages