googleapis / googleapis/google-api-nodejs-client

Docs don't match types

Offen
#3,790 0 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen
size: s type: docs
Vorherrschende Sprache
TypeScript
Sterne
12.2k
Forks
2k
Ø Merge
1 T. 9 Std.
Gemergte PRs (30 T.)
24

Beschreibung

### Please make sure you have searched for information in the following guides.

- [x] Search the issues already opened: https://github.com/GoogleCloudPlatform/google-cloud-node/issues
- [x] Check our Troubleshooting guide: https://googlecloudplatform.github.io/google-cloud-node/#/docs/guides/troubleshooting
- [x] Check our FAQ: https://googlecloudplatform.github.io/google-cloud-node/#/docs/guides/faq
- [x] Check our libraries HOW-TO: https://github.com/googleapis/gax-nodejs/blob/main/client-libraries.md
- [x] Check out our authentication guide: https://github.com/googleapis/google-auth-library-nodejs
- [x] Check out handwritten samples for many of our APIs: https://github.com/GoogleCloudPlatform/nodejs-docs-samples

### Documentation Request

The npm docs at: https://www.npmjs.com/package/googleapis#oauth2-client

say to use the googleapi oauth client like:

`
const oauth2Client = new google.auth.OAuth2(
YOUR_CLIENT_ID,
YOUR_CLIENT_SECRET,
YOUR_REDIRECT_URL
);
`

But in VS code that is marked as deprecated in the types, in favor of using a config object. Maybe the docs on npm need to be updated?

Also, your checklist before submitting an issue says to go to this url:

https://googlecloudplatform.github.io/google-cloud-node/#/docs/guides/troubleshooting

But when I went there I got a 404.

I also got a 404 for this FAQ link:

https://googlecloudplatform.github.io/google-cloud-node/#/docs/guides/faq

At this URL they show using the config object. Maybe link to this from the npm docs?

https://github.com/googleapis/google-auth-library-nodejs

Beitragsleitfaden

Beitragsleitfaden öffnen

Rechercherichtung

Vergleiche die Dokumentation des npm-Pakets OAuth2 mit den aktuellen TypeScript-Typen und überprüfe die in diesem issue zitierten URLs zur Fehlerbehebung und zu den FAQ. Aktualisiere das constructor-Beispiel und die defekten Links, damit die Dokumentation der unterstützten Konfiguration entspricht und erfolgreich aufgelöst wird.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
nodejs, typescript
Bereich
authentication, documentation
Issue-Typ
Dokumentation
Schwierigkeit
2/5
Geschätzter Aufwand
1-3 Stunden
Aktivitätsstatus
Veraltet
Klarheit
Größtenteils klar
Anfängerfreundlichkeit
45/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.