@resultsafe/core-fp-result 0.1.0

package/docs/api/refiners/matchVariant.md

@@ -0,0 +1,59 @@
+> [Back to package README](../../../README.md) | [Back to API index](../index.md) | [Back to module](./index.md)
+
+[**@resultsafe/core-fp-result v0.1.0**](../README.md)
+
+***
+
+[@resultsafe/core-fp-result](../README.md) / matchVariant
+
+# Функция: matchVariant()
+
+> **matchVariant**\<`T`\>(`value`): [`Matcher`](../type-aliases/Matcher.md)\<`T`, `unknown`\>
+
+Создает цепочный matcher для значения дискриминированного объединения.
+
+## Параметры типа
+
+### T
+
+`T` *extends* [`VariantOf`](../type-aliases/VariantOf.md)
+
+Тип дискриминированного объединения.
+
+## Параметры
+
+### value
+
+`T`
+
+Значение объединения для сопоставления.
+
+## Возвращает
+
+[`Matcher`](../type-aliases/Matcher.md)\<`T`, `unknown`\>
+
+Fluent matcher с ветками `with` и `otherwise`.
+
+## Начиная с версии
+
+0.1.0
+
+## См. также
+
+[matchVariantStrict](./matchVariantStrict.md) - Требует исчерпывающего сопоставления во время выполнения.
+
+## Пример
+
+```ts
+import { matchVariant } from '@resultsafe/core-fp-result';
+
+const out = matchVariant<{ type: 'ok'; value: number } | { type: 'err'; error: string }>({
+  type: 'ok',
+  value: 1,
+})
+  .with('ok', (v) => `ok:${v.value}`)
+  .otherwise(() => 'fallback')
+  .run();
+
+console.log(out); // ok:1
+```

package/docs/api/refiners/matchVariantStrict.md

@@ -0,0 +1,63 @@
+> [Back to package README](../../../README.md) | [Back to API index](../index.md) | [Back to module](./index.md)
+
+[**@resultsafe/core-fp-result v0.1.0**](../README.md)
+
+***
+
+[@resultsafe/core-fp-result](../README.md) / matchVariantStrict
+
+# Функция: matchVariantStrict()
+
+> **matchVariantStrict**\<`T`\>(`value`): [`MatchBuilder`](../type-aliases/MatchBuilder.md)\<`T`, `unknown`\>
+
+Создает строгий matcher, выбрасывающий исключение для необработанных вариантов.
+
+## Параметры типа
+
+### T
+
+`T` *extends* [`VariantOf`](../type-aliases/VariantOf.md)
+
+Тип дискриминированного объединения.
+
+## Параметры
+
+### value
+
+`T`
+
+Значение объединения для сопоставления.
+
+## Возвращает
+
+[`MatchBuilder`](../type-aliases/MatchBuilder.md)\<`T`, `unknown`\>
+
+Строгий builder сопоставления, требующий явных обработчиков.
+
+## Исключения
+
+Error - Выбрасывает исключение, если ни один зарегистрированный обработчик не соответствует `value.type`.
+
+## Начиная с версии
+
+0.1.0
+
+## См. также
+
+[matchVariant](./matchVariant.md) - Использует fallback-ветку вместо выброса исключения.
+
+## Пример
+
+```ts
+import { matchVariantStrict } from '@resultsafe/core-fp-result';
+
+const out = matchVariantStrict<{ type: 'ok'; value: number } | { type: 'err'; error: string }>({
+  type: 'err',
+  error: 'boom',
+})
+  .with('ok', (v) => `ok:${v.value}`)
+  .with('err', (v) => `err:${v.error}`)
+  .run();
+
+console.log(out); // err:boom
+```

package/docs/api/refiners/refineAsyncResult.md

