rename library

.github/README.md

@@ -1,72 +1,35 @@
-# Antiutils
+# pipe-function
 
-A minimal set of JS/TS utilities.
+A function to pipe a value through multiple transforms.
 
 ## Installation
 
 ```bash
-npm install antiutils
+npm install pipe-function
 ```
 
 or
 
 ```bash
-yarn add antiutils
+yarn add pipe-function
 ```
 
 or
 
 ```bash
-pnpm add antiutils
+pnpm add pipe-function
 ```
 
 ## Usage
 
-The library provides just two functions.
-
-### pipe
-
 ```ts
-import { pipe } from "antiutils";
+import { pipe } from "pipe-function";
 ```
 
 Takes between 2 and 20 arguments. `pipe(x, a, b)` is equivalent to `b(a(x))`, in other words, this function pipes a value through a number of functions in the order that they appear. [This article](https://dev.to/ivan7237d/i-ve-used-the-pipe-function-2-560-times-and-i-can-tell-you-it-s-good-4aal) talks about why this function is useful.
 
 `pipe(x)` will run and return `x`, but will produce a type error.
 
-### assertNever
-
-```ts
-import { assertNever } from "antiutils";
-```
-
-Takes 1+ arguments each of type `never` and throws. This is useful when you need to assert that all options have been exhausted:
-
-```ts
-const translate = (word: "hello" | "goodbye") =>
-  word === "hello"
-    ? "bonjour"
-    : word === "goodbye"
-    ? "au revoir"
-    : assertNever(word);
-```
-
-This typechecks because at the point where `word` is passed to `assertNever`, it has type `never`, but will no longer typecheck if you add a third option to `"hello" | "goodbye"`.
-
-If you use lint rules `@typescript-eslint/no-unnecessary-condition` and `eslint-comments/no-unused-disable`, you can do this instead:
-
-```ts
-const translate = (word: "hello" | "goodbye") =>
-  word === "hello"
-    ? "bonjour"
-    : // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
-    word === "goodbye"
-    ? "au revoir"
-    : assertNever();
-```
-
-In this case there is no need to pass an argument to `assertNever` since `eslint-comments/no-unused-disable` will activate if not all options are exhausted.
-
 ---
 
-[Contributing guidelines](https://github.com/ivan7237d/antiutils/blob/master/.github/CONTRIBUTING.md)
+[Contributing guidelines](https://github.com/ivan7237d/pipe-function/blob/master/.github/CONTRIBUTING.md)

CHANGELOG.md

@@ -1,107 +1,3 @@
 # Changelog
 
 All notable changes to this project will be documented in this file.
-
-## 4.2.0 (2023-05-29)
-
-Increase the number arguments supported by `pipe` from 12 to 20.
-
-## 4.1.0 (2022-12-27)
-
-Allow passing 0 arguments to `assertNever`.
-
-## 4.0.0 (2022-11-24)
-
-Trimmed the library a little bit. Memoization utility was moved [here](https://github.com/ivan7237d/monomemo).
-
-## [3.1.0](https://github.com/ivan7237d/antiutils/compare/v3.0.5...v3.1.0) (2021-02-23)
-
-### Features
-
-- rename applyPipe to pipe (applyPipe still available but deprecated) ([fc03348](https://github.com/ivan7237d/antiutils/commit/fc03348c271a6585b9fa8ff5ea492afe1e20a959))
-
-### [3.0.3 - 3.0.5](https://github.com/ivan7237d/antiutils/compare/v3.0.2...v3.0.5) (2021-02-06 - 2021-02-11)
-
-Chore releases.
-
-### [3.0.2](https://github.com/ivan7237d/antiutils/compare/v3.0.1...v3.0.2) (2021-01-22)
-
-### Bug Fixes
-
-- add missing exports ([f7f0c73](https://github.com/ivan7237d/antiutils/commit/f7f0c73a53e7789019d3db0d13cc5a62501acc03))
-
-### [3.0.1](https://github.com/ivan7237d/antiutils/compare/v3.0.0...v3.0.1) (2021-01-21)
-
-### Bug Fixes
-
-- fix jsdoc for PartialReducer ([55a7901](https://github.com/ivan7237d/antiutils/commit/55a790134619481536f0c23ee2dd172daee647b7))
-
-## [3.0.0](https://github.com/ivan7237d/antiutils/compare/v2.2.0...v3.0.0) (2021-01-21)
-
-### ⚠ BREAKING CHANGES
-
-- **reducer:** Reducer has been renamed to PartialReducer
-- **iterable:** firstIterable is now a generator function.
-
-### Features
-
-- replace types with interfaces ([12f14e7](https://github.com/ivan7237d/antiutils/commit/12f14e7490e2f653852622540dfbe3fdcb5ca9f5))
-- **iterable:** functions that returned Iterables now return IterableIterators ([4f1c4a4](https://github.com/ivan7237d/antiutils/commit/4f1c4a49cf88447f21abdd2e2abaa29456b51771))
-- **iterable:** someInIterable and noneInIterable ([48b3d80](https://github.com/ivan7237d/antiutils/commit/48b3d80032c08784b476a0a41a9ba3dea5aff687))
-- **reducer:** add interop Reducer type ([86b9db0](https://github.com/ivan7237d/antiutils/commit/86b9db02d7fdf538c366566c088e49cf04095938), [f0e4dcc](https://github.com/ivan7237d/antiutils/commit/f0e4dcc5aba138a63dec0162a8bd905b33f77e17))
-
-## [2.2.0](https://github.com/ivan7237d/antiutils/compare/v2.1.0...v2.2.0) (2021-01-12)
-
-### Features
-
-- add sideEffects property to package.json to help tree-shaking ([ac5e560](https://github.com/ivan7237d/antiutils/commit/ac5e5609c0b0444b128b636b02b9cd268a2f9a2d))
-
-## [2.1.0](https://github.com/ivan7237d/antiutils/compare/v2.0.1...v2.1.0) (2021-01-04)
-
-### Features
-
-- **iterable:** reverseIterable ([94a24be](https://github.com/ivan7237d/antiutils/commit/94a24beb6716d438f5d6f7115f1e38fe035e4ee6))
-- **iterable:** sliceReversedIterable ([30bf7f5](https://github.com/ivan7237d/antiutils/commit/30bf7f57d2061ecf026ae3609d5fd3895f28d4a7))
-
-### Bug Fixes
-
-- **rangeIterable:** correctly handle non-positive step ([19c83ec](https://github.com/ivan7237d/antiutils/commit/19c83ec74ab22e76b8c14265452870c7c2266dd9))
-
-### [2.0.1](https://github.com/ivan7237d/antiutils/compare/v2.0.0...v2.0.1) (2021-01-03)
-
-### Bug Fixes
-
-- add missing exports ([ea3c82c](https://github.com/ivan7237d/antiutils/commit/ea3c82c53c90a0ade00d98c144dcb0f8efba4cca))
-
-## [2.0.0](https://github.com/ivan7237d/antiutils/compare/v1.0.3...v2.0.0) (2020-12-17)
-
-### ⚠ BREAKING CHANGES
-
-- assertNever is now asNever
-- **view:** View's type shape has changed
-- **react:** bindingProps and bindingPropsCheckbox have been moved to a separate package
-- memoize() has been superceded by memoizeWeak(), memoizeStrong(), and teach()
-- **array:** sliceArray and reverseArray now return arrays instead of iterables
-- **iterable:** takeIterable has been removed - use sliceIterable
-- countInIterable, everyInIterable and someInIterable have been removed, use
-  reduceIterable instead
-- **iterable:** takeWhile operator has been removed
-- **iterable:** Signatures of Reducer, reduce and scan have changed
-
-### Features
-
-- downcasting functions ([7039bc8](https://github.com/ivan7237d/antiutils/commit/7039bc8b9685159832127f73c93714a3309bf59f))
-- **view:** better type shape for View ([36b1cf6](https://github.com/ivan7237d/antiutils/commit/36b1cf6908a92c7abc033daa801d72e57174dea7))
-- better memoization utilities ([e5e15d3](https://github.com/ivan7237d/antiutils/commit/e5e15d3f22a1885699564d5279c1368781dd63b3))
-- **array:** sliceReversedArray ([c4c1ff9](https://github.com/ivan7237d/antiutils/commit/c4c1ff9276b81578203f71180386342994c47f94))
-- **iterable:** expandIterable ([5ae3daa](https://github.com/ivan7237d/antiutils/commit/5ae3daa954415fb7176ab2ab2081102c36cad298))
-- **iterable:** lastInIterable ([abbe0fc](https://github.com/ivan7237d/antiutils/commit/abbe0fc305a7002098528eba61c40c91eeadfe8c))
-- **iterable:** more powerful reduce and scan functions ([48de11a](https://github.com/ivan7237d/antiutils/commit/48de11a6c3eec35ed06e4ec3ffaf3e8db645f148))
-- **iterable:** sliceIterable ([33d7c62](https://github.com/ivan7237d/antiutils/commit/33d7c625c6b17673b893286576a830000a9ff6d2))
-- **lastInIterable:** better performance for arrays ([106569d](https://github.com/ivan7237d/antiutils/commit/106569d2f4277ebf4387919cabf64e5eb5823523))
-- **sliceIterable:** use consistent way to check for array ([c738d6f](https://github.com/ivan7237d/antiutils/commit/c738d6f474cd727c98d1147d17b87ecb9ef2f193))
-- reducers ([aa92215](https://github.com/ivan7237d/antiutils/commit/aa92215aebb985ce3cc06609ecb2b7db27fec38e))
-
-## 1.0.0 (2020-11-29)
-
-First release.

README.md

@@ -1,3 +1,3 @@
 <!-- README for NPM; the one for GitHub is in .github directory. -->
 
-Please see the [GitHub README](https://github.com/ivan7237d/antiutils) for full documentation.
+Please see the [GitHub README](https://github.com/ivan7237d/pipe-function) for full documentation.

package.json

@@ -1,8 +1,8 @@
 {
-  "name": "antiutils",
-  "version": "4.2.0",
-  "description": "A minimal set of JS/TS utilities",
-  "repository": "https://github.com/ivan7237d/antiutils.git",
+  "name": "pipe-function",
+  "version": "0.0.1",
+  "description": "A function to pipe a value through multiple transforms",
+  "repository": "https://github.com/ivan7237d/pipe-function.git",
   "license": "MIT",
   "main": "build/main/index.js",
   "typings": "build/main/index.d.ts",

src/pipe.test.ts → src/index.test.ts

@@ -1,4 +1,4 @@
-import { pipe } from "./pipe";
+import { pipe } from ".";
 
 const addSuffix =
   <Suffix extends string>(suffix: Suffix) =>