@williamthorsen/toolbelt.arrays 3.4.0 → 4.0.0

package/CHANGELOG.md

@@ -2,6 +2,20 @@
 
 All notable changes to this project will be documented in this file.
 
+## 4.0.0 — 2026-08-12
+
+### Features
+
+- 🚨 **Breaking:** Rename get* functions by return kind and verb specificity (#119)
+
+  Renames thirteen functions across various packages to align with a consistent naming pattern.
+
+### Refactoring
+
+- Align stray modules with layout and TypeScript conventions (#118)
+
+  Aligns all packages with code-layout and annotation conventions, ending a handful of long-standing exceptions. Documentation has been updated to make the conventions clear.
+
 ## 3.4.0 — 2026-08-08
 
 ### Features

package/README.md

@@ -3,13 +3,13 @@
 Array utilities.
 
 <!-- section:release-notes -->
-## Release notes — v3.4.0 (2026-08-08)
+## Release notes — v4.0.0 (2026-08-12)
 
 ### Features
 
-- Use underscore separator at 4 digits or more
+- 🚨 **Breaking:** Rename get* functions by return kind and verb specificity (#119)
 
-  Changes the `unicorn/numeric-separators-style` rule config so that separators are consistently used in base 10 numbers, instead of exempting numbers of 5 digits or less.
+  Renames thirteen functions across various packages to align with a consistent naming pattern.
 <!-- /section:release-notes -->
 
 ## Installation

package/dist/esm/3-candidate/findWeightedIndex.d.ts

@@ -0,0 +1,3 @@
+export declare function findWeightedIndex(cumulativeWeights: ReadonlyArray<number>, targetWeight: number): Integer | undefined;
+type Integer = number;
+export {};

package/dist/esm/3-candidate/{getWeightedIndex.js → findWeightedIndex.js}

@@ -1,5 +1,5 @@
 import { getAtIndexOrThrow } from "./getAtIndexOrThrow.js";
-export function getWeightedIndex(cumulativeWeights, targetWeight) {
+export function findWeightedIndex(cumulativeWeights, targetWeight) {
     if (cumulativeWeights.length === 0) {
         return undefined;
     }

package/dist/esm/3-candidate/index.d.ts

@@ -1,11 +1,11 @@
 export { arraify } from './arraify.js';
 export { extractWeights } from './extractWeights.js';
 export { findOrThrow } from './findOrThrow.js';
+export { findWeightedIndex } from './findWeightedIndex.js';
 export { getAtIndexOrThrow } from './getAtIndexOrThrow.js';
-export { getDuplicateItems } from './getDuplicateItems.js';
-export { getUniqueItems } from './getUniqueItems.js';
-export { getWeightedIndex } from './getWeightedIndex.js';
 export { includes } from './includes.js';
+export { listDuplicateItems } from './listDuplicateItems.js';
+export { listUniqueItems } from './listUniqueItems.js';
 export { makePickWeightedItemFromDistribution } from './makePickWeightedItemFromDistribution.js';
 export { makeNullishCompare, nullishCompare } from './nullishCompare.js';
 export { pickItem } from './pickItem.js';

package/dist/esm/3-candidate/index.js

@@ -1,11 +1,11 @@
 export { arraify } from "./arraify.js";
 export { extractWeights } from "./extractWeights.js";
 export { findOrThrow } from "./findOrThrow.js";
+export { findWeightedIndex } from "./findWeightedIndex.js";
 export { getAtIndexOrThrow } from "./getAtIndexOrThrow.js";
-export { getDuplicateItems } from "./getDuplicateItems.js";
-export { getUniqueItems } from "./getUniqueItems.js";
-export { getWeightedIndex } from "./getWeightedIndex.js";
 export { includes } from "./includes.js";
+export { listDuplicateItems } from "./listDuplicateItems.js";
+export { listUniqueItems } from "./listUniqueItems.js";
 export { makePickWeightedItemFromDistribution } from "./makePickWeightedItemFromDistribution.js";
 export { makeNullishCompare, nullishCompare } from "./nullishCompare.js";
 export { pickItem } from "./pickItem.js";

package/dist/esm/3-candidate/listDuplicateItems.d.ts

@@ -0,0 +1 @@
+export declare function listDuplicateItems<T>(items: Iterable<T>): T[];

package/dist/esm/3-candidate/{getDuplicateItems.js → listDuplicateItems.js}

@@ -1,4 +1,4 @@
-export function getDuplicateItems(items) {
+export function listDuplicateItems(items) {
     const duplicates = new Set();
     const seen = new Set();
     for (const item of items) {
@@ -11,4 +11,3 @@ export function getDuplicateItems(items) {
     }
     return [...duplicates];
 }
-export const getDuplicates = getDuplicateItems;

package/dist/esm/3-candidate/listUniqueItems.d.ts

@@ -0,0 +1 @@
+export declare function listUniqueItems<T>(items: Iterable<T>): T[];

package/dist/esm/3-candidate/listUniqueItems.js

@@ -0,0 +1,3 @@
+export function listUniqueItems(items) {
+    return [...new Set(items)];
+}

package/dist/esm/3-candidate/pickWeightedIndex.js

@@ -1,13 +1,13 @@
 import { assert } from '@williamthorsen/toolbelt.guards';
 import { generateRandom } from '@williamthorsen/toolbelt.numbers/candidate';
+import { findWeightedIndex } from "./findWeightedIndex.js";
 import { getAtIndexOrThrow } from "./getAtIndexOrThrow.js";
-import { getWeightedIndex } from "./getWeightedIndex.js";
 export function pickWeightedIndex(cumulativeWeights, options = {}) {
     assertValidCumulativeWeights(cumulativeWeights);
     const cumulativeWeight = getAtIndexOrThrow(cumulativeWeights, cumulativeWeights.length - 1);
     const randomValue = generateRandom(options);
     const targetWeight = randomValue * cumulativeWeight;
-    const pickedIndex = getWeightedIndex(cumulativeWeights, targetWeight);
+    const pickedIndex = findWeightedIndex(cumulativeWeights, targetWeight);
     assert(pickedIndex !== undefined);
     return pickedIndex;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@williamthorsen/toolbelt.arrays",
-  "version": "3.4.0",
+  "version": "4.0.0",
   "description": "API",
   "keywords": [],
   "homepage": "https://github.com/williamthorsen/toolbelt/tree/main/packages/arrays#readme",
@@ -35,7 +35,7 @@
   ],
   "dependencies": {
     "@williamthorsen/toolbelt.guards": "3.1.9",
-    "@williamthorsen/toolbelt.numbers": "5.0.0"
+    "@williamthorsen/toolbelt.numbers": "6.0.0"
   },
   "engines": {
     "node": ">=24.0.0"

package/dist/esm/0-strawman/getSetItems.d.ts

@@ -1 +0,0 @@
-export declare function getSetItems<T>(iterable: Iterable<T>): T[];

package/dist/esm/0-strawman/getSetItems.js

@@ -1,3 +0,0 @@
-export function getSetItems(iterable) {
-    return [...new Set(iterable)];
-}

package/dist/esm/3-candidate/getDuplicateItems.d.ts

@@ -1,2 +0,0 @@
-export declare function getDuplicateItems<T>(items: Iterable<T>): T[];
-export declare const getDuplicates: typeof getDuplicateItems;

package/dist/esm/3-candidate/getUniqueItems.d.ts

@@ -1 +0,0 @@
-export declare function getUniqueItems<T>(items: Iterable<T>): T[];

package/dist/esm/3-candidate/getUniqueItems.js

@@ -1,3 +0,0 @@
-export function getUniqueItems(items) {
-    return [...new Set(items)];
-}

package/dist/esm/3-candidate/getWeightedIndex.d.ts

@@ -1,3 +0,0 @@
-export declare function getWeightedIndex(cumulativeWeights: ReadonlyArray<number>, targetWeight: number): Integer | undefined;
-type Integer = number;
-export {};