docs: add gaxios and node 18 migration guide#15
Open
thiyaguk09 wants to merge 31 commits into
Open
Conversation
…sport (googleapis#8283) - Remove Service.ts and common.ts files from handwritten/storage - Migrate remaining functionality to StorageTransport - chore(ci): upgrade conformance tests to Node 18
There was a problem hiding this comment.
Code Review
This pull request introduces a migration guide for transitioning from @google-cloud/storage v7 to v8, detailing breaking changes such as the shift to standard Headers objects and updated URL resolution logic. The review feedback identifies syntax errors in the documentation's code examples where variable shadowing would cause a ReferenceError and suggests adding context regarding Node.js 18 requirements and its relationship to native web APIs.
15bf4ba to
3b2a681
Compare
|
|
||
| ### 2. Passing Headers in Options | ||
|
|
||
| If you pass custom headers in options to Storage methods (which extend `GaxiosOptions`), you can still pass plain objects, as the Storage library will convert them to standard `Headers` internally for the request. However, if you read them back from the prepared options or response, they will be `Headers` objects. |
Collaborator
There was a problem hiding this comment.
add examples for 2 and 3 as well
|
|
||
| ## Troubleshooting | ||
|
|
||
| - If you encounter `undefined` when accessing headers on the response object, ensure you are using `apiResponse.headers.get('header-name')`. |
Collaborator
There was a problem hiding this comment.
gaxios is indirect dependency?
Owner
Author
There was a problem hiding this comment.
no, it's direct dependency.
…sport (googleapis#8283) - Remove Service.ts and common.ts files from handwritten/storage - Migrate remaining functionality to StorageTransport - chore(ci): upgrade conformance tests to Node 18
72c17d7 to
eacb087
Compare
…ios-migration-guide
…ios-migration-guide
…sport (googleapis#8283) - Remove Service.ts and common.ts files from handwritten/storage - Migrate remaining functionality to StorageTransport - chore(ci): upgrade conformance tests to Node 18
eacb087 to
0c58a9a
Compare
…ios-migration-guide
…sport (googleapis#8283) - Remove Service.ts and common.ts files from handwritten/storage - Migrate remaining functionality to StorageTransport - chore(ci): upgrade conformance tests to Node 18
0c58a9a to
fe44861
Compare
…ios-migration-guide
…sport (googleapis#8283) - Remove Service.ts and common.ts files from handwritten/storage - Migrate remaining functionality to StorageTransport - chore(ci): upgrade conformance tests to Node 18
fe44861 to
0a4f5ac
Compare
…ios-migration-guide
…sport (googleapis#8283) - Remove Service.ts and common.ts files from handwritten/storage - Migrate remaining functionality to StorageTransport - chore(ci): upgrade conformance tests to Node 18
0a4f5ac to
e3288e3
Compare
…ios-migration-guide
…sport (googleapis#8283) - Remove Service.ts and common.ts files from handwritten/storage - Migrate remaining functionality to StorageTransport - chore(ci): upgrade conformance tests to Node 18
e3288e3 to
1fba172
Compare
…ios-migration-guide
…sport (googleapis#8283) - Remove Service.ts and common.ts files from handwritten/storage - Migrate remaining functionality to StorageTransport - chore(ci): upgrade conformance tests to Node 18
1fba172 to
d4b912f
Compare
…ios-migration-guide
…sport (googleapis#8283) - Remove Service.ts and common.ts files from handwritten/storage - Migrate remaining functionality to StorageTransport - chore(ci): upgrade conformance tests to Node 18
d4b912f to
c0a6220
Compare
…ios-migration-guide
c0a6220 to
0f2652b
Compare
…ios-migration-guide
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Thank you for opening a Pull Request! Before submitting your PR, there are a few things you can do to make sure it goes smoothly:
Fixes #<issue_number_goes_here> 🦕