Skip to content

Commit 811b6c9

Browse files
docs: publicly document Datastore.dataset - fixes googleapis#547
1 parent 8b3f0cf commit 811b6c9

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

lib/datastore/index.js

+10
Original file line numberDiff line numberDiff line change
@@ -99,6 +99,16 @@ Datastore.dataset = Dataset;
9999
* @param {object=} options - Configuration object.
100100
* @return {module:datastore/dataset}
101101
*/
102+
/**
103+
* Create a Dataset object to reference an existing dataset.
104+
*
105+
* @param {object=} options - [Configuration object](#/docs/?method=gcloud).
106+
* @param {string=} options.apiEndpoint - Override the default API endpoint used
107+
* to reach Datastore. This is useful for connecting to your local Datastore
108+
* server (usually "http://localhost:8080").
109+
* @param {string} options.namespace - Namespace to isolate transactions to.
110+
* @return {module:datastore/dataset}
111+
*/
102112
Datastore.prototype.dataset = function(options) {
103113
options = options || {};
104114
// Mix in global config data to the provided options.

0 commit comments

Comments
 (0)