Node.js — Convert a String to Buffer

When working with Node.js’ crypto module you sometimes need to provide Buffer instances as an argument. For example, the timingSafeEqual function accepts two buffer arguments for comparison. Sometimes your raw values are strings and you need to convert them before using them in your application code.

This tutorial shows you how to convert a string value to a buffer in Node.js.

Node.js Series Overview

  1. String Replace All Appearances
  2. Remove All Whitespace From a String in JavaScript
  3. Generate a Random ID or String in Node.js or JavaScript
  4. Remove Extra Spaces From a String in JavaScript or Node.js
  5. Remove Numbers From a String in JavaScript or Node.js
  6. Get the Part Before a Character in a String in JavaScript or Node.js
  7. Get the Part After a Character in a String in JavaScript or Node.js
  8. How to Check if a Value is a String in JavaScript or Node.js
  9. Check If a String Includes All Strings in JavaScript/Node.js/TypeScript
  10. Check if a Value is a String in JavaScript and Node.js
  11. Limit and Truncate a String to a Given Length in JavaScript and Node.js
  12. Split a String into a List of Characters in JavaScript and Node.js
  13. How to Generage a UUID in Node.js
  14. Reverse a String in JavaScript or Node.js
  15. Split a String into a List of Lines in JavaScript or Node.js
  16. Split a String into a List of Words in JavaScript or Node.js
  17. Detect if a String is in camelCase Format in Javascript or Node.js
  18. Check If a String Is in Lowercase in JavaScript or Node.js
  19. Check If a String is in Uppercase in JavaScript or Node.js
  20. Get the Part After First Occurrence in a String in JavaScript or Node.js
  21. Get the Part Before First Occurrence in a String in JavaScript or Node.js
  22. Get the Part Before Last Occurrence in a String in JavaScript or Node.js
  23. Get the Part After Last Occurrence in a String in JavaScript or Node.js
  24. How to Count Words in a File
  25. How to Shuffle the Characters of a String in JavaScript or Node.js
  26. Append Characters or Words to a String in JavaScript or Node.js
  27. Check if a String is Empty in JavaScript or Node.js
  28. Ensure a String Ends with a Given Character in JavaScript or Node.js
  29. Left-Trim Characters Off a String in JavaScript or Node.js
  30. Right-Trim Characters Off a String in JavaScript or Node.js
  31. Lowercase the First Character of a String in JavaScript or Node.js
  32. Uppercase the First Character of a String in JavaScript or Node.js
  33. Prepend Characters or Words to a String in JavaScript or Node.js
  34. Check if a String is a Number
  35. Convert a String to Buffer
  36. Prevent Line Breaks in String Template Literals
  37. How to Implement a Custom `toString` Method (Coming soon)
  38. What Is `Symbol.toStringTag` and How to Use It (Coming soon)

Create Buffer From String in Node.js

Buffers in Node.js are used to represent a fixed-length sequence of bytes. As mentioned, some of the Node.js internals work with buffers. You may need to convert your input values to buffer instances before using them.

In Node.js you can typically use the static Buffer.from() method to create a buffer from a given input value:

const buffer = Buffer.from('your string value', 'utf8')  

The second argument to Buffer.from(input, encoding) is the encoding of your input value. In case you’re working with a different encoding than UTF-8, you can provide it there. Node.js supports a variety of encoding, like ascii, hex, base64, and so on.

If you want to make sure you’re properly using string inputs to create your buffers, you may build yourself a small utility function that checks the type of the input parameter:

/**
 * Converts the given `string` value to a buffer.
 * 
 * @param {String} input
 * @param {BufferEncoding|undefined} encoding
 *
 * @returns {Buffer}
 */
function stringToBuffer(input, encoding = 'utf8') {  
  if (typeof input !== 'string') {
    throw new TypeError(`You must provide a string value to "toBuffer". Received "${typeof input}"`)
  }

  return Buffer.from(input, encoding)
}

There’s a related tutorial here on Future Studio tutorial where we walk you through the process of creating a base64-encoded string in Node.js using Buffers, too.

Enjoy buffers!


Mentioned Resources

Explore the Library

Find interesting tutorials and solutions for your problems.