How to Get All Keys (Including Symbols) from an Object in JavaScript or Node.js

We recently added a new feature to the @supercharge/map package: create a map from an object. Objects and maps represent key-value pairs. We iterated through the object’s keys to create the related entries in the map.

While iterating through the object keys, we noticed that properties were missing in the used for…in loop. For example, symbols or non-enumerable properties weren’t available in the map. But they were on the object! Why are they missing?

This tutorial shows you how to retrieve all keys of an object, including symbols!

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

Get All Keys Including Symbols From a JavaScript Object

JavaScript objects can have non-enumerable properties. Non-enumerable properties are available when accessing them directly, like obj.nonEnumerableProperty. But these properties won’t show up when looping over an object’s properties using a for…in loop.

You can find more details about an object’s property enumerability in the MDN docs.

A way to iterate through all properties of an object is using the Reflect.ownKeys method. Reflect.ownKeys returns the list of enumerable, non-enumerable, and symbol keys of a given object.

Here’s a sample function returning the keys of a given object:

/**
 * Returns all keys from the given `obj`ect.
 *
 * @returns {Array<string>}
 */
function keysOf(obj) {  
    return Reflect.ownKeys(obj)
}

You may use the keysOf function like this:

const users = {  
  1: 'Marcus',
  'user:2': 'Norman',
  [Symbol.for('christian')]: 'Christian'
}

const keys = keysOf(users)  
// ['1', 'user:2', Symbol(christian)]

Please notice: Reflect.ownKeys() doesn’t return inherited enumerable properties. This can happen when working with class inheritance. You may not retrieve the properties of your base class using this approach with an inherited class instance.

Also, notice that JavaScript coerces all keys to a string. The example contains a key-value pair 1: 'Marcus where the key 1 is a number. Everything is a string when retrieving an object’s keys in JavaScript.

Enjoy!


Mentioned Resources

Explore the Library

Find interesting tutorials and solutions for your problems.