@jbuck/google-cloud-storage

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.

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

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.

   Go to the projects page

2. Enable billing for your project.

   Enable billing

3. Enable the Google Cloud Storage API.

   Enable the 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 --save @google-cloud/storage

Using the client library

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

// Your Google Cloud Platform project ID
const projectId = 'YOUR_PROJECT_ID';

// Creates a client
const storage = new Storage({
  projectId: projectId,
});

// The name for the new bucket
const bucketName = 'my-new-bucket';

// Creates the new bucket
storage
  .createBucket(bucketName)
  .then(() => {
    console.log(`Bucket ${bucketName} created.`);
  })
  .catch(err => {
    console.error('ERROR:', err);
  });

Samples

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

Sample	Source Code	Try it
ACL (Access Control Lists)	source code
Buckets	source code
Encryption	source code
Files	source code
Notifications	source code
Requester Pays	source code

The 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

Changelog

3.0.0 (2019-06-14)

⚠ BREAKING CHANGES

• upgrade engines field to >=8.10.0 (#688)

Bug Fixes

• deps: update dependency @google-cloud/common to v1 (#705) (72a9f51)
• deps: update dependency @google-cloud/paginator to v1 (#695) (ada995e)
• deps: update dependency @google-cloud/promisify to v1 (#693) (5df2f83)
• deps: update dependency @google-cloud/pubsub to ^0.29.0 (#714) (3ee1a2c)
• deps: update dependency arrify to v2 (#667) (ce02c27)
• validate action of getSignedUrl() function (#684) (1b09d24)
• deps: update dependency date-and-time to ^0.7.0 (#736) (7071f26)
• deps: update dependency xdg-basedir to v4 (#681) (8b40e6a)
• docs: move to new client docs URL (#738) (a637f99)
• ts: improve return types for response metadata (#666) (da42bed)
• types: fix signatures of listing methods (#703) (42937a8)

Build System

• upgrade engines field to >=8.10.0 (#688) (6a1fa0f)

Features

• add file.isPublic() function (#708) (f86cadb)
• support apiEndpoint override (#728) (61eeb64)