docs: add API documentation for @eslint-react/eff package

Author: Rel1cx

packages/utilities/eff/docs/README.md

@@ -0,0 +1,44 @@
+**@eslint-react/eff**
+
+***
+
+# @eslint-react/eff
+
+## Type Aliases
+
+- [\_](type-aliases.md)
+- [NarrowedTo](type-aliases/NarrowedTo.md)
+- [Pretty](type-aliases/Pretty.md)
+
+## Variables
+
+- [\_](variables.md)
+- [compose](variables/compose.md)
+- [dual](variables/dual.md)
+
+## Functions
+
+- [absurd](functions/absurd.md)
+- [apply](functions/apply.md)
+- [chunk](functions/chunk.md)
+- [constant](functions/constant.md)
+- [constFalse](functions/constFalse.md)
+- [constNull](functions/constNull.md)
+- [constTrue](functions/constTrue.md)
+- [constVoid](functions/constVoid.md)
+- [flip](functions/flip.md)
+- [flow](functions/flow.md)
+- [getOrUpdate](functions/getOrUpdate.md)
+- [identity](functions/identity.md)
+- [isArray](functions/isArray.md)
+- [isFunction](functions/isFunction.md)
+- [isObject](functions/isObject.md)
+- [isTruthy](functions/isTruthy.md)
+- [not](functions/not.md)
+- [or](functions/or.md)
+- [pipe](functions/pipe.md)
+- [pipeArguments](functions/pipeArguments.md)
+- [tryAddToSet](functions/tryAddToSet.md)
+- [tupled](functions/tupled.md)
+- [untupled](functions/untupled.md)
+- [zipWith](functions/zipWith.md)

packages/utilities/eff/docs/functions/absurd.md

@@ -0,0 +1,36 @@
+[**@eslint-react/eff**](../README.md)
+
+***
+
+[@eslint-react/eff](../README.md) / absurd
+
+# Function: absurd()
+
+> **absurd**\<`A`\>(`_`): `A`
+
+The `absurd` function is a stub for cases where a value of type `never` is encountered in your code,
+meaning that it should be impossible for this code to be executed.
+
+This function is particularly useful when it's necessary to specify that certain cases are impossible.
+
+## Type Parameters
+
+### A
+
+`A`
+
+## Parameters
+
+### \_
+
+`never`
+
+The value of type `never` that is passed to the function.
+
+## Returns
+
+`A`
+
+## Since
+
+1.0.0

packages/utilities/eff/docs/functions/apply.md

@@ -0,0 +1,59 @@
+[**@eslint-react/eff**](../README.md)
+
+***
+
+[@eslint-react/eff](../README.md) / apply
+
+# Function: apply()
+
+> **apply**\<`A`\>(`a`): \<`B`\>(`self`) => `B`
+
+Apply a function to a given value.
+
+## Type Parameters
+
+### A
+
+`A`
+
+## Parameters
+
+### a
+
+`A`
+
+The value to apply.
+
+## Returns
+
+> \<`B`\>(`self`): `B`
+
+### Type Parameters
+
+#### B
+
+`B`
+
+### Parameters
+
+#### self
+
+(`a`) => `B`
+
+### Returns
+
+`B`
+
+## Example
+
+```ts
+import * as assert from "node:assert"
+import { pipe, apply } from "effect/Function"
+import { length } from "effect/String"
+
+assert.deepStrictEqual(pipe(length, apply("hello")), 5)
+```
+
+## Since
+
+1.0.0

packages/utilities/eff/docs/functions/chunk.md

@@ -0,0 +1,29 @@
+[**@eslint-react/eff**](../README.md)
+
+***
+
+[@eslint-react/eff](../README.md) / chunk
+
+# Function: chunk()
+
+> **chunk**\<`T`\>(`array`, `size`): `T`[][]
+
+## Type Parameters
+
+### T
+
+`T`
+
+## Parameters
+
+### array
+
+`T`[]
+
+### size
+
+`number`
+
+## Returns
+
+`T`[][]

packages/utilities/eff/docs/functions/constFalse.md

@@ -0,0 +1,15 @@
+[**@eslint-react/eff**](../README.md)
+
+***
+
+[@eslint-react/eff](../README.md) / constFalse
+
+# Function: constFalse()
+
+> **constFalse**(): `false`
+
+Do nothing and return false
+
+## Returns
+
+`false`

packages/utilities/eff/docs/functions/constNull.md

@@ -0,0 +1,15 @@
+[**@eslint-react/eff**](../README.md)
+
+***
+
+[@eslint-react/eff](../README.md) / constNull
+
+# Function: constNull()
+
+> **constNull**(): `null`
+
+Do nothing and return null
+
+## Returns
+
+`null`

packages/utilities/eff/docs/functions/constTrue.md

@@ -0,0 +1,15 @@
+[**@eslint-react/eff**](../README.md)
+
+***
+
+[@eslint-react/eff](../README.md) / constTrue
+
+# Function: constTrue()
+
+> **constTrue**(): `true`
+
+Do nothing and return true
+
+## Returns
+
+`true`

packages/utilities/eff/docs/functions/constVoid.md

@@ -0,0 +1,15 @@
+[**@eslint-react/eff**](../README.md)
+
+***
+
+[@eslint-react/eff](../README.md) / constVoid
+
+# Function: constVoid()
+
+> **constVoid**(): `void`
+
+Do nothing and return void
+
+## Returns
+
+`void`

packages/utilities/eff/docs/functions/constant.md

@@ -0,0 +1,33 @@
+[**@eslint-react/eff**](../README.md)
+
+***
+
+[@eslint-react/eff](../README.md) / constant
+
+# Function: constant()
+
+> **constant**\<`T`\>(`x`): () => `T`
+
+Returns a function that always returns the same value.
+
+## Type Parameters
+
+### T
+
+`T`
+
+## Parameters
+
+### x
+
+`T`
+
+The value to return.
+
+## Returns
+
+> (): `T`
+
+### Returns
+
+`T`

packages/utilities/eff/docs/functions/flip.md

@@ -0,0 +1,72 @@
+[**@eslint-react/eff**](../README.md)
+
+***
+
+[@eslint-react/eff](../README.md) / flip
+
+# Function: flip()
+
+> **flip**\<`A`, `B`, `C`\>(`f`): (...`b`) => (...`a`) => `C`
+
+Reverses the order of arguments for a curried function.
+
+## Type Parameters
+
+### A
+
+`A` *extends* `unknown`[]
+
+### B
+
+`B` *extends* `unknown`[]
+
+### C
+
+`C`
+
+## Parameters
+
+### f
+
+(...`a`) => (...`b`) => `C`
+
+The function to flip.
+
+## Returns
+
+> (...`b`): (...`a`) => `C`
+
+### Parameters
+
+#### b
+
+...`B`
+
+### Returns
+
+> (...`a`): `C`
+
+#### Parameters
+
+##### a
+
+...`A`
+
+#### Returns
+
+`C`
+
+## Example
+
+```ts
+import * as assert from "node:assert"
+import { flip } from "effect/Function"
+
+const f = (a: number) => (b: string) => a - b.length
+
+assert.deepStrictEqual(flip(f)('aaa')(2), -1)
+```
+
+## Since
+
+1.0.0