# alcalzone-shared

> A set of utilities shared between my projects

Latest version **5.0.0** (published 2024-11-06) · MIT license · 0 weekly downloads

## Install

```sh
npm install alcalzone-shared
pnpm add alcalzone-shared
yarn add alcalzone-shared
bun add alcalzone-shared
```

## Health

**Score 55/100 (C)** — status: stable.

Positive: has types; esm support; no vulnerabilities; high maintenance score; high quality score.

Warnings: low downloads.

Negative: stale.

## Facts

| | |
|---|---|
| Version | 5.0.0 |
| Published | 2024-11-06 |
| First published | 2018-07-18 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Node | >=18 |
| Dependencies | 0 |
| Unpacked size | 134.4 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | AlCalzone |
| Maintainers | alcalzone |

## Links

- npm: https://www.npmjs.com/package/alcalzone-shared
- Repository: https://github.com/AlCalzone/shared-utils
- Homepage: https://github.com/AlCalzone/shared-utils#readme
- Issues: https://github.com/AlCalzone/shared-utils/issues
- npm.io page: https://npm.io/package/alcalzone-shared

## Recent versions

- 5.0.0 (latest) — 2024-11-06
- 4.0.8 — 2022-09-07
- 4.0.7 — 2022-09-07
- 4.0.6 — 2022-09-07
- 4.0.5 — 2022-09-07
- 4.0.4 — 2022-09-07
- 4.0.3 — 2022-08-27
- 4.0.2 — 2022-08-27
- 4.0.1 — 2021-11-15
- 4.0.0 — 2021-06-19
- 3.0.4 — 2021-04-24
- 3.0.3 — 2021-03-09
- 3.0.2 — 2021-01-16
- 3.0.1 — 2020-12-04
- 3.0.0 — 2020-08-16
- … 21 more at https://npm.io/package/alcalzone-shared/versions

## README

# shared-utils

[![node](https://img.shields.io/node/v/alcalzone-shared.svg) ![npm](https://img.shields.io/npm/v/alcalzone-shared.svg)](https://www.npmjs.com/package/alcalzone-shared)

[![Build Status](https://img.shields.io/circleci/project/github/AlCalzone/shared-utils.svg)](https://circleci.com/gh/AlCalzone/shared-utils)
[![Coverage Status](https://img.shields.io/coveralls/github/AlCalzone/shared-utils.svg)](https://coveralls.io/github/AlCalzone/shared-utils)

A set of utilities shared between my projects

Function documentation available [here](https://alcalzone.github.io/shared-utils/)

## Changelog
<!--
	Placeholder for the next version (at the beginning of the line):
	### __WORK IN PROGRESS__
-->
### 5.0.0 (2024-11-06)
* Breaking: Node.js 18 is now required
* Breaking: When using TypeScript, `moduleResolution` must be set to `node16` in `tsconfig.json`
* Breaking: `entries`, `values`, and `composeObject` were removed. Use the widely available `Object.entries`, `Object.values`, and `Object.fromEntries` instead.
* Breaking: `padStart` and by extension the entire `/strings` submodule were removed. Use the widely available `String.prototype.padStart` instead.
* The package is now a hybrid ESM/CJS package

### 4.0.8 (2022-09-07)
* Fix: Update return types of `isArray` and `isObject` to use an extensive conditional type to replace what used to work in TS 4.7

### 4.0.7 (2022-09-07)
Undo changes to `isObject` from `4.0.6`. TS narrowing in 4.8.2 is broken.

### 4.0.6 (2022-09-07)
* Fix: correctly narrow return type of `isObject`

### 4.0.5 (2022-09-07)
* Fix: correctly narrow return type of isArray for `{}` arguments

### 4.0.4 (2022-09-07)
* Fix: narrowed type for `isArray` is inferred correctly for `readonly` arrays

### 4.0.3 (2022-08-27)
* Update `isArray` to be compatible with TS 4.8 changes

### 4.0.1 (2021-11-15)
`SortedQueue`: Fixed an issue where inserting an item before the first one would cause the queue to lose track of items

### 4.0.0 (2021-06-19)
* Node.js 12+ is now required

### 3.0.4 (2021-04-24)
* Fix compatibility of `wait()` with Electron if `unref` is `true`
* Dependency updates

### 3.0.3 (2021-03-09)
#### Fixes
* Fixed compatibility with TypeScript 4.2

### 3.0.2 (2021-01-16)
#### Fixes
* The argument to `resolve` of `DeferredPromise` is no longer optional, except for `Promise<void>`

### 3.0.1 (2020-12-05)
#### Fixes
* The typeguard `isObject` no longer narrows the type of the argument to `object`

### 3.0.0 (2020-08-16)
#### Breaking changes
* Renamed the following types:
  * `DropLast` -> `Lead`
  * `TakeLast` -> `Last`
  * `TakeLastArgument` -> `LastArgument`
* TypeScript 4.1 is now required

#### Features
* Added the following types:
  * `FixedIndizesOf<T[]>` - Like `IndizesOf`, but does not include the type `number` if the tuple/array is variable-length
  * `Tail<T[]>` - Returns all but the first item's type in a tuple/array
  * `Push<List[], Item>` - Returns the given tuple/array with the item type appended to it
  * `Concat<T1[], T2[]>` - Concatenates the given tuples/arrays
  * `TupleOf<T, N>` - Returns a tuple of length `N` with item types `T`.
  * `Range<N>` - Creates a Union of all numbers (converted to string) from 0 to N (exclusive), e.g. `Range<4>` is equal to `"0" | "1" | "2" | "3"`.
  * `RangeFrom<N, M>` - Creates a Union of all numbers from N (inclusive) to M (exclusive), e.g. `RangeFrom<2, 4>` is equal to `"2" | "3"`.
  * `IsGreaterThan<N, M>` - is equal to `true` if `N > M`, otherwise `false`
  * `IsLessThanOrEqual<N, M>` - is equal to `true` if `N <= M`, otherwise `false`
  * `IsLessThan<N, M>` - is equal to `true` if `N < M`, otherwise `false`
  * `IsGreaterThanOrEqual<N, M>` - is equal to `true` if `N >= M`, otherwise `false`

#### Fixes
* The type `CallbackAPIReturnType` now works with `strictNullChecks`.
* The type `Promisify` is no longer experimental and no longer messes up the inferred signature argument names

### 2.3.0 (2020-06-08)
* Added optional `unref` parameter to `async` -> `wait(ms, [unref])`

---
_Source: https://npm.io/package/alcalzone-shared · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._