complete-common 1.3.0 → 2.0.0

package/src/functions/object.ts

@@ -12,11 +12,10 @@ import type { ReadonlyRecord } from "../types/ReadonlyRecord.js";
  *
  * This is efficient such that it avoids converting the object values into an array.
  */
-// eslint-disable-next-line complete/no-mutable-return
 export function objectFilter<K extends string | number | symbol, V>(
   object: ReadonlyRecord<K, V>,
   predicate: (value: V) => boolean,
-): V[] {
+): readonly V[] {
   const array: V[] = [];
 
   // eslint-disable-next-line complete/no-for-in
@@ -41,13 +40,10 @@ export function objectFilter<K extends string | number | symbol, V>(
  *
  * Note that the converted map will only have string keys, due to the nature of JavaScript objects
  * only having string keys under the hood.
- *
- * Also see the `objectToReadonlyMap` function.
  */
-// eslint-disable-next-line complete/no-mutable-return
 export function objectToMap<K extends string | number | symbol, V>(
   object: Record<K, V>,
-): Map<K, V> {
+): ReadonlyMap<K, V> {
   const map = new Map<K, V>();
 
   for (const [key, value] of Object.entries(object)) {
@@ -57,38 +53,16 @@ export function objectToMap<K extends string | number | symbol, V>(
   return map;
 }
 
-/**
- * Helper function to convert an object to a read-only map.
- *
- * This is useful when you need to construct a type safe object with the `satisfies` operator, but
- * then later on you need to query it in a way where you expect the return value to be T or
- * undefined. In this situation, by converting the object to a map, you can avoid unsafe type
- * assertions.
- *
- * Note that the converted map will only have string keys, due to the nature of JavaScript objects
- * only having string keys under the hood.
- *
- * Also see the `objectToMap` function.
- */
-export function objectToReadonlyMap<K extends string | number | symbol, V>(
-  object: Record<K, V>,
-): ReadonlyMap<K, V> {
-  return objectToMap(object);
-}
-
 /**
  * Helper function to convert an object to a reverse map.
  *
  * Note that the converted map will only have string keys, due to the nature of JavaScript objects
  * only having string keys under the hood.
- *
- * Also see the `objectToReverseReadonlyMap` function.
  */
-// eslint-disable-next-line complete/no-mutable-return
 export function objectToReverseMap<
   K extends string | number | symbol,
   V extends string | number | symbol,
->(object: Record<K, V>): Map<V, K> {
+>(object: Record<K, V>): ReadonlyMap<V, K> {
   const map = new Map<V, K>();
 
   for (const [key, value] of Object.entries(object)) {
@@ -97,18 +71,3 @@ export function objectToReverseMap<
 
   return map;
 }
-
-/**
- * Helper function to convert an object to a reverse read-only map.
- *
- * Note that the converted map will only have string keys, due to the nature of JavaScript objects
- * only having string keys under the hood.
- *
- * Also see the `objectToReverseMap` function.
- */
-export function objectToReverseReadonlyMap<
-  K extends string | number | symbol,
-  V extends string | number | symbol,
->(object: Record<K, V>): ReadonlyMap<V, K> {
-  return objectToReverseMap(object);
-}

package/src/functions/set.ts

@@ -28,8 +28,9 @@ export function addSetsToSet<T>(
  *
  * This function is variadic, meaning that you can specify N sets.
  */
-// eslint-disable-next-line complete/no-mutable-return
-export function combineSets<T>(...sets: ReadonlyArray<ReadonlySet<T>>): Set<T> {
+export function combineSets<T>(
+  ...sets: ReadonlyArray<ReadonlySet<T>>
+): ReadonlySet<T> {
   const newSet = new Set<T>();
   for (const set of sets) {
     for (const value of set) {
@@ -41,8 +42,7 @@ export function combineSets<T>(...sets: ReadonlyArray<ReadonlySet<T>>): Set<T> {
 }
 
 /** Helper function to copy a set. (You can also use a Set constructor to accomplish this task.) */
-// eslint-disable-next-line complete/no-mutable-return
-export function copySet<T>(oldSet: ReadonlySet<T>): Set<T> {
+export function copySet<T>(oldSet: ReadonlySet<T>): ReadonlySet<T> {
   const newSet = new Set<T>();
   for (const value of oldSet) {
     newSet.add(value);
@@ -51,26 +51,10 @@ export function copySet<T>(oldSet: ReadonlySet<T>): Set<T> {
   return newSet;
 }
 
-/**
- * Helper function to convert the keys of an object to a read-only set.
- *
- * Also see the `objectKeysToSet` function.
- */
-export function objectKeysToReadonlySet<K extends string | number | symbol, V>(
-  object: Record<K, V>,
-): ReadonlySet<K> {
-  return objectKeysToSet(object);
-}
-
-/**
- * Helper function to convert the keys of an object to a set.
- *
- * Also see the `objectKeysToReadonlySet` function.
- */
-// eslint-disable-next-line complete/no-mutable-return
+/** Helper function to convert the keys of an object to a set. */
 export function objectKeysToSet<K extends string | number | symbol, V>(
   object: Record<K, V>,
-): Set<K> {
+): ReadonlySet<K> {
   const set = new Set<K>();
 
   for (const key of Object.keys(object)) {
@@ -80,27 +64,10 @@ export function objectKeysToSet<K extends string | number | symbol, V>(
   return set;
 }
 
-/**
- * Helper function to convert the values of an object to a read-only set.
- *
- * Also see the `objectValuesToSet` function.
- */
-export function objectValuesToReadonlySet<
-  K extends string | number | symbol,
-  V,
->(object: Record<K, V>): ReadonlySet<V> {
-  return objectValuesToSet(object);
-}
-
-/**
- * Helper function to convert the values of an object to a set.
- *
- * Also see the `objectValuesToReadonlySet` function.
- */
-// eslint-disable-next-line complete/no-mutable-return
+/** Helper function to convert the values of an object to a set. */
 export function objectValuesToSet<K extends string | number | symbol, V>(
   object: Record<K, V>,
-): Set<V> {
+): ReadonlySet<V> {
   const set = new Set<V>();
 
   for (const key of Object.values(object)) {

package/src/functions/sort.ts

@@ -11,8 +11,9 @@
  * From:
  * https://stackoverflow.com/questions/8996963/how-to-perform-case-insensitive-sorting-array-of-string-in-javascript
  */
-// eslint-disable-next-line complete/no-mutable-return
-export function sortCaseInsensitive(array: readonly string[]): string[] {
+export function sortCaseInsensitive(
+  array: readonly string[],
+): readonly string[] {
   const newArray = [...array];
   newArray.sort((a, b) =>
     a.localeCompare(b, undefined, {

package/src/index.ts

@@ -24,6 +24,7 @@ export type * from "./types/ObjectValues.js";
 export * from "./types/ReadonlyMap.js";
 export type * from "./types/ReadonlyRecord.js";
 export * from "./types/ReadonlySet.js";
+export type * from "./types/TranspiledEnum.js";
 export type * from "./types/Tuple.js";
 export type * from "./types/WidenLiteral.js";
 export type * from "./types/Writeable.js";

package/src/types/TranspiledEnum.ts

@@ -0,0 +1,2 @@
+/** Helper type to represent a TypeScript `enum` at run-time. */
+export type TranspiledEnum = Record<string, string | number>;