UNPKG

2.37 kBJavaScriptView Raw
1// Copyright 2019 Google LLC
2//
3// Licensed under the Apache License, Version 2.0 (the "License");
4// you may not use this file except in compliance with the License.
5// You may obtain a copy of the License at
6//
7// http://www.apache.org/licenses/LICENSE-2.0
8//
9// Unless required by applicable law or agreed to in writing, software
10// distributed under the License is distributed on an "AS IS" BASIS,
11// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12// See the License for the specific language governing permissions and
13// limitations under the License.
14/**
15 * The `@google-cloud/storage` package has a single named export which is the
16 * {@link Storage} (ES6) class, which should be instantiated with `new`.
17 *
18 * See {@link Storage} and {@link ClientConfig} for client methods and
19 * configuration options.
20 *
21 * @module {Storage} @google-cloud/storage
22 * @alias nodejs-storage
23 *
24 * @example
25 * Install the client library with <a href="https://www.npmjs.com/">npm</a>:
26 * ```
27 * npm install --save @google-cloud/storage
28 * ```
29 *
30 * @example
31 * Import the client library
32 * ```
33 * const {Storage} = require('@google-cloud/storage');
34 * ```
35 *
36 * @example
37 * Create a client that uses <a
38 * href="https://cloud.google.com/docs/authentication/production#providing_credentials_to_your_application">Application
39 * Default Credentials (ADC)</a>:
40 * ```
41 * const storage = new Storage();
42 * ```
43 *
44 * @example
45 * Create a client with <a
46 * href="https://cloud.google.com/docs/authentication/production#obtaining_and_providing_service_account_credentials_manually">explicit
47 * credentials</a>:
48 * ```
49 * const storage = new Storage({ projectId:
50 * 'your-project-id', keyFilename: '/path/to/keyfile.json'
51 * });
52 * ```
53 *
54 * @example <caption>include:samples/quickstart.js</caption>
55 * region_tag:storage_quickstart
56 * Full quickstart example:
57 */
58export { ApiError } from './nodejs-common/index.js';
59export { IdempotencyStrategy, RETRYABLE_ERR_FN_DEFAULT, Storage, } from './storage.js';
60export { Bucket, } from './bucket.js';
61export * from './crc32c.js';
62export { Channel } from './channel.js';
63export { File, } from './file.js';
64export * from './hash-stream-validator.js';
65export { HmacKey, } from './hmacKey.js';
66export { Iam, } from './iam.js';
67export { Notification, } from './notification.js';
68export * from './transfer-manager.js';