Skip to content

Instantly share code, notes, and snippets.

@alexilyaev

alexilyaev/objectKeysTyped.md

Last active October 13, 2024 15:19
Show Gist options
  • Save alexilyaev/3fe3e6e6065b9f19450ac52a11209f52 to your computer and use it in GitHub Desktop.
Save alexilyaev/3fe3e6e6065b9f19450ac52a11209f52 to your computer and use it in GitHub Desktop.
Download ZIP
Object.keys() on a typed Object loses it's keys type
Raw
objectKeysTyped.md

Object.keys() on a typed Object loses it's keys type

Playground with examples

How is it different than ts-extra > objectKeys?

Source file

  • Preserves the keys type of a typed object instead of getting a union of the actual keys values (see playground)

TL;DR

/**
 * A strongly-typed version of `Object.keys()`
 *
 * Details:
 * https://gist.github.com/alexilyaev/3fe3e6e6065b9f19450ac52a11209f52
 */
// I don't know how to solve this use case without a type assertion
// eslint-disable-next-line @typescript-eslint/consistent-type-assertions
export const objectKeysTyped = Object.keys as <Type extends object>(
  value: Type
) => (keyof typeof value)[];
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment