Google Cloud Storage: Node.js Client

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.

• Google Cloud Storage Node.js Client API Reference
• Google Cloud Storage Documentation
• github.com/googleapis/nodejs-storage

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
  • Installing the client library
  • Using the client library
• Samples
• Versioning
• Contributing
• License

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
Bucket Lock	source code
Buckets	source code
Encryption	source code
Files	source code
Iam	source code
Notifications	source code
Quickstart	source code
Requester Pays	source code

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