Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs(NODE-4349): add note about Binary(string) behavior #504

Merged
merged 2 commits into from
Jun 29, 2022
Merged

docs(NODE-4349): add note about Binary(string) behavior #504

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
63be862
chore(NODE-4349): add note about Binary(string) behavior
addaleax Jun 28, 2022
b6e372a
fixup: adjust ts docs for unrecognized tag warning
addaleax Jun 28, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions src/binary.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,13 @@ export class Binary {
position!: number;

/**
* Create a new Binary instance.
*
* This constructor can accept a string as its first argument. In this case,
* this string will be encoded using ISO-8859-1, **not** using UTF-8.
* This is almost certainly not what you want. Use `new Binary(Buffer.from(string))`
* instead to convert the string to a Buffer using UTF-8 first.
*
* @param buffer - a buffer object containing the binary data.
* @param subType - the option binary type.
*/
Expand Down