docs: Improve documentation around options, especially metadata #161

ryanseys · 2014-09-01T03:06:04Z

Had the read the code to easily see what values I could pass into options like below. Shouldn't have to read the code.

var options = {
  data: data, // png image data
  metadata: {
    contentType: 'image/png'
  }
};

bucket.write('image.png', options, callback);

stephenplusplus · 2014-09-01T15:42:44Z

The docs could definitely use help. JSDoc is our "source of doc truth", so PRs welcome to better annotate parameters, describe functionality, etc.

stephenplusplus · 2014-09-19T13:25:19Z

a47cc9b

Feel free to add more if you think it can be improved.

* updated CHANGELOG.md * updated package.json * updated samples/package.json

fix: use google-gax v3.3.0 Source-Link: googleapis/synthtool@c73d112 Post-Processor: gcr.io/cloud-devrel-public-resources/owlbot-nodejs:latest@sha256:b15a6f06cc06dcffa11e1bebdf1a74b6775a134aac24a0f86f51ddf728eb373e

This PR contains the following updates: | Package | Type | Update | Change | |---|---|---|---| | [ts-loader](https://togithub.com/TypeStrong/ts-loader) | devDependencies | major | [`^7.0.0` -> `^8.0.0`](https://renovatebot.com/diffs/npm/ts-loader/7.0.5/8.0.0) | --- ### Release Notes <details> <summary>TypeStrong/ts-loader</summary> ### [`v8.0.0`](https://togithub.com/TypeStrong/ts-loader/blob/master/CHANGELOG.md#v800) [Compare Source](https://togithub.com/TypeStrong/ts-loader/compare/v7.0.5...v8.0.0) - [Support for symlinks in project references](https://togithub.com/TypeStrong/ts-loader/pull/1136) - thanks [@sheetalkamat](https://togithub.com/sheetalkamat)! - `ts-loader` now supports TypeScript 3.6 and greater **BREAKING CHANGE** </details> --- ### Renovate configuration :date: **Schedule**: "after 9am and before 3pm" (UTC). :vertical_traffic_light: **Automerge**: Disabled by config. Please merge this manually once you are satisfied. :recycle: **Rebasing**: Whenever PR is behind base branch, or you tick the rebase/retry checkbox. :no_bell: **Ignore**: Close this PR and you won't be reminded about this update again. --- - [ ] If you want to rebase/retry this PR, check this box --- This PR has been generated by [WhiteSource Renovate](https://renovate.whitesourcesoftware.com). View repository job log [here](https://app.renovatebot.com/dashboard#googleapis/nodejs-phishing-protection).

* feat: support regapic LRO Use gapic-generator-typescript v2.15.1. PiperOrigin-RevId: 456946341 Source-Link: googleapis/googleapis@88fd18d Source-Link: googleapis/googleapis-gen@accfa37 Copy-Tag: eyJwIjoiLmdpdGh1Yi8uT3dsQm90LnlhbWwiLCJoIjoiYWNjZmEzNzFmNjY3NDM5MzEzMzM1YzY0MDQyYjA2M2MxYzUzMTAyZSJ9 * 🦉 Updates from OwlBot post-processor See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com>

@alexander-fenster

The library is regenerated with gapic-generator-typescript v1.3.1. Committer: @alexander-fenster PiperOrigin-RevId: 372468161 Source-Link: googleapis/googleapis@75880c3 Source-Link: googleapis/googleapis-gen@77b1804

[![WhiteSource Renovate](https://app.renovatebot.com/images/banner.svg)](https://renovatebot.com) This PR contains the following updates: | Package | Change | Age | Adoption | Passing | Confidence | |---|---|---|---|---|---| | [@types/node](https://togithub.com/DefinitelyTyped/DefinitelyTyped) | [`^14.0.22` -> `^16.0.0`](https://renovatebot.com/diffs/npm/@types%2fnode/14.17.32/16.11.6) | [![age](https://badges.renovateapi.com/packages/npm/@types%2fnode/16.11.6/age-slim)](https://docs.renovatebot.com/merge-confidence/) | [![adoption](https://badges.renovateapi.com/packages/npm/@types%2fnode/16.11.6/adoption-slim)](https://docs.renovatebot.com/merge-confidence/) | [![passing](https://badges.renovateapi.com/packages/npm/@types%2fnode/16.11.6/compatibility-slim/14.17.32)](https://docs.renovatebot.com/merge-confidence/) | [![confidence](https://badges.renovateapi.com/packages/npm/@types%2fnode/16.11.6/confidence-slim/14.17.32)](https://docs.renovatebot.com/merge-confidence/) | --- ### Configuration 📅 **Schedule**: "after 9am and before 3pm" (UTC). 🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied. ♻ **Rebasing**: Whenever PR is behind base branch, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about this update again. --- - [ ] If you want to rebase/retry this PR, click this checkbox. --- This PR has been generated by [WhiteSource Renovate](https://renovate.whitesourcesoftware.com). View repository job log [here](https://app.renovatebot.com/dashboard#github/googleapis/nodejs-analytics-admin).

- [ ] Regenerate this pull request now. PiperOrigin-RevId: 468790263 Source-Link: googleapis/googleapis@873ab45 Source-Link: googleapis/googleapis-gen@cb6f37a Copy-Tag: eyJwIjoiLmdpdGh1Yi8uT3dsQm90LnlhbWwiLCJoIjoiY2I2ZjM3YWVmZjJhMzQ3MmU0MGE3YmJhY2U4YzY3ZDc1ZTI0YmVlNSJ9

[![Mend Renovate](https://app.renovatebot.com/images/banner.svg)](https://renovatebot.com) This PR contains the following updates: | Package | Change | Age | Adoption | Passing | Confidence | |---|---|---|---|---|---| | [@types/node](https://togithub.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/node) ([source](https://togithub.com/DefinitelyTyped/DefinitelyTyped)) | [`^16.0.0` -> `^18.0.0`](https://renovatebot.com/diffs/npm/@types%2fnode/16.18.3/18.11.9) | [![age](https://badges.renovateapi.com/packages/npm/@types%2fnode/18.11.9/age-slim)](https://docs.renovatebot.com/merge-confidence/) | [![adoption](https://badges.renovateapi.com/packages/npm/@types%2fnode/18.11.9/adoption-slim)](https://docs.renovatebot.com/merge-confidence/) | [![passing](https://badges.renovateapi.com/packages/npm/@types%2fnode/18.11.9/compatibility-slim/16.18.3)](https://docs.renovatebot.com/merge-confidence/) | [![confidence](https://badges.renovateapi.com/packages/npm/@types%2fnode/18.11.9/confidence-slim/16.18.3)](https://docs.renovatebot.com/merge-confidence/) | --- ### Configuration 📅 **Schedule**: Branch creation - "after 9am and before 3pm" (UTC), Automerge - At any time (no schedule defined). 🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied. ♻ **Rebasing**: Whenever PR is behind base branch, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about this update again. --- - [ ] If you want to rebase/retry this PR, check this box --- This PR has been generated by [Mend Renovate](https://www.mend.io/free-developer-tools/renovate/). View repository job log [here](https://app.renovatebot.com/dashboard#github/googleapis/nodejs-service-control).

[![Mend Renovate](https://app.renovatebot.com/images/banner.svg)](https://renovatebot.com) This PR contains the following updates: | Package | Change | Age | Adoption | Passing | Confidence | |---|---|---|---|---|---| | [jsdoc](https://togithub.com/jsdoc/jsdoc) | [`^3.6.6` -> `^4.0.0`](https://renovatebot.com/diffs/npm/jsdoc/3.6.11/4.0.0) | [![age](https://badges.renovateapi.com/packages/npm/jsdoc/4.0.0/age-slim)](https://docs.renovatebot.com/merge-confidence/) | [![adoption](https://badges.renovateapi.com/packages/npm/jsdoc/4.0.0/adoption-slim)](https://docs.renovatebot.com/merge-confidence/) | [![passing](https://badges.renovateapi.com/packages/npm/jsdoc/4.0.0/compatibility-slim/3.6.11)](https://docs.renovatebot.com/merge-confidence/) | [![confidence](https://badges.renovateapi.com/packages/npm/jsdoc/4.0.0/confidence-slim/3.6.11)](https://docs.renovatebot.com/merge-confidence/) | --- ### Release Notes <details> <summary>jsdoc/jsdoc</summary> ### [`v4.0.0`](https://togithub.com/jsdoc/jsdoc/blob/HEAD/CHANGES.md#400-November-2022) [Compare Source](https://togithub.com/jsdoc/jsdoc/compare/3.6.11...084218523a7d69fec14a852ce680f374f526af28) - JSDoc releases now use [semantic versioning](https://semver.org/). If JSDoc makes backwards-incompatible changes in the future, the major version will be incremented. - JSDoc no longer uses the [`taffydb`](https://taffydb.com/) package. If your JSDoc template or plugin uses the `taffydb` package, see the [instructions for replacing `taffydb` with `@jsdoc/salty`](https://togithub.com/jsdoc/jsdoc/tree/main/packages/jsdoc-salty#use-salty-in-a-jsdoc-template). - JSDoc now supports Node.js 12.0.0 and later. </details> --- ### Configuration 📅 **Schedule**: Branch creation - "after 9am and before 3pm" (UTC), Automerge - At any time (no schedule defined). 🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied. ♻ **Rebasing**: Whenever PR is behind base branch, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about this update again. --- - [ ] If you want to rebase/retry this PR, check this box --- This PR has been generated by [Mend Renovate](https://www.mend.io/free-developer-tools/renovate/). View repository job log [here](https://app.renovatebot.com/dashboard#github/googleapis/nodejs-managed-identities).

This PR contains the following updates: | Package | Type | Update | Change | |---|---|---|---| | [ts-loader](https://togithub.com/TypeStrong/ts-loader) | devDependencies | major | [`^6.2.1` -> `^7.0.0`](https://renovatebot.com/diffs/npm/ts-loader/6.2.2/7.0.0) | --- ### Release Notes <details> <summary>TypeStrong/ts-loader</summary> ### [`v7.0.0`](https://togithub.com/TypeStrong/ts-loader/blob/master/CHANGELOG.md#v700) [Compare Source](https://togithub.com/TypeStrong/ts-loader/compare/v6.2.2...v7.0.0) - [Project reference support enhancements](https://togithub.com/TypeStrong/ts-loader/pull/1076) - thanks [@sheetalkamat](https://togithub.com/sheetalkamat)! - Following the end of life of Node 8, `ts-loader` no longer supports Node 8 **BREAKING CHANGE** </details> --- ### Renovate configuration :date: **Schedule**: "after 9am and before 3pm" (UTC). :vertical_traffic_light: **Automerge**: Disabled by config. Please merge this manually once you are satisfied. :recycle: **Rebasing**: Whenever PR is behind base branch, or you tick the rebase/retry checkbox. :no_bell: **Ignore**: Close this PR and you won't be reminded about this update again. --- - [ ] If you want to rebase/retry this PR, check this box --- This PR has been generated by [WhiteSource Renovate](https://renovate.whitesourcesoftware.com). View repository job log [here](https://app.renovatebot.com/dashboard#googleapis/nodejs-recaptcha-enterprise).

Co-authored-by: release-please[bot] <55107282+release-please[bot]@users.noreply.github.com>

🤖 I have created a release \*beep\* \*boop\* --- ### [1.7.3](https://www.github.com/googleapis/nodejs-ai-platform/compare/v1.7.2...v1.7.3) (2021-06-29) ### Bug Fixes * add C#, PHP and Ruby options for all AI Platform protos ([#158](https://www.github.com/googleapis/nodejs-ai-platform/issues/158)) ([da0babf](https://www.github.com/googleapis/nodejs-ai-platform/commit/da0babf54c6b074b8dc3d0354f8a57b9bc0cefc1)) * **deps:** google-gax v2.17.0 with mTLS ([#161](https://www.github.com/googleapis/nodejs-ai-platform/issues/161)) ([8e7d46f](https://www.github.com/googleapis/nodejs-ai-platform/commit/8e7d46f1252c4e89a663dd28b70b49bf269f091a)) --- This PR was generated with [Release Please](https://github.com/googleapis/release-please). See [documentation](https://github.com/googleapis/release-please#release-please).

ryanseys added this to the M2: bigquery & pubsub milestone Sep 18, 2014

stephenplusplus closed this as completed in a47cc9b Sep 19, 2014

jgeewax added the docs label Feb 2, 2015

jgeewax modified the milestones: Core Stable, M2: bigquery & pubsub Feb 2, 2015

yoshi-automation added triage me I really want to be triaged. 🚨 This issue needs some love. labels Apr 6, 2020

snyk-bot mentioned this issue May 21, 2020

[Snyk] Upgrade google-proto-files from 0.1.1 to 0.20.0 aknuds1/gcloud-node#1

Open

JustinBeckwith assigned stephenplusplus Feb 1, 2021

chingor13 pushed a commit that referenced this issue Aug 22, 2022

chore: release 1.1.1 (#161)

01b42cb

* updated CHANGELOG.md * updated package.json * updated samples/package.json

release-please bot mentioned this issue Sep 14, 2022

chore: release main #3352

Merged

sofisl mentioned this issue Oct 11, 2022

migrate code from googleapis/nodejs-language #3395

Merged

4 tasks

sofisl pushed a commit that referenced this issue Oct 11, 2022

chore: update eslintignore config (#161)

5230c6e

sofisl pushed a commit that referenced this issue Oct 12, 2022

fix(deps): update dependency @google-cloud/common to ^0.28.0 (#161)

c002fcd

This was referenced Oct 12, 2022

migrate code from googleapis/nodejs-resource-manager #3402

Merged

migrate code from googleapis/nodejs-phishing-protection #3406

Merged

sofisl mentioned this issue Oct 13, 2022

migrate code from googleapis/nodejs-memcache #3412

Merged

4 tasks

sofisl pushed a commit that referenced this issue Oct 13, 2022

chore(cloud-rad): delete api-extractor config (#161)

9bc6699

sofisl mentioned this issue Oct 13, 2022

migrate code from googleapis/nodejs-bigquery-reservation #3413

Merged

4 tasks

release-please bot mentioned this issue Oct 13, 2022

chore: release main #3427

Merged

sofisl pushed a commit that referenced this issue Oct 13, 2022

chore: update eslintignore config (#161)

456d719

sofisl pushed a commit that referenced this issue Nov 10, 2022

fix(deps): update dependency google-gax to ^0.25.0 (#161)

cea42e5

This was referenced Nov 10, 2022

migrate code from googleapis/nodejs-tasks #3530

Merged

migrate code from googleapis/nodejs-cloud-container #3543

Merged

sofisl mentioned this issue Nov 11, 2022

migrate code from googleapis/nodejs-gke-hub #3579

Merged

4 tasks

sofisl pushed a commit that referenced this issue Nov 11, 2022

fix(deps): use google-gax v3.5.2 (#161)

9bd2131

This was referenced Nov 11, 2022

migrate code from googleapis/nodejs-dataproc-metastore #3580

Merged

migrate code from googleapis/nodejs-bigquery-storage #3599

Merged

sofisl mentioned this issue Nov 11, 2022

migrate code from googleapis/nodejs-analytics-admin #3600

Merged

4 tasks

sofisl mentioned this issue Nov 11, 2022

migrate code from googleapis/nodejs-kms #3601

Merged

4 tasks

sofisl pushed a commit that referenced this issue Nov 11, 2022

build: add new kokoro config for coverage and release-please (#161)

e070449

This was referenced Nov 11, 2022

migrate code from googleapis/nodejs-service-management #3608

Merged

migrate code from googleapis/nodejs-service-control #3609

Merged

sofisl mentioned this issue Nov 16, 2022

migrate code from googleapis/nodejs-managed-identities #3642

Merged

4 tasks

sofisl pushed a commit that referenced this issue Nov 16, 2022

fix(deps): use google-gax v3.5.2 (#161)

6d76922

sofisl mentioned this issue Nov 16, 2022

migrate code from googleapis/nodejs-network-connectivity #3643

Merged

4 tasks

This was referenced Nov 16, 2022

migrate code from googleapis/nodejs-recaptcha-enterprise #3645

Merged

migrate code from googleapis/nodejs-retail #3648

Merged

sofisl pushed a commit that referenced this issue Nov 16, 2022

chore(main): release 1.7.0 (#161)

e984a3b

Co-authored-by: release-please[bot] <55107282+release-please[bot]@users.noreply.github.com>

sofisl mentioned this issue Nov 30, 2022

migrate code from googleapis/nodejs-datacatalog #3689

Merged

4 tasks

sofisl pushed a commit that referenced this issue Nov 30, 2022

docs: update jsdoc annotations (#161)

f0d9b17

sofisl pushed a commit that referenced this issue Jan 24, 2023

Retry npm install in CI (#161)

9e5ed52

sofisl pushed a commit that referenced this issue Jan 25, 2023

Retry npm install in CI (#161)

ed177d8

sofisl pushed a commit that referenced this issue Jan 26, 2023

fix(deps): google-gax v2.17.0 with mTLS (#161)

120cb4a

sofisl mentioned this issue Jan 26, 2023

migrate code from googleapis/nodejs-ai-platform #3892

Merged

4 tasks

sofisl pushed a commit that referenced this issue Sep 14, 2023

refactor: reduce the number of deps (#161)

e205a79

sofisl mentioned this issue Sep 14, 2023

migrate code from googleapis/nodejs-dns #4657

Merged

4 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docs: Improve documentation around options, especially metadata #161

docs: Improve documentation around options, especially metadata #161

ryanseys commented Sep 1, 2014

stephenplusplus commented Sep 1, 2014

stephenplusplus commented Sep 19, 2014

docs: Improve documentation around options, especially metadata #161

docs: Improve documentation around options, especially metadata #161

Comments

ryanseys commented Sep 1, 2014

stephenplusplus commented Sep 1, 2014

stephenplusplus commented Sep 19, 2014