Skip to content

docs: Improve documentation around options, especially metadata #161

Description

@ryanseys

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);

Activity

  1. stephenplusplus commented on Sep 1, 2014

    @stephenplusplus
    Contributor

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

  2. added this to the milestone on Sep 18, 2014
  3. stephenplusplus commented on Sep 19, 2014

    @stephenplusplus
    Contributor

    a47cc9b

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

  4. modified the milestones: Core Stable, on Feb 2, 2015
  5. added a commit that references this issue on Aug 22, 2022
  6. 55 remaining items

  7. added a commit that references this issue on Mar 27, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Labels

🚨This issue needs some love.triage meI really want to be triaged.

Type

No type

Projects

No projects

    Milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions