feat(common): broaden types in StreamableFile constructor #9103
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.
PR Checklist
Please check if your PR fulfills the following requirements:
PR Type
What kind of change does this PR introduce?
What is the current behavior?
Issue Number: N/A
The
StreamableFile
constructor supports using aNodeJS.Buffer
when passing a buffer (as opposed to a readable stream).What is the new behavior?
The
StreamableFile
constructor accepts aUint8Array
when passing a buffer.The parameter is checked using
util
'stypes.isUint8Array
function, added in Node.js v10.0.0.Does this PR introduce a breaking change?
Other information
NodeJS.Buffer
extendsUint8Array
so this will not affect existing code that usesNodeJS.Buffer
instances.Supporting broader types for parameters is generally good because it makes it easier for developers to take advantage of Nest's features.
Specifically, allowing
Uint8Array
s in addition toNodeJS.Buffer
s makes it much easier to pass data buffers from WASM directly toStreamableFile
without needing to pass them throughBuffer.from
beforehand.