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.
yoshi-automation and JustinBeckwith chore: add synth.metadata
chore: add synth.metadata
Latest commit d854d89 Nov 19, 2018
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.circleci chore(build): update CI config Nov 2, 2018
.github chore: update issue templates (#488) Oct 25, 2018
.kokoro chore: use latest npm on Windows (#509) Nov 7, 2018
samples Release v2.3.1 (#516) Nov 15, 2018
src fix(ts): Update bucket options types (#518) Nov 19, 2018
system-test fix(ts): Update bucket options types (#518) Nov 19, 2018
test refactor: use object.assign where possible (#510) Nov 9, 2018
.clang-format refactor(ts): merge initial TypeScript conversion (#334) Aug 21, 2018
.cloud-repo-tools.json PubSub Notifications (#38) Oct 9, 2017
.eslintignore chore: update eslintignore config (#513) Nov 12, 2018
.eslintrc.yml Enable prefer-const in the eslint config (#404) Sep 20, 2018
.gitignore chore: ignore package-lock.json (#326) Aug 7, 2018
.jsdoc.js chore: update build config (#455) Oct 16, 2018
.nycrc Repository Migration (#15) Sep 21, 2017
.prettierignore Upgrade repo-tools and regenerate scaffolding. (#49) Oct 3, 2017
.prettierrc Repository Migration (#15) Sep 21, 2017
CHANGELOG.md Release v2.3.1 (#516) Nov 15, 2018
CODE_OF_CONDUCT.md Repository Migration (#15) Sep 21, 2017
LICENSE Upgrade repo-tools and regenerate scaffolding. (#49) Oct 3, 2017
README.md refactor(ts): merge initial TypeScript conversion (#334) Aug 21, 2018
codecov.yaml build: bring in latest kokoro cfgs to run System tests on PRs (#413) Oct 1, 2018
package.json Release v2.3.1 (#516) Nov 15, 2018
renovate.json chore: ignore package-lock.json (#326) Aug 7, 2018
synth.metadata chore: add synth.metadata Nov 19, 2018
synth.py fix(tests): fix system tests on CircleCI (#431) Oct 8, 2018
tsconfig.json chore(typescript): enable noImplicitAny (#483) Oct 24, 2018
tslint.json refactor(ts): merge initial TypeScript conversion (#334) Aug 21, 2018

README.md

Google Cloud Platform logo

Google Cloud Storage: Node.js Client

release level CircleCI AppVeyor 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.

    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 Open in Cloud Shell
Buckets source code Open in Cloud Shell
Encryption source code Open in Cloud Shell
Files source code Open in Cloud Shell
Notifications source code Open in Cloud Shell
Requester Pays source code Open in Cloud Shell

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