Skip to content

chore: Clean-up Documentation for Mapped SnakeCased Properties #516

@danielbankhead

Description

@danielbankhead

Today, we manually document mapped snakeCase'd keys in a number of places to improve ergonomics for customers manually instantiating AuthClients as of googleapis/google-auth-library-nodejs#1663.

At the time of writing, keys remapped via as do not pass the original keys' jsdoc, requiring us to manually write the documentation for each key. Once this has been resolved on the TypeScript side we should clean up the documentation and types throughout the library.

Implementation Notes:

  • Most places where this is a problem should reference this issue's id; it is best to start there.

Dependencies:

Metadata

Metadata

Assignees

No one assigned

    Labels

    priority: p3Desirable enhancement or fix. May not be included in next release.type: cleanupAn internal cleanup or hygiene concern.

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions