/nodejs-storage

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.

Primary LanguageTypeScriptApache License 2.0Apache-2.0

Google Cloud Platform logo

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.

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');

  // Creates a client
  const storage = new Storage();

  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  // const bucketName = 'bucket-name';

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

  createBucket();

Samples

Samples are in the samples/ directory. The samples' README.md has instructions for running the samples.

Sample Source Code Try it
Acl source code Open in Cloud Shell
Bucket Lock source code Open in Cloud Shell
Storage Get Bucket Metadata. source code Open in Cloud Shell
Buckets source code Open in Cloud Shell
Encryption source code Open in Cloud Shell
Storage Set File Metadata. source code Open in Cloud Shell
Files 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
Iam source code Open in Cloud Shell
Notifications source code Open in Cloud Shell
Quickstart source code Open in Cloud Shell
Requester Pays source code Open in Cloud Shell
Upload a directory to a bucket. source code Open in Cloud Shell

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

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.

License

Apache Version 2.0

See LICENSE