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

mongodb · Jun 29, 2022 · 5475378 · 5475378
1 parent 9613021
commit 5475378
Showing 1 changed file with 7 additions and 0 deletions.
diff --git a/src/binary.ts b/src/binary.ts
@@ -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.
    */