googleapis / googleapis/google-cloud-node

Could you modify README.md for streamId of WriterOptions?

Open
#7,520 0 comments 0 reactions 0 assignees View on GitHub
api: bigquery-storage api: bigquerystorage
Dominant language
TypeScript
Stars
3.2k
Forks
712
Avg merge
2d 3h
Merged PRs (30d)
99

Description

### 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

I think it is better to delete streamId in JSONWriter constructor in README.md

README.md is writed about blew.

```javascript
const streamId = connection.getStreamId();

const writer = new JSONWriter({
streamId,
connection,
protoDescriptor,
});
```

But WriterOptions has not streamId of properties and JSONWriter not use streamId.
https://github.com/googleapis/nodejs-bigquery-storage/blob/v5.1.0/src/managedwriter/writer.ts#L36

So, if we use typescript, then it occures error of typescript.

I think it is better to delete streamId of JSONWriter in README.md if we don't use it in the future

Thank you for your reading this issue 🙇

If there is a common understanding and no one is available, I will create a PR for README.md and related documents.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.