+ First, install gcloud with npm and require it into your project:
+
+
$ npm install --save gcloud
+
var gcloud = require('gcloud');
+
+
+
+ The gcloud.datastore object gives you some convenience methods, as well as exposes a Dataset function. This will allow you to create a Dataset, which is the object from which you will interact with the Google Cloud Datastore.
+
+
+var datastore = gcloud.datastore;
+var dataset = new datastore.Dataset();
+
+ See the Dataset documentation for examples of how to query the datastore, save entities, run a transaction, and others.
+
+
+
+
+
+ The gcloud.storage object contains a Bucket object, which is how you will interact with your Google Cloud Storage bucket.
+
// The following call will create 100 new IDs from the Company kind, which
-// exists under the default namespace.
-var incompleteKey = datastore.key('Company', null);
-dataset.allocateIds(incompleteKey, 100, function(err, keys) {});
-
-// You may prefer to create IDs from a non-default namespace by providing an
-// incomplete key with a namespace. Similar to the previous example, the call
-// below will create 100 new IDs, but from the Company kind that exists under
-// the "ns-test" namespace.
-var incompleteKey = datastore.key('ns-test', 'Company', null);
-dataset.allocateIds(incompleteKey, 100, function(err, keys) {});
// Delete a single entity.
-dataset.delete(datastore.key('Company', 123), function(err) {});
-
-// Delete multiple entities at once.
-dataset.delete([
- datastore.key('Company', 123),
- datastore.key('Product', 'Computer')
-], function(err) {});
-
-
-
-
-
-
-
-
get(key, callback)
-
-
-
-
-
-
-
-
Retrieve the entities identified with the specified key(s) in the current
-transaction. Get operations require a valid key to retrieve the
-key-identified entity from Datastore.
var key;
-
-// Create a key from the dataset's namespace.
-key = dataset.key('Company', 123);
-
-// Create a key from a provided namespace and path.
-key = dataset.key({
- namespace: 'My-NS',
- path: ['Company', 123]
-});
-
-
-
-
-
-
-
-
runInTransaction(fn, callback)
-
-
-
-
-
-
-
-
Run a function in the context of a new transaction. Transactions allow you to
-perform multiple operations, committing your changes atomically.
-
-
-
-
-
-
-
-
-
Parameters:
-
-
-
-
-
-
-
Name
-
-
-
Type
-
-
-
-
-
-
Description
-
-
-
-
-
-
-
-
-
fn
-
-
-
-
-
-function
-
-
-
-
-
-
-
-
-
-
The function to run in the context of a transaction.
dataset.transaction(function(transaction, done) {
- // From the `transaction` object, execute dataset methods as usual.
- // Call `done` when you're ready to commit all of the changes.
- transaction.get(datastore.key('Company', 123), function(err, entity) {
- if (err) {
- transaction.rollback(done);
- return;
- }
-
- done();
- });
-}, function(err) {});
-
-
-
-
-
-
-
-
runQuery(query, callback)
-
-
-
-
-
-
-
-
Datastore allows you to query entities by kind, filter them by property
-filters, and sort them by a property name. Projection and pagination are also
-supported. If more results are available, a query to retrieve the next page
-is provided to the callback function.
// Retrieve 5 companies.
-dataset.runQuery(queryObject, function(err, entities, nextQuery) {
- // `nextQuery` is not null if there are more results.
- if (nextQuery) {
- dataset.runQuery(nextQuery, function(err, entities, nextQuery) {});
- }
-});
-
-
-
-
-
-
-
-
save(entities, callback)
-
-
-
-
-
-
-
-
Insert or update the specified object(s) in the current transaction. If a
-key is incomplete, its associated object is inserted and its generated
-identifier is returned to the callback.
Google Cloud Datastore is a
-fully managed, schemaless database for storing non-relational data. Use this
-object to create a Dataset to interact with your data, an "Int", and a
-"Double" representation.
Google Cloud Pub/Sub
-is a reliable, many-to-many, asynchronous messaging service from Google Cloud
-Platform.
-
Note: Google Cloud Pub/Sub API is available as a Limited Preview and the
-client library we provide is currently experimental. The API and/or the
-client might be changed in backward-incompatible ways. This API is not
-subject to any SLA or deprecation policy. Request to be whitelisted to use it
-by filling the
-Limited Preview application form.
/**
- * Copyright 2014 Google Inc. All Rights Reserved.
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-/**
- * @module datastore
- */
-
-'use strict';
-
-/**
- * @private
- * @type module:datastore/entity
- */
-var entity = require('./entity');
-
-/** @alias module:datastore */
-var datastore = {};
-
-/**
- * @see {module:datastore/dataset}
- *
- * @example
- * var gcloud = require('gcloud');
- * var datastore = gcloud.datastore;
- *
- * // Create a Dataset object.
- * var dataset = new datastore.Dataset();
- */
-datastore.Dataset = require('./dataset');
-
-/**
- * Helper function to get a Datastore Integer object.
- *
- * @example
- * var gcloud = require('gcloud');
- *
- * // Create an Integer.
- * var sevenInteger = gcloud.datastore.int(7);
- */
-datastore.int = function(value) {
- return new entity.Int(value);
-};
-
-/**
- * Helper function to get a Datastore Double object.
- *
- * @example
- * var gcloud = require('gcloud');
- *
- * // Create a Double.
- * var threeDouble = gcloud.datastore.double(3.0);
- */
-datastore.double = function(value) {
- return new entity.Double(value);
-};
-
-module.exports = datastore;
-
/**
- * Copyright 2014 Google Inc. All Rights Reserved.
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-/**
- * @module gcloud
- */
-
-'use strict';
-
-/** @alias module:gcloud */
-var gcloud = {};
-
-/**
- * [Google Cloud Datastore]{@link https://developers.google.com/datastore/} is a
- * fully managed, schemaless database for storing non-relational data. Use this
- * object to create a Dataset to interact with your data, an "Int", and a
- * "Double" representation.
- *
- * @type {module:datastore}
- * @see {module:datastore}
- *
- * @return {object}
- *
- * @example
- * var gcloud = require('gcloud');
- * var datastore = gcloud.datastore;
- *
- * // datastore:
- * // {
- * // Dataset: function() {},
- * // double: function() {},
- * // int: function() {}
- * // }
- */
-gcloud.datastore = require('./datastore');
-
-/**
- * **Experimental**
- *
- * [Google Cloud Pub/Sub]{@link https://developers.google.com/pubsub/overview}
- * is a reliable, many-to-many, asynchronous messaging service from Google Cloud
- * Platform.
- *
- * Note: Google Cloud Pub/Sub API is available as a Limited Preview and the
- * client library we provide is currently experimental. The API and/or the
- * client might be changed in backward-incompatible ways. This API is not
- * subject to any SLA or deprecation policy. Request to be whitelisted to use it
- * by filling the
- * [Limited Preview application form]{@link http://goo.gl/sO0wTu}.
- *
- * @type {module:pubsub}
- *
- * @return {object}
- *
- * @example
- * var gcloud = require('gcloud');
- * var pubsub = gcloud.pubsub;
- *
- * var conn = new pubsub.Connection({
- * projectId: YOUR_PROJECT_ID,
- * keyFilename: '/path/to/the/key.json'
- * });
- */
-gcloud.pubsub = require('./pubsub');
-
-/**
- * Google Cloud Storage allows you to store data on Google infrastructure. Read
- * [Google Cloud Storage API docs]{@link https://developers.google.com/storage/}
- * for more information.
- *
- * You need to create a Google Cloud Storage bucket to use this client library.
- * Follow the steps on
- * [Google Cloud Storage docs]{@link https://developers.google.com/storage/} to
- * create a bucket.
-
- * @type {module:storage}
- * @see {module:storage}
- *
- * @return {object}
- *
- * @example
- * var gcloud = require('gcloud');
- * var storage = gcloud.storage;
- *
- * // storage:
- * // {
- * // Bucket: function() {}
- * // }
- */
-gcloud.storage = require('./storage');
-
-module.exports = gcloud;
-
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0\n
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
",
+ "summary": "
Copyright 2014 Google Inc. All Rights Reserved.
",
+ "body": "
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0\n
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
Retrieve the entities identified with the specified key(s) in the current transaction. Get operations require a valid key to retrieve the key-identified entity from Datastore.
",
+ "summary": "
Retrieve the entities identified with the specified key(s) in the current transaction. Get operations require a valid key to retrieve the key-identified entity from Datastore.
Insert or update the specified object(s) in the current transaction. If a key is incomplete, its associated object is inserted and its generated identifier is returned to the callback.
",
+ "summary": "
Insert or update the specified object(s) in the current transaction. If a key is incomplete, its associated object is inserted and its generated identifier is returned to the callback.
Datastore allows you to query entities by kind, filter them by property filters, and sort them by a property name. Projection and pagination are also supported. If more results are available, a query to retrieve the next page is provided to the callback function.
",
+ "summary": "
Datastore allows you to query entities by kind, filter them by property filters, and sort them by a property name. Projection and pagination are also supported. If more results are available, a query to retrieve the next page is provided to the callback function.
",
+ "body": ""
+ },
+ "isPrivate": false,
+ "ignore": false,
+ "code": "Dataset.prototype.runQuery = function(q, callback) {\n this.transaction.runQuery(q, callback);\n};",
+ "ctx": {
+ "type": "method",
+ "constructor": "Dataset",
+ "cons": "Dataset",
+ "name": "runQuery",
+ "string": "Dataset.prototype.runQuery()"
+ }
+ },
+ {
+ "tags": [
+ {
+ "type": "borrows",
+ "otherMemberName": "{module:datastore/transaction#begin}",
+ "thisMemberName": "runInTransaction "
+ },
+ {
+ "type": "param",
+ "types": [
+ "function"
+ ],
+ "name": "fn",
+ "description": "- The function to run in the context of a transaction."
+ },
+ {
+ "type": "param",
+ "types": [
+ "function"
+ ],
+ "name": "callback",
+ "description": "- The callback function. "
+ },
+ {
+ "type": "example",
+ "string": "dataset.runInTransaction(function(transaction, done) {\n // From the `transaction` object, execute dataset methods as usual.\n // Call `done` when you're ready to commit all of the changes.\n transaction.get(dataset.key('Company', 123), function(err, entity) {\n if (err) {\n transaction.rollback(done);\n return;\n }\n\n done();\n });\n}, function(err) {});"
+ }
+ ],
+ "description": {
+ "full": "
Run a function in the context of a new transaction. Transactions allow you to perform multiple operations, committing your changes atomically.
",
+ "summary": "
Run a function in the context of a new transaction. Transactions allow you to perform multiple operations, committing your changes atomically.
",
+ "body": ""
+ },
+ "isPrivate": false,
+ "ignore": false,
+ "code": "Dataset.prototype.runInTransaction = function(fn, callback) {\n var newTransaction = this.createTransaction_();\n newTransaction.begin(function(err) {\n if (err) {\n callback(err);\n return;\n }\n fn(newTransaction, newTransaction.finalize.bind(newTransaction, callback));\n });\n};",
+ "ctx": {
+ "type": "method",
+ "constructor": "Dataset",
+ "cons": "Dataset",
+ "name": "runInTransaction",
+ "string": "Dataset.prototype.runInTransaction()"
+ }
+ },
+ {
+ "tags": [
+ {
+ "type": "param",
+ "types": [
+ "Key"
+ ],
+ "name": "incompleteKey",
+ "description": "- The key object to complete."
+ },
+ {
+ "type": "param",
+ "types": [
+ "number"
+ ],
+ "name": "n",
+ "description": "- How many IDs to generate."
+ },
+ {
+ "type": "param",
+ "types": [
+ "function"
+ ],
+ "name": "callback",
+ "description": "- The callback function. "
+ },
+ {
+ "type": "example",
+ "string": "// The following call will create 100 new IDs from the Company kind, which\n// exists under the default namespace.\nvar incompleteKey = dataset.key('Company', null);\ndataset.allocateIds(incompleteKey, 100, function(err, keys) {});\n\n// You may prefer to create IDs from a non-default namespace by providing an\n// incomplete key with a namespace. Similar to the previous example, the call\n// below will create 100 new IDs, but from the Company kind that exists under\n// the \"ns-test\" namespace.\nvar incompleteKey = dataset.key('ns-test', 'Company', null);\ndataset.allocateIds(incompleteKey, 100, function(err, keys) {});"
+ }
+ ],
+ "description": {
+ "full": "
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0\n
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
",
+ "summary": "
Copyright 2014 Google Inc. All Rights Reserved.
",
+ "body": "
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0\n
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0\n
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
",
+ "summary": "
Copyright 2014 Google Inc. All Rights Reserved.
",
+ "body": "
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0\n
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
Datastore allows querying on properties. Supported comparison operators are =, <, >, <=, and >=. "Not equal" and IN operators are currently not supported.
To filter by ancestors, see {@linkcode module:datastore/query#hasAncestor}.
Datastore allows querying on properties. Supported comparison operators are =, <, >, <=, and >=. "Not equal" and IN operators are currently not supported.
",
+ "body": "
To filter by ancestors, see {@linkcode module:datastore/query#hasAncestor}.
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0\n
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
",
+ "summary": "
Copyright 2014 Google Inc. All Rights Reserved.
",
+ "body": "
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0\n
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
[Google Cloud Datastore]{@link https://developers.google.com/datastore/} is a fully managed, schemaless database for storing non-relational data. Use this object to create a Dataset to interact with your data, an "Int", and a "Double" representation.
",
+ "summary": "
[Google Cloud Datastore]{@link https://developers.google.com/datastore/} is a fully managed, schemaless database for storing non-relational data. Use this object to create a Dataset to interact with your data, an "Int", and a "Double" representation.
Note: Google Cloud Pub/Sub API is available as a Limited Preview and the client library we provide is currently experimental. The API and/or the client might be changed in backward-incompatible ways. This API is not subject to any SLA or deprecation policy. Request to be whitelisted to use it by filling the [Limited Preview application form]{@link http://goo.gl/sO0wTu}.
Note: Google Cloud Pub/Sub API is available as a Limited Preview and the client library we provide is currently experimental. The API and/or the client might be changed in backward-incompatible ways. This API is not subject to any SLA or deprecation policy. Request to be whitelisted to use it by filling the [Limited Preview application form]{@link http://goo.gl/sO0wTu}.
Google Cloud Storage allows you to store data on Google infrastructure. Read [Google Cloud Storage API docs]{@link https://developers.google.com/storage/} for more information.
You need to create a Google Cloud Storage bucket to use this client library. Follow the steps on [Google Cloud Storage docs]{@link https://developers.google.com/storage/} to create a bucket.
",
+ "summary": "
Google Cloud Storage allows you to store data on Google infrastructure. Read [Google Cloud Storage API docs]{@link https://developers.google.com/storage/} for more information.
",
+ "body": "
You need to create a Google Cloud Storage bucket to use this client library. Follow the steps on [Google Cloud Storage docs]{@link https://developers.google.com/storage/} to create a bucket.
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0\n
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
",
+ "summary": "
Copyright 2014 Google Inc. All Rights Reserved.
",
+ "body": "
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0\n
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
",
+ "body": ""
+ },
+ "isPrivate": true,
+ "ignore": false,
+ "code": "BufferStream.prototype._read = function() {\n this.push(this.data);\n this.push(null);\n};",
+ "ctx": {
+ "type": "method",
+ "constructor": "BufferStream",
+ "cons": "BufferStream",
+ "name": "_read",
+ "string": "BufferStream.prototype._read()"
+ }
+ },
+ {
+ "tags": [
+ {
+ "type": "alias",
+ "string": "module:storage "
+ },
+ {
+ "type": "throws",
+ "types": [
+ "if"
+ ],
+ "description": "a bucket name isn't provided. "
+ },
+ {
+ "type": "param",
+ "types": [
+ "object"
+ ],
+ "name": "options",
+ "description": "- Configuration options."
+ },
+ {
+ "type": "param",
+ "types": [
+ "string"
+ ],
+ "name": "options.bucketName",
+ "description": "- Name of the bucket."
+ },
+ {
+ "type": "param",
+ "types": [
+ "string="
+ ],
+ "name": "options.keyFilename",
+ "description": "- Full path to the JSON key downloaded from the Google Developers Console. Alternatively, you may provide a\n `credentials` object."
+ },
+ {
+ "type": "param",
+ "types": [
+ "object="
+ ],
+ "name": "options.credentials",
+ "description": "- Credentials object, used in place of a `keyFilename`.\n"
+ },
+ {
+ "type": "example",
+ "string": "var gcloud = require('gcloud');\nvar storage = gcloud.storage;\nvar bucket;\n\n// From Google Compute Engine\nbucket = new storage.Bucket({\n bucketName: YOUR_BUCKET_NAME\n});\n\n// From elsewhere\nbucket = new storage.Bucket({\n bucketName: YOUR_BUCKET_NAME,\n keyFilename: '/path/to/the/key.json'\n});"
+ }
+ ],
+ "description": {
+ "full": "
Google Cloud Storage allows you to store data on Google infrastructure. See the guide on {@link https://developers.google.com/storage} to create a bucket.
",
+ "summary": "
Google Cloud Storage allows you to store data on Google infrastructure. See the guide on {@link https://developers.google.com/storage} to create a bucket.
",
+ "body": ""
+ },
+ "isPrivate": false,
+ "ignore": false,
+ "code": "function Bucket(options) {\n if (!options.bucketName) {\n throw Error('A bucket name is needed to use Google Cloud Storage');\n }\n this.bucketName = options.bucketName;\n this.conn = new conn.Connection({\n credentials: options.credentials,\n keyFilename: options.keyFilename,\n scopes: SCOPES\n });\n}",
+ "ctx": {
+ "type": "function",
+ "name": "Bucket",
+ "string": "Bucket()"
+ }
+ },
+ {
+ "tags": [
+ {
+ "type": "param",
+ "types": [
+ "object="
+ ],
+ "name": "query",
+ "description": "- Query object."
+ },
+ {
+ "type": "param",
+ "types": [
+ "string"
+ ],
+ "name": "query.delimeter",
+ "description": "- Results will contain only objects whose names, aside from the prefix, do not contain delimiter. Objects whose\n names, aside from the prefix, contain delimiter will have their name\n truncated after the delimiter, returned in prefixes. Duplicate prefixes\n are omitted."
+ },
+ {
+ "type": "param",
+ "types": [
+ "string"
+ ],
+ "name": "query.prefix",
+ "description": "- Filters results to objects whose names begin with this prefix."
+ },
+ {
+ "type": "param",
+ "types": [
+ "number"
+ ],
+ "name": "query.maxResults",
+ "description": "- Maximum number of items plus prefixes to return."
+ },
+ {
+ "type": "param",
+ "types": [
+ "string"
+ ],
+ "name": "query.pageToken",
+ "description": "- A previously-returned page token representing part of the larger set of results to view."
+ },
+ {
+ "type": "param",
+ "types": [
+ "function"
+ ],
+ "name": "callback",
+ "description": "- The callback function. "
+ },
+ {
+ "type": "example",
+ "string": "bucket.list(function(err, files, nextQuery) {\n if (nextQuery) {\n // nextQuery will be non-null if there are more results.\n bucket.list(nextQuery, function(err, files, nextQuery) {});\n }\n});\n\n// Fetch using a query.\nbucket.list({ maxResults: 5 }, function(err, files, nextQuery) {});"
+ }
+ ],
+ "description": {
+ "full": "
Create a readable stream to read contents of the provided remote file. It can be piped to a write stream, or listened to for 'data' events to read a file's contents.
",
+ "summary": "
Create a readable stream to read contents of the provided remote file. It can be piped to a write stream, or listened to for 'data' events to read a file's contents.
Google Cloud Datastore is a
-fully managed, schemaless database for storing non-relational data. Use this
-object to create a Dataset to interact with your data, an "Int", and a
-"Double" representation.
Google Cloud Pub/Sub
-is a reliable, many-to-many, asynchronous messaging service from Google Cloud
-Platform.
-
Note: Google Cloud Pub/Sub API is available as a Limited Preview and the
-client library we provide is currently experimental. The API and/or the
-client might be changed in backward-incompatible ways. This API is not
-subject to any SLA or deprecation policy. Request to be whitelisted to use it
-by filling the
-Limited Preview application form.
Create a readable stream to read contents of the provided remote file. It
-can be piped to a write stream, or listened to for 'data' events to read a
-file's contents.
// Read from a local file and pipe to your bucket.
-var fs = require('fs');
-
-fs.createReadStream('local-file-path')
- .pipe(bucket.createWriteStream('remote-file-name'))
- .on('error', function(err) {})
- .on('complete', function(fileObject) {});
-
-
-
-
-
-
-
-
list(queryopt, callback)
-
-
-
-
-
-
-
-
List files from the current bucket.
-
-
-
-
-
-
-
-
-
Parameters:
-
-
-
-
-
-
-
Name
-
-
-
Type
-
-
-
Attributes
-
-
-
-
-
Description
-
-
-
-
-
-
-
-
-
query
-
-
-
-
-
-object
-
-
-
-
-
-
-
-
- <optional>
-
-
-
-
-
-
-
-
-
-
-
Query object.
-
Properties
-
-
-
-
-
-
-
Name
-
-
-
Type
-
-
-
-
-
-
Description
-
-
-
-
-
-
-
-
-
delimeter
-
-
-
-
-
-string
-
-
-
-
-
-
-
-
-
-
Results will contain only objects whose
- names, aside from the prefix, do not contain delimiter. Objects whose
- names, aside from the prefix, contain delimiter will have their name
- truncated after the delimiter, returned in prefixes. Duplicate prefixes
- are omitted.
-
-
-
-
-
-
-
prefix
-
-
-
-
-
-string
-
-
-
-
-
-
-
-
-
-
Filters results to objects whose names begin
- with this prefix.
-
-
-
-
-
-
-
maxResults
-
-
-
-
-
-number
-
-
-
-
-
-
-
-
-
-
Maximum number of items plus prefixes to
- return.
-
-
-
-
-
-
-
pageToken
-
-
-
-
-
-string
-
-
-
-
-
-
-
-
-
-
A previously-returned page token
- representing part of the larger set of results to view.
bucket.list(function(err, files, nextQuery) {
- if (nextQuery) {
- // nextQuery will be non-null if there are more results.
- bucket.list(nextQuery, function(err, files, nextQuery) {});
- }
-});
-
-// Fetch using a query.
-bucket.list({ maxResults: 5 }, function(err, files, nextQuery) {});
-
-
-
-
-
-
-
-
makeReq(method, path, query, body, callback)
-
-
-
-
-
-
-
-
Make a new request object from the provided arguments and wrap the callback
-to intercept non-successful responses.
// Upload "Hello World" as file contents. `data` can be any string or buffer.
-bucket.write('filename', {
- data: 'Hello World'
-}, function(err) {});
-
-// A shorthand for the above.
-bucket.write('filename', 'Hello World', function(err) {});
var query;
-
-// If your dataset was scoped to a namespace at initialization, your query
-// will likewise be scoped to that namespace.
-query = dataset.createQuery(['Lion', 'Chimp']);
-
-// However, you may override the namespace per query.
-query = dataset.createQuery('AnimalNamespace', ['Lion', 'Chimp']);
-
-// You may also remove the namespace altogether.
-query = dataset.createQuery(null, ['Lion', 'Chimp']);
Datastore allows querying on properties. Supported comparison operators
-are =, <, >, <=, and >=. "Not equal" and IN operators are
-currently not supported.
// List all companies named Google that have less than 400 employees.
-var companyQuery = query
- .filter('name =', 'Google');
- .filter('size <', 400);
-
-// To filter by key, use `__key__` for the property name. Filter on keys
-// stored as properties is not currently supported.
-var keyQuery = query.filter('__key__ =', datastore.key('Company', 'Google'));
/**
- * Copyright 2014 Google Inc. All Rights Reserved.
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-/**
- * @module datastore/query
- */
-
-'use strict';
-
-var util = require('../common/util.js');
-
-/**
- * Build a Query object.
- *
- * **Queries should be built with
- * {@linkcode module:datastore/dataset#createQuery} and run via
- * {@linkcode module:datastore/dataset#runQuery}.**
- *
- * *Reference: {@link http://goo.gl/Cag0r6}*
- *
- * @constructor
- * @alias module:datastore/query
- *
- * @param {string=} namespace - Namespace to query entities from.
- * @param {string[]} kinds - Kinds to query.
- *
- * @example
- * var query;
- *
- * // If your dataset was scoped to a namespace at initialization, your query
- * // will likewise be scoped to that namespace.
- * query = dataset.createQuery(['Lion', 'Chimp']);
- *
- * // However, you may override the namespace per query.
- * query = dataset.createQuery('AnimalNamespace', ['Lion', 'Chimp']);
- *
- * // You may also remove the namespace altogether.
- * query = dataset.createQuery(null, ['Lion', 'Chimp']);
- */
-function Query(namespace, kinds) {
- if (!kinds) {
- kinds = namespace;
- namespace = null;
- }
-
- this.namespace = namespace || null;
- this.kinds = kinds;
-
- this.filters = [];
- this.orders = [];
- this.groupByVal = [];
- this.selectVal = [];
-
- // pagination
- this.startVal = null;
- this.endVal = null;
- this.limitVal = -1;
- this.offsetVal = -1;
-}
-
-/**
- * Datastore allows querying on properties. Supported comparison operators
- * are `=`, `<`, `>`, `<=`, and `>=`. "Not equal" and `IN` operators are
- * currently not supported.
- *
- * *To filter by ancestors, see {@linkcode module:datastore/query#hasAncestor}.*
- *
- * *Reference: {@link http://goo.gl/ENCx7e}*
- *
- * @param {string} filter - Property + Operator (=, <, >, <=, >=).
- * @param {*} value - Value to compare property to.
- * @return {module:datastore/query}
- *
- * @example
- * // List all companies named Google that have less than 400 employees.
- * var companyQuery = query
- * .filter('name =', 'Google');
- * .filter('size <', 400);
- *
- * // To filter by key, use `__key__` for the property name. Filter on keys
- * // stored as properties is not currently supported.
- * var keyQuery = query.filter('__key__ =', datastore.key('Company', 'Google'));
- */
-Query.prototype.filter = function(filter, value) {
- // TODO: Add filter validation.
- var q = util.extend(this, new Query());
- filter = filter.trim();
- var fieldName = filter.replace(/[>|<|=|>=|<=]*$/, '').trim();
- var op = filter.substr(fieldName.length, filter.length).trim();
- q.filters = q.filters || [];
- q.filters.push({ name: fieldName, op: op, val: value });
- return q;
-};
-
-/**
- * Filter a query by ancestors.
- *
- * *Reference: {@link http://goo.gl/1qfpkZ}*
- *
- * @param {datastore/entity~Key} key - Key object to filter by.
- * @return {module:datastore/query}
- *
- * @example
- * var ancestoryQuery = query.hasAncestor(datastore.key('Parent', 123));
- */
-Query.prototype.hasAncestor = function(key) {
- var q = util.extend(this, new Query());
- this.filters.push({ name: '__key__', op: 'HAS_ANCESTOR', val: key });
- return q;
-};
-
-/**
- * Sort the results by a property name ascendingly or descendingly. By default,
- * an ascending sort order will be used.
- *
- * *Reference: {@link http://goo.gl/mfegFR}*
- *
- * @param {string} property - Optional operator (+, -) and property to order by.
- * @return {module:datastore/query}
- *
- * @example
- * // Sort by size ascendingly.
- * var companiesAscending = companyQuery.order('size');
- *
- * // Sort by size descendingly.
- * var companiesDescending = companyQuery.order('-size');
- */
-Query.prototype.order = function(property) {
- var q = util.extend(this, new Query());
- var sign = '+';
- if (property[0] === '-' || property[0] === '+') {
- sign = property[0];
- property = property.substr(1);
- }
- q.orders = q.orders || [];
- q.orders.push({ name: property, sign: sign });
- return q;
-};
-
-/**
- * Group query results by a list of properties.
- *
- * @param {array} properties - Properties to group by.
- * @return {module:datastore/query}
- *
- * @example
- * var groupedQuery = companyQuery.groupBy(['name', 'size']);
- */
-Query.prototype.groupBy = function(fieldNames) {
- var fields = util.arrayize(fieldNames);
- var q = util.extend(this, new Query());
- q.groupByVal = fields;
- return q;
-};
-
-/**
- * Retrieve only select properties from the matched entities.
- *
- * *Reference: [Projection Queries]{@link http://goo.gl/EfsrJl}*
- *
- * @param {array} fieldNames - Properties to return from the matched entities.
- * @return {module:datastore/query}
- *
- * @example
- * // Only retrieve the name and size properties.
- * var selectQuery = companyQuery.select(['name', 'size']);
- */
-Query.prototype.select = function(fieldNames) {
- var q = util.extend(this, new Query());
- q.selectVal = fieldNames;
- return q;
-};
-
-/**
- * Set a starting cursor to a query.
- *
- * *Reference: {@link http://goo.gl/WuTGRI}*
- *
- * @param {string} cursorToken - The starting cursor token.
- * @return {module:datastore/query}
- *
- * @example
- * var cursorToken = 'X';
- *
- * // Retrieve results starting from cursorToken.
- * var startQuery = companyQuery.start(cursorToken);
- */
-Query.prototype.start = function(start) {
- var q = util.extend(this, new Query());
- q.startVal = start;
- return q;
-};
-
-/**
- * Set an ending cursor to a query.
- *
- * *Reference: {@link http://goo.gl/WuTGRI}*
- *
- * @param {string} cursorToken - The ending cursor token.
- * @return {module:datastore/query}
- *
- * @example
- * var cursorToken = 'X';
- *
- * // Retrieve results limited to the extent of cursorToken.
- * var endQuery = companyQuery.end(cursorToken);
- */
-Query.prototype.end = function(end) {
- var q = util.extend(this, new Query());
- q.endVal = end;
- return q;
-};
-
-/**
- * Set a limit on a query.
- *
- * *Reference: {@link http://goo.gl/f0VZ0n}*
- *
- * @param {number} n - The number of results to limit the query to.
- * @return {module:datastore/query}
- *
- * @example
- * // Limit the results to 10 entities.
- * var limitQuery = companyQuery.limit(10);
- */
-Query.prototype.limit = function(n) {
- var q = util.extend(this, new Query());
- q.limitVal = n;
- return q;
-};
-
-/**
- * Set an offset on a query.
- *
- * *Reference: {@link http://goo.gl/f0VZ0n}*
- *
- * @param {number} n - The offset to start from after the start cursor.
- * @return {module:datastore/query}
- *
- * @example
- * // Start from the 101st result.
- * var offsetQuery = companyQuery.offset(100);
- */
-Query.prototype.offset = function(n) {
- var q = util.extend(this, new Query());
- q.offsetVal = n;
- return q;
-};
-
-module.exports = Query;
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
diff --git a/docs/scripts/linenumber.js b/docs/scripts/linenumber.js
deleted file mode 100644
index 8d52f7eafdb..00000000000
--- a/docs/scripts/linenumber.js
+++ /dev/null
@@ -1,25 +0,0 @@
-/*global document */
-(function() {
- var source = document.getElementsByClassName('prettyprint source linenums');
- var i = 0;
- var lineNumber = 0;
- var lineId;
- var lines;
- var totalLines;
- var anchorHash;
-
- if (source && source[0]) {
- anchorHash = document.location.hash.substring(1);
- lines = source[0].getElementsByTagName('li');
- totalLines = lines.length;
-
- for (; i < totalLines; i++) {
- lineNumber++;
- lineId = 'line' + lineNumber;
- lines[i].id = lineId;
- if (lineId === anchorHash) {
- lines[i].className += ' selected';
- }
- }
- }
-})();
diff --git a/docs/scripts/prettify/Apache-License-2.0.txt b/docs/scripts/prettify/Apache-License-2.0.txt
deleted file mode 100644
index d6456956733..00000000000
--- a/docs/scripts/prettify/Apache-License-2.0.txt
+++ /dev/null
@@ -1,202 +0,0 @@
-
- Apache License
- Version 2.0, January 2004
- http://www.apache.org/licenses/
-
- TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
-
- 1. Definitions.
-
- "License" shall mean the terms and conditions for use, reproduction,
- and distribution as defined by Sections 1 through 9 of this document.
-
- "Licensor" shall mean the copyright owner or entity authorized by
- the copyright owner that is granting the License.
-
- "Legal Entity" shall mean the union of the acting entity and all
- other entities that control, are controlled by, or are under common
- control with that entity. For the purposes of this definition,
- "control" means (i) the power, direct or indirect, to cause the
- direction or management of such entity, whether by contract or
- otherwise, or (ii) ownership of fifty percent (50%) or more of the
- outstanding shares, or (iii) beneficial ownership of such entity.
-
- "You" (or "Your") shall mean an individual or Legal Entity
- exercising permissions granted by this License.
-
- "Source" form shall mean the preferred form for making modifications,
- including but not limited to software source code, documentation
- source, and configuration files.
-
- "Object" form shall mean any form resulting from mechanical
- transformation or translation of a Source form, including but
- not limited to compiled object code, generated documentation,
- and conversions to other media types.
-
- "Work" shall mean the work of authorship, whether in Source or
- Object form, made available under the License, as indicated by a
- copyright notice that is included in or attached to the work
- (an example is provided in the Appendix below).
-
- "Derivative Works" shall mean any work, whether in Source or Object
- form, that is based on (or derived from) the Work and for which the
- editorial revisions, annotations, elaborations, or other modifications
- represent, as a whole, an original work of authorship. For the purposes
- of this License, Derivative Works shall not include works that remain
- separable from, or merely link (or bind by name) to the interfaces of,
- the Work and Derivative Works thereof.
-
- "Contribution" shall mean any work of authorship, including
- the original version of the Work and any modifications or additions
- to that Work or Derivative Works thereof, that is intentionally
- submitted to Licensor for inclusion in the Work by the copyright owner
- or by an individual or Legal Entity authorized to submit on behalf of
- the copyright owner. For the purposes of this definition, "submitted"
- means any form of electronic, verbal, or written communication sent
- to the Licensor or its representatives, including but not limited to
- communication on electronic mailing lists, source code control systems,
- and issue tracking systems that are managed by, or on behalf of, the
- Licensor for the purpose of discussing and improving the Work, but
- excluding communication that is conspicuously marked or otherwise
- designated in writing by the copyright owner as "Not a Contribution."
-
- "Contributor" shall mean Licensor and any individual or Legal Entity
- on behalf of whom a Contribution has been received by Licensor and
- subsequently incorporated within the Work.
-
- 2. Grant of Copyright License. Subject to the terms and conditions of
- this License, each Contributor hereby grants to You a perpetual,
- worldwide, non-exclusive, no-charge, royalty-free, irrevocable
- copyright license to reproduce, prepare Derivative Works of,
- publicly display, publicly perform, sublicense, and distribute the
- Work and such Derivative Works in Source or Object form.
-
- 3. Grant of Patent License. Subject to the terms and conditions of
- this License, each Contributor hereby grants to You a perpetual,
- worldwide, non-exclusive, no-charge, royalty-free, irrevocable
- (except as stated in this section) patent license to make, have made,
- use, offer to sell, sell, import, and otherwise transfer the Work,
- where such license applies only to those patent claims licensable
- by such Contributor that are necessarily infringed by their
- Contribution(s) alone or by combination of their Contribution(s)
- with the Work to which such Contribution(s) was submitted. If You
- institute patent litigation against any entity (including a
- cross-claim or counterclaim in a lawsuit) alleging that the Work
- or a Contribution incorporated within the Work constitutes direct
- or contributory patent infringement, then any patent licenses
- granted to You under this License for that Work shall terminate
- as of the date such litigation is filed.
-
- 4. Redistribution. You may reproduce and distribute copies of the
- Work or Derivative Works thereof in any medium, with or without
- modifications, and in Source or Object form, provided that You
- meet the following conditions:
-
- (a) You must give any other recipients of the Work or
- Derivative Works a copy of this License; and
-
- (b) You must cause any modified files to carry prominent notices
- stating that You changed the files; and
-
- (c) You must retain, in the Source form of any Derivative Works
- that You distribute, all copyright, patent, trademark, and
- attribution notices from the Source form of the Work,
- excluding those notices that do not pertain to any part of
- the Derivative Works; and
-
- (d) If the Work includes a "NOTICE" text file as part of its
- distribution, then any Derivative Works that You distribute must
- include a readable copy of the attribution notices contained
- within such NOTICE file, excluding those notices that do not
- pertain to any part of the Derivative Works, in at least one
- of the following places: within a NOTICE text file distributed
- as part of the Derivative Works; within the Source form or
- documentation, if provided along with the Derivative Works; or,
- within a display generated by the Derivative Works, if and
- wherever such third-party notices normally appear. The contents
- of the NOTICE file are for informational purposes only and
- do not modify the License. You may add Your own attribution
- notices within Derivative Works that You distribute, alongside
- or as an addendum to the NOTICE text from the Work, provided
- that such additional attribution notices cannot be construed
- as modifying the License.
-
- You may add Your own copyright statement to Your modifications and
- may provide additional or different license terms and conditions
- for use, reproduction, or distribution of Your modifications, or
- for any such Derivative Works as a whole, provided Your use,
- reproduction, and distribution of the Work otherwise complies with
- the conditions stated in this License.
-
- 5. Submission of Contributions. Unless You explicitly state otherwise,
- any Contribution intentionally submitted for inclusion in the Work
- by You to the Licensor shall be under the terms and conditions of
- this License, without any additional terms or conditions.
- Notwithstanding the above, nothing herein shall supersede or modify
- the terms of any separate license agreement you may have executed
- with Licensor regarding such Contributions.
-
- 6. Trademarks. This License does not grant permission to use the trade
- names, trademarks, service marks, or product names of the Licensor,
- except as required for reasonable and customary use in describing the
- origin of the Work and reproducing the content of the NOTICE file.
-
- 7. Disclaimer of Warranty. Unless required by applicable law or
- agreed to in writing, Licensor provides the Work (and each
- Contributor provides its Contributions) on an "AS IS" BASIS,
- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
- implied, including, without limitation, any warranties or conditions
- of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
- PARTICULAR PURPOSE. You are solely responsible for determining the
- appropriateness of using or redistributing the Work and assume any
- risks associated with Your exercise of permissions under this License.
-
- 8. Limitation of Liability. In no event and under no legal theory,
- whether in tort (including negligence), contract, or otherwise,
- unless required by applicable law (such as deliberate and grossly
- negligent acts) or agreed to in writing, shall any Contributor be
- liable to You for damages, including any direct, indirect, special,
- incidental, or consequential damages of any character arising as a
- result of this License or out of the use or inability to use the
- Work (including but not limited to damages for loss of goodwill,
- work stoppage, computer failure or malfunction, or any and all
- other commercial damages or losses), even if such Contributor
- has been advised of the possibility of such damages.
-
- 9. Accepting Warranty or Additional Liability. While redistributing
- the Work or Derivative Works thereof, You may choose to offer,
- and charge a fee for, acceptance of support, warranty, indemnity,
- or other liability obligations and/or rights consistent with this
- License. However, in accepting such obligations, You may act only
- on Your own behalf and on Your sole responsibility, not on behalf
- of any other Contributor, and only if You agree to indemnify,
- defend, and hold each Contributor harmless for any liability
- incurred by, or claims asserted against, such Contributor by reason
- of your accepting any such warranty or additional liability.
-
- END OF TERMS AND CONDITIONS
-
- APPENDIX: How to apply the Apache License to your work.
-
- To apply the Apache License to your work, attach the following
- boilerplate notice, with the fields enclosed by brackets "[]"
- replaced with your own identifying information. (Don't include
- the brackets!) The text should be enclosed in the appropriate
- comment syntax for the file format. We also recommend that a
- file or class name and description of purpose be included on the
- same "printed page" as the copyright notice for easier
- identification within third-party archives.
-
- Copyright [yyyy] [name of copyright owner]
-
- Licensed under the Apache License, Version 2.0 (the "License");
- you may not use this file except in compliance with the License.
- You may obtain a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing, software
- distributed under the License is distributed on an "AS IS" BASIS,
- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- See the License for the specific language governing permissions and
- limitations under the License.
diff --git a/docs/scripts/prettify/lang-css.js b/docs/scripts/prettify/lang-css.js
deleted file mode 100644
index 041e1f59067..00000000000
--- a/docs/scripts/prettify/lang-css.js
+++ /dev/null
@@ -1,2 +0,0 @@
-PR.registerLangHandler(PR.createSimpleLexer([["pln",/^[\t\n\f\r ]+/,null," \t\r\n "]],[["str",/^"(?:[^\n\f\r"\\]|\\(?:\r\n?|\n|\f)|\\[\S\s])*"/,null],["str",/^'(?:[^\n\f\r'\\]|\\(?:\r\n?|\n|\f)|\\[\S\s])*'/,null],["lang-css-str",/^url\(([^"')]*)\)/i],["kwd",/^(?:url|rgb|!important|@import|@page|@media|@charset|inherit)(?=[^\w-]|$)/i,null],["lang-css-kw",/^(-?(?:[_a-z]|\\[\da-f]+ ?)(?:[\w-]|\\\\[\da-f]+ ?)*)\s*:/i],["com",/^\/\*[^*]*\*+(?:[^*/][^*]*\*+)*\//],["com",
-/^(?:<\!--|--\>)/],["lit",/^(?:\d+|\d*\.\d+)(?:%|[a-z]+)?/i],["lit",/^#[\da-f]{3,6}/i],["pln",/^-?(?:[_a-z]|\\[\da-f]+ ?)(?:[\w-]|\\\\[\da-f]+ ?)*/i],["pun",/^[^\s\w"']+/]]),["css"]);PR.registerLangHandler(PR.createSimpleLexer([],[["kwd",/^-?(?:[_a-z]|\\[\da-f]+ ?)(?:[\w-]|\\\\[\da-f]+ ?)*/i]]),["css-kw"]);PR.registerLangHandler(PR.createSimpleLexer([],[["str",/^[^"')]+/]]),["css-str"]);
diff --git a/docs/scripts/prettify/prettify.js b/docs/scripts/prettify/prettify.js
deleted file mode 100644
index eef5ad7e6a0..00000000000
--- a/docs/scripts/prettify/prettify.js
+++ /dev/null
@@ -1,28 +0,0 @@
-var q=null;window.PR_SHOULD_USE_CONTINUATION=!0;
-(function(){function L(a){function m(a){var f=a.charCodeAt(0);if(f!==92)return f;var b=a.charAt(1);return(f=r[b])?f:"0"<=b&&b<="7"?parseInt(a.substring(1),8):b==="u"||b==="x"?parseInt(a.substring(2),16):a.charCodeAt(1)}function e(a){if(a<32)return(a<16?"\\x0":"\\x")+a.toString(16);a=String.fromCharCode(a);if(a==="\\"||a==="-"||a==="["||a==="]")a="\\"+a;return a}function h(a){for(var f=a.substring(1,a.length-1).match(/\\u[\dA-Fa-f]{4}|\\x[\dA-Fa-f]{2}|\\[0-3][0-7]{0,2}|\\[0-7]{1,2}|\\[\S\s]|[^\\]/g),a=
-[],b=[],o=f[0]==="^",c=o?1:0,i=f.length;c122||(d<65||j>90||b.push([Math.max(65,j)|32,Math.min(d,90)|32]),d<97||j>122||b.push([Math.max(97,j)&-33,Math.min(d,122)&-33]))}}b.sort(function(a,f){return a[0]-f[0]||f[1]-a[1]});f=[];j=[NaN,NaN];for(c=0;ci[0]&&(i[1]+1>i[0]&&b.push("-"),b.push(e(i[1])));b.push("]");return b.join("")}function y(a){for(var f=a.source.match(/\[(?:[^\\\]]|\\[\S\s])*]|\\u[\dA-Fa-f]{4}|\\x[\dA-Fa-f]{2}|\\\d+|\\[^\dux]|\(\?[!:=]|[()^]|[^()[\\^]+/g),b=f.length,d=[],c=0,i=0;c=2&&a==="["?f[c]=h(j):a!=="\\"&&(f[c]=j.replace(/[A-Za-z]/g,function(a){a=a.charCodeAt(0);return"["+String.fromCharCode(a&-33,a|32)+"]"}));return f.join("")}for(var t=0,s=!1,l=!1,p=0,d=a.length;p=5&&"lang-"===b.substring(0,5))&&!(o&&typeof o[1]==="string"))c=!1,b="src";c||(r[f]=b)}i=d;d+=f.length;if(c){c=o[1];var j=f.indexOf(c),k=j+c.length;o[2]&&(k=f.length-o[2].length,j=k-c.length);b=b.substring(5);B(l+i,f.substring(0,j),e,p);B(l+i+j,c,C(b,c),p);B(l+i+k,f.substring(k),e,p)}else p.push(l+i,b)}a.e=p}var h={},y;(function(){for(var e=a.concat(m),
-l=[],p={},d=0,g=e.length;d=0;)h[n.charAt(k)]=r;r=r[1];n=""+r;p.hasOwnProperty(n)||(l.push(r),p[n]=q)}l.push(/[\S\s]/);y=L(l)})();var t=m.length;return e}function u(a){var m=[],e=[];a.tripleQuotedStrings?m.push(["str",/^(?:'''(?:[^'\\]|\\[\S\s]|''?(?=[^']))*(?:'''|$)|"""(?:[^"\\]|\\[\S\s]|""?(?=[^"]))*(?:"""|$)|'(?:[^'\\]|\\[\S\s])*(?:'|$)|"(?:[^"\\]|\\[\S\s])*(?:"|$))/,q,"'\""]):a.multiLineStrings?m.push(["str",/^(?:'(?:[^'\\]|\\[\S\s])*(?:'|$)|"(?:[^"\\]|\\[\S\s])*(?:"|$)|`(?:[^\\`]|\\[\S\s])*(?:`|$))/,
-q,"'\"`"]):m.push(["str",/^(?:'(?:[^\n\r'\\]|\\.)*(?:'|$)|"(?:[^\n\r"\\]|\\.)*(?:"|$))/,q,"\"'"]);a.verbatimStrings&&e.push(["str",/^@"(?:[^"]|"")*(?:"|$)/,q]);var h=a.hashComments;h&&(a.cStyleComments?(h>1?m.push(["com",/^#(?:##(?:[^#]|#(?!##))*(?:###|$)|.*)/,q,"#"]):m.push(["com",/^#(?:(?:define|elif|else|endif|error|ifdef|include|ifndef|line|pragma|undef|warning)\b|[^\n\r]*)/,q,"#"]),e.push(["str",/^<(?:(?:(?:\.\.\/)*|\/?)(?:[\w-]+(?:\/[\w-]+)+)?[\w-]+\.h|[a-z]\w*)>/,q])):m.push(["com",/^#[^\n\r]*/,
-q,"#"]));a.cStyleComments&&(e.push(["com",/^\/\/[^\n\r]*/,q]),e.push(["com",/^\/\*[\S\s]*?(?:\*\/|$)/,q]));a.regexLiterals&&e.push(["lang-regex",/^(?:^^\.?|[!+-]|!=|!==|#|%|%=|&|&&|&&=|&=|\(|\*|\*=|\+=|,|-=|->|\/|\/=|:|::|;|<|<<|<<=|<=|=|==|===|>|>=|>>|>>=|>>>|>>>=|[?@[^]|\^=|\^\^|\^\^=|{|\||\|=|\|\||\|\|=|~|break|case|continue|delete|do|else|finally|instanceof|return|throw|try|typeof)\s*(\/(?=[^*/])(?:[^/[\\]|\\[\S\s]|\[(?:[^\\\]]|\\[\S\s])*(?:]|$))+\/)/]);(h=a.types)&&e.push(["typ",h]);a=(""+a.keywords).replace(/^ | $/g,
-"");a.length&&e.push(["kwd",RegExp("^(?:"+a.replace(/[\s,]+/g,"|")+")\\b"),q]);m.push(["pln",/^\s+/,q," \r\n\t\xa0"]);e.push(["lit",/^@[$_a-z][\w$@]*/i,q],["typ",/^(?:[@_]?[A-Z]+[a-z][\w$@]*|\w+_t\b)/,q],["pln",/^[$_a-z][\w$@]*/i,q],["lit",/^(?:0x[\da-f]+|(?:\d(?:_\d+)*\d*(?:\.\d*)?|\.\d\+)(?:e[+-]?\d+)?)[a-z]*/i,q,"0123456789"],["pln",/^\\[\S\s]?/,q],["pun",/^.[^\s\w"-$'./@\\`]*/,q]);return x(m,e)}function D(a,m){function e(a){switch(a.nodeType){case 1:if(k.test(a.className))break;if("BR"===a.nodeName)h(a),
-a.parentNode&&a.parentNode.removeChild(a);else for(a=a.firstChild;a;a=a.nextSibling)e(a);break;case 3:case 4:if(p){var b=a.nodeValue,d=b.match(t);if(d){var c=b.substring(0,d.index);a.nodeValue=c;(b=b.substring(d.index+d[0].length))&&a.parentNode.insertBefore(s.createTextNode(b),a.nextSibling);h(a);c||a.parentNode.removeChild(a)}}}}function h(a){function b(a,d){var e=d?a.cloneNode(!1):a,f=a.parentNode;if(f){var f=b(f,1),g=a.nextSibling;f.appendChild(e);for(var h=g;h;h=g)g=h.nextSibling,f.appendChild(h)}return e}
-for(;!a.nextSibling;)if(a=a.parentNode,!a)return;for(var a=b(a.nextSibling,0),e;(e=a.parentNode)&&e.nodeType===1;)a=e;d.push(a)}var k=/(?:^|\s)nocode(?:\s|$)/,t=/\r\n?|\n/,s=a.ownerDocument,l;a.currentStyle?l=a.currentStyle.whiteSpace:window.getComputedStyle&&(l=s.defaultView.getComputedStyle(a,q).getPropertyValue("white-space"));var p=l&&"pre"===l.substring(0,3);for(l=s.createElement("LI");a.firstChild;)l.appendChild(a.firstChild);for(var d=[l],g=0;g=0;){var h=m[e];A.hasOwnProperty(h)?window.console&&console.warn("cannot override language handler %s",h):A[h]=a}}function C(a,m){if(!a||!A.hasOwnProperty(a))a=/^\s*=o&&(h+=2);e>=c&&(a+=2)}}catch(w){"console"in window&&console.log(w&&w.stack?w.stack:w)}}var v=["break,continue,do,else,for,if,return,while"],w=[[v,"auto,case,char,const,default,double,enum,extern,float,goto,int,long,register,short,signed,sizeof,static,struct,switch,typedef,union,unsigned,void,volatile"],
-"catch,class,delete,false,import,new,operator,private,protected,public,this,throw,true,try,typeof"],F=[w,"alignof,align_union,asm,axiom,bool,concept,concept_map,const_cast,constexpr,decltype,dynamic_cast,explicit,export,friend,inline,late_check,mutable,namespace,nullptr,reinterpret_cast,static_assert,static_cast,template,typeid,typename,using,virtual,where"],G=[w,"abstract,boolean,byte,extends,final,finally,implements,import,instanceof,null,native,package,strictfp,super,synchronized,throws,transient"],
-H=[G,"as,base,by,checked,decimal,delegate,descending,dynamic,event,fixed,foreach,from,group,implicit,in,interface,internal,into,is,lock,object,out,override,orderby,params,partial,readonly,ref,sbyte,sealed,stackalloc,string,select,uint,ulong,unchecked,unsafe,ushort,var"],w=[w,"debugger,eval,export,function,get,null,set,undefined,var,with,Infinity,NaN"],I=[v,"and,as,assert,class,def,del,elif,except,exec,finally,from,global,import,in,is,lambda,nonlocal,not,or,pass,print,raise,try,with,yield,False,True,None"],
-J=[v,"alias,and,begin,case,class,def,defined,elsif,end,ensure,false,in,module,next,nil,not,or,redo,rescue,retry,self,super,then,true,undef,unless,until,when,yield,BEGIN,END"],v=[v,"case,done,elif,esac,eval,fi,function,in,local,set,then,until"],K=/^(DIR|FILE|vector|(de|priority_)?queue|list|stack|(const_)?iterator|(multi)?(set|map)|bitset|u?(int|float)\d*)/,N=/\S/,O=u({keywords:[F,H,w,"caller,delete,die,do,dump,elsif,eval,exit,foreach,for,goto,if,import,last,local,my,next,no,our,print,package,redo,require,sub,undef,unless,until,use,wantarray,while,BEGIN,END"+
-I,J,v],hashComments:!0,cStyleComments:!0,multiLineStrings:!0,regexLiterals:!0}),A={};k(O,["default-code"]);k(x([],[["pln",/^[^]*(?:>|$)/],["com",/^<\!--[\S\s]*?(?:--\>|$)/],["lang-",/^<\?([\S\s]+?)(?:\?>|$)/],["lang-",/^<%([\S\s]+?)(?:%>|$)/],["pun",/^(?:<[%?]|[%?]>)/],["lang-",/^]*>([\S\s]+?)<\/xmp\b[^>]*>/i],["lang-js",/^]*>([\S\s]*?)(<\/script\b[^>]*>)/i],["lang-css",/^]*>([\S\s]*?)(<\/style\b[^>]*>)/i],["lang-in.tag",/^(<\/?[a-z][^<>]*>)/i]]),
-["default-markup","htm","html","mxml","xhtml","xml","xsl"]);k(x([["pln",/^\s+/,q," \t\r\n"],["atv",/^(?:"[^"]*"?|'[^']*'?)/,q,"\"'"]],[["tag",/^^<\/?[a-z](?:[\w-.:]*\w)?|\/?>$/i],["atn",/^(?!style[\s=]|on)[a-z](?:[\w:-]*\w)?/i],["lang-uq.val",/^=\s*([^\s"'>]*(?:[^\s"'/>]|\/(?=\s)))/],["pun",/^[/<->]+/],["lang-js",/^on\w+\s*=\s*"([^"]+)"/i],["lang-js",/^on\w+\s*=\s*'([^']+)'/i],["lang-js",/^on\w+\s*=\s*([^\s"'>]+)/i],["lang-css",/^style\s*=\s*"([^"]+)"/i],["lang-css",/^style\s*=\s*'([^']+)'/i],["lang-css",
-/^style\s*=\s*([^\s"'>]+)/i]]),["in.tag"]);k(x([],[["atv",/^[\S\s]+/]]),["uq.val"]);k(u({keywords:F,hashComments:!0,cStyleComments:!0,types:K}),["c","cc","cpp","cxx","cyc","m"]);k(u({keywords:"null,true,false"}),["json"]);k(u({keywords:H,hashComments:!0,cStyleComments:!0,verbatimStrings:!0,types:K}),["cs"]);k(u({keywords:G,cStyleComments:!0}),["java"]);k(u({keywords:v,hashComments:!0,multiLineStrings:!0}),["bsh","csh","sh"]);k(u({keywords:I,hashComments:!0,multiLineStrings:!0,tripleQuotedStrings:!0}),
-["cv","py"]);k(u({keywords:"caller,delete,die,do,dump,elsif,eval,exit,foreach,for,goto,if,import,last,local,my,next,no,our,print,package,redo,require,sub,undef,unless,until,use,wantarray,while,BEGIN,END",hashComments:!0,multiLineStrings:!0,regexLiterals:!0}),["perl","pl","pm"]);k(u({keywords:J,hashComments:!0,multiLineStrings:!0,regexLiterals:!0}),["rb"]);k(u({keywords:w,cStyleComments:!0,regexLiterals:!0}),["js"]);k(u({keywords:"all,and,by,catch,class,else,extends,false,finally,for,if,in,is,isnt,loop,new,no,not,null,of,off,on,or,return,super,then,true,try,unless,until,when,while,yes",
-hashComments:3,cStyleComments:!0,multilineStrings:!0,tripleQuotedStrings:!0,regexLiterals:!0}),["coffee"]);k(x([],[["str",/^[\S\s]+/]]),["regex"]);window.prettyPrintOne=function(a,m,e){var h=document.createElement("PRE");h.innerHTML=a;e&&D(h,e);E({g:m,i:e,h:h});return h.innerHTML};window.prettyPrint=function(a){function m(){for(var e=window.PR_SHOULD_USE_CONTINUATION?l.now()+250:Infinity;p=0){var k=k.match(g),f,b;if(b=
-!k){b=n;for(var o=void 0,c=b.firstChild;c;c=c.nextSibling)var i=c.nodeType,o=i===1?o?b:c:i===3?N.test(c.nodeValue)?b:o:o;b=(f=o===b?void 0:o)&&"CODE"===f.tagName}b&&(k=f.className.match(g));k&&(k=k[1]);b=!1;for(o=n.parentNode;o;o=o.parentNode)if((o.tagName==="pre"||o.tagName==="code"||o.tagName==="xmp")&&o.className&&o.className.indexOf("prettyprint")>=0){b=!0;break}b||((b=(b=n.className.match(/\blinenums\b(?::(\d+))?/))?b[1]&&b[1].length?+b[1]:!0:!1)&&D(n,b),d={g:k,h:n,i:b},E(d))}}p p:first-child
-{
- margin-top: 0;
- padding-top: 0;
-}
-
-.params td.description > p:last-child
-{
- margin-bottom: 0;
- padding-bottom: 0;
-}
-
-.disabled {
- color: #454545;
-}
diff --git a/docs/styles/prettify-jsdoc.css b/docs/styles/prettify-jsdoc.css
deleted file mode 100644
index 5a2526e3748..00000000000
--- a/docs/styles/prettify-jsdoc.css
+++ /dev/null
@@ -1,111 +0,0 @@
-/* JSDoc prettify.js theme */
-
-/* plain text */
-.pln {
- color: #000000;
- font-weight: normal;
- font-style: normal;
-}
-
-/* string content */
-.str {
- color: #006400;
- font-weight: normal;
- font-style: normal;
-}
-
-/* a keyword */
-.kwd {
- color: #000000;
- font-weight: bold;
- font-style: normal;
-}
-
-/* a comment */
-.com {
- font-weight: normal;
- font-style: italic;
-}
-
-/* a type name */
-.typ {
- color: #000000;
- font-weight: normal;
- font-style: normal;
-}
-
-/* a literal value */
-.lit {
- color: #006400;
- font-weight: normal;
- font-style: normal;
-}
-
-/* punctuation */
-.pun {
- color: #000000;
- font-weight: bold;
- font-style: normal;
-}
-
-/* lisp open bracket */
-.opn {
- color: #000000;
- font-weight: bold;
- font-style: normal;
-}
-
-/* lisp close bracket */
-.clo {
- color: #000000;
- font-weight: bold;
- font-style: normal;
-}
-
-/* a markup tag name */
-.tag {
- color: #006400;
- font-weight: normal;
- font-style: normal;
-}
-
-/* a markup attribute name */
-.atn {
- color: #006400;
- font-weight: normal;
- font-style: normal;
-}
-
-/* a markup attribute value */
-.atv {
- color: #006400;
- font-weight: normal;
- font-style: normal;
-}
-
-/* a declaration */
-.dec {
- color: #000000;
- font-weight: bold;
- font-style: normal;
-}
-
-/* a variable name */
-.var {
- color: #000000;
- font-weight: normal;
- font-style: normal;
-}
-
-/* a function name */
-.fun {
- color: #000000;
- font-weight: bold;
- font-style: normal;
-}
-
-/* Specify class=linenums on a pre to get line numbering */
-ol.linenums {
- margin-top: 0;
- margin-bottom: 0;
-}
diff --git a/docs/styles/prettify-tomorrow.css b/docs/styles/prettify-tomorrow.css
deleted file mode 100644
index aa2908c251e..00000000000
--- a/docs/styles/prettify-tomorrow.css
+++ /dev/null
@@ -1,132 +0,0 @@
-/* Tomorrow Theme */
-/* Original theme - https://github.com/chriskempson/tomorrow-theme */
-/* Pretty printing styles. Used with prettify.js. */
-/* SPAN elements with the classes below are added by prettyprint. */
-/* plain text */
-.pln {
- color: #4d4d4c; }
-
-@media screen {
- /* string content */
- .str {
- color: #718c00; }
-
- /* a keyword */
- .kwd {
- color: #8959a8; }
-
- /* a comment */
- .com {
- color: #8e908c; }
-
- /* a type name */
- .typ {
- color: #4271ae; }
-
- /* a literal value */
- .lit {
- color: #f5871f; }
-
- /* punctuation */
- .pun {
- color: #4d4d4c; }
-
- /* lisp open bracket */
- .opn {
- color: #4d4d4c; }
-
- /* lisp close bracket */
- .clo {
- color: #4d4d4c; }
-
- /* a markup tag name */
- .tag {
- color: #c82829; }
-
- /* a markup attribute name */
- .atn {
- color: #f5871f; }
-
- /* a markup attribute value */
- .atv {
- color: #3e999f; }
-
- /* a declaration */
- .dec {
- color: #f5871f; }
-
- /* a variable name */
- .var {
- color: #c82829; }
-
- /* a function name */
- .fun {
- color: #4271ae; } }
-/* Use higher contrast and text-weight for printable form. */
-@media print, projection {
- .str {
- color: #060; }
-
- .kwd {
- color: #006;
- font-weight: bold; }
-
- .com {
- color: #600;
- font-style: italic; }
-
- .typ {
- color: #404;
- font-weight: bold; }
-
- .lit {
- color: #044; }
-
- .pun, .opn, .clo {
- color: #440; }
-
- .tag {
- color: #006;
- font-weight: bold; }
-
- .atn {
- color: #404; }
-
- .atv {
- color: #060; } }
-/* Style */
-/*
-pre.prettyprint {
- background: white;
- font-family: Menlo, Monaco, Consolas, monospace;
- font-size: 12px;
- line-height: 1.5;
- border: 1px solid #ccc;
- padding: 10px; }
-*/
-
-/* Specify class=linenums on a pre to get line numbering */
-ol.linenums {
- margin-top: 0;
- margin-bottom: 0; }
-
-/* IE indents via margin-left */
-li.L0,
-li.L1,
-li.L2,
-li.L3,
-li.L4,
-li.L5,
-li.L6,
-li.L7,
-li.L8,
-li.L9 {
- /* */ }
-
-/* Alternate shading for lines */
-li.L1,
-li.L3,
-li.L5,
-li.L7,
-li.L9 {
- /* */ }
diff --git a/lib/datastore/dataset.js b/lib/datastore/dataset.js
index 66d26a2145e..ed0e71b3db8 100644
--- a/lib/datastore/dataset.js
+++ b/lib/datastore/dataset.js
@@ -1,4 +1,4 @@
-/**
+/*!
* Copyright 2014 Google Inc. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License");
@@ -14,52 +14,52 @@
* limitations under the License.
*/
-/**
+/*!
* @module datastore/dataset
*/
'use strict';
/**
- * @private
* @type module:common/connection
+ * @private
*/
var conn = require('../common/connection.js');
/**
- * @private
* @type module:datastore/entity
+ * @private
*/
var entity = require('./entity.js');
/**
- * @private
* @type module:datastore/pb
+ * @private
*/
var pb = require('./pb.js');
/**
- * @private
* @type module:datastore/query
+ * @private
*/
var Query = require('./query.js');
/**
- * @private
* @type module:datastore/transaction
+ * @private
*/
var Transaction = require('./transaction.js');
/**
- * @private
* @type module:common/util
+ * @private
*/
var util = require('../common/util.js');
/**
* Scopes for Google Datastore access.
- * @private
* @const {array} SCOPES
+ * @private
*/
var SCOPES = [
'https://www.googleapis.com/auth/datastore',
@@ -67,7 +67,7 @@ var SCOPES = [
];
/**
- * Intract with a dataset from the
+ * Interact with a dataset from the
* [Google Cloud Datastore]{@link https://developers.google.com/datastore/}.
*
* @constructor
@@ -158,8 +158,7 @@ Dataset.prototype.createQuery = function(namespace, kinds) {
*
* @borrows {module:datastore/transaction#get} as get
*
- * @param {module:datastore/entity~Key|module:datastore/entity~Key[]} key -
- * Datastore key object(s).
+ * @param {Key|Key[]} key - Datastore key object(s).
* @param {function} callback - The callback function.
*
* @example
@@ -344,8 +343,8 @@ Dataset.prototype.allocateIds = function(incompleteKey, n, callback) {
/**
* Create a new Transaction object using the existing connection and dataset.
*
- * @private
* @return {module:datastore/transaction}
+ * @private
*/
Dataset.prototype.createTransaction_ = function() {
return new Transaction(this.connection, this.id);
diff --git a/lib/datastore/entity.js b/lib/datastore/entity.js
index 5fe63dd2ad6..c73c042836c 100644
--- a/lib/datastore/entity.js
+++ b/lib/datastore/entity.js
@@ -167,7 +167,7 @@ module.exports.entityFromEntityProto = entityFromEntityProto;
* Convert a key protocol object to a Key object.
*
* @param {object} proto - The key protocol object to convert.
- * @return {module:datastore/entity~Key}
+ * @return {Key}
*
* @example
* var key = keyFromKeyProto({
@@ -202,7 +202,7 @@ module.exports.keyFromKeyProto = keyFromKeyProto;
/**
* Convert a Key object to a key protocol object.
*
- * @param {module:datastore/entity~Key} key - The Key object to convert.
+ * @param {Key} key - The Key object to convert.
* @return {object}
*
* @example
@@ -264,7 +264,7 @@ module.exports.keyToKeyProto = keyToKeyProto;
*
* // entityObjects:
* // {
- * // key: {module:datastore/entity~Key},
+ * // key: {},
* // data: {
* // fieldName: 'value'
* // }
@@ -286,7 +286,7 @@ module.exports.formatArray = formatArray;
/**
* Check if a key is complete.
*
- * @param {module:datastore/entity~Key} key - The Key object.
+ * @param {Key} key - The Key object.
* @return {boolean}
*
* @example
diff --git a/lib/datastore/index.js b/lib/datastore/index.js
index 2fb207a0a19..1ee836ac2e6 100644
--- a/lib/datastore/index.js
+++ b/lib/datastore/index.js
@@ -1,4 +1,4 @@
-/**
+/*!
* Copyright 2014 Google Inc. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License");
@@ -14,19 +14,21 @@
* limitations under the License.
*/
-/**
+/*!
* @module datastore
*/
'use strict';
/**
- * @private
* @type module:datastore/entity
+ * @private
*/
var entity = require('./entity');
-/** @alias module:datastore */
+/*!
+ * @alias module:datastore
+ */
var datastore = {};
/**
@@ -44,6 +46,9 @@ datastore.Dataset = require('./dataset');
/**
* Helper function to get a Datastore Integer object.
*
+ * @param {number} value - The integer value.
+ * @return {object}
+ *
* @example
* var gcloud = require('gcloud');
*
@@ -57,6 +62,9 @@ datastore.int = function(value) {
/**
* Helper function to get a Datastore Double object.
*
+ * @param {number} value - The double value.
+ * @return {object}
+ *
* @example
* var gcloud = require('gcloud');
*
diff --git a/lib/datastore/query.js b/lib/datastore/query.js
index 8ec31340510..d86d9e90b9f 100644
--- a/lib/datastore/query.js
+++ b/lib/datastore/query.js
@@ -1,4 +1,4 @@
-/**
+/*!
* Copyright 2014 Google Inc. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License");
@@ -14,12 +14,16 @@
* limitations under the License.
*/
-/**
+/*!
* @module datastore/query
*/
'use strict';
+/**
+ * @type {module:common/util}
+ * @private
+ */
var util = require('../common/util.js');
/**
@@ -110,7 +114,7 @@ Query.prototype.filter = function(filter, value) {
*
* *Reference: {@link http://goo.gl/1qfpkZ}*
*
- * @param {datastore/entity~Key} key - Key object to filter by.
+ * @param {Key} key - Key object to filter by.
* @return {module:datastore/query}
*
* @example
diff --git a/lib/datastore/transaction.js b/lib/datastore/transaction.js
index 68faecfc39e..6c1f512a129 100644
--- a/lib/datastore/transaction.js
+++ b/lib/datastore/transaction.js
@@ -189,7 +189,7 @@ Transaction.prototype.finalize = function(callback) {
* transaction. Get operations require a valid key to retrieve the
* key-identified entity from Datastore.
*
- * @param {module:datastore/entity~Key|module:datastore/entity~Key[]} key -
+ * @param {Key|Key[]} key -
* Datastore key object(s).
* @param {function} callback - The callback function.
*
diff --git a/lib/index.js b/lib/index.js
index 26723947b97..c693970ce71 100644
--- a/lib/index.js
+++ b/lib/index.js
@@ -1,4 +1,4 @@
-/**
+/*!
* Copyright 2014 Google Inc. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License");
@@ -14,13 +14,15 @@
* limitations under the License.
*/
-/**
+/*!
* @module gcloud
*/
'use strict';
-/** @alias module:gcloud */
+/*!
+ * @alias module:gcloud
+ */
var gcloud = {};
/**
@@ -30,9 +32,8 @@ var gcloud = {};
* "Double" representation.
*
* @type {module:datastore}
- * @see {module:datastore}
*
- * @return {object}
+ * @return {module:datastore}
*
* @example
* var gcloud = require('gcloud');
@@ -87,9 +88,8 @@ gcloud.pubsub = require('./pubsub');
* create a bucket.
* @type {module:storage}
- * @see {module:storage}
*
- * @return {object}
+ * @return {module:storage}
*
* @example
* var gcloud = require('gcloud');
diff --git a/lib/storage/index.js b/lib/storage/index.js
index 28fc21a3922..6330947d549 100644
--- a/lib/storage/index.js
+++ b/lib/storage/index.js
@@ -1,4 +1,4 @@
-/**
+/*!
* Copyright 2014 Google Inc. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License");
@@ -14,7 +14,7 @@
* limitations under the License.
*/
-/**
+/*!
* @module storage
*/
@@ -27,44 +27,44 @@ var stream = require('stream');
var uuid = require('node-uuid');
/**
- * @private
* @type module:common/connection
+ * @private
*/
var conn = require('../common/connection.js');
/**
- * @private
* @type module:common/util
+ * @private
*/
var util = require('../common/util.js');
/**
* Required scopes for Google Cloud Storage API.
- * @private
* @const {array}
+ * @private
*/
var SCOPES = ['https://www.googleapis.com/auth/devstorage.full_control'];
/**
- * @private
* @const {string}
+ * @private
*/
var STORAGE_BASE_URL = 'https://www.googleapis.com/storage/v1/b';
/**
- * @private
* @const {string}
+ * @private
*/
var STORAGE_UPLOAD_BASE_URL = 'https://www.googleapis.com/upload/storage/v1/b';
/**
* Readable stream implementation to stream the given buffer.
*
- * @private
- *
* @constructor
*
* @param {buffer} buffer - The buffer to stream.
+ *
+ * @private
*/
function BufferStream(buffer) {
stream.Readable.call(this);
@@ -75,6 +75,7 @@ nodeutil.inherits(BufferStream, stream.Readable);
/**
* Push the provided buffer to the stream.
+ * @private
*/
BufferStream.prototype._read = function() {
this.push(this.data);
@@ -258,13 +259,11 @@ Bucket.prototype.remove = function(name, callback) {
* @return {string}
*
* @example
- * ```js
* var signedUrl = bucket.getSignedUrl({
* action: 'read',
* expires: Math.round(Date.now() / 1000) + (60 * 60 * 24 * 14), // 2 weeks.
* resource: 'my-dog.jpg'
* });
- * ```
*/
Bucket.prototype.getSignedUrl = function(options) {
options.action = {
diff --git a/package.json b/package.json
index 0c7c34e1f10..f73576097f7 100644
--- a/package.json
+++ b/package.json
@@ -54,15 +54,15 @@
},
"devDependencies": {
"coveralls": "^2.11.1",
+ "dox": "^0.4.6",
"istanbul": "^0.3.0",
- "jsdoc": "^3.3.0-alpha9",
"jshint": "^2.5.2",
"mocha": "^1.21.3",
"sandboxed-module": "^1.0.1",
"tmp": "0.0.24"
},
"scripts": {
- "docs": "jsdoc -c .jsdoc.json && cp docs/module-gcloud.html docs/index.html",
+ "docs": "dox < lib/index.js > docs/json/index.json & dox < lib/datastore/dataset.js > docs/json/datastore/dataset.json & dox < lib/datastore/index.js > docs/json/datastore/index.json & dox < lib/datastore/query.js > docs/json/datastore/query.json & dox < lib/storage/index.js > docs/json/storage/index.json",
"lint": "jshint lib/ regression/ test/",
"test": "mocha --recursive --reporter spec",
"regression-test": "mocha regression/datastore.js regression/storage.js --reporter spec --timeout 15000",
+ 
+ Docs
+ 
+ GitHub
+ 
+ StackOverflow
+ 
+ npm
+