Skip to content

Commit cdd4138

Browse files
Merge pull request #371 from ryanseys/rs-bucket-metadata
Clarify bucket metadata example
2 parents 5284a39 + 5826a2f commit cdd4138

1 file changed

Lines changed: 6 additions & 4 deletions

File tree

lib/storage/bucket.js

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -322,11 +322,13 @@ Bucket.prototype.getMetadata = function(callback) {
322322
* @param {function=} callback - The callback function.
323323
*
324324
* @example
325+
* //-
326+
* // Set website metadata field on the bucket.
327+
* //-
325328
* bucket.setMetadata({
326-
* contentType: 'application/x-font-ttf',
327-
* metadata: {
328-
* my: 'custom',
329-
* properties: 'go here'
329+
* website: {
330+
* mainPageSuffix: 'http://example.com',
331+
* notFoundPage: 'http://example.com/404.html'
330332
* }
331333
* }, function(err, metadata) {});
332334
*/

0 commit comments

Comments
 (0)