diff --git a/.ls-lint.yml b/.ls-lint.yml index db06d120..228ca901 100644 --- a/.ls-lint.yml +++ b/.ls-lint.yml @@ -30,3 +30,4 @@ ignore: - '**/dist' - '**/documentation' - '**/node_modules' + - '**/typedocs-output' diff --git a/package.json b/package.json index 19446a43..ef63c0ce 100644 --- a/package.json +++ b/package.json @@ -21,7 +21,6 @@ "deps:version-minor": "pnpm taze minor -r", "deps:version-patch": "pnpm taze patch -r", "dev": "turbo dev", - "docs": "turbo docs", "format": "pnpm biome format . --write", "indexer": "turbo index", "license": "pnpm zx scripts/license.mjs", diff --git a/packages/constants/documentation/README.md b/packages/constants/documentation/README.md deleted file mode 100644 index d03363fb..00000000 --- a/packages/constants/documentation/README.md +++ /dev/null @@ -1,9 +0,0 @@ -**@accelint/constants** • **Docs** - -*** - -# @accelint/constants - -## Variables - -- [DEFAULT\_COORDINATE](variables/DEFAULT_COORDINATE.md) diff --git a/packages/constants/documentation/variables/DEFAULT_COORDINATE.md b/packages/constants/documentation/variables/DEFAULT_COORDINATE.md deleted file mode 100644 index 7d858b10..00000000 --- a/packages/constants/documentation/variables/DEFAULT_COORDINATE.md +++ /dev/null @@ -1,9 +0,0 @@ -[**@accelint/constants**](../README.md) • **Docs** - -*** - -[@accelint/constants](../README.md) / DEFAULT\_COORDINATE - -# Variable: DEFAULT\_COORDINATE - -> `const` **DEFAULT\_COORDINATE**: `number`[] diff --git a/packages/constants/package.json b/packages/constants/package.json index 70d23496..d92609cd 100644 --- a/packages/constants/package.json +++ b/packages/constants/package.json @@ -22,7 +22,6 @@ "bench": "pnpm vitest bench --run --dir src", "build": "pnpm tsup", "dev": "pnpm tsc --watch", - "docs": "pnpm typedoc --logLevel Error --entryPoints src/index.ts --out documentation --readme none --disableSources --plugin typedoc-plugin-markdown", "index": "pnpm zx ../../scripts/indexer.mjs packages/constants", "lint": "pnpm biome lint ./" }, @@ -32,8 +31,6 @@ "@vitest/coverage-istanbul": "2.1.3", "esbuild-plugin-file-path-extensions": "2.1.3", "tsup": "8.3.0", - "typedoc": "0.26.11", - "typedoc-plugin-markdown": "4.2.10", "vitest": "2.1.3" }, "dependencies": { diff --git a/packages/converters/documentation/README.md b/packages/converters/documentation/README.md deleted file mode 100644 index 57a9ffa7..00000000 --- a/packages/converters/documentation/README.md +++ /dev/null @@ -1,17 +0,0 @@ -**@accelint/converters** • **Docs** - -*** - -# @accelint/converters - -## Type Aliases - -- [BoundingBoxTuple](type-aliases/BoundingBoxTuple.md) -- [XyzTuple](type-aliases/XyzTuple.md) - -## Functions - -- [booleanToNumber](functions/booleanToNumber.md) -- [toBoolean](functions/toBoolean.md) -- [toDigits](functions/toDigits.md) -- [xyzToBbox](functions/xyzToBbox.md) diff --git a/packages/converters/documentation/functions/booleanToNumber.md b/packages/converters/documentation/functions/booleanToNumber.md deleted file mode 100644 index 3591f9e2..00000000 --- a/packages/converters/documentation/functions/booleanToNumber.md +++ /dev/null @@ -1,31 +0,0 @@ -[**@accelint/converters**](../README.md) • **Docs** - -*** - -[@accelint/converters](../README.md) / booleanToNumber - -# Function: booleanToNumber() - -> **booleanToNumber**(`val`): `number` - -Convert a boolean to an integer - -## Parameters - -• **val**: `boolean` - -## Returns - -`number` - -## Pure - -## Example - -```ts -booleanToNumber(true); -// 1 - -booleanToNumber(false); -// 0 -``` diff --git a/packages/converters/documentation/functions/toBoolean.md b/packages/converters/documentation/functions/toBoolean.md deleted file mode 100644 index f4332e91..00000000 --- a/packages/converters/documentation/functions/toBoolean.md +++ /dev/null @@ -1,41 +0,0 @@ -[**@accelint/converters**](../README.md) • **Docs** - -*** - -[@accelint/converters](../README.md) / toBoolean - -# Function: toBoolean() - -> **toBoolean**(`val`): `boolean` - -Compare the given value against a custom list of `truthy` values. - -String values are not case sensitive. - -_1, '1', 'on', 'true', 'yes', true_ - -## Parameters - -• **val**: `unknown` - -## Returns - -`boolean` - -## Pure - -## Example - -```ts -toBoolean('on'); -// true - -toBoolean('yes'); -// true - -toBoolean('off'); -// false - -toBoolean('no'); -// false -``` diff --git a/packages/converters/documentation/functions/toDigits.md b/packages/converters/documentation/functions/toDigits.md deleted file mode 100644 index 2fc9fbe8..00000000 --- a/packages/converters/documentation/functions/toDigits.md +++ /dev/null @@ -1,31 +0,0 @@ -[**@accelint/converters**](../README.md) • **Docs** - -*** - -[@accelint/converters](../README.md) / toDigits - -# Function: toDigits() - -> **toDigits**(`value`, `precision`): `number` - -Round a number to n digits of precision after the decimal point. - -## Parameters - -• **value**: `number` - -• **precision**: `number` - -## Returns - -`number` - -## Pure - -## Example - -```ts -const value = 12.345; -toDigits(value, 2); -// 12.35 -``` diff --git a/packages/converters/documentation/functions/xyzToBbox.md b/packages/converters/documentation/functions/xyzToBbox.md deleted file mode 100644 index 1f1f462d..00000000 --- a/packages/converters/documentation/functions/xyzToBbox.md +++ /dev/null @@ -1,28 +0,0 @@ -[**@accelint/converters**](../README.md) • **Docs** - -*** - -[@accelint/converters](../README.md) / xyzToBbox - -# Function: xyzToBbox() - -> **xyzToBbox**(`tile`): [`BoundingBoxTuple`](../type-aliases/BoundingBoxTuple.md) - -Converts a Tile (x, y, z) to a Bounding Box (west, south, east, north). - -## Parameters - -• **tile**: [`XyzTuple`](../type-aliases/XyzTuple.md) - -## Returns - -[`BoundingBoxTuple`](../type-aliases/BoundingBoxTuple.md) - -## Pure - -## Example - -```ts -xyzToBbox([71, 96, 8]); -// [-80.15625, 39.909736234537185, -78.75, 40.97989806962013] -``` diff --git a/packages/converters/documentation/type-aliases/BoundingBoxTuple.md b/packages/converters/documentation/type-aliases/BoundingBoxTuple.md deleted file mode 100644 index 554708dd..00000000 --- a/packages/converters/documentation/type-aliases/BoundingBoxTuple.md +++ /dev/null @@ -1,11 +0,0 @@ -[**@accelint/converters**](../README.md) • **Docs** - -*** - -[@accelint/converters](../README.md) / BoundingBoxTuple - -# Type Alias: BoundingBoxTuple - -> **BoundingBoxTuple**: [`number`, `number`, `number`, `number`] - -[left, bottom, right, top] diff --git a/packages/converters/documentation/type-aliases/XyzTuple.md b/packages/converters/documentation/type-aliases/XyzTuple.md deleted file mode 100644 index 04bb3612..00000000 --- a/packages/converters/documentation/type-aliases/XyzTuple.md +++ /dev/null @@ -1,11 +0,0 @@ -[**@accelint/converters**](../README.md) • **Docs** - -*** - -[@accelint/converters](../README.md) / XyzTuple - -# Type Alias: XyzTuple - -> **XyzTuple**: [`number`, `number`, `number`] - -[z, x, y] diff --git a/packages/converters/package.json b/packages/converters/package.json index 77c1a8ba..38e7e174 100644 --- a/packages/converters/package.json +++ b/packages/converters/package.json @@ -22,7 +22,6 @@ "bench": "pnpm vitest bench --run --dir src", "build": "pnpm tsup", "dev": "pnpm tsc --watch", - "docs": "pnpm typedoc --logLevel Error --entryPoints src/index.ts --out documentation --readme none --disableSources --plugin typedoc-plugin-markdown", "index": "pnpm zx ../../scripts/indexer.mjs packages/converters", "lint": "pnpm biome lint ./", "test": "pnpm vitest --dir=src" @@ -33,8 +32,6 @@ "@vitest/coverage-istanbul": "2.1.3", "esbuild-plugin-file-path-extensions": "2.1.3", "tsup": "8.3.0", - "typedoc": "0.26.11", - "typedoc-plugin-markdown": "4.2.10", "vitest": "2.1.3" }, "dependencies": { diff --git a/packages/core/documentation/README.md b/packages/core/documentation/README.md deleted file mode 100644 index 6bc13d92..00000000 --- a/packages/core/documentation/README.md +++ /dev/null @@ -1,92 +0,0 @@ -**@accelint/core** • **Docs** - -*** - -# @accelint/core - -## Type Aliases - -- [Accumulator](type-aliases/Accumulator.md) -- [ArrayElementType](type-aliases/ArrayElementType.md) -- [Comparator](type-aliases/Comparator.md) -- [Curried](type-aliases/Curried.md) -- [Lens](type-aliases/Lens.md) -- [MapFn](type-aliases/MapFn.md) -- [Predicate](type-aliases/Predicate.md) -- [UnaryFunction](type-aliases/UnaryFunction.md) - -## Functions - -- [A](functions/A.md) -- [and](functions/and.md) -- [andFn](functions/andFn.md) -- [apply](functions/apply.md) -- [applyTo](functions/applyTo.md) -- [assoc](functions/assoc.md) -- [assocDeep](functions/assocDeep.md) -- [associate](functions/associate.md) -- [associateDeep](functions/associateDeep.md) -- [autoCurry](functions/autoCurry.md) -- [B](functions/B.md) -- [compose](functions/compose.md) -- [composeLens](functions/composeLens.md) -- [composition](functions/composition.md) -- [concat](functions/concat.md) -- [constant](functions/constant.md) -- [equality](functions/equality.md) -- [equalityFn](functions/equalityFn.md) -- [every](functions/every.md) -- [filter](functions/filter.md) -- [find](functions/find.md) -- [findIndex](functions/findIndex.md) -- [findLast](functions/findLast.md) -- [findLastIndex](functions/findLastIndex.md) -- [fork](functions/fork.md) -- [get](functions/get.md) -- [I](functions/I.md) -- [identity](functions/identity.md) -- [includes](functions/includes.md) -- [indexOf](functions/indexOf.md) -- [K](functions/K.md) -- [KI](functions/KI.md) -- [lens](functions/lens.md) -- [lensOptionalProp](functions/lensOptionalProp.md) -- [lensProp](functions/lensProp.md) -- [lookup](functions/lookup.md) -- [map](functions/map.md) -- [nand](functions/nand.md) -- [nandFn](functions/nandFn.md) -- [noop](functions/noop.md) -- [nor](functions/nor.md) -- [norFn](functions/norFn.md) -- [not](functions/not.md) -- [notFn](functions/notFn.md) -- [nullishOr](functions/nullishOr.md) -- [nullishOrFn](functions/nullishOrFn.md) -- [once](functions/once.md) -- [optionalProp](functions/optionalProp.md) -- [optionalProperty](functions/optionalProperty.md) -- [or](functions/or.md) -- [orFn](functions/orFn.md) -- [Phi](functions/Phi.md) -- [pipe](functions/pipe.md) -- [prop](functions/prop.md) -- [property](functions/property.md) -- [Psi](functions/Psi.md) -- [push](functions/push.md) -- [reduce](functions/reduce.md) -- [reduceRight](functions/reduceRight.md) -- [reverse](functions/reverse.md) -- [set](functions/set.md) -- [shift](functions/shift.md) -- [slice](functions/slice.md) -- [some](functions/some.md) -- [swappedNullishOr](functions/swappedNullishOr.md) -- [swappedNullishOrFn](functions/swappedNullishOrFn.md) -- [swappedOr](functions/swappedOr.md) -- [swappedOrFn](functions/swappedOrFn.md) -- [tap](functions/tap.md) -- [Th](functions/Th.md) -- [unshift](functions/unshift.md) -- [xor](functions/xor.md) -- [xorFn](functions/xorFn.md) diff --git a/packages/core/documentation/functions/A.md b/packages/core/documentation/functions/A.md deleted file mode 100644 index 29bfec53..00000000 --- a/packages/core/documentation/functions/A.md +++ /dev/null @@ -1,44 +0,0 @@ -[**@accelint/core**](../README.md) • **Docs** - -*** - -[@accelint/core](../README.md) / A - -# Function: A() - -> **A**\<`T`, `R`\>(`f`): (`x`) => `R` - -Takes an unary function and applies it to the given argument. - -Signature: `A :: (a → b) → a → b` - -Lambda: `λab.ab` - -## Type Parameters - -• **T** - -• **R** - -## Parameters - -• **f** - -## Returns - -`Function` - -### Parameters - -• **x**: `T` - -### Returns - -`R` - -## Example - -```ts -A((a) => a + 6)(3); -// 9 -``` diff --git a/packages/core/documentation/functions/B.md b/packages/core/documentation/functions/B.md deleted file mode 100644 index c0212e71..00000000 --- a/packages/core/documentation/functions/B.md +++ /dev/null @@ -1,58 +0,0 @@ -[**@accelint/core**](../README.md) • **Docs** - -*** - -[@accelint/core](../README.md) / B - -# Function: B() - -> **B**\<`A`, `B`\>(`f`): \<`C`\>(`g`) => (`x`) => `B` - -Pass a value to a function and then the result to another function. - -Bird: `Bluebird` - -Signature: `B :: (a → b) → (c → a) → c → b` - -Lambda: `λabc.a(bc)` - -## Type Parameters - -• **A** - -• **B** - -## Parameters - -• **f** - -## Returns - -`Function` - -### Type Parameters - -• **C** - -### Parameters - -• **g** - -### Returns - -`Function` - -#### Parameters - -• **x**: `C` - -#### Returns - -`B` - -## Example - -```ts -B((x) => x + 8)((x) => x * 3)(4); -// 20 -``` diff --git a/packages/core/documentation/functions/I.md b/packages/core/documentation/functions/I.md deleted file mode 100644 index 646ce722..00000000 --- a/packages/core/documentation/functions/I.md +++ /dev/null @@ -1,37 +0,0 @@ -[**@accelint/core**](../README.md) • **Docs** - -*** - -[@accelint/core](../README.md) / I - -# Function: I() - -> **I**\<`A`\>(`x`): `A` - -Mathematic identity function. A function that always returns the value -that was used as its argument, unchanged. - -Bird: `Idiot` - -Signature: `I :: a → a` - -Lambda: `λa.a` - -## Type Parameters - -• **A** - -## Parameters - -• **x**: `A` - -## Returns - -`A` - -## Example - -```ts -I(4); -// 4 -``` diff --git a/packages/core/documentation/functions/K.md b/packages/core/documentation/functions/K.md deleted file mode 100644 index d515f305..00000000 --- a/packages/core/documentation/functions/K.md +++ /dev/null @@ -1,49 +0,0 @@ -[**@accelint/core**](../README.md) • **Docs** - -*** - -[@accelint/core](../README.md) / K - -# Function: K() - -> **K**\<`A`\>(`a`): \<`B`\>(`_`) => `A` - -Corresponds to the encoding of `true` in the lambda calculus. -Takes two arguments and always returns the first. - -Bird: `Kestrel` - -Signature: `K :: a → b → a` - -Lambda: `λab.a` - -## Type Parameters - -• **A** - -## Parameters - -• **a**: `A` - -## Returns - -`Function` - -### Type Parameters - -• **B** - -### Parameters - -• **\_**: `B` - -### Returns - -`A` - -## Example - -```ts -K(1)(2); -// 1 -``` diff --git a/packages/core/documentation/functions/KI.md b/packages/core/documentation/functions/KI.md deleted file mode 100644 index 38cd7277..00000000 --- a/packages/core/documentation/functions/KI.md +++ /dev/null @@ -1,50 +0,0 @@ -[**@accelint/core**](../README.md) • **Docs** - -*** - -[@accelint/core](../README.md) / KI - -# Function: KI() - -> **KI**\<`A`\>(`_`): \<`B`\>(`b`) => `B` - -Corresponds to the encoding of `false` in the lambda calculus. -Takes two arguments and always returns the second. -Inverse of `constant` (`K`). - -Bird: `Kite` - -Signature: `Ki :: a → b → b` - -Lambda: `λab.b` - -## Type Parameters - -• **A** - -## Parameters - -• **\_**: `A` - -## Returns - -`Function` - -### Type Parameters - -• **B** - -### Parameters - -• **b**: `B` - -### Returns - -`B` - -## Example - -```ts -KI(1)(2); -// 2 -``` diff --git a/packages/core/documentation/functions/Phi.md b/packages/core/documentation/functions/Phi.md deleted file mode 100644 index 96e32021..00000000 --- a/packages/core/documentation/functions/Phi.md +++ /dev/null @@ -1,68 +0,0 @@ -[**@accelint/core**](../README.md) • **Docs** - -*** - -[@accelint/core](../README.md) / Phi - -# Function: Phi() - -> **Phi**\<`A`, `B`, `C`\>(`a`): \<`D`\>(`b`) => (`c`) => (`d`) => `C` - -Pass a value through two different functions and the results to a function that takes two arguments. - -Bird: `Phoenix` - -Signature: (Big) Phi :: (a → b → c) → (d → a) → (d → b) → d → c - -Lambda: λabcd.a(bd)(cd) - -## Type Parameters - -• **A** - -• **B** - -• **C** - -## Parameters - -• **a** - -## Returns - -`Function` - -### Type Parameters - -• **D** - -### Parameters - -• **b** - -### Returns - -`Function` - -#### Parameters - -• **c** - -#### Returns - -`Function` - -##### Parameters - -• **d**: `D` - -##### Returns - -`C` - -## Example - -```ts -Phi((x) => (y) => x + y)(x => x + 3)(x => x - 2)(9) -// 19 -``` diff --git a/packages/core/documentation/functions/Psi.md b/packages/core/documentation/functions/Psi.md deleted file mode 100644 index 8aa977de..00000000 --- a/packages/core/documentation/functions/Psi.md +++ /dev/null @@ -1,64 +0,0 @@ -[**@accelint/core**](../README.md) • **Docs** - -*** - -[@accelint/core](../README.md) / Psi - -# Function: Psi() - -> **Psi**\<`A`, `B`\>(`a`): \<`C`\>(`b`) => (`c`) => (`d`) => `B` - -Pass two values through the same function and pass the results to another function of 2-arity - -Signature: `Psi :: (a → a → b) → (c → a) → c → c → b` - -Lambda: `λabcd.a(bc)(bd)` - -## Type Parameters - -• **A** - -• **B** - -## Parameters - -• **a** - -## Returns - -`Function` - -### Type Parameters - -• **C** - -### Parameters - -• **b** - -### Returns - -`Function` - -#### Parameters - -• **c**: `C` - -#### Returns - -`Function` - -##### Parameters - -• **d**: `C` - -##### Returns - -`B` - -## Example - -```ts -Psi((x) => (y) => x + y)(x => x + 3)(3)(5) -// 14 -``` diff --git a/packages/core/documentation/functions/Th.md b/packages/core/documentation/functions/Th.md deleted file mode 100644 index fa586f9a..00000000 --- a/packages/core/documentation/functions/Th.md +++ /dev/null @@ -1,49 +0,0 @@ -[**@accelint/core**](../README.md) • **Docs** - -*** - -[@accelint/core](../README.md) / Th - -# Function: Th() - -> **Th**\<`A`\>(`a`): \<`B`\>(`b`) => `B` - -Takes an argument and an unary function and then applies the function to the argument. -Inverse of `apply` (`A`) - -Bird: `Thrush` - -Signature: `Th :: a → (a → b) → b` - -Lamda: `λab.ba` - -## Type Parameters - -• **A** - -## Parameters - -• **a**: `A` - -## Returns - -`Function` - -### Type Parameters - -• **B** - -### Parameters - -• **b** - -### Returns - -`B` - -## Example - -```ts -Th(6)(x => x * 2); -// 12 -``` diff --git a/packages/core/documentation/functions/and.md b/packages/core/documentation/functions/and.md deleted file mode 100644 index 08f2cba2..00000000 --- a/packages/core/documentation/functions/and.md +++ /dev/null @@ -1,48 +0,0 @@ -[**@accelint/core**](../README.md) • **Docs** - -*** - -[@accelint/core](../README.md) / and - -# Function: and() - -> **and**\<`A`\>(`a`): \<`B`\>(`b`) => `boolean` - -Logical `(a && b)` - -Logical Conjunction - -## Type Parameters - -• **A** - -## Parameters - -• **a**: `A` - -## Returns - -`Function` - -### Type Parameters - -• **B** - -### Parameters - -• **b**: `B` - -### Returns - -`boolean` - -## Link - -https://en.wikipedia.org/wiki/Logical_conjunction - -## Example - -```ts -and(true)(0); -// false -``` diff --git a/packages/core/documentation/functions/andFn.md b/packages/core/documentation/functions/andFn.md deleted file mode 100644 index 2e3dbd9a..00000000 --- a/packages/core/documentation/functions/andFn.md +++ /dev/null @@ -1,58 +0,0 @@ -[**@accelint/core**](../README.md) • **Docs** - -*** - -[@accelint/core](../README.md) / andFn - -# Function: andFn() - -> **andFn**\<`T`, `A`\>(`a`): \<`B`\>(`b`) => (`c`) => `boolean` - -Logical `(a(x) && b(x))` - -Logical (Function Result) Conjunction - -## Type Parameters - -• **T** - -• **A** - -## Parameters - -• **a** - -## Returns - -`Function` - -### Type Parameters - -• **B** - -### Parameters - -• **b** - -### Returns - -`Function` - -#### Parameters - -• **c**: `T` - -#### Returns - -`boolean` - -## Link - -https://en.wikipedia.org/wiki/Logical_conjunction - -## Example - -```ts -andFn(s => s.trim())(s => s.trimEnd())('foo bar '); -// true -``` diff --git a/packages/core/documentation/functions/apply.md b/packages/core/documentation/functions/apply.md deleted file mode 100644 index 5f7ba422..00000000 --- a/packages/core/documentation/functions/apply.md +++ /dev/null @@ -1,42 +0,0 @@ -[**@accelint/core**](../README.md) • **Docs** - -*** - -[@accelint/core](../README.md) / apply - -# Function: apply() - -> **apply**\<`T`, `R`\>(`f`): (`x`) => `R` - -## Type Parameters - -• **T** - -• **R** - -## Parameters - -• **f** - -## Returns - -`Function` - -### Parameters - -• **x**: `T` - -### Returns - -`R` - -## Alias - -A - -## Example - -```ts -A((a) => a + 6)(3); -// 9 -``` diff --git a/packages/core/documentation/functions/applyTo.md b/packages/core/documentation/functions/applyTo.md deleted file mode 100644 index db009573..00000000 --- a/packages/core/documentation/functions/applyTo.md +++ /dev/null @@ -1,44 +0,0 @@ -[**@accelint/core**](../README.md) • **Docs** - -*** - -[@accelint/core](../README.md) / applyTo - -# Function: applyTo() - -> **applyTo**\<`A`\>(`a`): \<`B`\>(`b`) => `B` - -## Type Parameters - -• **A** - -## Parameters - -• **a**: `A` - -## Returns - -`Function` - -### Type Parameters - -• **B** - -### Parameters - -• **b** - -### Returns - -`B` - -## Alias - -Th - -## Example - -```ts -Th(6)(x => x * 2); -// 12 -``` diff --git a/packages/core/documentation/functions/assoc.md b/packages/core/documentation/functions/assoc.md deleted file mode 100644 index 3b8cf4e1..00000000 --- a/packages/core/documentation/functions/assoc.md +++ /dev/null @@ -1,59 +0,0 @@ -[**@accelint/core**](../README.md) • **Docs** - -*** - -[@accelint/core](../README.md) / assoc - -# Function: assoc() - -> **assoc**\<`T`\>(`obj`): \<`K`\>(`prop`) => (`val`) => `T` - -## Type Parameters - -• **T** *extends* `object` - -## Parameters - -• **obj**: `T` - -## Returns - -`Function` - -### Type Parameters - -• **K** *extends* `string` \| `number` \| `symbol` = keyof `T` - -### Parameters - -• **prop**: `K` - -### Returns - -`Function` - -#### Parameters - -• **val**: `T`\[`K`\] - -#### Returns - -`T` - -## Alias - -associate - -## Example - -```ts -associate(personStore)('address')({ - city: 'Austin', - street: '987 Sample St', -}); -// { -// // ..., -// city: 'Austin', -// street: '987 Sample St', -// } -``` diff --git a/packages/core/documentation/functions/assocDeep.md b/packages/core/documentation/functions/assocDeep.md deleted file mode 100644 index 980f45ef..00000000 --- a/packages/core/documentation/functions/assocDeep.md +++ /dev/null @@ -1,59 +0,0 @@ -[**@accelint/core**](../README.md) • **Docs** - -*** - -[@accelint/core](../README.md) / assocDeep - -# Function: assocDeep() - -> **assocDeep**\<`T`\>(`obj`): \<`K`\>(`prop`) => (`val`) => `T` - -## Type Parameters - -• **T** *extends* `object` - -## Parameters - -• **obj**: `T` - -## Returns - -`Function` - -### Type Parameters - -• **K** *extends* `string` \| `number` \| `symbol` - -### Parameters - -• **prop**: `K` - -### Returns - -`Function` - -#### Parameters - -• **val**: `T`\[`K`\] - -#### Returns - -`T` - -## Alias - -associateDeep - -## Example - -```ts -associateDeep(personStore)('address')({ - city: 'Austin', - street: '987 Sample St', -}); -// { -// // ..., -// city: 'Austin', -// street: '987 Sample St', -// } -``` diff --git a/packages/core/documentation/functions/associate.md b/packages/core/documentation/functions/associate.md deleted file mode 100644 index dae70827..00000000 --- a/packages/core/documentation/functions/associate.md +++ /dev/null @@ -1,57 +0,0 @@ -[**@accelint/core**](../README.md) • **Docs** - -*** - -[@accelint/core](../README.md) / associate - -# Function: associate() - -> **associate**\<`T`\>(`obj`): \<`K`\>(`prop`) => (`val`) => `T` - -Sets the `val` of `prop` in `obj`. Returning a new, shallow copy of the object. - -## Type Parameters - -• **T** *extends* `object` - -## Parameters - -• **obj**: `T` - -## Returns - -`Function` - -### Type Parameters - -• **K** *extends* `string` \| `number` \| `symbol` = keyof `T` - -### Parameters - -• **prop**: `K` - -### Returns - -`Function` - -#### Parameters - -• **val**: `T`\[`K`\] - -#### Returns - -`T` - -## Example - -```ts -associate(personStore)('address')({ - city: 'Austin', - street: '987 Sample St', -}); -// { -// // ..., -// city: 'Austin', -// street: '987 Sample St', -// } -``` diff --git a/packages/core/documentation/functions/associateDeep.md b/packages/core/documentation/functions/associateDeep.md deleted file mode 100644 index fed84e7a..00000000 --- a/packages/core/documentation/functions/associateDeep.md +++ /dev/null @@ -1,57 +0,0 @@ -[**@accelint/core**](../README.md) • **Docs** - -*** - -[@accelint/core](../README.md) / associateDeep - -# Function: associateDeep() - -> **associateDeep**\<`T`\>(`obj`): \<`K`\>(`prop`) => (`val`) => `T` - -Sets the `val` of `prop` in `obj`. Returning a new, deep copy of the object. - -## Type Parameters - -• **T** *extends* `object` - -## Parameters - -• **obj**: `T` - -## Returns - -`Function` - -### Type Parameters - -• **K** *extends* `string` \| `number` \| `symbol` - -### Parameters - -• **prop**: `K` - -### Returns - -`Function` - -#### Parameters - -• **val**: `T`\[`K`\] - -#### Returns - -`T` - -## Example - -```ts -associateDeep(personStore)('address')({ - city: 'Austin', - street: '987 Sample St', -}); -// { -// // ..., -// city: 'Austin', -// street: '987 Sample St', -// } -``` diff --git a/packages/core/documentation/functions/autoCurry.md b/packages/core/documentation/functions/autoCurry.md deleted file mode 100644 index d49931a1..00000000 --- a/packages/core/documentation/functions/autoCurry.md +++ /dev/null @@ -1,35 +0,0 @@ -[**@accelint/core**](../README.md) • **Docs** - -*** - -[@accelint/core](../README.md) / autoCurry - -# Function: autoCurry() - -> **autoCurry**\<`T`\>(`fn`, `_args`): [`Curried`](../type-aliases/Curried.md)\<`Parameters`\<`T`\>, `ReturnType`\<`T`\>\> - -Curries the given function. Allowing it to be accept one or more arguments at a time. - -## Type Parameters - -• **T** *extends* (...`args`) => `any` - -## Parameters - -• **fn**: `T` - -• **\_args**: `any`[] = `...` - -## Returns - -[`Curried`](../type-aliases/Curried.md)\<`Parameters`\<`T`\>, `ReturnType`\<`T`\>\> - -## Example - -```ts -const curried = autoCurry((a, b, c) => (a + b) * c); -curried(2)(3)(4); -curried(2, 3)(4); -curried(2)(3, 4); -curried(2, 3, 4); -``` diff --git a/packages/core/documentation/functions/compose.md b/packages/core/documentation/functions/compose.md deleted file mode 100644 index b4b6729c..00000000 --- a/packages/core/documentation/functions/compose.md +++ /dev/null @@ -1,44 +0,0 @@ -[**@accelint/core**](../README.md) • **Docs** - -*** - -[@accelint/core](../README.md) / compose - -# Function: compose() - -> **compose**\<`Fns`\>(...`fns`): (`arg`) => `ReturnType`\<`Fns`\[`0`\]\> - -Allows you combine two or more functions to create a new function, which passes the results from one -function to the next until all have be called. Has a rigth-to-left call order. - -## Type Parameters - -• **Fns** *extends* readonly [`UnaryFunction`](../type-aliases/UnaryFunction.md)[] - -## Parameters - -• ...**fns**: `Composable`\<`Fns`\> - -## Returns - -`Function` - -### Parameters - -• **arg**: `ComposeParams`\<`Fns`\> - -### Returns - -`ReturnType`\<`Fns`\[`0`\]\> - -## Example - -```ts -const getActiveUsers = page => compose( - displayPage, - sortUserNames, - filterActive, -); - -const activeUsers = getActiveUsersByPage(users); -``` diff --git a/packages/core/documentation/functions/composeLens.md b/packages/core/documentation/functions/composeLens.md deleted file mode 100644 index 0e640265..00000000 --- a/packages/core/documentation/functions/composeLens.md +++ /dev/null @@ -1,46 +0,0 @@ -[**@accelint/core**](../README.md) • **Docs** - -*** - -[@accelint/core](../README.md) / composeLens - -# Function: composeLens() - -> **composeLens**\<`A`, `B`, `C`\>(`ab`, `bc`): [`Lens`](../type-aliases/Lens.md)\<`A`, `C`\> - -Compose two lenses together. - -Given a lens `A ⭢ B` and a lens `B ⭢ C`, produces a lens `A ⭢ C`. - -## Type Parameters - -• **A** - -• **B** - -• **C** - -## Parameters - -• **ab**: [`Lens`](../type-aliases/Lens.md)\<`A`, `B`\> - -• **bc**: [`Lens`](../type-aliases/Lens.md)\<`B`, `C`\> - -## Returns - -[`Lens`](../type-aliases/Lens.md)\<`A`, `C`\> - -## Example - -```ts -const addressLens = lens( - (person: Person) => property(person)('address'), - (person) => (addr) => associateDeep(person)('address')(addr) -); -const cityLens = lens( - (address?: Address) => optionalProperty(address)('city'), - (address) => (city) => associateDeep(address)('city')(city) -); - -const personCityLens = composeLens(addressLens, cityLens); -``` diff --git a/packages/core/documentation/functions/composition.md b/packages/core/documentation/functions/composition.md deleted file mode 100644 index 9356edf5..00000000 --- a/packages/core/documentation/functions/composition.md +++ /dev/null @@ -1,54 +0,0 @@ -[**@accelint/core**](../README.md) • **Docs** - -*** - -[@accelint/core](../README.md) / composition - -# Function: composition() - -> **composition**\<`A`, `B`\>(`f`): \<`C`\>(`g`) => (`x`) => `B` - -## Type Parameters - -• **A** - -• **B** - -## Parameters - -• **f** - -## Returns - -`Function` - -### Type Parameters - -• **C** - -### Parameters - -• **g** - -### Returns - -`Function` - -#### Parameters - -• **x**: `C` - -#### Returns - -`B` - -## Alias - -B - -## Example - -```ts -B((x) => x + 8)((x) => x * 3)(4); -// 20 -``` diff --git a/packages/core/documentation/functions/concat.md b/packages/core/documentation/functions/concat.md deleted file mode 100644 index dec2c20b..00000000 --- a/packages/core/documentation/functions/concat.md +++ /dev/null @@ -1,38 +0,0 @@ -[**@accelint/core**](../README.md) • **Docs** - -*** - -[@accelint/core](../README.md) / concat - -# Function: concat() - -> **concat**\<`T`\>(`newValue`): (`concatable`) => `T`[] - -Concatenate the two given arrays together. - -## Type Parameters - -• **T** - -## Parameters - -• **newValue**: `T`[] - -## Returns - -`Function` - -### Parameters - -• **concatable**: `T`[] - -### Returns - -`T`[] - -## Example - -```ts -concat([1, 2, 3])([4, 5, 6]); -// [1, 2, 3, 4, 5, 6] -``` diff --git a/packages/core/documentation/functions/constant.md b/packages/core/documentation/functions/constant.md deleted file mode 100644 index e3da8750..00000000 --- a/packages/core/documentation/functions/constant.md +++ /dev/null @@ -1,44 +0,0 @@ -[**@accelint/core**](../README.md) • **Docs** - -*** - -[@accelint/core](../README.md) / constant - -# Function: constant() - -> **constant**\<`A`\>(`a`): \<`B`\>(`_`) => `A` - -## Type Parameters - -• **A** - -## Parameters - -• **a**: `A` - -## Returns - -`Function` - -### Type Parameters - -• **B** - -### Parameters - -• **\_**: `B` - -### Returns - -`A` - -## Alias - -K - -## Example - -```ts -K(1)(2); -// 1 -``` diff --git a/packages/core/documentation/functions/equality.md b/packages/core/documentation/functions/equality.md deleted file mode 100644 index 8e686f2b..00000000 --- a/packages/core/documentation/functions/equality.md +++ /dev/null @@ -1,44 +0,0 @@ -[**@accelint/core**](../README.md) • **Docs** - -*** - -[@accelint/core](../README.md) / equality - -# Function: equality() - -> **equality**(`a`): (`b`) => `boolean` - -Logical `(a === b)` - -XNOR - -## Parameters - -• **a**: `unknown` - -## Returns - -`Function` - -### Parameters - -• **b**: `unknown` - -### Returns - -`boolean` - -## Link - -https://en.wikipedia.org/wiki/Logical_equality - -## Link - -https://en.wikipedia.org/wiki/Logical_biconditional - -## Example - -```ts -equality(4)(8); -// false -``` diff --git a/packages/core/documentation/functions/equalityFn.md b/packages/core/documentation/functions/equalityFn.md deleted file mode 100644 index bdf7fa13..00000000 --- a/packages/core/documentation/functions/equalityFn.md +++ /dev/null @@ -1,54 +0,0 @@ -[**@accelint/core**](../README.md) • **Docs** - -*** - -[@accelint/core](../README.md) / equalityFn - -# Function: equalityFn() - -> **equalityFn**\<`T`\>(`a`): (`b`) => (`c`) => `boolean` - -Logical `(a(x) === b(x))` - -## Type Parameters - -• **T** - -## Parameters - -• **a** - -## Returns - -`Function` - -### Parameters - -• **b** - -### Returns - -`Function` - -#### Parameters - -• **c**: `T` - -#### Returns - -`boolean` - -## Link - -https://en.wikipedia.org/wiki/Logical_equality - -## Link - -https://en.wikipedia.org/wiki/Logical_biconditional - -## Example - -```ts -equalityFn(s => s.trim())(s => s.trimEnd())('foo bar '); -// true -``` diff --git a/packages/core/documentation/functions/every.md b/packages/core/documentation/functions/every.md deleted file mode 100644 index 3d1bbd67..00000000 --- a/packages/core/documentation/functions/every.md +++ /dev/null @@ -1,38 +0,0 @@ -[**@accelint/core**](../README.md) • **Docs** - -*** - -[@accelint/core](../README.md) / every - -# Function: every() - -> **every**\<`T`\>(`comparator`): (`arr`) => `boolean` - -Tests whether all elements in the array pass the given comparator. - -## Type Parameters - -• **T** - -## Parameters - -• **comparator**: [`Comparator`](../type-aliases/Comparator.md)\<`T`\> - -## Returns - -`Function` - -### Parameters - -• **arr**: `T`[] - -### Returns - -`boolean` - -## Example - -```ts -every(x => !(x & 1))([1, 2, 3, 4, 5]); -// false -``` diff --git a/packages/core/documentation/functions/filter.md b/packages/core/documentation/functions/filter.md deleted file mode 100644 index fadb0ece..00000000 --- a/packages/core/documentation/functions/filter.md +++ /dev/null @@ -1,38 +0,0 @@ -[**@accelint/core**](../README.md) • **Docs** - -*** - -[@accelint/core](../README.md) / filter - -# Function: filter() - -> **filter**\<`T`\>(`predicate`): (`arr`) => `T`[] - -Returns a copy of the given array of elements that satisfy the predicate. - -## Type Parameters - -• **T** - -## Parameters - -• **predicate**: [`Predicate`](../type-aliases/Predicate.md)\<`T`\> - -## Returns - -`Function` - -### Parameters - -• **arr**: `T`[] - -### Returns - -`T`[] - -## Example - -```ts -filter(x => !(x & 1))([1, 2, 3, 4, 5]); -// [2, 4] -``` diff --git a/packages/core/documentation/functions/find.md b/packages/core/documentation/functions/find.md deleted file mode 100644 index 2b1209ab..00000000 --- a/packages/core/documentation/functions/find.md +++ /dev/null @@ -1,39 +0,0 @@ -[**@accelint/core**](../README.md) • **Docs** - -*** - -[@accelint/core](../README.md) / find - -# Function: find() - -> **find**\<`T`\>(`predicate`): (`arr`) => `undefined` \| `null` \| `T` - -Returns the first element of the given array that satisfies the predicate. -Returns `null` otherwise. - -## Type Parameters - -• **T** - -## Parameters - -• **predicate**: [`Predicate`](../type-aliases/Predicate.md)\<`T`\> - -## Returns - -`Function` - -### Parameters - -• **arr**: `T`[] - -### Returns - -`undefined` \| `null` \| `T` - -## Example - -```ts -find(x => !(x & 1))([1, 2, 3, 4, 5]); -// 2 -``` diff --git a/packages/core/documentation/functions/findIndex.md b/packages/core/documentation/functions/findIndex.md deleted file mode 100644 index 22988963..00000000 --- a/packages/core/documentation/functions/findIndex.md +++ /dev/null @@ -1,39 +0,0 @@ -[**@accelint/core**](../README.md) • **Docs** - -*** - -[@accelint/core](../README.md) / findIndex - -# Function: findIndex() - -> **findIndex**\<`T`\>(`predicate`): (`arr`) => `number` - -Returns the first index of the given array that satisfies the predicate. -Returns `-1` otherwise. - -## Type Parameters - -• **T** - -## Parameters - -• **predicate**: [`Predicate`](../type-aliases/Predicate.md)\<`T`\> - -## Returns - -`Function` - -### Parameters - -• **arr**: `T`[] - -### Returns - -`number` - -## Example - -```ts -findIndex(x => !(x & 1))([1, 2, 3, 4, 5]); -// 1 -``` diff --git a/packages/core/documentation/functions/findLast.md b/packages/core/documentation/functions/findLast.md deleted file mode 100644 index aeee48f2..00000000 --- a/packages/core/documentation/functions/findLast.md +++ /dev/null @@ -1,39 +0,0 @@ -[**@accelint/core**](../README.md) • **Docs** - -*** - -[@accelint/core](../README.md) / findLast - -# Function: findLast() - -> **findLast**\<`T`\>(`predicate`): (`arr`) => `undefined` \| `null` \| `T` - -Returns the last element of the given array that satisfies the predicate. -Returns `null` otherwise. - -## Type Parameters - -• **T** - -## Parameters - -• **predicate**: [`Predicate`](../type-aliases/Predicate.md)\<`T`\> - -## Returns - -`Function` - -### Parameters - -• **arr**: `T`[] - -### Returns - -`undefined` \| `null` \| `T` - -## Example - -```ts -findLast(x => !(x & 1))([1, 2, 3, 4, 5]); -// 4 -``` diff --git a/packages/core/documentation/functions/findLastIndex.md b/packages/core/documentation/functions/findLastIndex.md deleted file mode 100644 index c36c7b3b..00000000 --- a/packages/core/documentation/functions/findLastIndex.md +++ /dev/null @@ -1,39 +0,0 @@ -[**@accelint/core**](../README.md) • **Docs** - -*** - -[@accelint/core](../README.md) / findLastIndex - -# Function: findLastIndex() - -> **findLastIndex**\<`T`\>(`predicate`): (`arr`) => `number` - -Returns the last index of the given array that satisfies the predicate. -Returns `-1` otherwise. - -## Type Parameters - -• **T** - -## Parameters - -• **predicate**: [`Predicate`](../type-aliases/Predicate.md)\<`T`\> - -## Returns - -`Function` - -### Parameters - -• **arr**: `T`[] - -### Returns - -`number` - -## Example - -```ts -findLastIndex(x => !(x & 1))([1, 2, 3, 4, 5]); -// 3 -``` diff --git a/packages/core/documentation/functions/fork.md b/packages/core/documentation/functions/fork.md deleted file mode 100644 index ab7a18c8..00000000 --- a/packages/core/documentation/functions/fork.md +++ /dev/null @@ -1,64 +0,0 @@ -[**@accelint/core**](../README.md) • **Docs** - -*** - -[@accelint/core](../README.md) / fork - -# Function: fork() - -> **fork**\<`A`, `B`, `C`\>(`a`): \<`D`\>(`b`) => (`c`) => (`d`) => `C` - -## Type Parameters - -• **A** - -• **B** - -• **C** - -## Parameters - -• **a** - -## Returns - -`Function` - -### Type Parameters - -• **D** - -### Parameters - -• **b** - -### Returns - -`Function` - -#### Parameters - -• **c** - -#### Returns - -`Function` - -##### Parameters - -• **d**: `D` - -##### Returns - -`C` - -## Alias - -Phi - -## Example - -```ts -Phi((x) => (y) => x + y)(x => x + 3)(x => x - 2)(9) -// 19 -``` diff --git a/packages/core/documentation/functions/get.md b/packages/core/documentation/functions/get.md deleted file mode 100644 index 4f4c670a..00000000 --- a/packages/core/documentation/functions/get.md +++ /dev/null @@ -1,39 +0,0 @@ -[**@accelint/core**](../README.md) • **Docs** - -*** - -[@accelint/core](../README.md) / get - -# Function: get() - -> **get**\<`T`, `V`\>(`lensVal`): (`obj`) => `V` - -A simple warpper function to access the `get` of a lens and the given object. - -## Type Parameters - -• **T** - -• **V** - -## Parameters - -• **lensVal**: [`Lens`](../type-aliases/Lens.md)\<`T`, `V`\> - -## Returns - -`Function` - -### Parameters - -• **obj**: `T` - -### Returns - -`V` - -## Example - -```ts -get(nameLens)(personStore); -``` diff --git a/packages/core/documentation/functions/identity.md b/packages/core/documentation/functions/identity.md deleted file mode 100644 index cf0bb47e..00000000 --- a/packages/core/documentation/functions/identity.md +++ /dev/null @@ -1,32 +0,0 @@ -[**@accelint/core**](../README.md) • **Docs** - -*** - -[@accelint/core](../README.md) / identity - -# Function: identity() - -> **identity**\<`A`\>(`x`): `A` - -## Type Parameters - -• **A** - -## Parameters - -• **x**: `A` - -## Returns - -`A` - -## Alias - -I - -## Example - -```ts -I(4); -// 4 -``` diff --git a/packages/core/documentation/functions/includes.md b/packages/core/documentation/functions/includes.md deleted file mode 100644 index 79912c3e..00000000 --- a/packages/core/documentation/functions/includes.md +++ /dev/null @@ -1,39 +0,0 @@ -[**@accelint/core**](../README.md) • **Docs** - -*** - -[@accelint/core](../README.md) / includes - -# Function: includes() - -> **includes**\<`T`\>(`x`): (`arr`) => `boolean` - -Determines whether the given array includes and element. -Uses strict equality. - -## Type Parameters - -• **T** - -## Parameters - -• **x**: `T` - -## Returns - -`Function` - -### Parameters - -• **arr**: `T`[] - -### Returns - -`boolean` - -## Example - -```ts -includes(3)([[1, 2, 3, 4, 5]]) -// true -``` diff --git a/packages/core/documentation/functions/indexOf.md b/packages/core/documentation/functions/indexOf.md deleted file mode 100644 index a671976b..00000000 --- a/packages/core/documentation/functions/indexOf.md +++ /dev/null @@ -1,39 +0,0 @@ -[**@accelint/core**](../README.md) • **Docs** - -*** - -[@accelint/core](../README.md) / indexOf - -# Function: indexOf() - -> **indexOf**\<`T`\>(`x`): (`arr`) => `number` - -Returns the first index as which a given element can be found in the array. -Returns `-1` otherwise. - -## Type Parameters - -• **T** - -## Parameters - -• **x**: `T` - -## Returns - -`Function` - -### Parameters - -• **arr**: `T`[] - -### Returns - -`number` - -## Example - -```ts -indexOf(3)([[1, 2, 3, 4, 5]]) -// 2 -``` diff --git a/packages/core/documentation/functions/lens.md b/packages/core/documentation/functions/lens.md deleted file mode 100644 index 0c8dbf86..00000000 --- a/packages/core/documentation/functions/lens.md +++ /dev/null @@ -1,45 +0,0 @@ -[**@accelint/core**](../README.md) • **Docs** - -*** - -[@accelint/core](../README.md) / lens - -# Function: lens() - -> **lens**\<`T`, `V`\>(`getter`, `setter`): [`Lens`](../type-aliases/Lens.md)\<`T`, `V`\> - -Focus on and manipulate a specific property or substructure within an object. - -## Type Parameters - -• **T** - -• **V** - -## Parameters - -• **getter**: `LenseGet`\<`T`, `V`\> - -• **setter**: `LenseSet`\<`T`, `V`\> - -## Returns - -[`Lens`](../type-aliases/Lens.md)\<`T`, `V`\> - -## Example - -```ts -const nameLens = lens( - (person: Person) => person.name, - (person, name) => ({ ...person, name }) -); - -const name = nameLens.get(person); - -const { get: getUsername, set: setUsername } = lens( - (user: User) => property(user)('username'), - (user, name) => associateDeep(user)('username')(name) -); - -const username = getUsername(user); -``` diff --git a/packages/core/documentation/functions/lensOptionalProp.md b/packages/core/documentation/functions/lensOptionalProp.md deleted file mode 100644 index f395e043..00000000 --- a/packages/core/documentation/functions/lensOptionalProp.md +++ /dev/null @@ -1,37 +0,0 @@ -[**@accelint/core**](../README.md) • **Docs** - -*** - -[@accelint/core](../README.md) / lensOptionalProp - -# Function: lensOptionalProp() - -> **lensOptionalProp**\<`T`\>(): \<`K`\>(`prop`) => [`Lens`](../type-aliases/Lens.md)\<`T`, `undefined` \| `T`\[`K`\]\> - -Short-hand to create is simplistic, optional, get/set lens. - -## Type Parameters - -• **T** *extends* `object` - -## Returns - -`Function` - -### Type Parameters - -• **K** *extends* `string` \| `number` \| `symbol` - -### Parameters - -• **prop**: `K` - -### Returns - -[`Lens`](../type-aliases/Lens.md)\<`T`, `undefined` \| `T`\[`K`\]\> - -## Example - -```ts -const { get, set } = lensOptionalProp()('name'); -``` diff --git a/packages/core/documentation/functions/lensProp.md b/packages/core/documentation/functions/lensProp.md deleted file mode 100644 index 125c4f47..00000000 --- a/packages/core/documentation/functions/lensProp.md +++ /dev/null @@ -1,37 +0,0 @@ -[**@accelint/core**](../README.md) • **Docs** - -*** - -[@accelint/core](../README.md) / lensProp - -# Function: lensProp() - -> **lensProp**\<`T`\>(): \<`K`\>(`prop`) => [`Lens`](../type-aliases/Lens.md)\<`T`, `T`\[`K`\]\> - -Short-hand to create is simplistic get/set lens. - -## Type Parameters - -• **T** *extends* `object` - -## Returns - -`Function` - -### Type Parameters - -• **K** *extends* `string` \| `number` \| `symbol` - -### Parameters - -• **prop**: `K` - -### Returns - -[`Lens`](../type-aliases/Lens.md)\<`T`, `T`\[`K`\]\> - -## Example - -```ts -const { get, set } = lensProp()('name'); -``` diff --git a/packages/core/documentation/functions/lookup.md b/packages/core/documentation/functions/lookup.md deleted file mode 100644 index 475df68a..00000000 --- a/packages/core/documentation/functions/lookup.md +++ /dev/null @@ -1,54 +0,0 @@ -[**@accelint/core**](../README.md) • **Docs** - -*** - -[@accelint/core](../README.md) / lookup - -# Function: lookup() - -> **lookup**\<`A`, `B`\>(`obj`, `def`?): \<`C`\>(`prop`) => `A`\[`C`\] - -Takes an object and an optional fallback function and returns a function that -takes a string and returns the lookup value or the result default fallback. - -## Type Parameters - -• **A** *extends* `Record`\<`string` \| `number` \| `symbol`, `unknown`\> - -• **B** *extends* (...`args`) => `any` - -## Parameters - -• **obj**: `A` - -• **def?**: `B` - -## Returns - -`Function` - -### Type Parameters - -• **C** *extends* `string` \| `number` \| `symbol` - -### Parameters - -• **prop**: `string` \| `number` \| `symbol` - -### Returns - -`A`\[`C`\] - -## Example - -```ts -const colorTable = { - FOO: [0, 0, 255, 155], - BAR: [255, 0, 255, 155], - FIZZ: [230, 0, 0, 155], - BUZZ: [0, 128, 0, 155], -}; - -const colorLookup = tableLookup(colorTable, x => x ?? [128, 128, 128, 155]); -colorLookup(data.value); -``` diff --git a/packages/core/documentation/functions/map.md b/packages/core/documentation/functions/map.md deleted file mode 100644 index f6cc2a22..00000000 --- a/packages/core/documentation/functions/map.md +++ /dev/null @@ -1,41 +0,0 @@ -[**@accelint/core**](../README.md) • **Docs** - -*** - -[@accelint/core](../README.md) / map - -# Function: map() - -> **map**\<`T`, `R`\>(`map`): (`arr`) => `R`[] - -Maps over the given array, calling the mapping function for each element. -Returns a new array of the results. - -## Type Parameters - -• **T** - -• **R** - -## Parameters - -• **map**: [`MapFn`](../type-aliases/MapFn.md)\<`T`, `R`\> - -## Returns - -`Function` - -### Parameters - -• **arr**: `T`[] - -### Returns - -`R`[] - -## Example - -```ts -map(x => x * 2)([1, 2, 3, 4, 5]); -// [2, 4, 6, 8, 10] -``` diff --git a/packages/core/documentation/functions/nand.md b/packages/core/documentation/functions/nand.md deleted file mode 100644 index c4f150dc..00000000 --- a/packages/core/documentation/functions/nand.md +++ /dev/null @@ -1,48 +0,0 @@ -[**@accelint/core**](../README.md) • **Docs** - -*** - -[@accelint/core](../README.md) / nand - -# Function: nand() - -> **nand**\<`A`\>(`a`): \<`B`\>(`b`) => `boolean` - -Logical `!(a && b)` - -Logical Non-conjunction - -## Type Parameters - -• **A** - -## Parameters - -• **a**: `A` - -## Returns - -`Function` - -### Type Parameters - -• **B** - -### Parameters - -• **b**: `B` - -### Returns - -`boolean` - -## Link - -https://en.wikipedia.org/wiki/Sheffer_stroke - -## Example - -```ts -nand(true)(0); -// true -``` diff --git a/packages/core/documentation/functions/nandFn.md b/packages/core/documentation/functions/nandFn.md deleted file mode 100644 index 0ee35678..00000000 --- a/packages/core/documentation/functions/nandFn.md +++ /dev/null @@ -1,58 +0,0 @@ -[**@accelint/core**](../README.md) • **Docs** - -*** - -[@accelint/core](../README.md) / nandFn - -# Function: nandFn() - -> **nandFn**\<`T`, `A`\>(`a`): \<`B`\>(`b`) => (`c`) => `boolean` - -Logical `!(a(x) && b(x))` - -Logical (Function Result) Non-conjunction - -## Type Parameters - -• **T** - -• **A** - -## Parameters - -• **a** - -## Returns - -`Function` - -### Type Parameters - -• **B** - -### Parameters - -• **b** - -### Returns - -`Function` - -#### Parameters - -• **c**: `T` - -#### Returns - -`boolean` - -## Link - -https://en.wikipedia.org/wiki/Sheffer_stroke - -## Example - -```ts -nandFn(s => s.trim())(s => s.trimEnd())('foo bar '); -// false -``` diff --git a/packages/core/documentation/functions/noop.md b/packages/core/documentation/functions/noop.md deleted file mode 100644 index aa59eecf..00000000 --- a/packages/core/documentation/functions/noop.md +++ /dev/null @@ -1,19 +0,0 @@ -[**@accelint/core**](../README.md) • **Docs** - -*** - -[@accelint/core](../README.md) / noop - -# Function: noop() - -> **noop**(`_x`?): `void` - -A no operation function - -## Parameters - -• **\_x?**: `unknown` - -## Returns - -`void` diff --git a/packages/core/documentation/functions/nor.md b/packages/core/documentation/functions/nor.md deleted file mode 100644 index 973867ca..00000000 --- a/packages/core/documentation/functions/nor.md +++ /dev/null @@ -1,48 +0,0 @@ -[**@accelint/core**](../README.md) • **Docs** - -*** - -[@accelint/core](../README.md) / nor - -# Function: nor() - -> **nor**\<`A`\>(`a`): \<`B`\>(`b`) => `boolean` - -Logical `!(a || b)` - -Logical Non-disjunction - -## Type Parameters - -• **A** - -## Parameters - -• **a**: `A` - -## Returns - -`Function` - -### Type Parameters - -• **B** - -### Parameters - -• **b**: `B` - -### Returns - -`boolean` - -## Link - -https://en.wikipedia.org/wiki/Logical_NOR - -## Example - -```ts -nor(true)(0); -// false -``` diff --git a/packages/core/documentation/functions/norFn.md b/packages/core/documentation/functions/norFn.md deleted file mode 100644 index e653f394..00000000 --- a/packages/core/documentation/functions/norFn.md +++ /dev/null @@ -1,58 +0,0 @@ -[**@accelint/core**](../README.md) • **Docs** - -*** - -[@accelint/core](../README.md) / norFn - -# Function: norFn() - -> **norFn**\<`T`, `A`\>(`a`): \<`B`\>(`b`) => (`c`) => `boolean` - -Logical `!(a(x) || b(x))` - -Logical (Function Result) Non-disjunction - -## Type Parameters - -• **T** - -• **A** - -## Parameters - -• **a** - -## Returns - -`Function` - -### Type Parameters - -• **B** - -### Parameters - -• **b** - -### Returns - -`Function` - -#### Parameters - -• **c**: `T` - -#### Returns - -`boolean` - -## Link - -https://en.wikipedia.org/wiki/Logical_NOR - -## Example - -```ts -norFn(s => s.trim())(s => s.trimEnd())('foo bar '); -// false -``` diff --git a/packages/core/documentation/functions/not.md b/packages/core/documentation/functions/not.md deleted file mode 100644 index 66fadd89..00000000 --- a/packages/core/documentation/functions/not.md +++ /dev/null @@ -1,36 +0,0 @@ -[**@accelint/core**](../README.md) • **Docs** - -*** - -[@accelint/core](../README.md) / not - -# Function: not() - -> **not**\<`T`\>(`x`): `boolean` - -Logical `(!a)` - -Logical Not (Negation) - -## Type Parameters - -• **T** - -## Parameters - -• **x**: `T` - -## Returns - -`boolean` - -## Link - -https://en.wikipedia.org/wiki/Negation - -## Example - -```ts -not(2); -// false -``` diff --git a/packages/core/documentation/functions/notFn.md b/packages/core/documentation/functions/notFn.md deleted file mode 100644 index a5c82693..00000000 --- a/packages/core/documentation/functions/notFn.md +++ /dev/null @@ -1,44 +0,0 @@ -[**@accelint/core**](../README.md) • **Docs** - -*** - -[@accelint/core](../README.md) / notFn - -# Function: notFn() - -> **notFn**\<`T`\>(`a`): (`b`) => `boolean` - -Logical `(!a(b))` - -Logical (Function Result) Not (Negation) - -## Type Parameters - -• **T** - -## Parameters - -• **a** - -## Returns - -`Function` - -### Parameters - -• **b**: `T` - -### Returns - -`boolean` - -## Link - -https://en.wikipedia.org/wiki/Negation - -## Example - -```ts -notFn(x => x & 1)(4); -// true -``` diff --git a/packages/core/documentation/functions/nullishOr.md b/packages/core/documentation/functions/nullishOr.md deleted file mode 100644 index 2404ded7..00000000 --- a/packages/core/documentation/functions/nullishOr.md +++ /dev/null @@ -1,42 +0,0 @@ -[**@accelint/core**](../README.md) • **Docs** - -*** - -[@accelint/core](../README.md) / nullishOr - -# Function: nullishOr() - -> **nullishOr**\<`A`\>(`a`): \<`B`\>(`b`) => `B` \| `NonNullable`\<`A`\> - -Nullish Coalescing `(a ?? b)` - -## Type Parameters - -• **A** - -## Parameters - -• **a**: `A` - -## Returns - -`Function` - -### Type Parameters - -• **B** - -### Parameters - -• **b**: `B` - -### Returns - -`B` \| `NonNullable`\<`A`\> - -## Example - -```ts -nullishOr(null)(4); -// 4 -``` diff --git a/packages/core/documentation/functions/nullishOrFn.md b/packages/core/documentation/functions/nullishOrFn.md deleted file mode 100644 index 1c0995c9..00000000 --- a/packages/core/documentation/functions/nullishOrFn.md +++ /dev/null @@ -1,52 +0,0 @@ -[**@accelint/core**](../README.md) • **Docs** - -*** - -[@accelint/core](../README.md) / nullishOrFn - -# Function: nullishOrFn() - -> **nullishOrFn**\<`T`, `A`\>(`a`): \<`B`\>(`b`) => (`c`) => `B` \| `NonNullable`\<`A`\> - -Nullish Coalescing `(a(x) ?? b(x))` - -## Type Parameters - -• **T** - -• **A** - -## Parameters - -• **a** - -## Returns - -`Function` - -### Type Parameters - -• **B** - -### Parameters - -• **b** - -### Returns - -`Function` - -#### Parameters - -• **c**: `T` - -#### Returns - -`B` \| `NonNullable`\<`A`\> - -## Example - -```ts -nullishOrFn(x => x.foo)(x => x.bar)({ bar: 4 }); -// 4 -``` diff --git a/packages/core/documentation/functions/once.md b/packages/core/documentation/functions/once.md deleted file mode 100644 index 0dada7d9..00000000 --- a/packages/core/documentation/functions/once.md +++ /dev/null @@ -1,31 +0,0 @@ -[**@accelint/core**](../README.md) • **Docs** - -*** - -[@accelint/core](../README.md) / once - -# Function: once() - -> **once**\<`T`\>(`fn`): (...`args`) => `void` \| `ReturnType`\<`T`\> - -Ensures that the given function is only called once. - -## Type Parameters - -• **T** *extends* `SomeFunction` - -## Parameters - -• **fn**: `T` - -## Returns - -`Function` - -### Parameters - -• ...**args**: `Parameters`\<`T`\> - -### Returns - -`void` \| `ReturnType`\<`T`\> diff --git a/packages/core/documentation/functions/optionalProp.md b/packages/core/documentation/functions/optionalProp.md deleted file mode 100644 index 1438417b..00000000 --- a/packages/core/documentation/functions/optionalProp.md +++ /dev/null @@ -1,47 +0,0 @@ -[**@accelint/core**](../README.md) • **Docs** - -*** - -[@accelint/core](../README.md) / optionalProp - -# Function: optionalProp() - -> **optionalProp**\<`T`\>(`obj`?): \<`K`\>(`prop`) => `undefined` \| `T`\[`K`\] - -## Type Parameters - -• **T** *extends* `object` - -## Parameters - -• **obj?**: `T` - -## Returns - -`Function` - -### Type Parameters - -• **K** *extends* `string` \| `number` \| `symbol` - -### Parameters - -• **prop**: `K` - -### Returns - -`undefined` \| `T`\[`K`\] - -## Alias - -optionalProperty - -## Example - -```ts -optionalProperty(personStore)('address'); -// personStore?.address - -optionalProperty(userStore.profile)(0); -// userStore?.profile?.at(0) -``` diff --git a/packages/core/documentation/functions/optionalProperty.md b/packages/core/documentation/functions/optionalProperty.md deleted file mode 100644 index f5988cd6..00000000 --- a/packages/core/documentation/functions/optionalProperty.md +++ /dev/null @@ -1,45 +0,0 @@ -[**@accelint/core**](../README.md) • **Docs** - -*** - -[@accelint/core](../README.md) / optionalProperty - -# Function: optionalProperty() - -> **optionalProperty**\<`T`\>(`obj`?): \<`K`\>(`prop`) => `undefined` \| `T`\[`K`\] - -Gets the optional value of `prop` in `obj`. Array index support. - -## Type Parameters - -• **T** *extends* `object` - -## Parameters - -• **obj?**: `T` - -## Returns - -`Function` - -### Type Parameters - -• **K** *extends* `string` \| `number` \| `symbol` - -### Parameters - -• **prop**: `K` - -### Returns - -`undefined` \| `T`\[`K`\] - -## Example - -```ts -optionalProperty(personStore)('address'); -// personStore?.address - -optionalProperty(userStore.profile)(0); -// userStore?.profile?.at(0) -``` diff --git a/packages/core/documentation/functions/or.md b/packages/core/documentation/functions/or.md deleted file mode 100644 index 4cbf1454..00000000 --- a/packages/core/documentation/functions/or.md +++ /dev/null @@ -1,48 +0,0 @@ -[**@accelint/core**](../README.md) • **Docs** - -*** - -[@accelint/core](../README.md) / or - -# Function: or() - -> **or**\<`A`\>(`a`): \<`B`\>(`b`) => `boolean` - -Logical `(a || b)` - -Logical Disjunction - -## Type Parameters - -• **A** - -## Parameters - -• **a**: `A` - -## Returns - -`Function` - -### Type Parameters - -• **B** - -### Parameters - -• **b**: `B` - -### Returns - -`boolean` - -## Link - -https://en.wikipedia.org/wiki/Logical_disjunction - -## Example - -```ts -or(true)(0); -// true -``` diff --git a/packages/core/documentation/functions/orFn.md b/packages/core/documentation/functions/orFn.md deleted file mode 100644 index 4474e050..00000000 --- a/packages/core/documentation/functions/orFn.md +++ /dev/null @@ -1,58 +0,0 @@ -[**@accelint/core**](../README.md) • **Docs** - -*** - -[@accelint/core](../README.md) / orFn - -# Function: orFn() - -> **orFn**\<`T`, `A`\>(`a`): \<`B`\>(`b`) => (`c`) => `boolean` - -Logical `(a(x) || b(x))` - -Logical (Function Result) Disjunction - -## Type Parameters - -• **T** - -• **A** - -## Parameters - -• **a** - -## Returns - -`Function` - -### Type Parameters - -• **B** - -### Parameters - -• **b** - -### Returns - -`Function` - -#### Parameters - -• **c**: `T` - -#### Returns - -`boolean` - -## Link - -https://en.wikipedia.org/wiki/Logical_disjunction - -## Example - -```ts -orFn(s => s.trim())(s => s.trimEnd())('foo bar '); -// true -``` diff --git a/packages/core/documentation/functions/pipe.md b/packages/core/documentation/functions/pipe.md deleted file mode 100644 index 03365085..00000000 --- a/packages/core/documentation/functions/pipe.md +++ /dev/null @@ -1,44 +0,0 @@ -[**@accelint/core**](../README.md) • **Docs** - -*** - -[@accelint/core](../README.md) / pipe - -# Function: pipe() - -> **pipe**\<`Fns`\>(...`fns`): (`arg`) => `ReturnType`\<`Fns` *extends* readonly [`any`, `Last`] ? `Last` : `never`\> - -Allows you combine two or more functions to create a new function, which passes the results from one -function to the next until all have be called. Has a left-to-right call order. - -## Type Parameters - -• **Fns** *extends* readonly [`UnaryFunction`](../type-aliases/UnaryFunction.md)[] - -## Parameters - -• ...**fns**: `Pipeable`\<`Fns`\> - -## Returns - -`Function` - -### Parameters - -• **arg**: `PipeParams`\<`Fns`\> - -### Returns - -`ReturnType`\<`Fns` *extends* readonly [`any`, `Last`] ? `Last` : `never`\> - -## Example - -```ts -const getActiveUsers = page => pipe( - filterActive, - sortUserNames, - displayPage, -); - -const activeUsers = getActiveUsersByPage(users); -``` diff --git a/packages/core/documentation/functions/prop.md b/packages/core/documentation/functions/prop.md deleted file mode 100644 index 188c452a..00000000 --- a/packages/core/documentation/functions/prop.md +++ /dev/null @@ -1,47 +0,0 @@ -[**@accelint/core**](../README.md) • **Docs** - -*** - -[@accelint/core](../README.md) / prop - -# Function: prop() - -> **prop**\<`T`\>(`obj`): \<`K`\>(`prop`) => `T`\[`K`\] - -## Type Parameters - -• **T** *extends* `object` - -## Parameters - -• **obj**: `T` - -## Returns - -`Function` - -### Type Parameters - -• **K** *extends* `string` \| `number` \| `symbol` - -### Parameters - -• **prop**: `K` - -### Returns - -`T`\[`K`\] - -## Alias - -property - -## Example - -```ts -property(personStore)('address'); -// personStore.address - -property(userStore.profile)(0); -// userStore.profile.at(0) -``` diff --git a/packages/core/documentation/functions/property.md b/packages/core/documentation/functions/property.md deleted file mode 100644 index eef1706b..00000000 --- a/packages/core/documentation/functions/property.md +++ /dev/null @@ -1,45 +0,0 @@ -[**@accelint/core**](../README.md) • **Docs** - -*** - -[@accelint/core](../README.md) / property - -# Function: property() - -> **property**\<`T`\>(`obj`): \<`K`\>(`prop`) => `T`\[`K`\] - -Gets the value of `prop` in `obj`. Array index support. - -## Type Parameters - -• **T** *extends* `object` - -## Parameters - -• **obj**: `T` - -## Returns - -`Function` - -### Type Parameters - -• **K** *extends* `string` \| `number` \| `symbol` - -### Parameters - -• **prop**: `K` - -### Returns - -`T`\[`K`\] - -## Example - -```ts -property(personStore)('address'); -// personStore.address - -property(userStore.profile)(0); -// userStore.profile.at(0) -``` diff --git a/packages/core/documentation/functions/push.md b/packages/core/documentation/functions/push.md deleted file mode 100644 index 7737e9e0..00000000 --- a/packages/core/documentation/functions/push.md +++ /dev/null @@ -1,38 +0,0 @@ -[**@accelint/core**](../README.md) • **Docs** - -*** - -[@accelint/core](../README.md) / push - -# Function: push() - -> **push**\<`T`\>(`arr`): (`x`) => `T`[] - -Returns a new array with the given value added to the end. - -## Type Parameters - -• **T** - -## Parameters - -• **arr**: `T`[] - -## Returns - -`Function` - -### Parameters - -• **x**: `T` - -### Returns - -`T`[] - -## Example - -```ts -push([1, 2, 3, 4])(5); -// [1, 2, 3, 4, 5] -``` diff --git a/packages/core/documentation/functions/reduce.md b/packages/core/documentation/functions/reduce.md deleted file mode 100644 index a11e1029..00000000 --- a/packages/core/documentation/functions/reduce.md +++ /dev/null @@ -1,49 +0,0 @@ -[**@accelint/core**](../README.md) • **Docs** - -*** - -[@accelint/core](../README.md) / reduce - -# Function: reduce() - -> **reduce**\<`T`, `R`\>(`fn`): (`initVal`) => (`arr`) => `R` - -Calls the accumulator with each element of the given array, starting with the first element. -Returns the final result. - -## Type Parameters - -• **T** - -• **R** - -## Parameters - -• **fn**: [`Accumulator`](../type-aliases/Accumulator.md)\<`T`, `R`\> - -## Returns - -`Function` - -### Parameters - -• **initVal**: `R` - -### Returns - -`Function` - -#### Parameters - -• **arr**: `T`[] - -#### Returns - -`R` - -## Example - -```ts -reduce((total, n) => total - n)(0)([1, 2, 3, 4, 5]); -// -13 -``` diff --git a/packages/core/documentation/functions/reduceRight.md b/packages/core/documentation/functions/reduceRight.md deleted file mode 100644 index 2e1ed68a..00000000 --- a/packages/core/documentation/functions/reduceRight.md +++ /dev/null @@ -1,49 +0,0 @@ -[**@accelint/core**](../README.md) • **Docs** - -*** - -[@accelint/core](../README.md) / reduceRight - -# Function: reduceRight() - -> **reduceRight**\<`T`, `R`\>(`fn`): (`initVal`) => (`arr`) => `R` - -Calls the accumulator with each element of the given array, starting with the last element. -Returns the final result. - -## Type Parameters - -• **T** - -• **R** - -## Parameters - -• **fn**: [`Accumulator`](../type-aliases/Accumulator.md)\<`T`, `R`\> - -## Returns - -`Function` - -### Parameters - -• **initVal**: `R` - -### Returns - -`Function` - -#### Parameters - -• **arr**: `T`[] - -#### Returns - -`R` - -## Example - -```ts -reduceRight((total, n) => total - n)(0)([1, 2, 3, 4, 5]); -// -5 -``` diff --git a/packages/core/documentation/functions/reverse.md b/packages/core/documentation/functions/reverse.md deleted file mode 100644 index c7ce02bb..00000000 --- a/packages/core/documentation/functions/reverse.md +++ /dev/null @@ -1,30 +0,0 @@ -[**@accelint/core**](../README.md) • **Docs** - -*** - -[@accelint/core](../README.md) / reverse - -# Function: reverse() - -> **reverse**\<`T`\>(`arr`): `T`[] - -Returns a new array with the order of the elements reversed. - -## Type Parameters - -• **T** - -## Parameters - -• **arr**: `T`[] - -## Returns - -`T`[] - -## Example - -```ts -reverse([1, 2, 3, 4, 5]) -// [5, 4, 3, 2, 1] -``` diff --git a/packages/core/documentation/functions/set.md b/packages/core/documentation/functions/set.md deleted file mode 100644 index 3d1746e2..00000000 --- a/packages/core/documentation/functions/set.md +++ /dev/null @@ -1,47 +0,0 @@ -[**@accelint/core**](../README.md) • **Docs** - -*** - -[@accelint/core](../README.md) / set - -# Function: set() - -> **set**\<`T`, `V`\>(`lensVal`): (`value`) => (`obj`) => `T` - -A simple warpper function to access the `set` of a lens and the given object.. - -## Type Parameters - -• **T** - -• **V** - -## Parameters - -• **lensVal**: [`Lens`](../type-aliases/Lens.md)\<`T`, `V`\> - -## Returns - -`Function` - -### Parameters - -• **value**: `V` - -### Returns - -`Function` - -#### Parameters - -• **obj**: `T` - -#### Returns - -`T` - -## Example - -```ts -set(nameLens)('Fred')(personStore); -``` diff --git a/packages/core/documentation/functions/shift.md b/packages/core/documentation/functions/shift.md deleted file mode 100644 index ba209f63..00000000 --- a/packages/core/documentation/functions/shift.md +++ /dev/null @@ -1,31 +0,0 @@ -[**@accelint/core**](../README.md) • **Docs** - -*** - -[@accelint/core](../README.md) / shift - -# Function: shift() - -> **shift**\<`T`\>(`arr`): [`T`, `T`[]] - -Returns a tuple containing the first element (head) of the given array and -the remaining elements of the array (tail). - -## Type Parameters - -• **T** - -## Parameters - -• **arr**: `T`[] - -## Returns - -[`T`, `T`[]] - -## Example - -```ts -shift([1, 2, 3, 4]); -// [1, [2, 3, 4, 5]] -``` diff --git a/packages/core/documentation/functions/slice.md b/packages/core/documentation/functions/slice.md deleted file mode 100644 index 80d12377..00000000 --- a/packages/core/documentation/functions/slice.md +++ /dev/null @@ -1,47 +0,0 @@ -[**@accelint/core**](../README.md) • **Docs** - -*** - -[@accelint/core](../README.md) / slice - -# Function: slice() - -> **slice**(`start`): (`end`) => \<`T`\>(`arr`) => `T`[] - -Returns a new array containing elements between `start` and `end` (exclusive) -from the original array. - -## Parameters - -• **start**: `number` - -## Returns - -`Function` - -### Parameters - -• **end**: `number` - -### Returns - -`Function` - -#### Type Parameters - -• **T** - -#### Parameters - -• **arr**: `T`[] - -#### Returns - -`T`[] - -## Example - -```ts -slice(0)(4)([1, 2, 3, 4, 5, 6]); -// [1, 2, 3, 4] -``` diff --git a/packages/core/documentation/functions/some.md b/packages/core/documentation/functions/some.md deleted file mode 100644 index 3809d282..00000000 --- a/packages/core/documentation/functions/some.md +++ /dev/null @@ -1,38 +0,0 @@ -[**@accelint/core**](../README.md) • **Docs** - -*** - -[@accelint/core](../README.md) / some - -# Function: some() - -> **some**\<`T`\>(`comparator`): (`arr`) => `boolean` - -Tests whether any elements in the array pass the given comparator. - -## Type Parameters - -• **T** - -## Parameters - -• **comparator**: [`Comparator`](../type-aliases/Comparator.md)\<`T`\> - -## Returns - -`Function` - -### Parameters - -• **arr**: `T`[] - -### Returns - -`boolean` - -## Example - -```ts -every(x => !(x & 1))([1, 2, 3, 4, 5]); -// true -``` diff --git a/packages/core/documentation/functions/swappedNullishOr.md b/packages/core/documentation/functions/swappedNullishOr.md deleted file mode 100644 index 08ac770f..00000000 --- a/packages/core/documentation/functions/swappedNullishOr.md +++ /dev/null @@ -1,42 +0,0 @@ -[**@accelint/core**](../README.md) • **Docs** - -*** - -[@accelint/core](../README.md) / swappedNullishOr - -# Function: swappedNullishOr() - -> **swappedNullishOr**\<`A`\>(`a`): \<`B`\>(`b`) => `A` \| `NonNullable`\<`B`\> - -Swapped Nullish Coalescing: `b ?? a` - -## Type Parameters - -• **A** - -## Parameters - -• **a**: `A` - -## Returns - -`Function` - -### Type Parameters - -• **B** - -### Parameters - -• **b**: `B` - -### Returns - -`A` \| `NonNullable`\<`B`\> - -## Example - -```ts -swappedNullishOr(4)(null); -// 4 -``` diff --git a/packages/core/documentation/functions/swappedNullishOrFn.md b/packages/core/documentation/functions/swappedNullishOrFn.md deleted file mode 100644 index 13cea631..00000000 --- a/packages/core/documentation/functions/swappedNullishOrFn.md +++ /dev/null @@ -1,52 +0,0 @@ -[**@accelint/core**](../README.md) • **Docs** - -*** - -[@accelint/core](../README.md) / swappedNullishOrFn - -# Function: swappedNullishOrFn() - -> **swappedNullishOrFn**\<`T`, `A`\>(`a`): \<`B`\>(`b`) => (`c`) => `A` \| `NonNullable`\<`B`\> - -Swapped Nullish Coalescing: `b(x) ?? a(x)` - -## Type Parameters - -• **T** - -• **A** - -## Parameters - -• **a** - -## Returns - -`Function` - -### Type Parameters - -• **B** - -### Parameters - -• **b** - -### Returns - -`Function` - -#### Parameters - -• **c**: `T` - -#### Returns - -`A` \| `NonNullable`\<`B`\> - -## Example - -```ts -swappedNullishOrFn(x => x.bar)(x => x.foo)({ bar: 4 }); -// 4 -``` diff --git a/packages/core/documentation/functions/swappedOr.md b/packages/core/documentation/functions/swappedOr.md deleted file mode 100644 index 4fbae33f..00000000 --- a/packages/core/documentation/functions/swappedOr.md +++ /dev/null @@ -1,48 +0,0 @@ -[**@accelint/core**](../README.md) • **Docs** - -*** - -[@accelint/core](../README.md) / swappedOr - -# Function: swappedOr() - -> **swappedOr**\<`A`\>(`a`): \<`B`\>(`b`) => `boolean` - -Swapped Logical Or: `(b || a)` - -Swapped Logical Disjunction - -## Type Parameters - -• **A** - -## Parameters - -• **a**: `A` - -## Returns - -`Function` - -### Type Parameters - -• **B** - -### Parameters - -• **b**: `B` - -### Returns - -`boolean` - -## Link - -https://en.wikipedia.org/wiki/Logical_disjunction - -## Example - -```ts -swappedOr(0)(true); -// true -``` diff --git a/packages/core/documentation/functions/swappedOrFn.md b/packages/core/documentation/functions/swappedOrFn.md deleted file mode 100644 index 525bcc38..00000000 --- a/packages/core/documentation/functions/swappedOrFn.md +++ /dev/null @@ -1,58 +0,0 @@ -[**@accelint/core**](../README.md) • **Docs** - -*** - -[@accelint/core](../README.md) / swappedOrFn - -# Function: swappedOrFn() - -> **swappedOrFn**\<`T`, `A`\>(`a`): \<`B`\>(`b`) => (`c`) => `boolean` - -Swapped Logical Or(): `(b(x) || a(x))` - -Swapped Logical (Function Result) Disjunction - -## Type Parameters - -• **T** - -• **A** - -## Parameters - -• **a** - -## Returns - -`Function` - -### Type Parameters - -• **B** - -### Parameters - -• **b** - -### Returns - -`Function` - -#### Parameters - -• **c**: `T` - -#### Returns - -`boolean` - -## Link - -https://en.wikipedia.org/wiki/Logical_disjunction - -## Example - -```ts -swappedOrFn(s => s.trimEnd())(s => s.trim())('foo bar '); -// true -``` diff --git a/packages/core/documentation/functions/tap.md b/packages/core/documentation/functions/tap.md deleted file mode 100644 index 98f3f330..00000000 --- a/packages/core/documentation/functions/tap.md +++ /dev/null @@ -1,44 +0,0 @@ -[**@accelint/core**](../README.md) • **Docs** - -*** - -[@accelint/core](../README.md) / tap - -# Function: tap() - -> **tap**\<`T`, `R`\>(`fn`): (`val`) => `T` - -Calls the given function with the passed value and returns the value unchanged. - -## Type Parameters - -• **T** - -• **R** - -## Parameters - -• **fn** - -## Returns - -`Function` - -### Parameters - -• **val**: `T` - -### Returns - -`T` - -## Signature - -tap :: (a -> b) -> a -> a - -## Example - -```ts -tap(console.log)('foobar'); -// foobar -``` diff --git a/packages/core/documentation/functions/unshift.md b/packages/core/documentation/functions/unshift.md deleted file mode 100644 index d07e9158..00000000 --- a/packages/core/documentation/functions/unshift.md +++ /dev/null @@ -1,38 +0,0 @@ -[**@accelint/core**](../README.md) • **Docs** - -*** - -[@accelint/core](../README.md) / unshift - -# Function: unshift() - -> **unshift**\<`T`\>(`arr`): (`x`) => `T`[] - -Returns a new array with the given value added to the start. - -## Type Parameters - -• **T** - -## Parameters - -• **arr**: `T`[] - -## Returns - -`Function` - -### Parameters - -• **x**: `T` - -### Returns - -`T`[] - -## Example - -```ts -push([1, 2, 3, 4])(0); -// [0, 1, 2, 3, 4] -``` diff --git a/packages/core/documentation/functions/xor.md b/packages/core/documentation/functions/xor.md deleted file mode 100644 index 6551f8c1..00000000 --- a/packages/core/documentation/functions/xor.md +++ /dev/null @@ -1,40 +0,0 @@ -[**@accelint/core**](../README.md) • **Docs** - -*** - -[@accelint/core](../README.md) / xor - -# Function: xor() - -> **xor**(`a`): (`b`) => `boolean` - -Logical `(a ^ b)` - -Exclusive Disjunction - -## Parameters - -• **a**: `unknown` - -## Returns - -`Function` - -### Parameters - -• **b**: `unknown` - -### Returns - -`boolean` - -## Link - -https://en.wikipedia.org/wiki/Exclusive_or - -## Example - -```ts -xor(true)(0); -// true -``` diff --git a/packages/core/documentation/functions/xorFn.md b/packages/core/documentation/functions/xorFn.md deleted file mode 100644 index 0f67d563..00000000 --- a/packages/core/documentation/functions/xorFn.md +++ /dev/null @@ -1,52 +0,0 @@ -[**@accelint/core**](../README.md) • **Docs** - -*** - -[@accelint/core](../README.md) / xorFn - -# Function: xorFn() - -> **xorFn**\<`T`\>(`a`): (`b`) => (`c`) => `boolean` - -Logical `(a(x) ^ b(x))` - -Exclusive (Function Result) Disjunction - -## Type Parameters - -• **T** - -## Parameters - -• **a** - -## Returns - -`Function` - -### Parameters - -• **b** - -### Returns - -`Function` - -#### Parameters - -• **c**: `T` - -#### Returns - -`boolean` - -## Link - -https://en.wikipedia.org/wiki/Exclusive_or - -## Example - -```ts -xorFn(s => s.trim())(s => s.trimEnd())('foo bar '); -// false -``` diff --git a/packages/core/documentation/type-aliases/Accumulator.md b/packages/core/documentation/type-aliases/Accumulator.md deleted file mode 100644 index 83b4a3a7..00000000 --- a/packages/core/documentation/type-aliases/Accumulator.md +++ /dev/null @@ -1,25 +0,0 @@ -[**@accelint/core**](../README.md) • **Docs** - -*** - -[@accelint/core](../README.md) / Accumulator - -# Type Alias: Accumulator()\ - -> **Accumulator**\<`T`, `R`\>: (`acc`, `x`) => `R` - -## Type Parameters - -• **T** - -• **R** - -## Parameters - -• **acc**: `R` - -• **x**: `T` - -## Returns - -`R` diff --git a/packages/core/documentation/type-aliases/ArrayElementType.md b/packages/core/documentation/type-aliases/ArrayElementType.md deleted file mode 100644 index ce6744c2..00000000 --- a/packages/core/documentation/type-aliases/ArrayElementType.md +++ /dev/null @@ -1,13 +0,0 @@ -[**@accelint/core**](../README.md) • **Docs** - -*** - -[@accelint/core](../README.md) / ArrayElementType - -# Type Alias: ArrayElementType\ - -> **ArrayElementType**\<`T`\>: `T` *extends* infer E[] ? `E` : `T` - -## Type Parameters - -• **T** diff --git a/packages/core/documentation/type-aliases/Comparator.md b/packages/core/documentation/type-aliases/Comparator.md deleted file mode 100644 index 490a3359..00000000 --- a/packages/core/documentation/type-aliases/Comparator.md +++ /dev/null @@ -1,21 +0,0 @@ -[**@accelint/core**](../README.md) • **Docs** - -*** - -[@accelint/core](../README.md) / Comparator - -# Type Alias: Comparator()\ - -> **Comparator**\<`T`\>: (`x`) => `boolean` - -## Type Parameters - -• **T** - -## Parameters - -• **x**: `T` - -## Returns - -`boolean` diff --git a/packages/core/documentation/type-aliases/Curried.md b/packages/core/documentation/type-aliases/Curried.md deleted file mode 100644 index 71e76877..00000000 --- a/packages/core/documentation/type-aliases/Curried.md +++ /dev/null @@ -1,27 +0,0 @@ -[**@accelint/core**](../README.md) • **Docs** - -*** - -[@accelint/core](../README.md) / Curried - -# Type Alias: Curried()\ - -> **Curried**\<`T`, `R`\>: \<`P`\>(...`args`) => (...`args`) => `any` *extends* (...`args`) => `any` ? `Args` *extends* [] ? `R` : [`Curried`](Curried.md)\<`Args`, `R`\> : `never` - -## Type Parameters - -• **T** *extends* `unknown`[] - -• **R** - -## Type Parameters - -• **P** *extends* `Partial`\<`T`\> - -## Parameters - -• ...**args**: `P` - -## Returns - -(...`args`) => `any` *extends* (...`args`) => `any` ? `Args` *extends* [] ? `R` : [`Curried`](Curried.md)\<`Args`, `R`\> : `never` diff --git a/packages/core/documentation/type-aliases/Lens.md b/packages/core/documentation/type-aliases/Lens.md deleted file mode 100644 index d8aa9188..00000000 --- a/packages/core/documentation/type-aliases/Lens.md +++ /dev/null @@ -1,25 +0,0 @@ -[**@accelint/core**](../README.md) • **Docs** - -*** - -[@accelint/core](../README.md) / Lens - -# Type Alias: Lens\ - -> **Lens**\<`T`, `V`\>: `object` - -## Type Parameters - -• **T** - -• **V** - -## Type declaration - -### get - -> **get**: `LenseGet`\<`T`, `V`\> - -### set - -> **set**: `LenseSet`\<`T`, `V`\> diff --git a/packages/core/documentation/type-aliases/MapFn.md b/packages/core/documentation/type-aliases/MapFn.md deleted file mode 100644 index 622b5277..00000000 --- a/packages/core/documentation/type-aliases/MapFn.md +++ /dev/null @@ -1,25 +0,0 @@ -[**@accelint/core**](../README.md) • **Docs** - -*** - -[@accelint/core](../README.md) / MapFn - -# Type Alias: MapFn()\ - -> **MapFn**\<`T`, `R`\>: (`x`, `idx`?) => `R` - -## Type Parameters - -• **T** - -• **R** - -## Parameters - -• **x**: `T` - -• **idx?**: `number` - -## Returns - -`R` diff --git a/packages/core/documentation/type-aliases/Predicate.md b/packages/core/documentation/type-aliases/Predicate.md deleted file mode 100644 index 1b14f13f..00000000 --- a/packages/core/documentation/type-aliases/Predicate.md +++ /dev/null @@ -1,23 +0,0 @@ -[**@accelint/core**](../README.md) • **Docs** - -*** - -[@accelint/core](../README.md) / Predicate - -# Type Alias: Predicate()\ - -> **Predicate**\<`T`\>: (`x`, `idx`?) => `boolean` - -## Type Parameters - -• **T** - -## Parameters - -• **x**: `T` - -• **idx?**: `number` - -## Returns - -`boolean` diff --git a/packages/core/documentation/type-aliases/UnaryFunction.md b/packages/core/documentation/type-aliases/UnaryFunction.md deleted file mode 100644 index 612e3e6a..00000000 --- a/packages/core/documentation/type-aliases/UnaryFunction.md +++ /dev/null @@ -1,17 +0,0 @@ -[**@accelint/core**](../README.md) • **Docs** - -*** - -[@accelint/core](../README.md) / UnaryFunction - -# Type Alias: UnaryFunction() - -> **UnaryFunction**: (`x`) => `any` - -## Parameters - -• **x**: `any` - -## Returns - -`any` diff --git a/packages/core/package.json b/packages/core/package.json index e1ae7706..196d3b6c 100644 --- a/packages/core/package.json +++ b/packages/core/package.json @@ -21,7 +21,6 @@ "scripts": { "build": "pnpm tsup", "dev": "pnpm tsc --watch", - "docs": "pnpm typedoc --logLevel Error --entryPoints src/index.ts --out documentation --readme none --disableSources --plugin typedoc-plugin-markdown", "index": "pnpm zx ../../scripts/indexer.mjs packages/core", "lint": "pnpm biome lint ./", "test": "pnpm vitest --dir=src" @@ -32,8 +31,6 @@ "@vitest/coverage-istanbul": "2.1.3", "esbuild-plugin-file-path-extensions": "2.1.3", "tsup": "8.3.0", - "typedoc": "0.26.11", - "typedoc-plugin-markdown": "4.2.10", "vitest": "2.1.3" }, "dependencies": { diff --git a/packages/design-system/documentation/api/README.md b/packages/design-system/documentation/api/README.md deleted file mode 100644 index a3602bc8..00000000 --- a/packages/design-system/documentation/api/README.md +++ /dev/null @@ -1,523 +0,0 @@ -**@accelint/design-system** • **Docs** - -*** - -# @accelint/design-system - -## Type Aliases - -- [AsType](type-aliases/AsType.md) -- [ButtonClassNames](type-aliases/ButtonClassNames.md) -- [ButtonColors](type-aliases/ButtonColors.md) -- [ButtonMapping](type-aliases/ButtonMapping.md) -- [ButtonProps](type-aliases/ButtonProps.md) -- [ButtonRenderProps](type-aliases/ButtonRenderProps.md) -- [ButtonSizes](type-aliases/ButtonSizes.md) -- [ButtonState](type-aliases/ButtonState.md) -- [CheckboxAlignment](type-aliases/CheckboxAlignment.md) -- [CheckboxClassNames](type-aliases/CheckboxClassNames.md) -- [CheckboxGroupProps](type-aliases/CheckboxGroupProps.md) -- [CheckboxGroupRenderProps](type-aliases/CheckboxGroupRenderProps.md) -- [CheckboxGroupState](type-aliases/CheckboxGroupState.md) -- [CheckboxProps](type-aliases/CheckboxProps.md) -- [CheckboxRenderProps](type-aliases/CheckboxRenderProps.md) -- [CheckboxState](type-aliases/CheckboxState.md) -- [ChildrenRenderProps](type-aliases/ChildrenRenderProps.md) -- [ChipClassNames](type-aliases/ChipClassNames.md) -- [ChipColors](type-aliases/ChipColors.md) -- [ChipGroupProps](type-aliases/ChipGroupProps.md) -- [ChipItemProps](type-aliases/ChipItemProps.md) -- [ChipListProps](type-aliases/ChipListProps.md) -- [ChipMapping](type-aliases/ChipMapping.md) -- [ChipProps](type-aliases/ChipProps.md) -- [ChipRenderProps](type-aliases/ChipRenderProps.md) -- [ChipSizes](type-aliases/ChipSizes.md) -- [ChipState](type-aliases/ChipState.md) -- [ClassNameRenderProps](type-aliases/ClassNameRenderProps.md) -- [ClassNames](type-aliases/ClassNames.md) -- [ComboBoxClassNames](type-aliases/ComboBoxClassNames.md) -- [ComboBoxMapping](type-aliases/ComboBoxMapping.md) -- [ComboBoxProps](type-aliases/ComboBoxProps.md) -- [ComboBoxRenderProps](type-aliases/ComboBoxRenderProps.md) -- [ComboBoxSizes](type-aliases/ComboBoxSizes.md) -- [ComboBoxState](type-aliases/ComboBoxState.md) -- [Contract](type-aliases/Contract.md) -- [CssVarFunction](type-aliases/CssVarFunction.md) -- [DefaultsContext](type-aliases/DefaultsContext.md) -- [DefaultsProviderProps](type-aliases/DefaultsProviderProps.md) -- [DialogClassNames](type-aliases/DialogClassNames.md) -- [DialogMapping](type-aliases/DialogMapping.md) -- [DialogProps](type-aliases/DialogProps.md) -- [DialogRenderProps](type-aliases/DialogRenderProps.md) -- [DialogSizes](type-aliases/DialogSizes.md) -- [DialogState](type-aliases/DialogState.md) -- [DrawerAnchor](type-aliases/DrawerAnchor.md) -- [DrawerClassNames](type-aliases/DrawerClassNames.md) -- [DrawerDialogProps](type-aliases/DrawerDialogProps.md) -- [DrawerDialogState](type-aliases/DrawerDialogState.md) -- [DrawerMapping](type-aliases/DrawerMapping.md) -- [DrawerProps](type-aliases/DrawerProps.md) -- [DrawerRenderProps](type-aliases/DrawerRenderProps.md) -- [DrawerState](type-aliases/DrawerState.md) -- [DrawerTabListProps](type-aliases/DrawerTabListProps.md) -- [DrawerTabProps](type-aliases/DrawerTabProps.md) -- [DrawerTabRenderProps](type-aliases/DrawerTabRenderProps.md) -- [ElementProps](type-aliases/ElementProps.md) -- [GroupClassNames](type-aliases/GroupClassNames.md) -- [GroupProps](type-aliases/GroupProps.md) -- [GroupState](type-aliases/GroupState.md) -- [IconClassNames](type-aliases/IconClassNames.md) -- [IconProps](type-aliases/IconProps.md) -- [IconSizes](type-aliases/IconSizes.md) -- [IconState](type-aliases/IconState.md) -- [InputClassNames](type-aliases/InputClassNames.md) -- [InputMapping](type-aliases/InputMapping.md) -- [InputProps](type-aliases/InputProps.md) -- [InputRenderProps](type-aliases/InputRenderProps.md) -- [InputState](type-aliases/InputState.md) -- [InputType](type-aliases/InputType.md) -- [LinkButtonProps](type-aliases/LinkButtonProps.md) -- [MapLeafNodes](type-aliases/MapLeafNodes.md) -- [MenuClassNames](type-aliases/MenuClassNames.md) -- [MenuItemProps](type-aliases/MenuItemProps.md) -- [MenuItemRenderProps](type-aliases/MenuItemRenderProps.md) -- [MenuItemState](type-aliases/MenuItemState.md) -- [MenuListProps](type-aliases/MenuListProps.md) -- [MenuMapping](type-aliases/MenuMapping.md) -- [MenuProps](type-aliases/MenuProps.md) -- [MenuSizes](type-aliases/MenuSizes.md) -- [MenuState](type-aliases/MenuState.md) -- [MergeProviderProps](type-aliases/MergeProviderProps.md) -- [NumberFieldClassNames](type-aliases/NumberFieldClassNames.md) -- [NumberFieldMapping](type-aliases/NumberFieldMapping.md) -- [NumberFieldProps](type-aliases/NumberFieldProps.md) -- [NumberFieldSizes](type-aliases/NumberFieldSizes.md) -- [NumberFieldState](type-aliases/NumberFieldState.md) -- [OmitProtectedProps](type-aliases/OmitProtectedProps.md) -- [OptionsClassNames](type-aliases/OptionsClassNames.md) -- [OptionsItemProps](type-aliases/OptionsItemProps.md) -- [OptionsItemState](type-aliases/OptionsItemState.md) -- [OptionsListProps](type-aliases/OptionsListProps.md) -- [OptionsListState](type-aliases/OptionsListState.md) -- [OptionsMapping](type-aliases/OptionsMapping.md) -- [OptionsProps](type-aliases/OptionsProps.md) -- [OptionsSizes](type-aliases/OptionsSizes.md) -- [OptionsState](type-aliases/OptionsState.md) -- [PartialMapLeafNodes](type-aliases/PartialMapLeafNodes.md) -- [PickerClassNames](type-aliases/PickerClassNames.md) -- [PickerItemProps](type-aliases/PickerItemProps.md) -- [PickerItemRenderProps](type-aliases/PickerItemRenderProps.md) -- [PickerItemState](type-aliases/PickerItemState.md) -- [PickerProps](type-aliases/PickerProps.md) -- [PickerState](type-aliases/PickerState.md) -- [PopoverClassNames](type-aliases/PopoverClassNames.md) -- [PopoverProps](type-aliases/PopoverProps.md) -- [PopoverState](type-aliases/PopoverState.md) -- [Primitive](type-aliases/Primitive.md) -- [ProviderValue](type-aliases/ProviderValue.md) -- [ProviderValues](type-aliases/ProviderValues.md) -- [QueryBuilderClassNames](type-aliases/QueryBuilderClassNames.md) -- [QueryBuilderContextValue](type-aliases/QueryBuilderContextValue.md) -- [QueryBuilderGroupState](type-aliases/QueryBuilderGroupState.md) -- [QueryBuilderMapping](type-aliases/QueryBuilderMapping.md) -- [QueryBuilderProps](type-aliases/QueryBuilderProps.md) -- [QueryBuilderRuleState](type-aliases/QueryBuilderRuleState.md) -- [QueryBuilderSizes](type-aliases/QueryBuilderSizes.md) -- [QueryBuilderState](type-aliases/QueryBuilderState.md) -- [QueryBuilderValueEditors](type-aliases/QueryBuilderValueEditors.md) -- [RadioAlignment](type-aliases/RadioAlignment.md) -- [RadioClassNames](type-aliases/RadioClassNames.md) -- [RadioGroupProps](type-aliases/RadioGroupProps.md) -- [RadioGroupState](type-aliases/RadioGroupState.md) -- [RadioProps](type-aliases/RadioProps.md) -- [RadioState](type-aliases/RadioState.md) -- [RenderProps](type-aliases/RenderProps.md) -- [RenderPropsChildren](type-aliases/RenderPropsChildren.md) -- [RenderPropsClassName](type-aliases/RenderPropsClassName.md) -- [RenderPropsStyle](type-aliases/RenderPropsStyle.md) -- [RGBA](type-aliases/RGBA.md) -- [SearchFieldClassNames](type-aliases/SearchFieldClassNames.md) -- [SearchFieldMapping](type-aliases/SearchFieldMapping.md) -- [SearchFieldProps](type-aliases/SearchFieldProps.md) -- [SearchFieldRenderProps](type-aliases/SearchFieldRenderProps.md) -- [SearchFieldState](type-aliases/SearchFieldState.md) -- [SelectClassNames](type-aliases/SelectClassNames.md) -- [SelectMapping](type-aliases/SelectMapping.md) -- [SelectProps](type-aliases/SelectProps.md) -- [SelectRenderProps](type-aliases/SelectRenderProps.md) -- [SelectState](type-aliases/SelectState.md) -- [StylePropRenderProps](type-aliases/StylePropRenderProps.md) -- [StyleRenderProps](type-aliases/StyleRenderProps.md) -- [SwitchAlignment](type-aliases/SwitchAlignment.md) -- [SwitchClassNames](type-aliases/SwitchClassNames.md) -- [SwitchProps](type-aliases/SwitchProps.md) -- [SwitchRenderProps](type-aliases/SwitchRenderProps.md) -- [SwitchState](type-aliases/SwitchState.md) -- [TabListAlignment](type-aliases/TabListAlignment.md) -- [TabListAnchor](type-aliases/TabListAnchor.md) -- [TabListProps](type-aliases/TabListProps.md) -- [TabListState](type-aliases/TabListState.md) -- [TabListVariants](type-aliases/TabListVariants.md) -- [TabPanelProps](type-aliases/TabPanelProps.md) -- [TabPanelRenderProps](type-aliases/TabPanelRenderProps.md) -- [TabPanelsProps](type-aliases/TabPanelsProps.md) -- [TabPanelsState](type-aliases/TabPanelsState.md) -- [TabPanelState](type-aliases/TabPanelState.md) -- [TabProps](type-aliases/TabProps.md) -- [TabRenderProps](type-aliases/TabRenderProps.md) -- [TabsClassNames](type-aliases/TabsClassNames.md) -- [TabsProps](type-aliases/TabsProps.md) -- [TabState](type-aliases/TabState.md) -- [TextAreaClassNames](type-aliases/TextAreaClassNames.md) -- [TextAreaProps](type-aliases/TextAreaProps.md) -- [TextAreaRenderProps](type-aliases/TextAreaRenderProps.md) -- [TextAreaState](type-aliases/TextAreaState.md) -- [TextFieldClassNames](type-aliases/TextFieldClassNames.md) -- [TextFieldMapping](type-aliases/TextFieldMapping.md) -- [TextFieldProps](type-aliases/TextFieldProps.md) -- [TextFieldSizes](type-aliases/TextFieldSizes.md) -- [TextFieldState](type-aliases/TextFieldState.md) -- [ThemeContext](type-aliases/ThemeContext.md) -- [ThemeProviderProps](type-aliases/ThemeProviderProps.md) -- [ThemeVars](type-aliases/ThemeVars.md) -- [ToggleButtonProps](type-aliases/ToggleButtonProps.md) -- [TooltipClassNames](type-aliases/TooltipClassNames.md) -- [TooltipMapping](type-aliases/TooltipMapping.md) -- [TooltipProps](type-aliases/TooltipProps.md) -- [TooltipRenderProps](type-aliases/TooltipRenderProps.md) -- [TooltipState](type-aliases/TooltipState.md) -- [TooltipTargetProps](type-aliases/TooltipTargetProps.md) -- [TooltipTargetState](type-aliases/TooltipTargetState.md) -- [TreeActions](type-aliases/TreeActions.md) -- [TreeClassNames](type-aliases/TreeClassNames.md) -- [TreeGroupNode](type-aliases/TreeGroupNode.md) -- [TreeGroupProps](type-aliases/TreeGroupProps.md) -- [TreeGroupRenderProps](type-aliases/TreeGroupRenderProps.md) -- [TreeGroupState](type-aliases/TreeGroupState.md) -- [TreeIndicatorRenderProps](type-aliases/TreeIndicatorRenderProps.md) -- [TreeIndicatorState](type-aliases/TreeIndicatorState.md) -- [TreeItemNode](type-aliases/TreeItemNode.md) -- [TreeItemProps](type-aliases/TreeItemProps.md) -- [TreeItemRenderProps](type-aliases/TreeItemRenderProps.md) -- [TreeItemState](type-aliases/TreeItemState.md) -- [TreeMapping](type-aliases/TreeMapping.md) -- [TreeNode](type-aliases/TreeNode.md) -- [TreeNodes](type-aliases/TreeNodes.md) -- [TreeProps](type-aliases/TreeProps.md) -- [TreeRenderProps](type-aliases/TreeRenderProps.md) -- [TreeSizes](type-aliases/TreeSizes.md) -- [TreeState](type-aliases/TreeState.md) -- [TreeStateContextValue](type-aliases/TreeStateContextValue.md) -- [UseTreeOptions](type-aliases/UseTreeOptions.md) -- [UseTreeResult](type-aliases/UseTreeResult.md) - -## Variables - -- [alphaChannelAsNumberValidator](variables/alphaChannelAsNumberValidator.md) -- [alphaChannelAsStringValidator](variables/alphaChannelAsStringValidator.md) -- [AriaFieldErrorContext](variables/AriaFieldErrorContext.md) -- [AriaGroupContext](variables/AriaGroupContext.md) -- [AriaHeaderContext](variables/AriaHeaderContext.md) -- [AriaHeadingContext](variables/AriaHeadingContext.md) -- [AriaKeyboardContext](variables/AriaKeyboardContext.md) -- [AriaLabelContext](variables/AriaLabelContext.md) -- [AriaSectionContext](variables/AriaSectionContext.md) -- [AriaSelectValueContext](variables/AriaSelectValueContext.md) -- [AriaSeparatorContext](variables/AriaSeparatorContext.md) -- [AriaTextContext](variables/AriaTextContext.md) -- [bodies](variables/bodies.md) -- [buttonClassNames](variables/buttonClassNames.md) -- [buttonColorVars](variables/buttonColorVars.md) -- [buttonContainer](variables/buttonContainer.md) -- [ButtonContext](variables/ButtonContext.md) -- [buttonSpaceVars](variables/buttonSpaceVars.md) -- [buttonStateVars](variables/buttonStateVars.md) -- [checkboxClassNames](variables/checkboxClassNames.md) -- [checkboxColorVars](variables/checkboxColorVars.md) -- [checkboxContainer](variables/checkboxContainer.md) -- [CheckboxContext](variables/CheckboxContext.md) -- [CheckboxGroupContext](variables/CheckboxGroupContext.md) -- [checkboxGroupStateVars](variables/checkboxGroupStateVars.md) -- [checkboxSpaceVars](variables/checkboxSpaceVars.md) -- [checkboxStateVars](variables/checkboxStateVars.md) -- [chipClassNames](variables/chipClassNames.md) -- [chipColorVars](variables/chipColorVars.md) -- [chipContainer](variables/chipContainer.md) -- [ChipContext](variables/ChipContext.md) -- [ChipGroupContext](variables/ChipGroupContext.md) -- [chipSpaceVars](variables/chipSpaceVars.md) -- [chipStateVars](variables/chipStateVars.md) -- [colorChannelAsNumberValidator](variables/colorChannelAsNumberValidator.md) -- [colorChannelAsStringValidator](variables/colorChannelAsStringValidator.md) -- [comboBoxClassNames](variables/comboBoxClassNames.md) -- [comboBoxColorVars](variables/comboBoxColorVars.md) -- [comboBoxContainer](variables/comboBoxContainer.md) -- [ComboBoxContext](variables/ComboBoxContext.md) -- [comboBoxSpaceVars](variables/comboBoxSpaceVars.md) -- [comboBoxStateVars](variables/comboBoxStateVars.md) -- [defaultElevations](variables/defaultElevations.md) -- [defaultElevationVarValues](variables/defaultElevationVarValues.md) -- [defaultFocus](variables/defaultFocus.md) -- [defaultFocusVarValues](variables/defaultFocusVarValues.md) -- [defaultGenericColors](variables/defaultGenericColors.md) -- [defaultGenericColorVarValues](variables/defaultGenericColorVarValues.md) -- [defaultRadius](variables/defaultRadius.md) -- [defaultRadiusVarValues](variables/defaultRadiusVarValues.md) -- [defaultSemanticColors](variables/defaultSemanticColors.md) -- [defaultSemanticColorVarValues](variables/defaultSemanticColorVarValues.md) -- [defaultSizes](variables/defaultSizes.md) -- [defaultSizesVarValues](variables/defaultSizesVarValues.md) -- [defaultSpace](variables/defaultSpace.md) -- [defaultSpaceVarValues](variables/defaultSpaceVarValues.md) -- [defaultTypography](variables/defaultTypography.md) -- [defaultTypographyVarValues](variables/defaultTypographyVarValues.md) -- [defaultZIndex](variables/defaultZIndex.md) -- [defaultZIndexVarValues](variables/defaultZIndexVarValues.md) -- [dialogClassNames](variables/dialogClassNames.md) -- [dialogColorVars](variables/dialogColorVars.md) -- [dialogContainer](variables/dialogContainer.md) -- [DialogContext](variables/DialogContext.md) -- [dialogSpaceVars](variables/dialogSpaceVars.md) -- [dialogStateVars](variables/dialogStateVars.md) -- [drawerAnimationVars](variables/drawerAnimationVars.md) -- [drawerClassNames](variables/drawerClassNames.md) -- [drawerColorVars](variables/drawerColorVars.md) -- [drawerContainer](variables/drawerContainer.md) -- [drawerDialogStateVars](variables/drawerDialogStateVars.md) -- [drawerSpaceVars](variables/drawerSpaceVars.md) -- [drawerStateVars](variables/drawerStateVars.md) -- [ElementContext](variables/ElementContext.md) -- [elevationVars](variables/elevationVars.md) -- [families](variables/families.md) -- [focusOutlineStyle](variables/focusOutlineStyle.md) -- [focusVars](variables/focusVars.md) -- [genericColorVars](variables/genericColorVars.md) -- [groupClassNames](variables/groupClassNames.md) -- [groupContainer](variables/groupContainer.md) -- [GroupContext](variables/GroupContext.md) -- [groupSpaceVars](variables/groupSpaceVars.md) -- [groupStateVars](variables/groupStateVars.md) -- [headings](variables/headings.md) -- [iconClassNames](variables/iconClassNames.md) -- [iconColorVars](variables/iconColorVars.md) -- [iconContainer](variables/iconContainer.md) -- [IconContext](variables/IconContext.md) -- [iconSpaceVars](variables/iconSpaceVars.md) -- [iconStateVars](variables/iconStateVars.md) -- [inputClassNames](variables/inputClassNames.md) -- [inputColorVars](variables/inputColorVars.md) -- [inputContainer](variables/inputContainer.md) -- [InputContext](variables/InputContext.md) -- [inputs](variables/inputs.md) -- [inputSpaceVars](variables/inputSpaceVars.md) -- [inputStateVars](variables/inputStateVars.md) -- [label](variables/label.md) -- [layers](variables/layers.md) -- [LinkButtonContext](variables/LinkButtonContext.md) -- [menuColorVars](variables/menuColorVars.md) -- [MenuContext](variables/MenuContext.md) -- [MenuItemContext](variables/MenuItemContext.md) -- [menuItemStateVars](variables/menuItemStateVars.md) -- [MenuListContext](variables/MenuListContext.md) -- [menuSpaceVars](variables/menuSpaceVars.md) -- [menuStateVars](variables/menuStateVars.md) -- [numberFieldClassNames](variables/numberFieldClassNames.md) -- [numberFieldColorVars](variables/numberFieldColorVars.md) -- [numberFieldContainer](variables/numberFieldContainer.md) -- [NumberFieldContext](variables/NumberFieldContext.md) -- [numberFieldSpaceVars](variables/numberFieldSpaceVars.md) -- [numberFieldStateVars](variables/numberFieldStateVars.md) -- [optionsClassNames](variables/optionsClassNames.md) -- [optionsColorVars](variables/optionsColorVars.md) -- [optionsContainers](variables/optionsContainers.md) -- [OptionsContext](variables/OptionsContext.md) -- [OptionsItemContext](variables/OptionsItemContext.md) -- [optionsItemStateVars](variables/optionsItemStateVars.md) -- [OptionsListContext](variables/OptionsListContext.md) -- [optionsListStateVars](variables/optionsListStateVars.md) -- [optionsSpaceVars](variables/optionsSpaceVars.md) -- [optionsStateVars](variables/optionsStateVars.md) -- [pickerClassNames](variables/pickerClassNames.md) -- [pickerContainers](variables/pickerContainers.md) -- [PickerContext](variables/PickerContext.md) -- [pickerItemColorVars](variables/pickerItemColorVars.md) -- [PickerItemContext](variables/PickerItemContext.md) -- [pickerItemStateVars](variables/pickerItemStateVars.md) -- [pickerSpaceVars](variables/pickerSpaceVars.md) -- [pickerStateVars](variables/pickerStateVars.md) -- [pixelValueAsNumberValidator](variables/pixelValueAsNumberValidator.md) -- [pixelValueAsStringValidator](variables/pixelValueAsStringValidator.md) -- [popoverClassNames](variables/popoverClassNames.md) -- [popoverColorVars](variables/popoverColorVars.md) -- [PopoverContext](variables/PopoverContext.md) -- [popoverSpaceVars](variables/popoverSpaceVars.md) -- [popoverStateVars](variables/popoverStateVars.md) -- [queryBuilderClassNames](variables/queryBuilderClassNames.md) -- [queryBuilderColorVars](variables/queryBuilderColorVars.md) -- [queryBuilderContainers](variables/queryBuilderContainers.md) -- [QueryBuilderContext](variables/QueryBuilderContext.md) -- [queryBuilderGroupStateVars](variables/queryBuilderGroupStateVars.md) -- [queryBuilderRuleStateVars](variables/queryBuilderRuleStateVars.md) -- [queryBuilderSpaceVars](variables/queryBuilderSpaceVars.md) -- [queryBuilderStateVars](variables/queryBuilderStateVars.md) -- [radioClassNames](variables/radioClassNames.md) -- [radioColorVars](variables/radioColorVars.md) -- [RadioContext](variables/RadioContext.md) -- [RadioGroupContext](variables/RadioGroupContext.md) -- [radioGroupStateVars](variables/radioGroupStateVars.md) -- [radioSpaceVars](variables/radioSpaceVars.md) -- [radioStateVars](variables/radioStateVars.md) -- [radiusVars](variables/radiusVars.md) -- [rgbaAsStringValidator](variables/rgbaAsStringValidator.md) -- [rgbaAsTupleValidator](variables/rgbaAsTupleValidator.md) -- [searchFieldClassNames](variables/searchFieldClassNames.md) -- [searchFieldContainer](variables/searchFieldContainer.md) -- [SearchFieldContext](variables/SearchFieldContext.md) -- [searchFieldSpaceVars](variables/searchFieldSpaceVars.md) -- [searchFieldStateVars](variables/searchFieldStateVars.md) -- [selectClassNames](variables/selectClassNames.md) -- [selectColorVars](variables/selectColorVars.md) -- [selectContainer](variables/selectContainer.md) -- [SelectContext](variables/SelectContext.md) -- [selectSpaceVars](variables/selectSpaceVars.md) -- [selectStateVars](variables/selectStateVars.md) -- [semanticColorVars](variables/semanticColorVars.md) -- [sizeVars](variables/sizeVars.md) -- [spaceVars](variables/spaceVars.md) -- [surfaces](variables/surfaces.md) -- [switchClassNames](variables/switchClassNames.md) -- [switchColorVars](variables/switchColorVars.md) -- [switchContainer](variables/switchContainer.md) -- [SwitchContext](variables/SwitchContext.md) -- [switchSpaceVars](variables/switchSpaceVars.md) -- [switchStateVars](variables/switchStateVars.md) -- [tabColorVars](variables/tabColorVars.md) -- [TabContext](variables/TabContext.md) -- [TabListContext](variables/TabListContext.md) -- [tabListStateVars](variables/tabListStateVars.md) -- [TabPanelContext](variables/TabPanelContext.md) -- [TabPanelsContext](variables/TabPanelsContext.md) -- [tabPanelsStateVars](variables/tabPanelsStateVars.md) -- [tabPanelStateVars](variables/tabPanelStateVars.md) -- [tabsClassNames](variables/tabsClassNames.md) -- [tabsContainers](variables/tabsContainers.md) -- [TabsContext](variables/TabsContext.md) -- [tabSpaceVars](variables/tabSpaceVars.md) -- [tabStateVars](variables/tabStateVars.md) -- [textAreaClassNames](variables/textAreaClassNames.md) -- [textAreaColorVars](variables/textAreaColorVars.md) -- [textAreaContainer](variables/textAreaContainer.md) -- [TextAreaContext](variables/TextAreaContext.md) -- [textAreaSpaceVars](variables/textAreaSpaceVars.md) -- [textAreaStateVars](variables/textAreaStateVars.md) -- [textFieldClassNames](variables/textFieldClassNames.md) -- [textFieldColorVars](variables/textFieldColorVars.md) -- [textFieldContainer](variables/textFieldContainer.md) -- [TextFieldContext](variables/TextFieldContext.md) -- [textFieldSpaceVars](variables/textFieldSpaceVars.md) -- [textFieldStateVars](variables/textFieldStateVars.md) -- [ToggleButtonContext](variables/ToggleButtonContext.md) -- [tooltipClassNames](variables/tooltipClassNames.md) -- [tooltipContainers](variables/tooltipContainers.md) -- [TooltipContext](variables/TooltipContext.md) -- [tooltipSpaceVars](variables/tooltipSpaceVars.md) -- [tooltipStateVars](variables/tooltipStateVars.md) -- [TooltipTargetContext](variables/TooltipTargetContext.md) -- [tooltipTargetStateVars](variables/tooltipTargetStateVars.md) -- [treeClassNames](variables/treeClassNames.md) -- [treeColorVars](variables/treeColorVars.md) -- [treeContainers](variables/treeContainers.md) -- [treeGroupStateVars](variables/treeGroupStateVars.md) -- [treeIndicatorStateVars](variables/treeIndicatorStateVars.md) -- [treeItemStateVars](variables/treeItemStateVars.md) -- [treeSpaceVars](variables/treeSpaceVars.md) -- [TreeStateContext](variables/TreeStateContext.md) -- [treeStateVars](variables/treeStateVars.md) -- [typographyVars](variables/typographyVars.md) -- [zIndexVars](variables/zIndexVars.md) - -## Functions - -- [applyThemeVars](functions/applyThemeVars.md) -- [AriaFieldError](functions/AriaFieldError.md) -- [AriaGroup](functions/AriaGroup.md) -- [AriaHeader](functions/AriaHeader.md) -- [AriaHeading](functions/AriaHeading.md) -- [AriaKeyboard](functions/AriaKeyboard.md) -- [AriaLabel](functions/AriaLabel.md) -- [AriaSection](functions/AriaSection.md) -- [AriaSelectValue](functions/AriaSelectValue.md) -- [AriaSeparator](functions/AriaSeparator.md) -- [AriaText](functions/AriaText.md) -- [assignPartialVars](functions/assignPartialVars.md) -- [Button](functions/Button.md) -- [callRenderProps](functions/callRenderProps.md) -- [Checkbox](functions/Checkbox.md) -- [CheckboxGroup](functions/CheckboxGroup.md) -- [Chip](functions/Chip.md) -- [ChipGroup](functions/ChipGroup.md) -- [ChipItem](functions/ChipItem.md) -- [ChipList](functions/ChipList.md) -- [ComboBox](functions/ComboBox.md) -- [computeContract](functions/computeContract.md) -- [containerQueries](functions/containerQueries.md) -- [containerQuery](functions/containerQuery.md) -- [continuePropagation](functions/continuePropagation.md) -- [createCollectionRenderer](functions/createCollectionRenderer.md) -- [DefaultsProvider](functions/DefaultsProvider.md) -- [Dialog](functions/Dialog.md) -- [Drawer](functions/Drawer.md) -- [DrawerDialog](functions/DrawerDialog.md) -- [DrawerTab](functions/DrawerTab.md) -- [DrawerTabList](functions/DrawerTabList.md) -- [Element](functions/Element.md) -- [Group](functions/Group.md) -- [Icon](functions/Icon.md) -- [inlineVars](functions/inlineVars.md) -- [Input](functions/Input.md) -- [LinkButton](functions/LinkButton.md) -- [Menu](functions/Menu.md) -- [MenuItem](functions/MenuItem.md) -- [MenuList](functions/MenuList.md) -- [mergeClassNames](functions/mergeClassNames.md) -- [mergeProps](functions/mergeProps.md) -- [MergeProvider](functions/MergeProvider.md) -- [NumberField](functions/NumberField.md) -- [Options](functions/Options.md) -- [OptionsItem](functions/OptionsItem.md) -- [OptionsList](functions/OptionsList.md) -- [Picker](functions/Picker.md) -- [PickerItem](functions/PickerItem.md) -- [Popover](functions/Popover.md) -- [pressToMouseEvent](functions/pressToMouseEvent.md) -- [QueryBuilder](functions/QueryBuilder.md) -- [Radio](functions/Radio.md) -- [RadioGroup](functions/RadioGroup.md) -- [SearchField](functions/SearchField.md) -- [Select](functions/Select.md) -- [Switch](functions/Switch.md) -- [Tab](functions/Tab.md) -- [TabList](functions/TabList.md) -- [TabPanel](functions/TabPanel.md) -- [TabPanels](functions/TabPanels.md) -- [Tabs](functions/Tabs.md) -- [TextArea](functions/TextArea.md) -- [TextField](functions/TextField.md) -- [ThemeProvider](functions/ThemeProvider.md) -- [ToggleButton](functions/ToggleButton.md) -- [Tooltip](functions/Tooltip.md) -- [TooltipTarget](functions/TooltipTarget.md) -- [Tree](functions/Tree.md) -- [TreeGroup](functions/TreeGroup.md) -- [TreeItem](functions/TreeItem.md) -- [unwrapCssVar](functions/unwrapCssVar.md) -- [useCollectionRender](functions/useCollectionRender.md) -- [useContextProps](functions/useContextProps.md) -- [useDefaultProps](functions/useDefaultProps.md) -- [useDefaults](functions/useDefaults.md) -- [usePropagatingPress](functions/usePropagatingPress.md) -- [useSlot](functions/useSlot.md) -- [useTheme](functions/useTheme.md) -- [useTree](functions/useTree.md) -- [useUpdateEffect](functions/useUpdateEffect.md) -- [wrapRenderProps](functions/wrapRenderProps.md) diff --git a/packages/design-system/documentation/api/functions/AriaFieldError.md b/packages/design-system/documentation/api/functions/AriaFieldError.md deleted file mode 100644 index b8a47052..00000000 --- a/packages/design-system/documentation/api/functions/AriaFieldError.md +++ /dev/null @@ -1,17 +0,0 @@ -[**@accelint/design-system**](../README.md) • **Docs** - -*** - -[@accelint/design-system](../README.md) / AriaFieldError - -# Function: AriaFieldError() - -> **AriaFieldError**(`props`): `null` \| `ReactElement`\<`any`, `string` \| `JSXElementConstructor`\<`any`\>\> - -## Parameters - -• **props**: `FieldErrorProps` & `RefAttributes`\<`HTMLElement`\> - -## Returns - -`null` \| `ReactElement`\<`any`, `string` \| `JSXElementConstructor`\<`any`\>\> diff --git a/packages/design-system/documentation/api/functions/AriaGroup.md b/packages/design-system/documentation/api/functions/AriaGroup.md deleted file mode 100644 index c33ff695..00000000 --- a/packages/design-system/documentation/api/functions/AriaGroup.md +++ /dev/null @@ -1,17 +0,0 @@ -[**@accelint/design-system**](../README.md) • **Docs** - -*** - -[@accelint/design-system](../README.md) / AriaGroup - -# Function: AriaGroup() - -> **AriaGroup**(`props`): `null` \| `ReactElement`\<`any`, `string` \| `JSXElementConstructor`\<`any`\>\> - -## Parameters - -• **props**: `GroupProps` & `RefAttributes`\<`HTMLDivElement`\> - -## Returns - -`null` \| `ReactElement`\<`any`, `string` \| `JSXElementConstructor`\<`any`\>\> diff --git a/packages/design-system/documentation/api/functions/AriaHeader.md b/packages/design-system/documentation/api/functions/AriaHeader.md deleted file mode 100644 index b2825b73..00000000 --- a/packages/design-system/documentation/api/functions/AriaHeader.md +++ /dev/null @@ -1,17 +0,0 @@ -[**@accelint/design-system**](../README.md) • **Docs** - -*** - -[@accelint/design-system](../README.md) / AriaHeader - -# Function: AriaHeader() - -> **AriaHeader**(`props`): `null` \| `ReactElement`\<`any`, `string` \| `JSXElementConstructor`\<`any`\>\> - -## Parameters - -• **props**: `HTMLAttributes`\<`HTMLElement`\> & `RefAttributes`\<`object`\> & `RefAttributes`\<`HTMLElement`\> - -## Returns - -`null` \| `ReactElement`\<`any`, `string` \| `JSXElementConstructor`\<`any`\>\> diff --git a/packages/design-system/documentation/api/functions/AriaHeading.md b/packages/design-system/documentation/api/functions/AriaHeading.md deleted file mode 100644 index 6ded3351..00000000 --- a/packages/design-system/documentation/api/functions/AriaHeading.md +++ /dev/null @@ -1,17 +0,0 @@ -[**@accelint/design-system**](../README.md) • **Docs** - -*** - -[@accelint/design-system](../README.md) / AriaHeading - -# Function: AriaHeading() - -> **AriaHeading**(`props`): `null` \| `ReactElement`\<`any`, `string` \| `JSXElementConstructor`\<`any`\>\> - -## Parameters - -• **props**: `HeadingProps` & `RefAttributes`\<`HTMLHeadingElement`\> - -## Returns - -`null` \| `ReactElement`\<`any`, `string` \| `JSXElementConstructor`\<`any`\>\> diff --git a/packages/design-system/documentation/api/functions/AriaKeyboard.md b/packages/design-system/documentation/api/functions/AriaKeyboard.md deleted file mode 100644 index 8ebc38a9..00000000 --- a/packages/design-system/documentation/api/functions/AriaKeyboard.md +++ /dev/null @@ -1,17 +0,0 @@ -[**@accelint/design-system**](../README.md) • **Docs** - -*** - -[@accelint/design-system](../README.md) / AriaKeyboard - -# Function: AriaKeyboard() - -> **AriaKeyboard**(`props`): `null` \| `ReactElement`\<`any`, `string` \| `JSXElementConstructor`\<`any`\>\> - -## Parameters - -• **props**: `HTMLAttributes`\<`HTMLElement`\> & `RefAttributes`\<`HTMLElement`\> - -## Returns - -`null` \| `ReactElement`\<`any`, `string` \| `JSXElementConstructor`\<`any`\>\> diff --git a/packages/design-system/documentation/api/functions/AriaLabel.md b/packages/design-system/documentation/api/functions/AriaLabel.md deleted file mode 100644 index ef73c07c..00000000 --- a/packages/design-system/documentation/api/functions/AriaLabel.md +++ /dev/null @@ -1,17 +0,0 @@ -[**@accelint/design-system**](../README.md) • **Docs** - -*** - -[@accelint/design-system](../README.md) / AriaLabel - -# Function: AriaLabel() - -> **AriaLabel**(`props`): `null` \| `ReactElement`\<`any`, `string` \| `JSXElementConstructor`\<`any`\>\> - -## Parameters - -• **props**: `LabelProps` & `RefAttributes`\<`HTMLLabelElement`\> - -## Returns - -`null` \| `ReactElement`\<`any`, `string` \| `JSXElementConstructor`\<`any`\>\> diff --git a/packages/design-system/documentation/api/functions/AriaSection.md b/packages/design-system/documentation/api/functions/AriaSection.md deleted file mode 100644 index ea334df2..00000000 --- a/packages/design-system/documentation/api/functions/AriaSection.md +++ /dev/null @@ -1,21 +0,0 @@ -[**@accelint/design-system**](../README.md) • **Docs** - -*** - -[@accelint/design-system](../README.md) / AriaSection - -# Function: AriaSection() - -> **AriaSection**\<`T`\>(`props`): `null` \| `ReactElement`\<`any`, `string` \| `JSXElementConstructor`\<`any`\>\> - -## Type Parameters - -• **T** *extends* `object` - -## Parameters - -• **props**: `SectionProps`\<`T`\> & `RefAttributes`\<`HTMLElement`\> - -## Returns - -`null` \| `ReactElement`\<`any`, `string` \| `JSXElementConstructor`\<`any`\>\> diff --git a/packages/design-system/documentation/api/functions/AriaSelectValue.md b/packages/design-system/documentation/api/functions/AriaSelectValue.md deleted file mode 100644 index 9e7b1387..00000000 --- a/packages/design-system/documentation/api/functions/AriaSelectValue.md +++ /dev/null @@ -1,21 +0,0 @@ -[**@accelint/design-system**](../README.md) • **Docs** - -*** - -[@accelint/design-system](../README.md) / AriaSelectValue - -# Function: AriaSelectValue() - -> **AriaSelectValue**\<`T`\>(`props`): `null` \| `ReactElement`\<`any`, `string` \| `JSXElementConstructor`\<`any`\>\> - -## Type Parameters - -• **T** *extends* `object` - -## Parameters - -• **props**: `SelectValueProps`\<`T`\> & `RefAttributes`\<`HTMLSpanElement`\> - -## Returns - -`null` \| `ReactElement`\<`any`, `string` \| `JSXElementConstructor`\<`any`\>\> diff --git a/packages/design-system/documentation/api/functions/AriaSeparator.md b/packages/design-system/documentation/api/functions/AriaSeparator.md deleted file mode 100644 index 7539d789..00000000 --- a/packages/design-system/documentation/api/functions/AriaSeparator.md +++ /dev/null @@ -1,17 +0,0 @@ -[**@accelint/design-system**](../README.md) • **Docs** - -*** - -[@accelint/design-system](../README.md) / AriaSeparator - -# Function: AriaSeparator() - -> **AriaSeparator**(`props`): `null` \| `ReactElement`\<`any`, `string` \| `JSXElementConstructor`\<`any`\>\> - -## Parameters - -• **props**: `SeparatorProps` & `RefAttributes`\<`object`\> & `RefAttributes`\<`HTMLElement`\> - -## Returns - -`null` \| `ReactElement`\<`any`, `string` \| `JSXElementConstructor`\<`any`\>\> diff --git a/packages/design-system/documentation/api/functions/AriaText.md b/packages/design-system/documentation/api/functions/AriaText.md deleted file mode 100644 index 64e96409..00000000 --- a/packages/design-system/documentation/api/functions/AriaText.md +++ /dev/null @@ -1,17 +0,0 @@ -[**@accelint/design-system**](../README.md) • **Docs** - -*** - -[@accelint/design-system](../README.md) / AriaText - -# Function: AriaText() - -> **AriaText**(`props`): `null` \| `ReactElement`\<`any`, `string` \| `JSXElementConstructor`\<`any`\>\> - -## Parameters - -• **props**: `TextProps` & `RefAttributes`\<`HTMLElement`\> - -## Returns - -`null` \| `ReactElement`\<`any`, `string` \| `JSXElementConstructor`\<`any`\>\> diff --git a/packages/design-system/documentation/api/functions/Button.md b/packages/design-system/documentation/api/functions/Button.md deleted file mode 100644 index 40aa6464..00000000 --- a/packages/design-system/documentation/api/functions/Button.md +++ /dev/null @@ -1,17 +0,0 @@ -[**@accelint/design-system**](../README.md) • **Docs** - -*** - -[@accelint/design-system](../README.md) / Button - -# Function: Button() - -> **Button**(`props`): `null` \| `ReactElement`\<`any`, `string` \| `JSXElementConstructor`\<`any`\>\> - -## Parameters - -• **props**: `Omit`\<`ButtonProps`, `"children"` \| `"className"` \| `"style"`\> & `BaseButtonProps` & `RefAttributes`\<`HTMLButtonElement`\> - -## Returns - -`null` \| `ReactElement`\<`any`, `string` \| `JSXElementConstructor`\<`any`\>\> diff --git a/packages/design-system/documentation/api/functions/Checkbox.md b/packages/design-system/documentation/api/functions/Checkbox.md deleted file mode 100644 index 20a5c270..00000000 --- a/packages/design-system/documentation/api/functions/Checkbox.md +++ /dev/null @@ -1,17 +0,0 @@ -[**@accelint/design-system**](../README.md) • **Docs** - -*** - -[@accelint/design-system](../README.md) / Checkbox - -# Function: Checkbox() - -> **Checkbox**(`props`): `null` \| `ReactElement`\<`any`, `string` \| `JSXElementConstructor`\<`any`\>\> - -## Parameters - -• **props**: `Omit`\<`CheckboxProps`, `"children"` \| `"className"` \| `"style"`\> & `BaseCheckboxProps` & `RefAttributes`\<`HTMLLabelElement`\> - -## Returns - -`null` \| `ReactElement`\<`any`, `string` \| `JSXElementConstructor`\<`any`\>\> diff --git a/packages/design-system/documentation/api/functions/CheckboxGroup.md b/packages/design-system/documentation/api/functions/CheckboxGroup.md deleted file mode 100644 index 4bf43055..00000000 --- a/packages/design-system/documentation/api/functions/CheckboxGroup.md +++ /dev/null @@ -1,17 +0,0 @@ -[**@accelint/design-system**](../README.md) • **Docs** - -*** - -[@accelint/design-system](../README.md) / CheckboxGroup - -# Function: CheckboxGroup() - -> **CheckboxGroup**(`props`): `null` \| `ReactElement`\<`any`, `string` \| `JSXElementConstructor`\<`any`\>\> - -## Parameters - -• **props**: `Omit`\<`CheckboxGroupProps`, `"children"` \| `"className"` \| `"style"`\> & `object` & `Pick`\<`BaseCheckboxProps`, `"alignInput"`\> & `RefAttributes`\<`HTMLDivElement`\> - -## Returns - -`null` \| `ReactElement`\<`any`, `string` \| `JSXElementConstructor`\<`any`\>\> diff --git a/packages/design-system/documentation/api/functions/Chip.md b/packages/design-system/documentation/api/functions/Chip.md deleted file mode 100644 index 81a4461f..00000000 --- a/packages/design-system/documentation/api/functions/Chip.md +++ /dev/null @@ -1,17 +0,0 @@ -[**@accelint/design-system**](../README.md) • **Docs** - -*** - -[@accelint/design-system](../README.md) / Chip - -# Function: Chip() - -> **Chip**(`props`): `Element` - -## Parameters - -• **props**: [`ChipProps`](../type-aliases/ChipProps.md) - -## Returns - -`Element` diff --git a/packages/design-system/documentation/api/functions/ChipGroup.md b/packages/design-system/documentation/api/functions/ChipGroup.md deleted file mode 100644 index 9a493434..00000000 --- a/packages/design-system/documentation/api/functions/ChipGroup.md +++ /dev/null @@ -1,20 +0,0 @@ -[**@accelint/design-system**](../README.md) • **Docs** - -*** - -[@accelint/design-system](../README.md) / ChipGroup - -# Function: ChipGroup() - -> **ChipGroup**(`props`): `null` \| `ReactElement`\<`any`, `string` \| `JSXElementConstructor`\<`any`\>\> - -Color & Size props are passed down to ChipItem but can be overridden -on each component if desired - -## Parameters - -• **props**: `Omit`\<`TagGroupProps`, `"className"` \| `"style"`\> & `Omit`\<`BaseChipProps`, `"children"`\> & `RefAttributes`\<`HTMLDivElement`\> - -## Returns - -`null` \| `ReactElement`\<`any`, `string` \| `JSXElementConstructor`\<`any`\>\> diff --git a/packages/design-system/documentation/api/functions/ChipItem.md b/packages/design-system/documentation/api/functions/ChipItem.md deleted file mode 100644 index d1c57238..00000000 --- a/packages/design-system/documentation/api/functions/ChipItem.md +++ /dev/null @@ -1,30 +0,0 @@ -[**@accelint/design-system**](../README.md) • **Docs** - -*** - -[@accelint/design-system](../README.md) / ChipItem - -# Function: ChipItem() - -> **ChipItem**(`props`): `null` \| `ReactElement`\<`any`, `string` \| `JSXElementConstructor`\<`any`\>\> - -Must be used in conjunction with ChipList & ChipGroup and -cannot be used outside of ChipList, else will throw error - -Color & Size props can be passed in from ChipGroup and overriden -on each instance of this components - -Order of precedence (from lowest to highest): -Design System Defaults of Chip -Global Defaults of ChipGroup -Instance of ChipGroup -Global Defaults of ChipItem -Instance of ChipItem - -## Parameters - -• **props**: `Omit`\<`TagProps`, `"children"` \| `"className"` \| `"style"`\> & `BaseChipProps` & `RefAttributes`\<`HTMLDivElement`\> - -## Returns - -`null` \| `ReactElement`\<`any`, `string` \| `JSXElementConstructor`\<`any`\>\> diff --git a/packages/design-system/documentation/api/functions/ChipList.md b/packages/design-system/documentation/api/functions/ChipList.md deleted file mode 100644 index 10ef8c9b..00000000 --- a/packages/design-system/documentation/api/functions/ChipList.md +++ /dev/null @@ -1,24 +0,0 @@ -[**@accelint/design-system**](../README.md) • **Docs** - -*** - -[@accelint/design-system](../README.md) / ChipList - -# Function: ChipList() - -> **ChipList**\<`T`\>(`__namedParameters`): `Element` - -Must be used in conjunction with ChipItem & ChipGroup and -cannot be used outside of ChipGroup, else will throw error - -## Type Parameters - -• **T** *extends* `object` - -## Parameters - -• **\_\_namedParameters**: [`ChipListProps`](../type-aliases/ChipListProps.md)\<`T`\> - -## Returns - -`Element` diff --git a/packages/design-system/documentation/api/functions/ComboBox.md b/packages/design-system/documentation/api/functions/ComboBox.md deleted file mode 100644 index 52093552..00000000 --- a/packages/design-system/documentation/api/functions/ComboBox.md +++ /dev/null @@ -1,21 +0,0 @@ -[**@accelint/design-system**](../README.md) • **Docs** - -*** - -[@accelint/design-system](../README.md) / ComboBox - -# Function: ComboBox() - -> **ComboBox**\<`T`\>(`props`): `null` \| `ReactElement`\<`any`, `string` \| `JSXElementConstructor`\<`any`\>\> - -## Type Parameters - -• **T** *extends* `object` - -## Parameters - -• **props**: `Omit`\<`ComboBoxProps`\<`T`\>, `"className"` \| `"style"`\> & `BaseComboBoxProps` & `RefAttributes`\<`HTMLDivElement`\> - -## Returns - -`null` \| `ReactElement`\<`any`, `string` \| `JSXElementConstructor`\<`any`\>\> diff --git a/packages/design-system/documentation/api/functions/DefaultsProvider.md b/packages/design-system/documentation/api/functions/DefaultsProvider.md deleted file mode 100644 index 6909f32d..00000000 --- a/packages/design-system/documentation/api/functions/DefaultsProvider.md +++ /dev/null @@ -1,24 +0,0 @@ -[**@accelint/design-system**](../README.md) • **Docs** - -*** - -[@accelint/design-system](../README.md) / DefaultsProvider - -# Function: DefaultsProvider() - -> **DefaultsProvider**(`__namedParameters`): `Element` - -Set default props for any component, to be merged in with props at point -of implementation. Global defaults take lower priority than props from -composition context or props attached to instance - -Nested instances of this provider will shallow merge defaults from parent -context, with the defaults prop taking precedence - -## Parameters - -• **\_\_namedParameters**: [`DefaultsProviderProps`](../type-aliases/DefaultsProviderProps.md) - -## Returns - -`Element` diff --git a/packages/design-system/documentation/api/functions/Dialog.md b/packages/design-system/documentation/api/functions/Dialog.md deleted file mode 100644 index 9b5c0f35..00000000 --- a/packages/design-system/documentation/api/functions/Dialog.md +++ /dev/null @@ -1,17 +0,0 @@ -[**@accelint/design-system**](../README.md) • **Docs** - -*** - -[@accelint/design-system](../README.md) / Dialog - -# Function: Dialog() - -> **Dialog**(`props`): `null` \| `ReactElement`\<`any`, `string` \| `JSXElementConstructor`\<`any`\>\> - -## Parameters - -• **props**: `Omit`\<`ModalOverlayProps`, `"children"` \| `"className"` \| `"style"`\> & `Pick`\<`DialogProps`, `"role"`\> & `object` & `RefAttributes`\<`HTMLDivElement`\> - -## Returns - -`null` \| `ReactElement`\<`any`, `string` \| `JSXElementConstructor`\<`any`\>\> diff --git a/packages/design-system/documentation/api/functions/Drawer.md b/packages/design-system/documentation/api/functions/Drawer.md deleted file mode 100644 index 3b73a889..00000000 --- a/packages/design-system/documentation/api/functions/Drawer.md +++ /dev/null @@ -1,17 +0,0 @@ -[**@accelint/design-system**](../README.md) • **Docs** - -*** - -[@accelint/design-system](../README.md) / Drawer - -# Function: Drawer() - -> **Drawer**(`props`): `Element` - -## Parameters - -• **props**: [`DrawerProps`](../type-aliases/DrawerProps.md) - -## Returns - -`Element` diff --git a/packages/design-system/documentation/api/functions/DrawerDialog.md b/packages/design-system/documentation/api/functions/DrawerDialog.md deleted file mode 100644 index 158dfaec..00000000 --- a/packages/design-system/documentation/api/functions/DrawerDialog.md +++ /dev/null @@ -1,17 +0,0 @@ -[**@accelint/design-system**](../README.md) • **Docs** - -*** - -[@accelint/design-system](../README.md) / DrawerDialog - -# Function: DrawerDialog() - -> **DrawerDialog**(`props`): `null` \| `ReactElement`\<`any`, `string` \| `JSXElementConstructor`\<`any`\>\> - -## Parameters - -• **props**: `AriaLabelingProps` & `BaseProps` & `object` & `object` & `RefAttributes`\<`HTMLDivElement`\> - -## Returns - -`null` \| `ReactElement`\<`any`, `string` \| `JSXElementConstructor`\<`any`\>\> diff --git a/packages/design-system/documentation/api/functions/DrawerTab.md b/packages/design-system/documentation/api/functions/DrawerTab.md deleted file mode 100644 index 20986d3e..00000000 --- a/packages/design-system/documentation/api/functions/DrawerTab.md +++ /dev/null @@ -1,17 +0,0 @@ -[**@accelint/design-system**](../README.md) • **Docs** - -*** - -[@accelint/design-system](../README.md) / DrawerTab - -# Function: DrawerTab() - -> **DrawerTab**(`props`): `Element` - -## Parameters - -• **props**: [`DrawerTabProps`](../type-aliases/DrawerTabProps.md) - -## Returns - -`Element` diff --git a/packages/design-system/documentation/api/functions/DrawerTabList.md b/packages/design-system/documentation/api/functions/DrawerTabList.md deleted file mode 100644 index e3e3b8a0..00000000 --- a/packages/design-system/documentation/api/functions/DrawerTabList.md +++ /dev/null @@ -1,21 +0,0 @@ -[**@accelint/design-system**](../README.md) • **Docs** - -*** - -[@accelint/design-system](../README.md) / DrawerTabList - -# Function: DrawerTabList() - -> **DrawerTabList**\<`T`\>(`props`): `Element` - -## Type Parameters - -• **T** *extends* `object` - -## Parameters - -• **props**: [`DrawerTabListProps`](../type-aliases/DrawerTabListProps.md)\<`T`\> - -## Returns - -`Element` diff --git a/packages/design-system/documentation/api/functions/Element.md b/packages/design-system/documentation/api/functions/Element.md deleted file mode 100644 index 340e8aa0..00000000 --- a/packages/design-system/documentation/api/functions/Element.md +++ /dev/null @@ -1,47 +0,0 @@ -[**@accelint/design-system**](../README.md) • **Docs** - -*** - -[@accelint/design-system](../README.md) / Element - -# Function: Element() - -> **Element**\<`A`, `B`, `C`, `D`, `E`, `F`, `G`, `H`, `I`, `J`, `K`\>(`props`): `null` \| `ReactElement`\<`any`, `string` \| `JSXElementConstructor`\<`any`\>\> - -This generic component serves as any easy way for more complex components -to establish stylable content areas within their layout with optional -targetted contexts for any subcomponents - -See Dialog & Drawer as examples - -## Type Parameters - -• **A** - -• **B** - -• **C** - -• **D** - -• **E** - -• **F** - -• **G** - -• **H** - -• **I** - -• **J** - -• **K** - -## Parameters - -• **props**: [`ElementProps`](../type-aliases/ElementProps.md)\<`A`, `B`, `C`, `D`, `E`, `F`, `G`, `H`, `I`, `J`, `K`\> & `RefAttributes`\<`HTMLElement`\> - -## Returns - -`null` \| `ReactElement`\<`any`, `string` \| `JSXElementConstructor`\<`any`\>\> diff --git a/packages/design-system/documentation/api/functions/Group.md b/packages/design-system/documentation/api/functions/Group.md deleted file mode 100644 index 441573f2..00000000 --- a/packages/design-system/documentation/api/functions/Group.md +++ /dev/null @@ -1,31 +0,0 @@ -[**@accelint/design-system**](../README.md) • **Docs** - -*** - -[@accelint/design-system](../README.md) / Group - -# Function: Group() - -> **Group**\<`T`, `E`\>(`props`): `null` \| `ReactElement`\<`any`, `string` \| `JSXElementConstructor`\<`any`\>\> - -This generic component allows for collective prop distribution to a collection of components of the same type - -## Type Parameters - -• **T** - -• **E** *extends* `Element` - -## Parameters - -• **props**: `BaseGroupProps`\<`T`, `E`\> & `SlotProps` & `RefAttributes`\<`HTMLDivElement`\> - -## Returns - -`null` \| `ReactElement`\<`any`, `string` \| `JSXElementConstructor`\<`any`\>\> - -## Example - -```ts -A list of -``` - -### "Normal" Props - -Components can all receive props in the standard way passed directly or through the render props pattern. However, there are two other ways for a component to receive props: via default props and context. - -#### Default Props - -Default props is a pattern C2DS establishes to enable global changes to the defaults of components within. If a default prop on a component isn't what the application implementor wants to be the default, they can provide that change to the DefaultsProvider and the component will now have that new value as its default. - -#### Context - -Unlike most applications where context is provided almost exclusively at a global level and consumed towards the leaves of the component tree, RAC establishes a pattern of micro implementations of context as described by Context Props, Slots and Composition. - -##### Context props - -Context props is a pattern established by RAC which is used widely for composition. Many components will establish a unique context that is based on its props. This allows the component to consume props from a parent that expects this component to be composed inside of itself. The parent composes the values passed into the provider and any children then have access to those values as consumers of context. - -##### Slots - -RAC establishes a pattern of [slots](https://react-spectrum.adobe.com/react-aria/advanced.html#slots), where a parent provides props on a given context with multiple named slots. Then when a component that consumes the matching context and includes the slot prop with a matching value (to the one of the slot names), then that component will receive the provided props on that slot. This is a means to disambiguate different context values for composed children when there are multiple children of the same component type composed together. - -[Learn](./implementation.md#slots) how this applies in an implementation. - -##### Composition - -One of the goals of this design system is to move away from mega, do-it-all components. By utilizing composition instead, each component is able to remain much more focused and concise. It also means that there's more flexibility in the end implementation since the composed components only need to adhere to specific interfaces to be compatible. Each component or style declares the interface it needs to behave correctly, but the application (or composition context) is responsible for the concrete expression of that interface. - -#### Merging props - -Whenever multiple sets of props for a component are received, the props go through a merging process. C2DS extends the standard merging process that [RAC establishes](https://react-spectrum.adobe.com/react-aria/mergeProps.html) by also handling the merge of render props, classNames and styles. - -Event handlers are merged by chaining them in the order they were merged so that they are called with the same props sequentially. Ids are simply merged by being deduplicated. `className` is merged with `clsx` while `classNames` are deep merged by merging each property on the object with `clsx`. For context props merged via the `useContextProps()` hook, local props (and refs) are merged with the ones provided via context by a parent component. The local props always take precedence over the context values. - -For all other props, the last prop object overrides all previous ones. diff --git a/packages/design-system/documentation/container-queries.md b/packages/design-system/documentation/container-queries.md deleted file mode 100644 index 25667158..00000000 --- a/packages/design-system/documentation/container-queries.md +++ /dev/null @@ -1,84 +0,0 @@ -# Container Queries - -## Anatomy - -Components that implement a Vanilla Extract [container](https://vanilla-extract.style/documentation/api/create-container/), which are based on [CSS `@container` queries](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_containment/Container_queries), expose CSS variables reflecting their state. `State` is a type that describes the possible values for the `stateVars` contract. A contract is simply a record of CSS var lookups. These variables can be queried to apply condition-based styles, enabling flexible and context-sensitive styling without extensive predefined variations. - -## Writing - -While there are multiple utility functions throughout the code that utilize container queries, they are not all documented here. For consistency, they all use the same general pattern of accepting a type and contract pair, which provides a type safe query syntax. - -#### Using `containerQueries()` for Multiple Rules - -Combine multiple conditional styles within a single container block for comprehensive styling based on component states. - -```typescript -style({ - '@container': containerQueries( - stateVars, - { - query: { foo: true }, - // Styles for specific conditions - }, - {...} - ) -}) -``` - -#### Using `containerQuery()` for a Single Rule - -Apply specific condition-based styles using a single query. - -```typescript -style({ - '@container': { - [containerQuery(stateVars, { foo: true })]: { - // Styles for specific conditions - }, - }, -}); -``` - -#### Writing Queries Manually - -For more flexibility, manually write queries that allow for customized and granular control over the component's responsive behavior. - -```typescript -style({ - '@container': { - '(--foo: true)': { - // Custom query styles - }, - }, -}); -``` - -#### Nested Queries - -Use nested structures to reference state from multiple containers, enhancing clarity and avoiding conflicts in scenarios where shared state property naming occurs. - -For example, the partially nested approach may be desirable in scenarios where `AState` parameters are the majority of the queries and `BState` is a rare occurrence. - -```typescript -type AState = { foo: boolean }; -type BState = { foo: 'foo' | 'bar' }; - -style({ - '@container': { - [containerQuery<{ A: AState; B: BState }>( - { A: aStateVars, B: bStateVars }, - { A: { foo: true }, B: { foo: 'bar' } } - )]: { - // Combined container queries - }, - }, -}); -``` - -## Order matters - -When writing multiple container queries, it's best practice to start with the most generic, default state styles and work your way up to the most specific. This is because all of them apply to the same selector. Instead of battling selector specificity, we rely on layers and query order to provide a very clear order to how styles should cascade. - -## Caveats - -Containers cannot query themselves, queries are only capable of accessing CSS variables of an ancestor. This means that styles cannot be applied to a container based on its own state. Because of this limitation, you'll often times come across a component that is represented by a container to expose state variables and a presentational element that is styled based on that state. diff --git a/packages/design-system/documentation/contribution.md b/packages/design-system/documentation/contribution.md deleted file mode 100644 index 8971fc4c..00000000 --- a/packages/design-system/documentation/contribution.md +++ /dev/null @@ -1,121 +0,0 @@ -# Contributing to the C2 Design System (C2DS) - -## Overview - -When contributing components to C2DS, keep in mind that the mental model is not that of a commercial component library. Because it is intended to be used across multiple applications with complex and specific requirements, we optimize for flexibility, granularity and favor composition rather than large and specialized "mega" components. - -That focus on flexibility requires adherence to a few guidelines: - -- Instead of designing for every possible scenario, we provide contracts and structures for composition. -- The application is responsible for determining how granular behavior and style should be; we provide the opportunity for specificity but don't enforce it. -- We do not use specific icons or svg components - that is a theming, application-level concern. -- While some defaults are inevitable, "out of the box" theming is counter-productive so defaults should be minimal and easily overridden. - -## Contribution Guidelines - -C2DS is expected to continue evolving as requirements and capabilities change. Changes and MRs are welcome and appreciated, as are suggestions and engagement in defining the roadmap. This guide will also evolve as more contributors take ownership and invest back into C2DS, so please feel free to be your naturally opinionated self as we build this foundation together, and don't hestitate to point out opportunities for optimization or improvement. - -### When to contribute - -If a component is being used in multiple locations and you are faced with the choice of copying or referencing that component, consider abstraction and build out of a C2DS component instead. It is very likely that other engineers will face that same choice in the future. - -Additionally, while feature planning and execution are underway, if a component or set of components need to be built that might be be applicable across multiple applications or features, that could also be a good candidate. If there is no time or runway to invest in abstraction and build, consider adding the component to the roadmap for a future build out. - -### Opening an MR - -This is the process for contribution: - -- First, make sure that there isn't already a component or a component on the roadmap to avoid duplicating efforts. -- Create an issue and schedule a review to ensure design consistency standards. Designers and a dev from the technical steering committee will review the proposal. -- Once the requirements and the general design are settled, have fun! A TSC dev is available for questions or pairing. - -> **Note:** The PR will need review and approval by at least one TSC member in order to be merged. - -### Component File Elements and Export/Import - -Each new component should be encapsulated in a folder named for that component inside the `src/components` folder. Each component should have, at a minimum: - -- file that publishes the component -- `my-component.tsx` -- Ladle story to demonstrate usage of relavant variants, props and styles -- `my-component.stories.tsx` -- tests to ensure coverage -- `my-component.test.tsx` -- `types.ts` file -- exports in the root `my-component/index.ts` file decorated with the `// __private-exports` so that it is not double imported when the index generation runs -- exports in the root of the `src/components` folder, alphabetically listed -- a theming example in the `.ladle/theme` folder to demonstrate how the component might be themed for an application - -### Generate index barrel file - -In order to keep the imports clean, all the components and their related configuration and types are exported at the root of the project. Therefore, when building a new component, once types are defined, run the following command to generate those exports at the root. - -`npm run index -w @cbc2/c2-design-system` - -### Ladle as development environment - -[Ladle](https://ladle.dev/) provides a convenient platform in which to develop new components. It is very similar to Storybook but has better performance and is built on Vite. For the most part, Ladle is self-explanatory but there are a few gotchas: - -- The `storyName`, `title`, and `meta` values need to be serializable and also need to be unique. -- Additionally, while the library provides hot module reload, it can sometimes fail to compile changes completely, so restarting can address that issue. - -To run Ladle: `npm run preview -w @cbc2/ds-design-system`. - -If you choose to develop a new component outside of Ladle and then port it in later, you must also provide a Ladle story to demonstrate usage. - -## Building Concepts - -In order to effectively build within C2DS, we recommend familiarizing yourself with the essential concepts and architecture upon which it has been built. [Core concepts](./concepts.md). - -### Advanced Customization with Hooks - -If the RAC don't work to meet a specific use case, there are other customized tools that allow for more granular control. While in general we prefer the approach of wrapping the React Aria components; however, for a highly customized component, it might be necessary to build on a different DOM structure or to blend functionality that might not be available otherwise. - -React Aria publishes [component-specific hooks](https://react-spectrum.adobe.com/react-aria/hooks.html#building-a-component) that allow engineers to access the functionality of the components without the default DOM structure. - -Additionally, React Stately publishes [state-management hooks](https://react-spectrum.adobe.com/react-stately/getting-started.html) for managing state with a lot of precision. It is possible to combine approaches as well -- for example, using a combination of RAC and state hooks to architect the desired solution. - -### Core styles versus application theming - -For any specific components, contracts and styles that are essential for the correct theming of that component should be co-located in the component folder. In general, the styles here should be as minimal as possible and contain no style definitions that would be better left to the application to determine. Instead, define the vars as a contract that will be later assigned as a part of implementation. - -For example, in the component we might define a property that references the color as defined in a contract, which will only have a concrete CSS var assigned to it when the application theme is initialized. - -```ts -button: style( - { - '@layer': { - [layers.components.l1]: { - color: buttonColorVars.color, - } - } - } -); -``` - -Note that Vanilla Extract provides a [utility for creating a fallBack var](https://vanilla-extract.style/documentation/api/fallback-var/) if one is not assigned, for example `minWidth: fallbackVar(buttonSpaceVars.minWidth, 'auto')`. - -[Learn](./theming.md) more about theming. - -### Layers - -When we create a core style for a component, it is essential to assign it to a layer so that it has the correct precedence and can be overridden if necessary. If we miss this detail, then application engineers won't be able to theme the component correctly. - -[Learn](./concepts.md#layers) more about layers. - -### Container queries - -Container queries are an important concept when theming a component and allow for dynamic assigment of styles based on component state. It is critical to scope the component to a container correctly so that style assignments are appropriately instanced to the component being built and container queries executed as expected. - -[Learn](./concepts#container-queries) more in depth about how to write container queries. - -## Anatomy/Architecture of a Component - -It might be helpful to visualize the basic architecture of a component in C2DS. This is a (very, very simplified) diagram that illustrates the essential concepts. - -![Component Diagram](./assets/component_diagram.png) - -To review the diagram in Excalidraw instead: https://app.excalidraw.com/s/1nHFfuetcLC/9KQMMIc4Wbj - -## Unit Testing - -At a minimum, there should be a test that proves any new component renders without error. Ideally, there should be coverage with different props and usage scenarios. Code coverage must be 80% at a minimum or the build will fail. - -## Roadmap diff --git a/packages/design-system/documentation/implementation.md b/packages/design-system/documentation/implementation.md deleted file mode 100644 index e9f98a2f..00000000 --- a/packages/design-system/documentation/implementation.md +++ /dev/null @@ -1,318 +0,0 @@ -# Using the C2 Design System - -## Overview - -Welcome to the C2 Design System (C2DS) implementation guide. If you haven't already read [why we built this system](../README.md#why-does-this-design-system-exist) or looked over the [concept docs](./concepts.md), you might want to familiarize yourself with those first before digging into the implementation. Having a good grounding in the architecture and foundational libraries will smooth the process of building and integrating this system into an application. - -This guide has four sections: - -[1. Previewing and exploring components](#components) - -[2. Building and applying styles](#styles) - -[3. Theming an application](#theming) - -[4. Advanced Customization and Reuse](#advanced-customization-and-reuse) - -## Components - -For the most part, once theming has been established in an application, using the C2DS components should be comparable to any other component library -- import the component and provide props, styling and behavior. The most notable difference is that C2DS favors component composition over complex, specialized components with a million props. Ideally, the C2DS library provides enough atomic granularity and flexibility that any UI can be composed of the component parts. - -### Previewing components with stories - -The simplest way to familiarize yourself with the available components and their usage is to review the [C2DS Stories](https://gohypergiant.github.io/standard-toolkit). You can also [run the stories locally](../README.md#getting-started) in [Ladle](https://ladle.dev/), which is similar to Storybook. It uses mocked props to demonstrate how to theme, compose and use C2DS components. It serves as a way to explore functionality and to document capabilities. - -To run the stories from the command line, run the following to start the preview: - -``` -npm run preview -w @cbc2/c2-design-system -``` - -### Props and source code spelunking - -The ladle stories render a story in the main stage and a menu to the right for navigation. The stories demonstrate and catalog design tokens, primitives (like typography), hooks and components. These sections will grow as resources are added to C2DS. - -Clicking on any child in the -`Components` list and hovering over the icons at the bottom of your screen will show additional tools. The left-most icon opens a control panel demonstrating some characteristic properties a component can receive. Editing the props in the control panel will change the props passed into the components. - -There are often props available for the C2DS components that are not represented in the story. However, the [React Aria Component (RAC) documentation](https://react-spectrum.adobe.com/react-aria/Button.html) is an additional, valuable source of information about what props the component can receive (among other information). It is highly recommended that you make use of this resource to research more specific or targeted questions. - -Reviewing the source code for the story will also provide a handy example for common use cases. From a component's story in Ladle, you can click on the -`` icon to see the source code. If you prefer, you can open the story source in an editor. All of the source code for the C2DS is located in -`packages/c2-design-system`. - -Components and the source for their stories are in their own folders in the [ -`packages/design-system/src/components`](../src/components). Stories will have a -`.stories.tsx` extension. - -### Import and Composition - -The import for the components will be from -`@cbc2/c2-design-system`. This is important to notice because there might be overlap in naming from other component systems like MUI. - -Another important detail is that, because this design system favors composition over "mega-component" behavior, you might find yourself looking for a prop when the component is expecting a child component composed in. You will see examples of composition throughout the C2DS stories. The [ -`` component story file](../src/components/checkbox/checkbox.stories.tsx) is one example that uses a combination of the C2DS -``, `` and `` components while relying on ``and -`` components for the group label and individual checkbox label text. This pattern is typical and will be how you organize your components as well. - -The stories will be your best source of information about how to build. You can also look at examples on the [React Aria components documentation](https://react-spectrum.adobe.com/react-aria/components.html). If you try and use a child component that is not supported by the C2DS component, you may get unexpected results -- however, experimentation and creative composition are encouraged. - -## Styles - -### Style Objects - -We are using [Vanilla Extract](https://vanilla-extract.style/) as the style engine, which provides type-safe and scoped classes at compile time. To define a style in VE, it is expressed as a style object passed into the -`style()` function exported by VE. The simplest syntax looks like this: - -```tsx -// styles.css.ts -const shout = style({ - color: 'red', - textTransform: 'uppercase', -}); -``` - -Styles are defined in typescript files that have a -`css.ts` extension -- those will be recognized and compiled into classes for use in the application. The -`style` function, and most everything else from VE, can only be used inside a -`*.css.ts` file and will cause an error otherwise. To use the style objects in a component or a div, import it as you would any other object. Note that like other imports, the -`ts` gets dropped so the file will look like a `css` file in the import. - -```tsx -// component.tsx -import {shout} from './styles.css'; - -export function Component() { - return
Foo! Bar!
; -} -``` - -To understand more of the functionality and features that Vanilla Extract can provide -- for example pseudo-selectors or more complex selectors, [use their documentation](https://vanilla-extract.style/documentation/api/style/). For more complex behavior, you can use [container-style queries](https://developer.mozilla.org/en-US/docs/Web/CSS/@container#container_style_queries) and [layers](#controlling-precedence-and-css-cascade), but it will most likely not be required for day to day use unless you are building reusable components for use throughout the application. - -### Styles in C2DS Components - -C2DS components will already have the default styling that is provided for them through the theming. However, if you need to adjust styles for instances of C2DS components, you can define styles in the same way as above, with the advantage of those styles being typed. The components in our design system all have a -`classNames` prop rather than `className` -- note the `s` on the end. - -You can also reuse css vars that have been defined in the theme to apply to specific elements. - -For example, the `Menu` component exports a -`MenuClassNames` type that includes properties to style elements of the menu. You might define a stylesheet similar to the following, and the style you define will be applied to the correct DOM elements: - -```tsx -// exampleMenu.css.ts -import {style} from '@vanilla-extract/css'; -import {menuColorVars} from '@cbc2/c2-design-system'; - -export const menuClassNames = { - item: { - item: { - background: menuColorVars.item.background, - }, - description: style({ - textTransform: 'uppercase', - }), - }, -}; -``` - -```tsx -// menu.tsx -import {Button, Menu, MenuItem, MenuList} from '@cbc2/c2-design-system'; -import {MenuTrigger} from 'react-aria-components'; -import {menuClassNames} from './exampleMenu.css'; - -export function Menu() { - return ( - - - - - COP - - - - ); -} -``` - -As a debugging tool, the inspector from Chrome dev tools can show you exactly what styles are being applied to each element in the component. - -### Colors / Palette - -Colors and palette are established within your application theme but we've provided values in alignment with the N2X Figma designs that you can use to get started. See the -`semanticColorVars`, `genericColorVars`, and `elevationVars` within [ -`src/styles/theme.css.ts`](../src/styles/theme.css.ts) and in the Ladle preview `Tokens` and`Primitives` sections. - -### Size / Spacing - -Sizing and spacing is also aided by C2DS `sizeVars` and `spaceVars`. Check out [ -`src/styles/theme.css.ts`](../src/styles/theme.css.ts) for more specific information on `sizeVars` and -`spaceVars` and see how space vars are applied globally in [`src/styles/space.css.ts`](../src/styles/space.css.ts). - -### Icons - -C2DS does not provide any icons and is explicitly icon library agnostic, meaning you can use whichever icon library your application requires. The C2DS -`` component wraps an -`SVG` in an easy to size, themed wrapper that makes it easy to compose into other patterns as needed. - -## Theming - -### Overview - -At it's simplest, theming is the process of "skinning" specific brand, design and behavior requirements onto the C2DS for application use. This includes establishing design tokens such as color and typography as well as standards for spacing, border radius and other shared primitives. Theming also involves crafting the style and state-based behavior for the C2DS components (for example, defining what -`onSelect()` or `isDisabled`, etc. means visually). As another example, the -` - - - ); -} -``` - -```tsx -import { useState } from 'react'; -import { inlineVars, genericColorVars } from '@cbc2/c2-design-system'; - -function App() { - const [highlightColor, setHighlightColor] = useState(); - - const handleUserSettingUpdate = (color: string) => { - setHightlightColor(color); - }; - - return ( - - - - ); -} -``` - -## Nested Theming - -If a portion of your application needs to `inherit` and modify the theme contract. - -```tsx -import { compactSizeClass, roomySizeClass } from 'theme.css.ts'; - -function App() { - return ( - - - - - - - - ); -} -``` - -The general flow of how contracts are utilized to define the shape of tokens, how tokens are populated and used to fulfill contracts, contracts are used to style components, and how user changes to tokens can be propagated across rendering technologies: [Live Editor Version](https://mermaid.live/edit#pako:eNp1VF1vmzAU_SuWHyoikTQQaBM0VWqDtpdOjUbWSmv64IYbQAEbGbM1jfLfZ2PchIg8-fiec78t7_GaxYADvMnZv3VKuEDLcEURCqM5o4KTtaisEKosoSjaVQIK9GUfoOHwTgqXbAv0XKWNg7NQjcd9WS5TKMCSADWoV6buRcko0J4SDHEpwYmrynLm0AhMd5rv9KQq1E01JR5bOXXs9KLL0MpuiF7GuHypehmFzYwVXnD2N4uBd6fx7Z2j6zstNop2LB0vGQnNowg9E15pn_s4hhgJhsKnn9pybO57nW-yPJe82YVhrjpTuJRIDrwW0vuZ5DW0-X4BidGGs0IlbOKqMPAhrPZsym5xw_-uQD-VugW9-zaq3g2dkgbrnmC9_fFo6WMg23qB9xfGt8ArS0LU4ot7P74pU5O59ys6BlMan6eEJrBXsF1BYzi05bZ83yvoUUQgREaTKnx4tQxG4cPgTWmPpFrQE0WPTK7jSmddsDyXJLpGi7pK-9JhGxfAC5LF8rfYq4ArLJrB4kDCmPDtCq_oQepILVi0o2scCF6DjesyJgLCjCScFDjYkLyS1pLQP4x17jjY4w8cDCczf-Q44xvXuZ35_sxxbbzDgeeMJo7veu7NxJu6vjc92PizieCOxrOx73muO7md-t547NmYszpJ2-CH_8akn8M) - -```mermaid -flowchart TD - DSContracts(Design System Contracts) --> DSTokens(Design System Tokens) - DSContracts --> AppTheme(App Theme) - DSContracts --> DSComponents(Design System Components) - DSContracts --> AppComponents(App Components) - AppContracts(App Contracts) --> AppTokens(App Tokens) - AppContracts --> AppTheme - DSTokens --> AppTokens - DSTokens --> AppTheme - AppTokens --> AppTheme - AppTheme --> DSThemeProvider(Design System
Theme Provider) - DSThemeProvider -- CSS Vars
Added to DOM
Contracts Fulfilled --> DSContracts & AppContracts - DSThemeProvider -- Computed Values
Read from DOM --> Context(Context) - Context --> UseTheme(useTheme) - DSContracts --> UseTheme - AppContracts --> UseTheme - UseTheme --> DeckGL(DeckGL) & WebWorkers(Web Workers) - AppContracts --> AppComponents - DSComponents --> AppComponents - AppComponents --> UserChange{User
Change} - UserChange --> DSThemeProvider - UserChange --> SettingsDB[(Settings DB)] - SettingsDB -- On Load &
Polling / Push --> DSThemeProvider -``` diff --git a/packages/design-system/package.json b/packages/design-system/package.json index d4cc5248..82bf1176 100644 --- a/packages/design-system/package.json +++ b/packages/design-system/package.json @@ -34,7 +34,6 @@ "bench": "pnpm vitest bench --run --dir src", "build": "rm -rf dist && pnpm tsup --config=tsup.css.config.ts && rm -f dist/index.js && NODE_OPTIONS=--max_old_space_size=8192 pnpm tsup", "dev": "pnpm tsc --watch", - "docs": "pnpm typedoc --logLevel Error --entryPoints src/index.ts --out documentation/api --readme none --disableSources --plugin typedoc-plugin-markdown", "index": "pnpm zx ../../scripts/indexer.mjs packages/design-system --barrels", "lint:todo": "pnpm biome lint ./", "preview": "pnpm ladle serve", @@ -81,8 +80,6 @@ "postcss": "8.4.47", "react-test-renderer": "18.3.1", "tsup": "8.3.0", - "typedoc": "0.26.11", - "typedoc-plugin-markdown": "4.2.10", "vite": "5.4.9", "vitest": "2.1.3" }, diff --git a/packages/formatters/documentation/README.md b/packages/formatters/documentation/README.md deleted file mode 100644 index 97edb063..00000000 --- a/packages/formatters/documentation/README.md +++ /dev/null @@ -1,13 +0,0 @@ -**@accelint/formatters** • **Docs** - -*** - -# @accelint/formatters - -## Functions - -- [formatM1](functions/formatM1.md) -- [formatM2](functions/formatM2.md) -- [formatM3A](functions/formatM3A.md) -- [formatM4](functions/formatM4.md) -- [formatM5](functions/formatM5.md) diff --git a/packages/formatters/documentation/functions/formatM1.md b/packages/formatters/documentation/functions/formatM1.md deleted file mode 100644 index 6605516d..00000000 --- a/packages/formatters/documentation/functions/formatM1.md +++ /dev/null @@ -1,20 +0,0 @@ -[**@accelint/formatters**](../README.md) • **Docs** - -*** - -[@accelint/formatters](../README.md) / formatM1 - -# Function: formatM1() - -> **formatM1**(`value`?): `string` - -A 2-digit octal code that identifies the aircraft's mission or type. -This mode is only used by the military. - -## Parameters - -• **value?**: `string` \| `number` - -## Returns - -`string` diff --git a/packages/formatters/documentation/functions/formatM2.md b/packages/formatters/documentation/functions/formatM2.md deleted file mode 100644 index 7050da9c..00000000 --- a/packages/formatters/documentation/functions/formatM2.md +++ /dev/null @@ -1,20 +0,0 @@ -[**@accelint/formatters**](../README.md) • **Docs** - -*** - -[@accelint/formatters](../README.md) / formatM2 - -# Function: formatM2() - -> **formatM2**(`value`?): `string` - -A 4-digit octal code that identifies the aircraft's unit code or tail number. -This mode is only used by the military. - -## Parameters - -• **value?**: `string` \| `number` - -## Returns - -`string` diff --git a/packages/formatters/documentation/functions/formatM3A.md b/packages/formatters/documentation/functions/formatM3A.md deleted file mode 100644 index 29ce83a7..00000000 --- a/packages/formatters/documentation/functions/formatM3A.md +++ /dev/null @@ -1,21 +0,0 @@ -[**@accelint/formatters**](../README.md) • **Docs** - -*** - -[@accelint/formatters](../README.md) / formatM3A - -# Function: formatM3A() - -> **formatM3A**(`value`?): `string` - -A 4-digit octal code that identifies the aircraft. This mode is used by both the -military and civilians, and is often called a squawk code. Air traffic controllers -assign these codes. - -## Parameters - -• **value?**: `string` \| `number` - -## Returns - -`string` diff --git a/packages/formatters/documentation/functions/formatM4.md b/packages/formatters/documentation/functions/formatM4.md deleted file mode 100644 index b6129901..00000000 --- a/packages/formatters/documentation/functions/formatM4.md +++ /dev/null @@ -1,21 +0,0 @@ -[**@accelint/formatters**](../README.md) • **Docs** - -*** - -[@accelint/formatters](../README.md) / formatM4 - -# Function: formatM4() - -> **formatM4**(`value`): `string` - -⚠️ We don't actually know the format of M4 -A 3-pulse reply that uses an encrypted challenge to determine the delay. -This mode is only used by the military. - -## Parameters - -• **value**: `string` \| `number` - -## Returns - -`string` diff --git a/packages/formatters/documentation/functions/formatM5.md b/packages/formatters/documentation/functions/formatM5.md deleted file mode 100644 index 512aa103..00000000 --- a/packages/formatters/documentation/functions/formatM5.md +++ /dev/null @@ -1,21 +0,0 @@ -[**@accelint/formatters**](../README.md) • **Docs** - -*** - -[@accelint/formatters](../README.md) / formatM5 - -# Function: formatM5() - -> **formatM5**(`value`): `string` - -⚠️ We don't actually know the format of M5 -A cryptographically secured version of Mode S and ADS-B GPS position. -This mode is only used by the military. - -## Parameters - -• **value**: `string` \| `number` - -## Returns - -`string` diff --git a/packages/formatters/package.json b/packages/formatters/package.json index e701954a..96a36dd4 100644 --- a/packages/formatters/package.json +++ b/packages/formatters/package.json @@ -22,7 +22,6 @@ "bench": "pnpm vitest bench --run --dir src", "build": "pnpm tsup", "dev": "pnpm tsc --watch", - "docs": "pnpm typedoc --logLevel Error --entryPoints src/index.ts --out documentation --readme none --disableSources --plugin typedoc-plugin-markdown", "index": "pnpm zx ../../scripts/indexer.mjs packages/formatters", "lint": "pnpm biome lint ./" }, @@ -32,8 +31,6 @@ "@vitest/coverage-istanbul": "2.1.3", "esbuild-plugin-file-path-extensions": "2.1.3", "tsup": "8.3.0", - "typedoc": "0.26.11", - "typedoc-plugin-markdown": "4.2.10", "vitest": "2.1.3" }, "dependencies": { diff --git a/packages/geo/documentation/README.md b/packages/geo/documentation/README.md deleted file mode 100644 index 3b1731d5..00000000 --- a/packages/geo/documentation/README.md +++ /dev/null @@ -1,11 +0,0 @@ -**@accelint/geo** • **Docs** - -*** - -# @accelint/geo - -## Functions - -- [matchDD](functions/matchDD.md) -- [matchDMS](functions/matchDMS.md) -- [normalizeDecimalDegree](functions/normalizeDecimalDegree.md) diff --git a/packages/geo/documentation/functions/matchDD.md b/packages/geo/documentation/functions/matchDD.md deleted file mode 100644 index 3f1e9c45..00000000 --- a/packages/geo/documentation/functions/matchDD.md +++ /dev/null @@ -1,17 +0,0 @@ -[**@accelint/geo**](../README.md) • **Docs** - -*** - -[@accelint/geo](../README.md) / matchDD - -# Function: matchDD() - -> **matchDD**(`val`): `DDMatches` - -## Parameters - -• **val**: `unknown` - -## Returns - -`DDMatches` diff --git a/packages/geo/documentation/functions/matchDMS.md b/packages/geo/documentation/functions/matchDMS.md deleted file mode 100644 index 0f8c3777..00000000 --- a/packages/geo/documentation/functions/matchDMS.md +++ /dev/null @@ -1,17 +0,0 @@ -[**@accelint/geo**](../README.md) • **Docs** - -*** - -[@accelint/geo](../README.md) / matchDMS - -# Function: matchDMS() - -> **matchDMS**(`val`): `DMSMatches` - -## Parameters - -• **val**: `unknown` - -## Returns - -`DMSMatches` diff --git a/packages/geo/documentation/functions/normalizeDecimalDegree.md b/packages/geo/documentation/functions/normalizeDecimalDegree.md deleted file mode 100644 index c3bd0ef8..00000000 --- a/packages/geo/documentation/functions/normalizeDecimalDegree.md +++ /dev/null @@ -1,17 +0,0 @@ -[**@accelint/geo**](../README.md) • **Docs** - -*** - -[@accelint/geo](../README.md) / normalizeDecimalDegree - -# Function: normalizeDecimalDegree() - -> **normalizeDecimalDegree**(`val`): `number`[] - -## Parameters - -• **val**: `string` - -## Returns - -`number`[] diff --git a/packages/geo/package.json b/packages/geo/package.json index a337f997..532fa2b6 100644 --- a/packages/geo/package.json +++ b/packages/geo/package.json @@ -22,7 +22,6 @@ "bench": "pnpm vitest bench --run --dir src", "build": "pnpm tsup", "dev": "pnpm tsc --watch", - "docs": "pnpm typedoc --logLevel Error --entryPoints src/index.ts --out documentation --readme none --disableSources --plugin typedoc-plugin-markdown", "index": "pnpm zx ../../scripts/indexer.mjs packages/geo", "lint": "pnpm biome lint ./", "test": "pnpm vitest --dir=src" @@ -33,8 +32,6 @@ "@vitest/coverage-istanbul": "2.1.3", "esbuild-plugin-file-path-extensions": "2.1.3", "tsup": "8.3.0", - "typedoc": "0.26.11", - "typedoc-plugin-markdown": "4.2.10", "vitest": "2.1.3" }, "dependencies": { diff --git a/packages/math/documentation/README.md b/packages/math/documentation/README.md deleted file mode 100644 index bf33fc26..00000000 --- a/packages/math/documentation/README.md +++ /dev/null @@ -1,12 +0,0 @@ -**@accelint/math** • **Docs** - -*** - -# @accelint/math - -## Functions - -- [clamp](functions/clamp.md) -- [random](functions/random.md) -- [randomInt](functions/randomInt.md) -- [round](functions/round.md) diff --git a/packages/math/documentation/functions/clamp.md b/packages/math/documentation/functions/clamp.md deleted file mode 100644 index 98eb8cfa..00000000 --- a/packages/math/documentation/functions/clamp.md +++ /dev/null @@ -1,36 +0,0 @@ -[**@accelint/math**](../README.md) • **Docs** - -*** - -[@accelint/math](../README.md) / clamp - -# Function: clamp() - -> **clamp**(`min`, `max`, `value`): `number` - -Clamps a number within the specified bounds. - -## Parameters - -• **min**: `number` - -• **max**: `number` - -• **value**: `number` - -## Returns - -`number` - -## Throws - -Throws an error if min > max. - -## Example - -```ts -const value = clamp(5, 15, 10); // 10 -const value = clamp(5, 15, 2); // 5 -const value = clamp(5, 15, 20); // 15 -const value = clamp(15, 5, 10); // RangeError -``` diff --git a/packages/math/documentation/functions/random.md b/packages/math/documentation/functions/random.md deleted file mode 100644 index 3520b500..00000000 --- a/packages/math/documentation/functions/random.md +++ /dev/null @@ -1,35 +0,0 @@ -[**@accelint/math**](../README.md) • **Docs** - -*** - -[@accelint/math](../README.md) / random - -# Function: random() - -> **random**(`min`, `max`): `number` - -Generate a random number within the given bounds. - -## Parameters - -• **min**: `number` - -• **max**: `number` - -## Returns - -`number` - -## Throws - -Throws an error if min > max. - -## Example - -```ts -const value = random(0, 10); -// value >= 0 && value <= 10; - -const value = random(10, 0); -// RangeError -``` diff --git a/packages/math/documentation/functions/randomInt.md b/packages/math/documentation/functions/randomInt.md deleted file mode 100644 index 402d8bf6..00000000 --- a/packages/math/documentation/functions/randomInt.md +++ /dev/null @@ -1,35 +0,0 @@ -[**@accelint/math**](../README.md) • **Docs** - -*** - -[@accelint/math](../README.md) / randomInt - -# Function: randomInt() - -> **randomInt**(`min`, `max`): `number` - -Generate a random integer within the given bounds. - -## Parameters - -• **min**: `number` - -• **max**: `number` - -## Returns - -`number` - -## Throws - -Throws an error if min > max. - -## Example - -```ts -const value = randomInt(0, 10); -// value >= 0 && value <= 10; - -const value = randomInt(10, 0); -// RangeError -``` diff --git a/packages/math/documentation/functions/round.md b/packages/math/documentation/functions/round.md deleted file mode 100644 index 979c3103..00000000 --- a/packages/math/documentation/functions/round.md +++ /dev/null @@ -1,34 +0,0 @@ -[**@accelint/math**](../README.md) • **Docs** - -*** - -[@accelint/math](../README.md) / round - -# Function: round() - -> **round**(`precision`, `value`): `number` - -Rounds a number to a specified precision. - -## Parameters - -• **precision**: `number` - -• **value**: `number` - -## Returns - -`number` - -## Throws - -Throws an error if precision is not integer. - -## Example - -```ts -const value = round(1, 1.2345); // 1.2 -const value = round(2, 1.2345); // 1.23 -const value = round(3, 1.2345); // 1.235 -const value = round(3.1, 1.2345); // Error -``` diff --git a/packages/math/package.json b/packages/math/package.json index aa6aad4d..6ffc1e51 100644 --- a/packages/math/package.json +++ b/packages/math/package.json @@ -22,7 +22,6 @@ "bench": "pnpm vitest bench --run --dir src", "build": "pnpm tsup", "dev": "pnpm tsc --watch", - "docs": "pnpm typedoc --logLevel Error --entryPoints src/index.ts --out documentation --readme none --disableSources --plugin typedoc-plugin-markdown", "index": "pnpm zx ../../scripts/indexer.mjs packages/math", "lint": "pnpm biome lint ./", "test": "pnpm vitest --dir=src" @@ -33,8 +32,6 @@ "@vitest/coverage-istanbul": "2.1.3", "esbuild-plugin-file-path-extensions": "2.1.3", "tsup": "8.3.0", - "typedoc": "0.26.11", - "typedoc-plugin-markdown": "4.2.10", "vitest": "2.1.3" }, "dependencies": { diff --git a/packages/predicates/documentation/README.md b/packages/predicates/documentation/README.md deleted file mode 100644 index af802151..00000000 --- a/packages/predicates/documentation/README.md +++ /dev/null @@ -1,24 +0,0 @@ -**@accelint/predicates** • **Docs** - -*** - -# @accelint/predicates - -## Functions - -- [isBbox](functions/isBbox.md) -- [isFalse](functions/isFalse.md) -- [isFiniteNumber](functions/isFiniteNumber.md) -- [isFiniteNumeric](functions/isFiniteNumeric.md) -- [isLatitude](functions/isLatitude.md) -- [isLongitude](functions/isLongitude.md) -- [isNo](functions/isNo.md) -- [isNothing](functions/isNothing.md) -- [isNumber](functions/isNumber.md) -- [isNumeric](functions/isNumeric.md) -- [isSharedWorker](functions/isSharedWorker.md) -- [isSomething](functions/isSomething.md) -- [isString](functions/isString.md) -- [isTrue](functions/isTrue.md) -- [isWorker](functions/isWorker.md) -- [isYes](functions/isYes.md) diff --git a/packages/predicates/documentation/functions/isBbox.md b/packages/predicates/documentation/functions/isBbox.md deleted file mode 100644 index e88794fb..00000000 --- a/packages/predicates/documentation/functions/isBbox.md +++ /dev/null @@ -1,21 +0,0 @@ -[**@accelint/predicates**](../README.md) • **Docs** - -*** - -[@accelint/predicates](../README.md) / isBbox - -# Function: isBbox() - -> **isBbox**(`bbox`): `boolean` - -Determines if the given value is a valid bounding box. - -Does not currently validate the lon/lat pairs. - -## Parameters - -• **bbox**: `unknown` - -## Returns - -`boolean` diff --git a/packages/predicates/documentation/functions/isFalse.md b/packages/predicates/documentation/functions/isFalse.md deleted file mode 100644 index 51e7f17c..00000000 --- a/packages/predicates/documentation/functions/isFalse.md +++ /dev/null @@ -1,41 +0,0 @@ -[**@accelint/predicates**](../README.md) • **Docs** - -*** - -[@accelint/predicates](../README.md) / isFalse - -# Function: isFalse() - -> **isFalse**(`val`): `boolean` - -Compare the given value against a custom list of `falsey` values. - -String values are not case sensitive. - -_0, '0', 'n', 'no', 'off', 'false', false_ - -## Parameters - -• **val**: `unknown` - -## Returns - -`boolean` - -## Pure - -## Example - -```ts -isFalse('on'); -// false - -isFalse('yes'); -// false - -isFalse('off'); -// true - -isFalse('no'); -// true -``` diff --git a/packages/predicates/documentation/functions/isFiniteNumber.md b/packages/predicates/documentation/functions/isFiniteNumber.md deleted file mode 100644 index fed4c8e3..00000000 --- a/packages/predicates/documentation/functions/isFiniteNumber.md +++ /dev/null @@ -1,30 +0,0 @@ -[**@accelint/predicates**](../README.md) • **Docs** - -*** - -[@accelint/predicates](../README.md) / isFiniteNumber - -# Function: isFiniteNumber() - -> **isFiniteNumber**(`val`): `boolean` - -Determine if the given value is a finite number. - -Does not include infinities, NaN, or strings that look like numbers. - -## Parameters - -• **val**: `unknown` - -## Returns - -`boolean` - -## Example - -```ts -isFiniteNumber(1.23) // true -isFiniteNumber(Infinity) // false -isFiniteNumber(NaN) // false -isFiniteNumber('1.23') // false -``` diff --git a/packages/predicates/documentation/functions/isFiniteNumeric.md b/packages/predicates/documentation/functions/isFiniteNumeric.md deleted file mode 100644 index 6b245010..00000000 --- a/packages/predicates/documentation/functions/isFiniteNumeric.md +++ /dev/null @@ -1,31 +0,0 @@ -[**@accelint/predicates**](../README.md) • **Docs** - -*** - -[@accelint/predicates](../README.md) / isFiniteNumeric - -# Function: isFiniteNumeric() - -> **isFiniteNumeric**(`val`): `boolean` - -Determine if given value is a finite number, or string that parses to a finite number. - -Does not include infinities, NaN. - -## Parameters - -• **val**: `unknown` - -## Returns - -`boolean` - -## Example - -```ts -isFiniteNumeric(1.23) // true -isFiniteNumeric('Infinity') // false -isFiniteNumeric(NaN) // false -isFiniteNumeric('1.23') // true -isFiniteNumeric('hi') // false -``` diff --git a/packages/predicates/documentation/functions/isLatitude.md b/packages/predicates/documentation/functions/isLatitude.md deleted file mode 100644 index adf33e15..00000000 --- a/packages/predicates/documentation/functions/isLatitude.md +++ /dev/null @@ -1,31 +0,0 @@ -[**@accelint/predicates**](../README.md) • **Docs** - -*** - -[@accelint/predicates](../README.md) / isLatitude - -# Function: isLatitude() - -> **isLatitude**(`val`): `boolean` - -Determines if given value is a valid latitude range. - -Assumes degrees as the unit of measure. - -## Parameters - -• **val**: `unknown` - -## Returns - -`boolean` - -## Example - -```ts -isLatitude(-90) // true -isLatitude(0) // true -isLatitude(90) // true -isLatitude(-100) // false -isLatitude(NaN) // false -``` diff --git a/packages/predicates/documentation/functions/isLongitude.md b/packages/predicates/documentation/functions/isLongitude.md deleted file mode 100644 index a12feea5..00000000 --- a/packages/predicates/documentation/functions/isLongitude.md +++ /dev/null @@ -1,31 +0,0 @@ -[**@accelint/predicates**](../README.md) • **Docs** - -*** - -[@accelint/predicates](../README.md) / isLongitude - -# Function: isLongitude() - -> **isLongitude**(`val`): `boolean` - -Determines if given value is a valid longitude range. - -Assumes degrees as the unit of measure. - -## Parameters - -• **val**: `unknown` - -## Returns - -`boolean` - -## Example - -```ts -isLongitude(-180) // true -isLongitude(0) // true -isLongitude(180) // true -isLongitude(-190) // false -isLongitude(NaN) // false -``` diff --git a/packages/predicates/documentation/functions/isNo.md b/packages/predicates/documentation/functions/isNo.md deleted file mode 100644 index 7eb3e21f..00000000 --- a/packages/predicates/documentation/functions/isNo.md +++ /dev/null @@ -1,40 +0,0 @@ -[**@accelint/predicates**](../README.md) • **Docs** - -*** - -[@accelint/predicates](../README.md) / isNo - -# Function: isNo() - -> **isNo**(`val`): `boolean` - -Compare the given value against a custom list of `falsey` values. - -String values are not case sensitive. - -_0, '0', 'n', 'no', 'off', 'false', false_ - -## Parameters - -• **val**: `unknown` - -## Returns - -`boolean` - -## Pure - -## Example - -```ts -isNo('on'); -// false - -isNo('yes'); -// false - -isNo('off'); -// true - -isNo('no'); -``` diff --git a/packages/predicates/documentation/functions/isNothing.md b/packages/predicates/documentation/functions/isNothing.md deleted file mode 100644 index f8d8f06a..00000000 --- a/packages/predicates/documentation/functions/isNothing.md +++ /dev/null @@ -1,27 +0,0 @@ -[**@accelint/predicates**](../README.md) • **Docs** - -*** - -[@accelint/predicates](../README.md) / isNothing - -# Function: isNothing() - -> **isNothing**(`val`): val is undefined \| null - -Determines if the given value is undefined or null. - -## Parameters - -• **val**: `unknown` - -## Returns - -val is undefined \| null - -## Example - -```ts -if(isNothing(val)) { - // error path... -} -``` diff --git a/packages/predicates/documentation/functions/isNumber.md b/packages/predicates/documentation/functions/isNumber.md deleted file mode 100644 index fca7f19f..00000000 --- a/packages/predicates/documentation/functions/isNumber.md +++ /dev/null @@ -1,30 +0,0 @@ -[**@accelint/predicates**](../README.md) • **Docs** - -*** - -[@accelint/predicates](../README.md) / isNumber - -# Function: isNumber() - -> **isNumber**(`val`): val is number \| Number - -Determine if the given value is a number. - -Includes Infinities and NaN, does not include strings that look like numbers - -## Parameters - -• **val**: `unknown` - -## Returns - -val is number \| Number - -## Example - -```ts -isNumber(1.23) // true -isNumber(Infinity) // true -isNumber(NaN) // true -isNumber('1.23') // false -``` diff --git a/packages/predicates/documentation/functions/isNumeric.md b/packages/predicates/documentation/functions/isNumeric.md deleted file mode 100644 index fb7d019d..00000000 --- a/packages/predicates/documentation/functions/isNumeric.md +++ /dev/null @@ -1,31 +0,0 @@ -[**@accelint/predicates**](../README.md) • **Docs** - -*** - -[@accelint/predicates](../README.md) / isNumeric - -# Function: isNumeric() - -> **isNumeric**(`val`): `boolean` - -Determine if given value is a number, or string that parses to a number. Includes infinities and NaN. - -Non-finite strings are: 'Infinity', '-Infinity', and 'NaN'. - -## Parameters - -• **val**: `unknown` - -## Returns - -`boolean` - -## Example - -```ts -isNumeric(1.23) // true -isNumeric('Infinity') // true -isNumeric(NaN) // true -isNumeric('1.23') // true -isNumeric('hi') // false -``` diff --git a/packages/predicates/documentation/functions/isSharedWorker.md b/packages/predicates/documentation/functions/isSharedWorker.md deleted file mode 100644 index 18ae5d73..00000000 --- a/packages/predicates/documentation/functions/isSharedWorker.md +++ /dev/null @@ -1,19 +0,0 @@ -[**@accelint/predicates**](../README.md) • **Docs** - -*** - -[@accelint/predicates](../README.md) / isSharedWorker - -# Function: isSharedWorker() - -> **isSharedWorker**(`val`): `val is SharedWorker` - -Determine if the given value is a SharedWorker. - -## Parameters - -• **val**: `unknown` - -## Returns - -`val is SharedWorker` diff --git a/packages/predicates/documentation/functions/isSomething.md b/packages/predicates/documentation/functions/isSomething.md deleted file mode 100644 index 5217c079..00000000 --- a/packages/predicates/documentation/functions/isSomething.md +++ /dev/null @@ -1,27 +0,0 @@ -[**@accelint/predicates**](../README.md) • **Docs** - -*** - -[@accelint/predicates](../README.md) / isSomething - -# Function: isSomething() - -> **isSomething**(`arg`): `boolean` - -Determines if the given value is **not** undefined or null. - -## Parameters - -• **arg**: `unknown` - -## Returns - -`boolean` - -## Example - -```ts -if(isSomething(val)) { - // happy path... -} -``` diff --git a/packages/predicates/documentation/functions/isString.md b/packages/predicates/documentation/functions/isString.md deleted file mode 100644 index ed11143f..00000000 --- a/packages/predicates/documentation/functions/isString.md +++ /dev/null @@ -1,19 +0,0 @@ -[**@accelint/predicates**](../README.md) • **Docs** - -*** - -[@accelint/predicates](../README.md) / isString - -# Function: isString() - -> **isString**(`val`): val is string \| String - -Determines if the given value is a string. - -## Parameters - -• **val**: `unknown` - -## Returns - -val is string \| String diff --git a/packages/predicates/documentation/functions/isTrue.md b/packages/predicates/documentation/functions/isTrue.md deleted file mode 100644 index e42543e7..00000000 --- a/packages/predicates/documentation/functions/isTrue.md +++ /dev/null @@ -1,41 +0,0 @@ -[**@accelint/predicates**](../README.md) • **Docs** - -*** - -[@accelint/predicates](../README.md) / isTrue - -# Function: isTrue() - -> **isTrue**(`val`): `boolean` - -Compare the given value against a custom list of `truthy` values. - -String values are not case sensitive. - -_1, '1', 'y', 'yes', 'on', 'true', true_ - -## Parameters - -• **val**: `unknown` - -## Returns - -`boolean` - -## Pure - -## Example - -```ts -isTrue('on'); -// true - -isTrue('yes'); -// true - -isTrue('off'); -// false - -isTrue('no'); -// false -``` diff --git a/packages/predicates/documentation/functions/isWorker.md b/packages/predicates/documentation/functions/isWorker.md deleted file mode 100644 index 32360820..00000000 --- a/packages/predicates/documentation/functions/isWorker.md +++ /dev/null @@ -1,19 +0,0 @@ -[**@accelint/predicates**](../README.md) • **Docs** - -*** - -[@accelint/predicates](../README.md) / isWorker - -# Function: isWorker() - -> **isWorker**(`val`): `val is Worker` - -Determines if given value is a Worker. - -## Parameters - -• **val**: `unknown` - -## Returns - -`val is Worker` diff --git a/packages/predicates/documentation/functions/isYes.md b/packages/predicates/documentation/functions/isYes.md deleted file mode 100644 index 5239c72c..00000000 --- a/packages/predicates/documentation/functions/isYes.md +++ /dev/null @@ -1,41 +0,0 @@ -[**@accelint/predicates**](../README.md) • **Docs** - -*** - -[@accelint/predicates](../README.md) / isYes - -# Function: isYes() - -> **isYes**(`val`): `boolean` - -Compare the given value against a custom list of `truthy` values. - -String values are not case sensitive. - -_1, '1', 'y', 'yes', 'on', 'true', true_ - -## Parameters - -• **val**: `unknown` - -## Returns - -`boolean` - -## Pure - -## Example - -```ts -isYes('on'); -// true - -isYes('yes'); -// true - -isYes('off'); -// false - -isYes('no'); -// false -``` diff --git a/packages/predicates/package.json b/packages/predicates/package.json index 769f3f34..0f27ca2c 100644 --- a/packages/predicates/package.json +++ b/packages/predicates/package.json @@ -22,7 +22,6 @@ "bench": "pnpm vitest bench --run --dir src", "build": "pnpm tsup", "dev": "pnpm tsc --watch", - "docs": "pnpm typedoc --logLevel Error --entryPoints src/index.ts --out documentation --readme none --disableSources --plugin typedoc-plugin-markdown", "index": "pnpm zx ../../scripts/indexer.mjs packages/predicates", "lint": "pnpm biome lint ./", "test": "pnpm vitest --dir=src" @@ -34,8 +33,6 @@ "@vitest/web-worker": "2.1.3", "esbuild-plugin-file-path-extensions": "2.1.3", "tsup": "8.3.0", - "typedoc": "0.26.11", - "typedoc-plugin-markdown": "4.2.10", "vitest": "2.1.3" }, "dependencies": { diff --git a/packages/temporal/documentation/README.md b/packages/temporal/documentation/README.md deleted file mode 100644 index 2f600ab3..00000000 --- a/packages/temporal/documentation/README.md +++ /dev/null @@ -1,10 +0,0 @@ -**@accelint/temporal** • **Docs** - -*** - -# @accelint/temporal - -## Functions - -- [setClockInterval](functions/setClockInterval.md) -- [setClockTimeout](functions/setClockTimeout.md) diff --git a/packages/temporal/documentation/functions/setClockInterval.md b/packages/temporal/documentation/functions/setClockInterval.md deleted file mode 100644 index e9413ceb..00000000 --- a/packages/temporal/documentation/functions/setClockInterval.md +++ /dev/null @@ -1,32 +0,0 @@ -[**@accelint/temporal**](../README.md) • **Docs** - -*** - -[@accelint/temporal](../README.md) / setClockInterval - -# Function: setClockInterval() - -> **setClockInterval**(`cb`, `ms`): () => `void` - -Works the same way as setInterval but will wait to fire until next clock second. - -## Parameters - -• **cb** - -• **ms**: `number` - -## Returns - -`Function` - -### Returns - -`void` - -## Example - -```ts -const cleanup = setClockInterval(() => console.log('hi'), 250); -// will log hi every 250ms starting on next clock second -``` diff --git a/packages/temporal/documentation/functions/setClockTimeout.md b/packages/temporal/documentation/functions/setClockTimeout.md deleted file mode 100644 index 30d3786a..00000000 --- a/packages/temporal/documentation/functions/setClockTimeout.md +++ /dev/null @@ -1,32 +0,0 @@ -[**@accelint/temporal**](../README.md) • **Docs** - -*** - -[@accelint/temporal](../README.md) / setClockTimeout - -# Function: setClockTimeout() - -> **setClockTimeout**(`cb`, `ms`): () => `void` - -Works the same way as setTimeout but will wait to fire until next clock second. - -## Parameters - -• **cb** - -• **ms**: `number` - -## Returns - -`Function` - -### Returns - -`void` - -## Example - -```ts -const cleanup = setClockTimeout(() => console.log('hi'), 250); -// will log hi after 250ms starting on next clock second -``` diff --git a/packages/temporal/package.json b/packages/temporal/package.json index 343aa92c..2d7c1776 100644 --- a/packages/temporal/package.json +++ b/packages/temporal/package.json @@ -22,7 +22,6 @@ "bench": "pnpm vitest bench --run --dir src", "build": "pnpm tsup", "dev": "pnpm tsc --watch", - "docs": "pnpm typedoc --logLevel Error --entryPoints src/index.ts --out documentation --readme none --disableSources --plugin typedoc-plugin-markdown", "index": "pnpm zx ../../scripts/indexer.mjs packages/clock", "lint": "pnpm biome lint ./", "test": "pnpm vitest --dir=src" @@ -33,8 +32,6 @@ "@vitest/coverage-istanbul": "2.1.3", "esbuild-plugin-file-path-extensions": "2.1.3", "tsup": "8.3.0", - "typedoc": "0.26.11", - "typedoc-plugin-markdown": "4.2.10", "vitest": "2.1.3" }, "dependencies": { diff --git a/packages/web-worker/documentation/README.md b/packages/web-worker/documentation/README.md deleted file mode 100644 index a36cdfe7..00000000 --- a/packages/web-worker/documentation/README.md +++ /dev/null @@ -1,14 +0,0 @@ -**@accelint/worker** • **Docs** - -*** - -# @accelint/worker - -## Type Aliases - -- [Action](type-aliases/Action.md) - -## Functions - -- [create](functions/create.md) -- [expose](functions/expose.md) diff --git a/packages/web-worker/documentation/functions/create.md b/packages/web-worker/documentation/functions/create.md deleted file mode 100644 index fce89038..00000000 --- a/packages/web-worker/documentation/functions/create.md +++ /dev/null @@ -1,53 +0,0 @@ -[**@accelint/worker**](../README.md) • **Docs** - -*** - -[@accelint/worker](../README.md) / create - -# Function: create() - -> **create**\<`Functions`\>(`createFn`): `object` - -## Type Parameters - -• **Functions** *extends* `Actions` - -## Parameters - -• **createFn** - -## Returns - -`object` - -### destroy() - -> **destroy**: () => `void` - -#### Returns - -`void` - -### instance - -> **instance**: `Worker` \| `SharedWorker` = `worker` - -### run() - -> **run**: \<`FunctionName`, `FunctionCall`\>(`functionName`, ...`args`) => `Promise`\<`ReturnType`\<`FunctionCall`\>\> - -#### Type Parameters - -• **FunctionName** *extends* `string` \| `number` \| `symbol` - -• **FunctionCall** *extends* (...`args`) => `any` - -#### Parameters - -• **functionName**: `FunctionName` - -• ...**args**: `Parameters`\<`FunctionCall`\> - -#### Returns - -`Promise`\<`ReturnType`\<`FunctionCall`\>\> diff --git a/packages/web-worker/documentation/functions/expose.md b/packages/web-worker/documentation/functions/expose.md deleted file mode 100644 index ea89f8ae..00000000 --- a/packages/web-worker/documentation/functions/expose.md +++ /dev/null @@ -1,19 +0,0 @@ -[**@accelint/worker**](../README.md) • **Docs** - -*** - -[@accelint/worker](../README.md) / expose - -# Function: expose() - -> **expose**(`actions`, `shared`): `void` - -## Parameters - -• **actions**: `Actions` - -• **shared**: `boolean` = `false` - -## Returns - -`void` diff --git a/packages/web-worker/documentation/type-aliases/Action.md b/packages/web-worker/documentation/type-aliases/Action.md deleted file mode 100644 index c6139a56..00000000 --- a/packages/web-worker/documentation/type-aliases/Action.md +++ /dev/null @@ -1,13 +0,0 @@ -[**@accelint/worker**](../README.md) • **Docs** - -*** - -[@accelint/worker](../README.md) / Action - -# Type Alias: Action\ - -> **Action**\<`T`\>: [`T`, `Transferable`[]] - -## Type Parameters - -• **T** diff --git a/packages/web-worker/package.json b/packages/web-worker/package.json index 250760e7..3a6742a4 100644 --- a/packages/web-worker/package.json +++ b/packages/web-worker/package.json @@ -22,7 +22,6 @@ "bench": "pnpm vitest bench --run --dir src", "build": "pnpm tsup", "dev": "pnpm tsc --watch", - "docs": "pnpm typedoc --logLevel Error --entryPoints src/index.ts --out documentation --readme none --disableSources --plugin typedoc-plugin-markdown", "index": "pnpm zx ../../scripts/indexer.mjs packages/web-worker", "lint": "pnpm biome lint ./" }, @@ -32,8 +31,6 @@ "@vitest/coverage-istanbul": "2.1.3", "esbuild-plugin-file-path-extensions": "2.1.3", "tsup": "8.3.0", - "typedoc": "0.26.11", - "typedoc-plugin-markdown": "4.2.10", "vitest": "2.1.3" }, "dependencies": { diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml index 2ea98e3c..a268f0de 100644 --- a/pnpm-lock.yaml +++ b/pnpm-lock.yaml @@ -179,12 +179,6 @@ importers: tsup: specifier: 8.3.0 version: 8.3.0(@swc/core@1.7.36(@swc/helpers@0.5.15))(jiti@2.4.2)(postcss@8.4.49)(tsx@4.19.2)(typescript@5.6.3)(yaml@2.6.1) - typedoc: - specifier: 0.26.11 - version: 0.26.11(typescript@5.6.3) - typedoc-plugin-markdown: - specifier: 4.2.10 - version: 4.2.10(typedoc@0.26.11(typescript@5.6.3)) vitest: specifier: 2.1.3 version: 2.1.3(@types/node@20.17.10)(jsdom@25.0.1)(msw@2.7.0(@types/node@20.17.10)(typescript@5.6.3))(sass-embedded@1.83.0)(terser@5.37.0) @@ -213,12 +207,6 @@ importers: tsup: specifier: 8.3.0 version: 8.3.0(@swc/core@1.7.36(@swc/helpers@0.5.15))(jiti@2.4.2)(postcss@8.4.49)(tsx@4.19.2)(typescript@5.6.3)(yaml@2.6.1) - typedoc: - specifier: 0.26.11 - version: 0.26.11(typescript@5.6.3) - typedoc-plugin-markdown: - specifier: 4.2.10 - version: 4.2.10(typedoc@0.26.11(typescript@5.6.3)) vitest: specifier: 2.1.3 version: 2.1.3(@types/node@20.17.10)(jsdom@25.0.1)(msw@2.7.0(@types/node@20.17.10)(typescript@5.6.3))(sass-embedded@1.83.0)(terser@5.37.0) @@ -244,12 +232,6 @@ importers: tsup: specifier: 8.3.0 version: 8.3.0(@swc/core@1.7.36(@swc/helpers@0.5.15))(jiti@2.4.2)(postcss@8.4.49)(tsx@4.19.2)(typescript@5.6.3)(yaml@2.6.1) - typedoc: - specifier: 0.26.11 - version: 0.26.11(typescript@5.6.3) - typedoc-plugin-markdown: - specifier: 4.2.10 - version: 4.2.10(typedoc@0.26.11(typescript@5.6.3)) vitest: specifier: 2.1.3 version: 2.1.3(@types/node@20.17.10)(jsdom@25.0.1)(msw@2.7.0(@types/node@20.17.10)(typescript@5.6.3))(sass-embedded@1.83.0)(terser@5.37.0) @@ -398,12 +380,6 @@ importers: tsup: specifier: 8.3.0 version: 8.3.0(@swc/core@1.7.36(@swc/helpers@0.5.15))(jiti@2.4.2)(postcss@8.4.47)(tsx@4.19.2)(typescript@5.6.3)(yaml@2.6.1) - typedoc: - specifier: 0.26.11 - version: 0.26.11(typescript@5.6.3) - typedoc-plugin-markdown: - specifier: 4.2.10 - version: 4.2.10(typedoc@0.26.11(typescript@5.6.3)) vite: specifier: 5.4.9 version: 5.4.9(@types/node@20.17.10)(sass-embedded@1.83.0)(terser@5.37.0) @@ -432,12 +408,6 @@ importers: tsup: specifier: 8.3.0 version: 8.3.0(@swc/core@1.7.36(@swc/helpers@0.5.15))(jiti@2.4.2)(postcss@8.4.49)(tsx@4.19.2)(typescript@5.6.3)(yaml@2.6.1) - typedoc: - specifier: 0.26.11 - version: 0.26.11(typescript@5.6.3) - typedoc-plugin-markdown: - specifier: 4.2.10 - version: 4.2.10(typedoc@0.26.11(typescript@5.6.3)) vitest: specifier: 2.1.3 version: 2.1.3(@types/node@20.17.10)(jsdom@25.0.1)(msw@2.7.0(@types/node@20.17.10)(typescript@5.6.3))(sass-embedded@1.83.0)(terser@5.37.0) @@ -475,12 +445,6 @@ importers: tsup: specifier: 8.3.0 version: 8.3.0(@swc/core@1.7.36(@swc/helpers@0.5.15))(jiti@2.4.2)(postcss@8.4.49)(tsx@4.19.2)(typescript@5.6.3)(yaml@2.6.1) - typedoc: - specifier: 0.26.11 - version: 0.26.11(typescript@5.6.3) - typedoc-plugin-markdown: - specifier: 4.2.10 - version: 4.2.10(typedoc@0.26.11(typescript@5.6.3)) vitest: specifier: 2.1.3 version: 2.1.3(@types/node@20.17.10)(jsdom@25.0.1)(msw@2.7.0(@types/node@20.17.10)(typescript@5.6.3))(sass-embedded@1.83.0)(terser@5.37.0) @@ -506,12 +470,6 @@ importers: tsup: specifier: 8.3.0 version: 8.3.0(@swc/core@1.7.36(@swc/helpers@0.5.15))(jiti@2.4.2)(postcss@8.4.49)(tsx@4.19.2)(typescript@5.6.3)(yaml@2.6.1) - typedoc: - specifier: 0.26.11 - version: 0.26.11(typescript@5.6.3) - typedoc-plugin-markdown: - specifier: 4.2.10 - version: 4.2.10(typedoc@0.26.11(typescript@5.6.3)) vitest: specifier: 2.1.3 version: 2.1.3(@types/node@20.17.10)(jsdom@25.0.1)(msw@2.7.0(@types/node@20.17.10)(typescript@5.6.3))(sass-embedded@1.83.0)(terser@5.37.0) @@ -543,12 +501,6 @@ importers: tsup: specifier: 8.3.0 version: 8.3.0(@swc/core@1.7.36(@swc/helpers@0.5.15))(jiti@2.4.2)(postcss@8.4.49)(tsx@4.19.2)(typescript@5.6.3)(yaml@2.6.1) - typedoc: - specifier: 0.26.11 - version: 0.26.11(typescript@5.6.3) - typedoc-plugin-markdown: - specifier: 4.2.10 - version: 4.2.10(typedoc@0.26.11(typescript@5.6.3)) vitest: specifier: 2.1.3 version: 2.1.3(@types/node@20.17.10)(jsdom@25.0.1)(msw@2.7.0(@types/node@20.17.10)(typescript@5.6.3))(sass-embedded@1.83.0)(terser@5.37.0) @@ -574,12 +526,6 @@ importers: tsup: specifier: 8.3.0 version: 8.3.0(@swc/core@1.7.36(@swc/helpers@0.5.15))(jiti@2.4.2)(postcss@8.4.49)(tsx@4.19.2)(typescript@5.6.3)(yaml@2.6.1) - typedoc: - specifier: 0.26.11 - version: 0.26.11(typescript@5.6.3) - typedoc-plugin-markdown: - specifier: 4.2.10 - version: 4.2.10(typedoc@0.26.11(typescript@5.6.3)) vitest: specifier: 2.1.3 version: 2.1.3(@types/node@20.17.10)(jsdom@25.0.1)(msw@2.7.0(@types/node@20.17.10)(typescript@5.6.3))(sass-embedded@1.83.0)(terser@5.37.0) @@ -608,12 +554,6 @@ importers: tsup: specifier: 8.3.0 version: 8.3.0(@swc/core@1.7.36(@swc/helpers@0.5.15))(jiti@2.4.2)(postcss@8.4.49)(tsx@4.19.2)(typescript@5.6.3)(yaml@2.6.1) - typedoc: - specifier: 0.26.11 - version: 0.26.11(typescript@5.6.3) - typedoc-plugin-markdown: - specifier: 4.2.10 - version: 4.2.10(typedoc@0.26.11(typescript@5.6.3)) vitest: specifier: 2.1.3 version: 2.1.3(@types/node@20.17.10)(jsdom@25.0.1)(msw@2.7.0(@types/node@20.17.10)(typescript@5.6.3))(sass-embedded@1.83.0)(terser@5.37.0) @@ -1542,7 +1482,6 @@ packages: '@ls-lint/ls-lint@2.3.0-beta.1': resolution: {integrity: sha512-NmujBNFslP4GhFsB92zh1evSSBadcg+RMsQ5FM70OrU36C3AbQYaVXDn4reC28GM6DFoOtiETRdKV6ie1TfP7g==} - cpu: [x64, arm64, s390x, ppc64le] os: [darwin, linux, win32] hasBin: true @@ -2631,21 +2570,6 @@ packages: '@selderee/plugin-htmlparser2@0.11.0': resolution: {integrity: sha512-P33hHGdldxGabLFjPPpaTxVolMrzrcegejx+0GxjrIb9Zv48D8yAIA/QTDR2dFl7Uz7urX8aX6+5bCZslr+gWQ==} - '@shikijs/core@1.24.4': - resolution: {integrity: sha512-jjLsld+xEEGYlxAXDyGwWsKJ1sw5Pc1pnp4ai2ORpjx2UX08YYTC0NNqQYO1PaghYaR+PvgMOGuvzw2he9sk0Q==} - - '@shikijs/engine-javascript@1.24.4': - resolution: {integrity: sha512-TClaQOLvo9WEMJv6GoUsykQ6QdynuKszuORFWCke8qvi6PeLm7FcD9+7y45UenysxEWYpDL5KJaVXTngTE+2BA==} - - '@shikijs/engine-oniguruma@1.24.4': - resolution: {integrity: sha512-Do2ry6flp2HWdvpj2XOwwa0ljZBRy15HKZITzPcNIBOGSeprnA8gOooA/bLsSPuy8aJBa+Q/r34dMmC3KNL/zw==} - - '@shikijs/types@1.24.4': - resolution: {integrity: sha512-0r0XU7Eaow0PuDxuWC1bVqmWCgm3XqizIaT7SM42K03vc69LGooT0U8ccSR44xP/hGlNx4FKhtYpV+BU6aaKAA==} - - '@shikijs/vscode-textmate@9.3.1': - resolution: {integrity: sha512-79QfK1393x9Ho60QFyLti+QfdJzRQCVLFb97kOIV7Eo9vQU/roINgk7m24uv0a7AUvN//RDH36FLjjK48v0s9g==} - '@sindresorhus/merge-streams@2.3.0': resolution: {integrity: sha512-LtoMMhxAlorcGhmFYI+LhPgbPZCkgP6ra1YL604EeF6U98pLlQ3iWIGMdWSC+vWmPBWBNgmDBAhnAobLROJmwg==} engines: {node: '>=18'} @@ -3579,9 +3503,6 @@ packages: electron-to-chromium@1.5.76: resolution: {integrity: sha512-CjVQyG7n7Sr+eBXE86HIulnL5N8xZY1sgmOPGuq/F0Rr0FJq63lg0kEtOIDfZBk44FnDLf6FUJ+dsJcuiUDdDQ==} - emoji-regex-xs@1.0.0: - resolution: {integrity: sha512-LRlerrMYoIDrT6jgpeZ2YYl/L8EulRTt5hQcYjy5AInh7HWXKimpqx68aknBFpGL2+/IcogTcaydJEgaTmOpDg==} - emoji-regex@10.4.0: resolution: {integrity: sha512-EC+0oUMY1Rqm4O6LLrgjtYDvcVYTy7chDnM4Q7030tP4Kwj3u/pR6gP9ygnp2CJMK5Gq+9Q2oqmrFJAz01DXjw==} @@ -3951,9 +3872,6 @@ packages: hast-util-to-estree@3.1.0: resolution: {integrity: sha512-lfX5g6hqVh9kjS/B9E2gSkvHH4SZNiQFiqWS0x9fENzEl+8W12RqdRxX6d/Cwxi30tPQs3bIO+aolQJNp1bIyw==} - hast-util-to-html@9.0.4: - resolution: {integrity: sha512-wxQzXtdbhiwGAUKrnQJXlOPmHnEehzphwkK7aluUPQ+lEc1xefC8pblMgpp2w5ldBTEfveRIrADcrhGIWrlTDA==} - hast-util-to-jsx-runtime@2.3.2: resolution: {integrity: sha512-1ngXYb+V9UT5h+PxNRa1O1FYguZK/XL+gkeqvp7EdHlB9oHUG0eYRo/vY5inBdcqo3RkPMC58/H94HvkbfGdyg==} @@ -4335,9 +4253,6 @@ packages: lines-and-columns@1.2.4: resolution: {integrity: sha512-7ylylesZQ/PV29jhEDl3Ufjo6ZX7gCqJr5F7PKrqc93v7fzSymt1BpwEU8nAUXs8qzzvqhbjhK5QZg6Mt/HkBg==} - linkify-it@5.0.0: - resolution: {integrity: sha512-5aHCbzQRADcdP+ATqnDuhhJ/MRIqDkZX5pyjFHRRysS8vZ5AbqGEoFIb6pYHPZ+L/OC2Lc+xT8uHVVR5CAK/wQ==} - load-tsconfig@0.2.5: resolution: {integrity: sha512-IXO6OCs9yg8tMKzfPZ1YmheJbZCiEsnBdcB03l0OcfK9prKnJb96siuHCr5Fl37/yo9DnKU+TLpxzTUspw9shg==} engines: {node: ^12.20.0 || ^14.13.1 || >=16.0.0} @@ -4424,10 +4339,6 @@ packages: resolution: {integrity: sha512-o5vL7aDWatOTX8LzaS1WMoaoxIiLRQJuIKKe2wAw6IeULDHaqbiqiggmx+pKvZDb1Sj+pE46Sn1T7lCqfFtg1Q==} engines: {node: '>=16'} - markdown-it@14.1.0: - resolution: {integrity: sha512-a54IwgWPaeBCAAsv13YgmALOF1elABB08FxO9i+r4VFk5Vl4pKokRPeX8u5TCgSsPi6ec1otfLjdOpVcgbpshg==} - hasBin: true - markdown-table@3.0.4: resolution: {integrity: sha512-wiYz4+JrLyb/DqW2hkFJxP7Vd7JuTDm77fvbM8VfEQdmSMqcImWeeRbHwZjBjIFki/VaMK2BhFi7oUUZeM5bqw==} @@ -4535,9 +4446,6 @@ packages: mdast-util-to-string@4.0.0: resolution: {integrity: sha512-0H44vDimn51F0YwvxSJSm0eCDOJTRlmN0R1yBh4HLj9wiV1Dn0QoXGbvFAWj2hSItVTlCmBF1hqKlIyUBVFLPg==} - mdurl@2.0.0: - resolution: {integrity: sha512-Lf+9+2r+Tdp5wXDXC4PcIBjTDtq4UKjCPMQhKIuzpJNW0b96kVqSwW0bT7FhRSfmAiFYgP+SCRvdrDozfh0U5w==} - media-query-parser@2.0.2: resolution: {integrity: sha512-1N4qp+jE0pL5Xv4uEcwVUhIkwdUO3S/9gML90nqKA7v7FcOS5vUtatfzok9S9U1EJU8dHWlcv95WLnKmmxZI9w==} @@ -4915,9 +4823,6 @@ packages: resolution: {integrity: sha512-kbpaSSGJTWdAY5KPVeMOKXSrPtr8C8C7wodJbcsd51jRnmD+GZu8Y0VoU6Dm5Z4vWr0Ig/1NKuWRKf7j5aaYSg==} engines: {node: '>=6'} - oniguruma-to-es@0.8.1: - resolution: {integrity: sha512-dekySTEvCxCj0IgKcA2uUCO/e4ArsqpucDPcX26w9ajx+DvMWLc5eZeJaRQkd7oC/+rwif5gnT900tA34uN9Zw==} - only@0.0.2: resolution: {integrity: sha512-Fvw+Jemq5fjjyWz6CpKx6w9s7xxqo3+JCyM0WXWeCSOboZ8ABkyvP8ID4CZuChA/wxSx+XSJmdOm8rGVyJ1hdQ==} @@ -5133,10 +5038,6 @@ packages: psl@1.15.0: resolution: {integrity: sha512-JZd3gMVBAVQkSs6HdNZo9Sdo0LNcQeMNP3CozBJb3JYC/QUYZTnKxP+f8oWRX4rHP5EurWxqAHTSwUCjlNKa1w==} - punycode.js@2.3.1: - resolution: {integrity: sha512-uxFIHU0YlHYhDQtV4R9J6a52SLx28BCjT+4ieh7IGbgwVJWO+km431c4yRlREUAsAmt/uMjQUyQHNEPf0M39CA==} - engines: {node: '>=6'} - punycode@2.3.1: resolution: {integrity: sha512-vYt7UD1U9Wg6138shLtLOvdAu+8DsC/ilFtEVHcH+wydcSpNE20AfSOduf6MkRFahL5FY7X1oU7nKVZFtfq8Fg==} engines: {node: '>=6'} @@ -5313,15 +5214,6 @@ packages: regenerator-runtime@0.14.1: resolution: {integrity: sha512-dYnhHh0nJoMfnkZs6GmmhFknAGRrLznOu5nc9ML+EJxGvrx6H7teuevqVqCuPcPK//3eDrrjQhehXVx9cnkGdw==} - regex-recursion@5.0.0: - resolution: {integrity: sha512-UwyOqeobrCCqTXPcsSqH4gDhOjD5cI/b8kjngWgSZbxYh5yVjAwTjO5+hAuPRNiuR70+5RlWSs+U9PVcVcW9Lw==} - - regex-utilities@2.3.0: - resolution: {integrity: sha512-8VhliFJAWRaUiVvREIiW2NXXTmHs4vMNnSzuJVhscgmGav3g9VDxLrQndI3dZZVVdp0ZO/5v0xmX516/7M9cng==} - - regex@5.0.2: - resolution: {integrity: sha512-/pczGbKIQgfTMRV0XjABvc5RzLqQmwqxLHdQao2RTXPk+pmTXB2P0IaUHYdYyk412YLwUIkaeMd5T+RzVgTqnQ==} - rehype-class-names@2.0.0: resolution: {integrity: sha512-jldCIiAEvXKdq8hqr5f5PzNdIDkvHC6zfKhwta9oRoMu7bn0W7qLES/JrrjBvr9rKz3nJ8x4vY1EWI+dhjHVZQ==} @@ -5630,9 +5522,6 @@ packages: shiki@0.14.7: resolution: {integrity: sha512-dNPAPrxSc87ua2sKJ3H5dQ/6ZaY8RNnaAqK+t0eG7p0Soi2ydiqbGOTaZCqaYvA/uZYfS1LJnemt3Q+mSfcPCg==} - shiki@1.24.4: - resolution: {integrity: sha512-aVGSFAOAr1v26Hh/+GBIsRVDWJ583XYV7CuNURKRWh9gpGv4OdbisZGq96B9arMYTZhTQkmRF5BrShOSTvNqhw==} - siginfo@2.0.0: resolution: {integrity: sha512-ybx0WO1/8bSBLEWXZvEd7gMW3Sn3JFlW3TvX1nREbDLRNQNaeNN8WK0meBwPdAaOI7TtRRRJn/Es1zhrrCHu7g==} @@ -6050,12 +5939,6 @@ packages: peerDependencies: typedoc: '>=0.24.0' - typedoc-plugin-markdown@4.2.10: - resolution: {integrity: sha512-PLX3pc1/7z13UJm4TDE9vo9jWGcClFUErXXtd5LdnoLjV6mynPpqZLU992DwMGFSRqJFZeKbVyqlNNeNHnk2tQ==} - engines: {node: '>= 18'} - peerDependencies: - typedoc: 0.26.x - typedoc@0.24.8: resolution: {integrity: sha512-ahJ6Cpcvxwaxfu4KtjA8qZNqS43wYt6JL27wYiIgl1vd38WW/KWX11YuAeZhuz9v+ttrutSsgK+XO1CjL1kA3w==} engines: {node: '>= 14.14'} @@ -6063,13 +5946,6 @@ packages: peerDependencies: typescript: 4.6.x || 4.7.x || 4.8.x || 4.9.x || 5.0.x || 5.1.x - typedoc@0.26.11: - resolution: {integrity: sha512-sFEgRRtrcDl2FxVP58Ze++ZK2UQAEvtvvH8rRlig1Ja3o7dDaMHmaBfvJmdGnNEFaLTpQsN8dpvZaTqJSu/Ugw==} - engines: {node: '>= 18'} - hasBin: true - peerDependencies: - typescript: 4.6.x || 4.7.x || 4.8.x || 4.9.x || 5.0.x || 5.1.x || 5.2.x || 5.3.x || 5.4.x || 5.5.x || 5.6.x - typescript@5.6.3: resolution: {integrity: sha512-hjcS1mhfuyi4WW8IWtjP7brDrG2cuDZukyrYrSauoXGNgx0S7zceP07adYkJycEr56BOUTNPzbInooiN3fn1qw==} engines: {node: '>=14.17'} @@ -6080,9 +5956,6 @@ packages: engines: {node: '>=14.17'} hasBin: true - uc.micro@2.1.0: - resolution: {integrity: sha512-ARDJmphmdvUk6Glw7y9DQ2bFkKBHwQHLi2lsaH6PPmz/Ka9sFOBsBluozhDltWmnv9u/cF6Rt87znRTPV+yp/A==} - ufo@1.5.4: resolution: {integrity: sha512-UsUk3byDzKd04EyoZ7U4DOlxQaD14JUKQl6/P7wiX4FNvUfm3XL246n9W5AmqwW5RSFJ27NAuM0iLscAOYUiGQ==} @@ -8879,33 +8752,6 @@ snapshots: domhandler: 5.0.3 selderee: 0.11.0 - '@shikijs/core@1.24.4': - dependencies: - '@shikijs/engine-javascript': 1.24.4 - '@shikijs/engine-oniguruma': 1.24.4 - '@shikijs/types': 1.24.4 - '@shikijs/vscode-textmate': 9.3.1 - '@types/hast': 3.0.4 - hast-util-to-html: 9.0.4 - - '@shikijs/engine-javascript@1.24.4': - dependencies: - '@shikijs/types': 1.24.4 - '@shikijs/vscode-textmate': 9.3.1 - oniguruma-to-es: 0.8.1 - - '@shikijs/engine-oniguruma@1.24.4': - dependencies: - '@shikijs/types': 1.24.4 - '@shikijs/vscode-textmate': 9.3.1 - - '@shikijs/types@1.24.4': - dependencies: - '@shikijs/vscode-textmate': 9.3.1 - '@types/hast': 3.0.4 - - '@shikijs/vscode-textmate@9.3.1': {} - '@sindresorhus/merge-streams@2.3.0': {} '@swc/core-darwin-arm64@1.7.36': @@ -9936,8 +9782,6 @@ snapshots: electron-to-chromium@1.5.76: {} - emoji-regex-xs@1.0.0: {} - emoji-regex@10.4.0: {} emoji-regex@8.0.0: {} @@ -10468,20 +10312,6 @@ snapshots: transitivePeerDependencies: - supports-color - hast-util-to-html@9.0.4: - dependencies: - '@types/hast': 3.0.4 - '@types/unist': 3.0.3 - ccount: 2.0.1 - comma-separated-tokens: 2.0.3 - hast-util-whitespace: 3.0.0 - html-void-elements: 3.0.0 - mdast-util-to-hast: 13.2.0 - property-information: 6.5.0 - space-separated-tokens: 2.0.2 - stringify-entities: 4.0.4 - zwitch: 2.0.4 - hast-util-to-jsx-runtime@2.3.2: dependencies: '@types/estree': 1.0.6 @@ -10922,10 +10752,6 @@ snapshots: lines-and-columns@1.2.4: {} - linkify-it@5.0.0: - dependencies: - uc.micro: 2.1.0 - load-tsconfig@0.2.5: {} loader-runner@4.3.0: {} @@ -11005,15 +10831,6 @@ snapshots: markdown-extensions@2.0.0: {} - markdown-it@14.1.0: - dependencies: - argparse: 2.0.1 - entities: 4.5.0 - linkify-it: 5.0.0 - mdurl: 2.0.0 - punycode.js: 2.3.1 - uc.micro: 2.1.0 - markdown-table@3.0.4: {} marked@4.3.0: {} @@ -11333,8 +11150,6 @@ snapshots: dependencies: '@types/mdast': 4.0.4 - mdurl@2.0.0: {} - media-query-parser@2.0.2: dependencies: '@babel/runtime': 7.26.0 @@ -12052,12 +11867,6 @@ snapshots: dependencies: mimic-fn: 2.1.0 - oniguruma-to-es@0.8.1: - dependencies: - emoji-regex-xs: 1.0.0 - regex: 5.0.2 - regex-recursion: 5.0.0 - only@0.0.2: {} open@10.1.0: @@ -12278,8 +12087,6 @@ snapshots: dependencies: punycode: 2.3.1 - punycode.js@2.3.1: {} - punycode@2.3.1: {} pure-rand@6.1.0: {} @@ -12573,16 +12380,6 @@ snapshots: regenerator-runtime@0.14.1: {} - regex-recursion@5.0.0: - dependencies: - regex-utilities: 2.3.0 - - regex-utilities@2.3.0: {} - - regex@5.0.2: - dependencies: - regex-utilities: 2.3.0 - rehype-class-names@2.0.0: dependencies: '@types/hast': 3.0.4 @@ -12968,15 +12765,6 @@ snapshots: vscode-oniguruma: 1.7.0 vscode-textmate: 8.0.0 - shiki@1.24.4: - dependencies: - '@shikijs/core': 1.24.4 - '@shikijs/engine-javascript': 1.24.4 - '@shikijs/engine-oniguruma': 1.24.4 - '@shikijs/types': 1.24.4 - '@shikijs/vscode-textmate': 9.3.1 - '@types/hast': 3.0.4 - siginfo@2.0.0: {} signal-exit@3.0.7: {} @@ -13396,10 +13184,6 @@ snapshots: handlebars: 4.7.8 typedoc: 0.24.8(typescript@5.7.2) - typedoc-plugin-markdown@4.2.10(typedoc@0.26.11(typescript@5.6.3)): - dependencies: - typedoc: 0.26.11(typescript@5.6.3) - typedoc@0.24.8(typescript@5.7.2): dependencies: lunr: 2.3.9 @@ -13408,21 +13192,10 @@ snapshots: shiki: 0.14.7 typescript: 5.7.2 - typedoc@0.26.11(typescript@5.6.3): - dependencies: - lunr: 2.3.9 - markdown-it: 14.1.0 - minimatch: 9.0.5 - shiki: 1.24.4 - typescript: 5.6.3 - yaml: 2.6.1 - typescript@5.6.3: {} typescript@5.7.2: {} - uc.micro@2.1.0: {} - ufo@1.5.4: {} uglify-js@3.19.3: @@ -13849,7 +13622,8 @@ snapshots: yallist@3.1.1: {} - yaml@2.6.1: {} + yaml@2.6.1: + optional: true yargs-parser@21.1.1: {} diff --git a/turbo.json b/turbo.json index 588ca51e..2abcd2f4 100644 --- a/turbo.json +++ b/turbo.json @@ -19,10 +19,6 @@ "build": { "dependsOn": ["index", "^build"], "outputs": ["dist"] - }, - "docs": { - "dependsOn": ["index", "^build"], - "outputs": ["documentation"] } } }