@@ -0,0 +1,98 @@
+> [Back to package README](../../../README.md) | [Back to API index](../index.md) | [Back to module](./index.md)
+
+[**@resultsafe/core-fp-result v0.1.0**](../README.md)
+
+***
+
+[@resultsafe/core-fp-result](../README.md) / refineAsyncResult
+
+# Функция: refineAsyncResult()
+
+> **refineAsyncResult**\<`TMap`\>(`variantMap`): \<`K`\>(`variant`) => \<`TValidators`\>(`validators`) => (`value`) => `Promise`\<`null` \| [`UniversalAsyncRefinedResult`](../type-aliases/UniversalAsyncRefinedResult.md)\<`K`, `TMap`, `TValidators`\>\>
+
+Создает асинхронный refiner варианта с асинхронными валидаторами payload.
+
+## Параметры типа
+
+### TMap
+
+`TMap` *extends* `Record`\<`string`, `VariantConfig`\>
+
+Тип карты конфигурации вариантов.
+
+## Параметры
+
+### variantMap
+
+`TMap`
+
+Карта, описывающая допустимые варианты и поля payload.
+
+## Возвращает
+
+A curried async refiner factory bound to `variantMap`.
+
+> \<`K`\>(`variant`): \<`TValidators`\>(`validators`) => (`value`) => `Promise`\<`null` \| [`UniversalAsyncRefinedResult`](../type-aliases/UniversalAsyncRefinedResult.md)\<`K`, `TMap`, `TValidators`\>\>
+
+### Параметры типа
+
+#### K
+
+`K` *extends* `string`
+
+### Параметры
+
+#### variant
+
+`K`
+
+### Возвращает
+
+> \<`TValidators`\>(`validators`): (`value`) => `Promise`\<`null` \| [`UniversalAsyncRefinedResult`](../type-aliases/UniversalAsyncRefinedResult.md)\<`K`, `TMap`, `TValidators`\>\>
+
+#### Параметры типа
+
+##### TValidators
+
+`TValidators` *extends* `Partial`\<`Record`\<`PayloadKeys`\<`TMap`\[`K`\]\>, `AsyncValidatorFn`\>\>
+
+#### Параметры
+
+##### validators
+
+`TValidators`
+
+#### Возвращает
+
+> (`value`): `Promise`\<`null` \| [`UniversalAsyncRefinedResult`](../type-aliases/UniversalAsyncRefinedResult.md)\<`K`, `TMap`, `TValidators`\>\>
+
+##### Параметры
+
+###### value
+
+`unknown`
+
+##### Возвращает
+
+`Promise`\<`null` \| [`UniversalAsyncRefinedResult`](../type-aliases/UniversalAsyncRefinedResult.md)\<`K`, `TMap`, `TValidators`\>\>
+
+## Начиная с версии
+
+0.1.0
+
+## См. также
+
+[refineAsyncResultU](./refineAsyncResultU.md) - Непосредственный (не-curry) вариант helper.
+
+## Пример
+
+```ts
+import { refineAsyncResult } from '@resultsafe/core-fp-result';
+
+const map = { ok: { payload: 'value' } } as const;
+const refineOk = refineAsyncResult(map)('ok')({
+  value: async (x: unknown) => typeof x === 'number',
+});
+
+console.log(await refineOk({ type: 'ok', value: 1 })); // { type: 'ok', value: 1 }
+```

package/docs/api/refiners/refineAsyncResultU.md

@@ -0,0 +1,86 @@
+> [Back to package README](../../../README.md) | [Back to API index](../index.md) | [Back to module](./index.md)
+
+[**@resultsafe/core-fp-result v0.1.0**](../README.md)
+
+***
+
+[@resultsafe/core-fp-result](../README.md) / refineAsyncResultU
+
+# Функция: refineAsyncResultU()
+
+> **refineAsyncResultU**\<`TMap`, `K`, `TValidators`\>(`value`, `variant`, `variantMap`, `validators`): `Promise`\<`null` \| [`UniversalAsyncRefinedResult`](../type-aliases/UniversalAsyncRefinedResult.md)\<`K`, `TMap`, `TValidators`\>\>
+
+Уточняет значение асинхронно в не-curry стиле вызова.
+
+## Параметры типа
+
+### TMap
+
+`TMap` *extends* `Record`\<`string`, `VariantConfig`\>
+
+Тип карты конфигурации вариантов.
+
+### K
+
+`K` *extends* `string`
+
+Ключ целевого варианта.
+
+### TValidators
+
+`TValidators` *extends* `Partial`\<`Record`\<`PayloadKeys`\<`TMap`\[`K`\]\>, `AsyncValidatorFn`\>\>
+
+Карта асинхронных валидаторов для полей payload.
+
+## Параметры
+
+### value
+
+`unknown`
+
+Значение для валидации и уточнения.
+
+### variant
+
+`K`
+
+Ключ целевого варианта.
+
+### variantMap
+
+`TMap`
+
+Карта конфигурации вариантов.
+
+### validators
+
+`TValidators`
+
+Асинхронные валидаторы payload.
+
+## Возвращает
+
+`Promise`\<`null` \| [`UniversalAsyncRefinedResult`](../type-aliases/UniversalAsyncRefinedResult.md)\<`K`, `TMap`, `TValidators`\>\>
+
+Промис с уточненным значением или `null`.
+
+## Начиная с версии
+
+0.1.0
+
+## См. также
+
+[refineAsyncResult](./refineAsyncResult.md) - Curry-конструктор асинхронного refiner.
+
+## Пример
+
+```ts
+import { refineAsyncResultU } from '@resultsafe/core-fp-result';
+
+const map = { ok: { payload: 'value' } } as const;
+const out = await refineAsyncResultU({ type: 'ok', value: 1 }, 'ok', map, {
+  value: async (x: unknown) => typeof x === 'number',
+});
+
+console.log(out?.type); // ok
+```

package/docs/api/refiners/refineResult.md

@@ -0,0 +1,98 @@
+> [Back to package README](../../../README.md) | [Back to API index](../index.md) | [Back to module](./index.md)
+
+[**@resultsafe/core-fp-result v0.1.0**](../README.md)
+
+***
+
+[@resultsafe/core-fp-result](../README.md) / refineResult
+
+# Функция: refineResult()
+
+> **refineResult**\<`TMap`\>(`variantMap`): \<`K`\>(`variant`) => \<`TValidators`\>(`validators`) => (`value`) => `null` \| [`UniversalRefinedResult`](../type-aliases/UniversalRefinedResult.md)\<`K`, `TMap`, `TValidators`\>
+
+Создает синхронный refiner варианта с валидаторами payload.
+
+## Параметры типа
+
+### TMap
+
+`TMap` *extends* `Record`\<`string`, `VariantConfig`\>
+
+Тип карты конфигурации вариантов.
+
+## Параметры
+
+### variantMap
+
+`TMap`
+
+Карта, описывающая допустимые варианты и поля payload.
+
+## Возвращает
+
+A curried refiner factory bound to `variantMap`.
+
+> \<`K`\>(`variant`): \<`TValidators`\>(`validators`) => (`value`) => `null` \| [`UniversalRefinedResult`](../type-aliases/UniversalRefinedResult.md)\<`K`, `TMap`, `TValidators`\>
+
+### Параметры типа
+
+#### K
+
+`K` *extends* `string`
+
+### Параметры
+
+#### variant
+
+`K`
+
+### Возвращает
+
+> \<`TValidators`\>(`validators`): (`value`) => `null` \| [`UniversalRefinedResult`](../type-aliases/UniversalRefinedResult.md)\<`K`, `TMap`, `TValidators`\>
+
+#### Параметры типа
+
+##### TValidators
+
+`TValidators` *extends* `Partial`\<`Record`\<`PayloadKeys`\<`TMap`\[`K`\]\>, `ValidatorFn`\>\>
+
+#### Параметры
+
+##### validators
+
+`TValidators`
+
+#### Возвращает
+
+> (`value`): `null` \| [`UniversalRefinedResult`](../type-aliases/UniversalRefinedResult.md)\<`K`, `TMap`, `TValidators`\>
+
+##### Параметры
+
+###### value
+
+`unknown`
+
+##### Возвращает
+
+`null` \| [`UniversalRefinedResult`](../type-aliases/UniversalRefinedResult.md)\<`K`, `TMap`, `TValidators`\>
+
+## Начиная с версии
+
+0.1.0
+
+## См. также
+
+[refineResultU](./refineResultU.md) - Непосредственный (не-curry) вариант helper.
+
+## Пример
+
+```ts
+import { refineResult } from '@resultsafe/core-fp-result';
+
+const map = { ok: { payload: 'value' } } as const;
+const refineOk = refineResult(map)('ok')({
+  value: (x: unknown): x is number => typeof x === 'number',
+});
+
+console.log(refineOk({ type: 'ok', value: 1 })); // { type: 'ok', value: 1 }
+```

package/docs/api/refiners/refineResultU.md

@@ -0,0 +1,86 @@
+> [Back to package README](../../../README.md) | [Back to API index](../index.md) | [Back to module](./index.md)
+
+[**@resultsafe/core-fp-result v0.1.0**](../README.md)
+
+***
+
+[@resultsafe/core-fp-result](../README.md) / refineResultU
+
+# Функция: refineResultU()
+
+> **refineResultU**\<`TMap`, `K`, `TValidators`\>(`value`, `variant`, `variantMap`, `validators`): `null` \| [`SyncRefinedResult`](../type-aliases/SyncRefinedResult.md)\<`K`, `TMap`, `TValidators`\>
+
+Уточняет значение по карте вариантов в не-curry стиле вызова.
+
+## Параметры типа
+
+### TMap
+
+`TMap` *extends* `Record`\<`string`, `VariantConfig`\>
+
+Тип карты конфигурации вариантов.
+
+### K
+
+`K` *extends* `string`
+
+Ключ целевого варианта.
+
+### TValidators
+
+`TValidators` *extends* `Partial`\<`Record`\<`PayloadKeys`\<`TMap`\[`K`\]\>, `ValidatorFn`\>\>
+
+Карта валидаторов для полей payload.
+
+## Параметры
+
+### value
+
+`unknown`
+
+Значение для валидации и уточнения.
+
+### variant
+
+`K`
+
+Ключ целевого варианта.
+
+### variantMap
+
+`TMap`
+
+Карта конфигурации вариантов.
+
+### validators
+
+`TValidators`
+
+Валидаторы payload для целевого варианта.
+
+## Возвращает
+
+`null` \| [`SyncRefinedResult`](../type-aliases/SyncRefinedResult.md)\<`K`, `TMap`, `TValidators`\>
+
+Уточненное значение или `null`.
+
+## Начиная с версии
+
+0.1.0
+
+## См. также
+
+[refineResult](./refineResult.md) - Curry-конструктор refiner.
+
+## Пример
+
+```ts
+import { refineResultU } from '@resultsafe/core-fp-result';
+
+const map = { ok: { payload: 'value' } } as const;
+const out = refineResultU({ type: 'ok', value: 1 }, 'ok', map, {
+  value: (x: unknown): x is number => typeof x === 'number',
+});
+
+console.log(out?.type); // ok
+```

package/docs/api/refiners/refineVariantMap.md

@@ -0,0 +1,79 @@
+> [Back to package README](../../../README.md) | [Back to API index](../index.md) | [Back to module](./index.md)
+
+[**@resultsafe/core-fp-result v0.1.0**](../README.md)
+
+***
+
+[@resultsafe/core-fp-result](../README.md) / refineVariantMap
+
+# Функция: refineVariantMap()
+
+> **refineVariantMap**\<`TMap`, `TValidators`\>(`value`, `variantMap`, `validators`): `null` \| [`SyncRefinedResultUnion`](../type-aliases/SyncRefinedResultUnion.md)\<`TMap`, `TValidators`\>
+
+Уточняет значение дискриминированного объединения по полной карте вариантов.
+
+## Параметры типа
+
+### TMap
+
+`TMap` *extends* `Record`\<`string`, `VariantConfig`\>
+
+Тип карты конфигурации вариантов.
+
+### TValidators
+
+`TValidators` *extends* [`SyncValidatorMap`](../type-aliases/SyncValidatorMap.md)\<`TMap`\>
+
+Тип карты валидаторов по вариантам.
+
+## Параметры
+
+### value
+
+`unknown`
+
+Значение для валидации и уточнения.
+
+### variantMap
+
+`TMap`
+
+Полная карта конфигурации вариантов.
+
+### validators
+
+`TValidators`
+
+Валидаторы, сгруппированные по ключу варианта.
+
+## Возвращает
+
+`null` \| [`SyncRefinedResultUnion`](../type-aliases/SyncRefinedResultUnion.md)\<`TMap`, `TValidators`\>
+
+Уточненный элемент объединения или `null`.
+
+## Начиная с версии
+
+0.1.0
+
+## См. также
+
+[refineResult](./refineResult.md) - Refines one concrete variant key.
+
+## Пример
+
+```ts
+import { refineVariantMap } from '@resultsafe/core-fp-result';
+
+const map = {
+  created: { payload: 'id' },
+  failed: { payload: 'reason' },
+} as const;
+
+const out = refineVariantMap({ type: 'created', id: '1' }, map, {
+  created: { id: (x: unknown): x is string => typeof x === 'string' },
+  failed: { reason: (x: unknown): x is string => typeof x === 'string' },
+});
+
+console.log(out?.type); // created
+```

package/docs/api/type-aliases/Handler.md

@@ -0,0 +1,49 @@
+[**@resultsafe/core-fp-result v0.1.0**](../README.md)
+
+***
+
+[@resultsafe/core-fp-result](../README.md) / Handler
+
+# Type Alias: Handler\<K, T, R\>
+
+> **Handler**\<`K`, `T`, `R`\> = `object`
+
+**`Internal`**
+
+Описывает запись обработчика варианта во внутренних механизмах matcher.
+
+## Type Parameters
+
+### K
+
+`K` *extends* `string`
+
+### T
+
+`T` *extends* [`VariantOf`](VariantOf.md)\<`K`\>
+
+### R
+
+`R`
+
+## Properties
+
+### variant
+
+> `readonly` **variant**: `K`
+
+***
+
+### fn()
+
+> `readonly` **fn**: (`value`) => `R`
+
+#### Parameters
+
+##### value
+
+`Extract`\<`T`, \{ `type`: `K`; \}\>
+
+#### Returns
+
+`R`

package/docs/api/type-aliases/MatchBuilder.md

@@ -0,0 +1,57 @@
+[**@resultsafe/core-fp-result v0.1.0**](../README.md)
+
+***
+
+[@resultsafe/core-fp-result](../README.md) / MatchBuilder
+
+# Type Alias: MatchBuilder\<T, R, Handled\>
+
+> **MatchBuilder**\<`T`, `R`, `Handled`\> = `object`
+
+Описывает форму строгого builder для matcher.
+
+## Type Parameters
+
+### T
+
+`T` *extends* [`VariantOf`](VariantOf.md)
+
+### R
+
+`R`
+
+### Handled
+
+`Handled` *extends* `T`\[`"type"`\] = `never`
+
+## Properties
+
+### with()
+
+> `readonly` **with**: \<`K`\>(`variant`, `fn`) => `MatchBuilder`\<`T`, `R`, `Handled` \| `K`\>
+
+#### Type Parameters
+
+##### K
+
+`K` *extends* `Exclude`\<`T`\[`"type"`\], `Handled`\>
+
+#### Parameters
+
+##### variant
+
+`K`
+
+##### fn
+
+(`value`) => `R`
+
+#### Returns
+
+`MatchBuilder`\<`T`, `R`, `Handled` \| `K`\>
+
+***
+
+### run
+
+> `readonly` **run**: `Handled` *extends* `T`\[`"type"`\] ? () => `R` : `never`