Skip to content

Commit

Permalink
Update doc
Browse files Browse the repository at this point in the history
  • Loading branch information
@davidbonnet
davidbonnet committed Dec 7, 2023
1 parent 7809fdd commit de35f87
Show file tree
Hide file tree
Showing 3 changed files with 46 additions and 46 deletions.
78 changes: 39 additions & 39 deletions doc/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ realue

#### Defined in

[types.ts:5](https://github.com/nevoland/realue/blob/2038dc9/lib/types.ts#L5)
[types.ts:5](https://github.com/nevoland/realue/blob/7809fdd/lib/types.ts#L5)

___

Expand Down Expand Up @@ -95,7 +95,7 @@ Function that mutates an `error`. Used as the signature for the `onChangeError`

#### Defined in

[types.ts:46](https://github.com/nevoland/realue/blob/2038dc9/lib/types.ts#L46)
[types.ts:46](https://github.com/nevoland/realue/blob/7809fdd/lib/types.ts#L46)

___

Expand All @@ -112,7 +112,7 @@ ___

#### Defined in

[types.ts:152](https://github.com/nevoland/realue/blob/2038dc9/lib/types.ts#L152)
[types.ts:152](https://github.com/nevoland/realue/blob/7809fdd/lib/types.ts#L152)

___

Expand All @@ -128,7 +128,7 @@ ___

#### Defined in

[types.ts:158](https://github.com/nevoland/realue/blob/2038dc9/lib/types.ts#L158)
[types.ts:158](https://github.com/nevoland/realue/blob/7809fdd/lib/types.ts#L158)

___

Expand All @@ -144,7 +144,7 @@ ___

#### Defined in

[types.ts:164](https://github.com/nevoland/realue/blob/2038dc9/lib/types.ts#L164)
[types.ts:164](https://github.com/nevoland/realue/blob/7809fdd/lib/types.ts#L164)

___

Expand Down Expand Up @@ -175,7 +175,7 @@ ___

#### Defined in

[types.ts:51](https://github.com/nevoland/realue/blob/2038dc9/lib/types.ts#L51)
[types.ts:51](https://github.com/nevoland/realue/blob/7809fdd/lib/types.ts#L51)

___

Expand All @@ -193,7 +193,7 @@ ___

#### Defined in

[types.ts:198](https://github.com/nevoland/realue/blob/2038dc9/lib/types.ts#L198)
[types.ts:198](https://github.com/nevoland/realue/blob/7809fdd/lib/types.ts#L198)

___

Expand All @@ -203,7 +203,7 @@ ___

#### Defined in

[types.ts:16](https://github.com/nevoland/realue/blob/2038dc9/lib/types.ts#L16)
[types.ts:16](https://github.com/nevoland/realue/blob/7809fdd/lib/types.ts#L16)

___

Expand All @@ -213,7 +213,7 @@ ___

#### Defined in

[types.ts:20](https://github.com/nevoland/realue/blob/2038dc9/lib/types.ts#L20)
[types.ts:20](https://github.com/nevoland/realue/blob/7809fdd/lib/types.ts#L20)

___

Expand All @@ -223,7 +223,7 @@ ___

#### Defined in

[types.ts:18](https://github.com/nevoland/realue/blob/2038dc9/lib/types.ts#L18)
[types.ts:18](https://github.com/nevoland/realue/blob/7809fdd/lib/types.ts#L18)

___

Expand All @@ -245,7 +245,7 @@ Excludes the props following the NEVO pattern. Useful for creating discriminated

#### Defined in

[types.ts:87](https://github.com/nevoland/realue/blob/2038dc9/lib/types.ts#L87)
[types.ts:87](https://github.com/nevoland/realue/blob/7809fdd/lib/types.ts#L87)

___

Expand Down Expand Up @@ -280,7 +280,7 @@ Set of properties that define the NEVO pattern:

#### Defined in

[types.ts:61](https://github.com/nevoland/realue/blob/2038dc9/lib/types.ts#L61)
[types.ts:61](https://github.com/nevoland/realue/blob/7809fdd/lib/types.ts#L61)

___

Expand All @@ -299,7 +299,7 @@ ___

#### Defined in

[types.ts:95](https://github.com/nevoland/realue/blob/2038dc9/lib/types.ts#L95)
[types.ts:95](https://github.com/nevoland/realue/blob/7809fdd/lib/types.ts#L95)

___

Expand All @@ -326,7 +326,7 @@ ___

#### Defined in

[types.ts:190](https://github.com/nevoland/realue/blob/2038dc9/lib/types.ts#L190)
[types.ts:190](https://github.com/nevoland/realue/blob/7809fdd/lib/types.ts#L190)

___

Expand All @@ -344,7 +344,7 @@ ___

#### Defined in

[types.ts:146](https://github.com/nevoland/realue/blob/2038dc9/lib/types.ts#L146)
[types.ts:146](https://github.com/nevoland/realue/blob/7809fdd/lib/types.ts#L146)

___

Expand All @@ -363,7 +363,7 @@ Options for `useTransform`.

#### Defined in

[types.ts:109](https://github.com/nevoland/realue/blob/2038dc9/lib/types.ts#L109)
[types.ts:109](https://github.com/nevoland/realue/blob/7809fdd/lib/types.ts#L109)

___

Expand Down Expand Up @@ -397,7 +397,7 @@ Function that changes a `value`. Used as the signature for the `onChange` callba

#### Defined in

[types.ts:33](https://github.com/nevoland/realue/blob/2038dc9/lib/types.ts#L33)
[types.ts:33](https://github.com/nevoland/realue/blob/7809fdd/lib/types.ts#L33)

___

Expand All @@ -423,7 +423,7 @@ Function that removes an array item at index `name`.

#### Defined in

[types.ts:41](https://github.com/nevoland/realue/blob/2038dc9/lib/types.ts#L41)
[types.ts:41](https://github.com/nevoland/realue/blob/7809fdd/lib/types.ts#L41)

___

Expand Down Expand Up @@ -457,7 +457,7 @@ Function that valides a `value` with a given `name` and returns a promise that r

#### Defined in

[types.ts:25](https://github.com/nevoland/realue/blob/2038dc9/lib/types.ts#L25)
[types.ts:25](https://github.com/nevoland/realue/blob/7809fdd/lib/types.ts#L25)

## Functions

Expand Down Expand Up @@ -493,7 +493,7 @@ Adapts the provided `props` to the specified `propertyName`.

#### Defined in

[tools/adapt.ts:17](https://github.com/nevoland/realue/blob/2038dc9/lib/tools/adapt.ts#L17)
[tools/adapt.ts:17](https://github.com/nevoland/realue/blob/7809fdd/lib/tools/adapt.ts#L17)

___

Expand All @@ -519,7 +519,7 @@ ___

#### Defined in

[tools/capitalize.ts:1](https://github.com/nevoland/realue/blob/2038dc9/lib/tools/capitalize.ts#L1)
[tools/capitalize.ts:1](https://github.com/nevoland/realue/blob/7809fdd/lib/tools/capitalize.ts#L1)

___

Expand All @@ -543,7 +543,7 @@ The props necessary to disable changes or not.

#### Defined in

[tools/disable.ts:7](https://github.com/nevoland/realue/blob/2038dc9/lib/tools/disable.ts#L7)
[tools/disable.ts:7](https://github.com/nevoland/realue/blob/7809fdd/lib/tools/disable.ts#L7)

___

Expand Down Expand Up @@ -574,7 +574,7 @@ A unique identifier string for this item.

#### Defined in

[tools/itemIdDefault.ts:8](https://github.com/nevoland/realue/blob/2038dc9/lib/tools/itemIdDefault.ts#L8)
[tools/itemIdDefault.ts:8](https://github.com/nevoland/realue/blob/7809fdd/lib/tools/itemIdDefault.ts#L8)

___

Expand Down Expand Up @@ -610,7 +610,7 @@ Normalizes the provided `props` from the provided `propertyName`.

#### Defined in

[tools/normalize.ts:17](https://github.com/nevoland/realue/blob/2038dc9/lib/tools/normalize.ts#L17)
[tools/normalize.ts:17](https://github.com/nevoland/realue/blob/7809fdd/lib/tools/normalize.ts#L17)

___

Expand Down Expand Up @@ -645,7 +645,7 @@ The `item` function that returns the props for a specific item `index`.

#### Defined in

[hooks/useArray.ts:33](https://github.com/nevoland/realue/blob/2038dc9/lib/hooks/useArray.ts#L33)
[hooks/useArray.ts:33](https://github.com/nevoland/realue/blob/7809fdd/lib/hooks/useArray.ts#L33)

___

Expand All @@ -672,7 +672,7 @@ ___

#### Defined in

[hooks/useChange.ts:4](https://github.com/nevoland/realue/blob/2038dc9/lib/hooks/useChange.ts#L4)
[hooks/useChange.ts:4](https://github.com/nevoland/realue/blob/7809fdd/lib/hooks/useChange.ts#L4)

___

Expand Down Expand Up @@ -709,7 +709,7 @@ ___

#### Defined in

[hooks/useDebounce.ts:4](https://github.com/nevoland/realue/blob/2038dc9/lib/hooks/useDebounce.ts#L4)
[hooks/useDebounce.ts:4](https://github.com/nevoland/realue/blob/7809fdd/lib/hooks/useDebounce.ts#L4)

___

Expand Down Expand Up @@ -737,7 +737,7 @@ ___

#### Defined in

[hooks/useInput.ts:4](https://github.com/nevoland/realue/blob/2038dc9/lib/hooks/useInput.ts#L4)
[hooks/useInput.ts:4](https://github.com/nevoland/realue/blob/7809fdd/lib/hooks/useInput.ts#L4)

___

Expand All @@ -758,7 +758,7 @@ ___

#### Defined in

[hooks/useLog.ts:6](https://github.com/nevoland/realue/blob/2038dc9/lib/hooks/useLog.ts#L6)
[hooks/useLog.ts:6](https://github.com/nevoland/realue/blob/7809fdd/lib/hooks/useLog.ts#L6)

___

Expand Down Expand Up @@ -790,7 +790,7 @@ The `property` function that returns the props for a specific property `name`.

#### Defined in

[hooks/useObject.ts:19](https://github.com/nevoland/realue/blob/2038dc9/lib/hooks/useObject.ts#L19)
[hooks/useObject.ts:19](https://github.com/nevoland/realue/blob/7809fdd/lib/hooks/useObject.ts#L19)

___

Expand Down Expand Up @@ -818,7 +818,7 @@ ___

#### Defined in

[hooks/useOption.ts:4](https://github.com/nevoland/realue/blob/2038dc9/lib/hooks/useOption.ts#L4)
[hooks/useOption.ts:4](https://github.com/nevoland/realue/blob/7809fdd/lib/hooks/useOption.ts#L4)

___

Expand Down Expand Up @@ -849,7 +849,7 @@ A promise state object

#### Defined in

[hooks/usePromise.ts:25](https://github.com/nevoland/realue/blob/2038dc9/lib/hooks/usePromise.ts#L25)
[hooks/usePromise.ts:25](https://github.com/nevoland/realue/blob/7809fdd/lib/hooks/usePromise.ts#L25)

___

Expand All @@ -871,7 +871,7 @@ ___

#### Defined in

[hooks/useRemove.ts:4](https://github.com/nevoland/realue/blob/2038dc9/lib/hooks/useRemove.ts#L4)
[hooks/useRemove.ts:4](https://github.com/nevoland/realue/blob/7809fdd/lib/hooks/useRemove.ts#L4)

___

Expand Down Expand Up @@ -903,7 +903,7 @@ The last non-undefined version of the provided `value`, or `undefined`.

#### Defined in

[hooks/useResilient.ts:11](https://github.com/nevoland/realue/blob/2038dc9/lib/hooks/useResilient.ts#L11)
[hooks/useResilient.ts:11](https://github.com/nevoland/realue/blob/7809fdd/lib/hooks/useResilient.ts#L11)

___

Expand All @@ -929,7 +929,7 @@ ___

#### Defined in

[hooks/useSyncedSignal.ts:3](https://github.com/nevoland/realue/blob/2038dc9/lib/hooks/useSyncedSignal.ts#L3)
[hooks/useSyncedSignal.ts:3](https://github.com/nevoland/realue/blob/7809fdd/lib/hooks/useSyncedSignal.ts#L3)

___

Expand Down Expand Up @@ -961,15 +961,15 @@ The `[state, onChangeState]` tuple.

#### Defined in

[hooks/useSyncedState.ts:12](https://github.com/nevoland/realue/blob/2038dc9/lib/hooks/useSyncedState.ts#L12)
[hooks/useSyncedState.ts:12](https://github.com/nevoland/realue/blob/7809fdd/lib/hooks/useSyncedState.ts#L12)

___

### useTransform

▸ **useTransform**<`T`, `U`\>(`props`, `options`): [`NevoProps`](README.md#nevoprops)<`U`\>

Transforms the incoming `value` and the outgoing `value` passed to the `onChange` callback, and optionally the incoming `error` and the outgoing `error` passed to the `onChangeError` callback.
Transforms the incoming `value` and the outgoing `value` passed to the `onChange` callback, and optionally the incoming `error` and the outgoing `error` passed to the `onChangeError` callback. If the incoming and outgoing `error` transforms are not provided, returned props will not contain `error` nor `onChangeError`.

#### Type parameters

Expand All @@ -993,7 +993,7 @@ Updated props.

#### Defined in

[hooks/useTransform.ts:17](https://github.com/nevoland/realue/blob/2038dc9/lib/hooks/useTransform.ts#L17)
[hooks/useTransform.ts:17](https://github.com/nevoland/realue/blob/7809fdd/lib/hooks/useTransform.ts#L17)

___

Expand Down Expand Up @@ -1021,4 +1021,4 @@ ___

#### Defined in

[hooks/useValidator.ts:6](https://github.com/nevoland/realue/blob/2038dc9/lib/hooks/useValidator.ts#L6)
[hooks/useValidator.ts:6](https://github.com/nevoland/realue/blob/7809fdd/lib/hooks/useValidator.ts#L6)
10 changes: 5 additions & 5 deletions doc/interfaces/ItemCallable.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ The index of the item for which to generate the props.

#### Defined in

[types.ts:214](https://github.com/nevoland/realue/blob/2038dc9/lib/types.ts#L214)
[types.ts:214](https://github.com/nevoland/realue/blob/7809fdd/lib/types.ts#L214)

### ItemCallable

Expand All @@ -46,7 +46,7 @@ The index of the item for which to generate the props.

#### Defined in

[types.ts:215](https://github.com/nevoland/realue/blob/2038dc9/lib/types.ts#L215)
[types.ts:215](https://github.com/nevoland/realue/blob/7809fdd/lib/types.ts#L215)

## Table of contents

Expand Down Expand Up @@ -81,7 +81,7 @@ Inserts an item at the specified index, shifting by one the previous item found

#### Defined in

[types.ts:233](https://github.com/nevoland/realue/blob/2038dc9/lib/types.ts#L233)
[types.ts:233](https://github.com/nevoland/realue/blob/7809fdd/lib/types.ts#L233)

___

Expand Down Expand Up @@ -110,7 +110,7 @@ An array containing the produced elements out of `Component`.

#### Defined in

[types.ts:223](https://github.com/nevoland/realue/blob/2038dc9/lib/types.ts#L223)
[types.ts:223](https://github.com/nevoland/realue/blob/7809fdd/lib/types.ts#L223)

___

Expand All @@ -136,4 +136,4 @@ Removes the item found at the specified `index`.

#### Defined in

[types.ts:239](https://github.com/nevoland/realue/blob/2038dc9/lib/types.ts#L239)
[types.ts:239](https://github.com/nevoland/realue/blob/7809fdd/lib/types.ts#L239)
Loading

0 comments on commit de35f87

Please sign in to comment.