ts-enum-utilx

Strictly typed utilities for working with TypeScript enums inspired by ts-enum-util.

Install

# npm
npm install ts-enum-utilx

# Yarn
yarn add ts-enum-utilx

# pnpm
pnpm add ts-enum-utilx
Copy

Differences from ts-enum-util

• Smaller Bundle Size: ts-enum-utilx has a much smaller bundle size and is fully tree-shakable.
• Functional Programming Approach: Supports currying and functional programming paradigms.
• Streamlined API: Provides a set of essential functions without a wrapper class, making it more intuitive and easier to use. Additional functionalities can be easily achieved using modern JavaScript features or simple invariant libraries like tiny-invariant.

Usage

Basic setup

Namespace import is recommended for better tree-shaking:

import * as E from "ts-enum-utilx";

enum Answer {
  No = 0,
  Yes = "YES",
}
Copy

size

Get the number of keys in the enum:

E.size(Answer);
// => 2
Copy

keys

Get an iterable of the enum keys:

const iter = E.keys(Answer);
//    ^? IterableIterator<"No" | "Yes">

[...E.keys(Answer)];
// => ["No", "Yes"]
Copy

values

Get an iterable of the enum values:

const iter = E.values(Answer);
//    ^? IterableIterator<Answer>

[...E.values(Answer)];
// => [0, "YES"]
Copy

entries

Get an iterable of key-value pairs:

const iter = E.entries(Answer);
//    ^? IterableIterator<[("No" | "Yes"), Answer]>

[...E.entries(Answer)];
// => [["No", 0], ["Yes", "YES"]]
Copy

value

Get the value associated with a key:

E.value(Answer, "No");
// => 0

E.value(Answer, "Unknown");
// => undefined

const getValue = E.value(Answer);
//    ^? (key: Nullable<string>) => Answer | undefined

getValue("Yes");
// => "YES"
Copy

key

Get the key associated with a value:

E.key(Answer, 0);
// => "No"

E.key(Answer, "Unknown");
// => undefined

const getKey = E.key(Answer);
//    ^? (value: Nullable<string | number>) => "No" | "Yes" | undefined

getKey("YES");
// => "Yes"
Copy

The key function is type-safe and will only accept values that are assignable to the enum values.

enum NumberEnum {
  One = 1,
}

// @ts-expect-error: Argument of type '"A"' is not assignable to parameter of type 'Nullable<number>'
E.key(NumberEnum, "A");

enum StringEnum {
  A = "A",
}

// @ts-expect-error: Argument of type '1' is not assignable to parameter of type 'Nullable<string>'
E.key(StringEnum, 1);

enum HetEnum {
  A = 1,
  B = "B",
}

// @ts-expect-error: Argument of type 'true' is not assignable to parameter of type 'Nullable<string | number>'
E.key(HetEnum, true);
Copy

isKey

Check if a string is a key in the enum:

E.isKey(Answer, "No");
// => true

const key: string = "No";

if (E.isKey(Answer, key)) {
  console.log(key);
  //          ^? "No" | "Yes"
}

const isKey = E.isKey(Answer);
//    ^? (key: Nullable<string>) => key is "No" | "Yes"

isKey("Yes");
// => true
Copy

isValue

Check if a value is in the enum:

E.isValue(Answer, 0);
// => true

const value: string | number = 0;

if (E.isValue(Answer, value)) {
  console.log(value);
  //          ^? Answer
}

const isValue = E.isValue(Answer);
//    ^? (value: Nullable<string | number>) => value is Answer

isValue("YES");
// => true
Copy

The isValue function is type-safe and will only accept values that are assignable to the enum values.

enum NumberEnum {
  One = 1,
}

// @ts-expect-error: Argument of type '"A"' is not assignable to parameter of type 'Nullable<number>'.
E.isValue(NumberEnum, "A");

enum StringEnum {
  A = "A",
}

// @ts-expect-error: Argument of type '1' is not assignable to parameter of type 'Nullable<string>'.
E.isValue(StringEnum, 1);

enum HetEnum {
  A = 1,
  B = "B",
}

// @ts-expect-error: Argument of type 'true' is not assignable to parameter of type 'Nullable<string | number>'.
E.isValue(HetEnum, true);
Copy

forEach

Iterate over the enum:

E.forEach(Answer, (value, key, enumObj) => {
  console.log(value);
  //          ^? Answer
  console.log(key);
  //          ^? "No" | "Yes"
  console.log(enumObj);
  //          ^? typeof Answer
});

const forEachAnswer = E.forEach(Answer);
//    ^? (iteratee: (value: Answer, key: "No" | "Yes", enumObj: typeof Answer) => void) => void

const logEntries = E.forEach((value, key) => console.log([key, value]));
//    ^? (enumObj: Record<string, string | number>) => void

logEntries(Answer);
// => [ "No", 0 ]
// => [ "Yes", "YES" ]
Copy

API

See the API documentation for more details.

License

MIT License @ 2024-Present Xuanbo Cheng