@resultsafe/core-fp-result 0.1.0

package/dist/docs/api/methods/unwrapErr.md

@@ -0,0 +1,62 @@
+> [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) / unwrapErr
+
+# Функция: unwrapErr()
+
+> **unwrapErr**\<`T`, `E`\>(`result`): `E`
+
+Возвращает значение ошибки или выбрасывает исключение, если результат `Ok`.
+
+## Параметры типа
+
+### T
+
+`T`
+
+Тип успешного значения.
+
+### E
+
+`E`
+
+Тип значения ошибки.
+
+## Параметры
+
+### result
+
+`Result`\<`T`, `E`\>
+
+Исходный `Result`.
+
+## Возвращает
+
+`E`
+
+Payload ошибки.
+
+## Исключения
+
+Error - Выбрасывает исключение при вызове на `Ok`.
+
+## Начиная с версии
+
+0.1.0
+
+## См. также
+
+[unwrapOrElse](./unwrapOrElse.md) - Возвращает fallback успеха без выброса исключения.
+
+## Пример
+
+```ts
+import { Err, unwrapErr } from '@resultsafe/core-fp-result';
+
+const error = unwrapErr(Err('boom'));
+console.log(error); // boom
+```

package/dist/docs/api/methods/unwrapOr.md

@@ -0,0 +1,64 @@
+> [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) / unwrapOr
+
+# Функция: unwrapOr()
+
+> **unwrapOr**\<`T`, `E`\>(`result`, `defaultValue`): `T`
+
+Возвращает успешное значение или переданный fallback по умолчанию.
+
+## Параметры типа
+
+### T
+
+`T`
+
+Тип успешного значения.
+
+### E
+
+`E`
+
+Тип значения ошибки.
+
+## Параметры
+
+### result
+
+`Result`\<`T`, `E`\>
+
+Исходный `Result`.
+
+### defaultValue
+
+`T`
+
+Fallback-значение для `Err`.
+
+## Возвращает
+
+`T`
+
+Payload успеха или `defaultValue`.
+
+## Начиная с версии
+
+0.1.0
+
+## См. также
+
+[unwrapOrElse](./unwrapOrElse.md) - Вычисляет fallback лениво.
+
+## Пример
+
+```ts
+import { Err, unwrapOr } from '@resultsafe/core-fp-result';
+
+const value = unwrapOr(Err('boom'), 0);
+console.log(value); // 0
+```

package/dist/docs/api/methods/unwrapOrElse.md

@@ -0,0 +1,64 @@
+> [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) / unwrapOrElse
+
+# Функция: unwrapOrElse()
+
+> **unwrapOrElse**\<`T`, `E`\>(`result`, `fn`): `T`
+
+Возвращает успешное значение или вычисляет fallback из ошибки.
+
+## Параметры типа
+
+### T
+
+`T`
+
+Тип успешного значения.
+
+### E
+
+`E`
+
+Тип значения ошибки.
+
+## Параметры
+
+### result
+
+`Result`\<`T`, `E`\>
+
+Исходный `Result`.
+
+### fn
+
+(`error`) => `T`
+
+Функция-поставщик fallback для `Err`.
+
+## Возвращает
+
+`T`
+
+Payload успеха или вычисленный fallback.
+
+## Начиная с версии
+
+0.1.0
+
+## См. также
+
+[unwrapOr](./unwrapOr.md) - Использует eager fallback-значение.
+
+## Пример
+
+```ts
+import { Err, unwrapOrElse } from '@resultsafe/core-fp-result';
+
+const value = unwrapOrElse(Err('fatal'), (error) => error.length);
+console.log(value); // 5
+```

package/dist/docs/api/modules.md

@@ -0,0 +1,10 @@
+# Modules
+
+> [Back to package README](../../README.md) | [Back to API index](./index.md)
+
+Module entry points:
+- [Конструкторы](./constructors/index.md)
+- [Гарды](./guards/index.md)
+- [Методы](./methods/index.md)
+- [Рефайнеры](./refiners/index.md)
+- [Type Aliases](./type-aliases/index.md)

package/dist/docs/api/refiners/index.md

@@ -0,0 +1,14 @@
+# Рефайнеры
+
+> [Back to package README](../../../README.md) | [Back to API index](../index.md)
+
+Символы модуля:
+- [isTypedVariant](./isTypedVariant.md)
+- [isTypedVariantOf](./isTypedVariantOf.md)
+- [matchVariant](./matchVariant.md)
+- [matchVariantStrict](./matchVariantStrict.md)
+- [refineAsyncResult](./refineAsyncResult.md)
+- [refineAsyncResultU](./refineAsyncResultU.md)
+- [refineResult](./refineResult.md)
+- [refineResultU](./refineResultU.md)
+- [refineVariantMap](./refineVariantMap.md)

package/dist/docs/api/refiners/isTypedVariant.md

@@ -0,0 +1,62 @@
+> [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) / isTypedVariant
+
+# Функция: isTypedVariant()
+
+> **isTypedVariant**\<`K`\>(`variant`): (`value`) => `value is { type: K }`
+
+Создает runtime type guard для варианта дискриминированного объединения.
+
+## Параметры типа
+
+### K
+
+`K` *extends* `string`
+
+The discriminant literal type.
+
+## Параметры
+
+### variant
+
+`K`
+
+Значение дискриминанта для сопоставления.
+
+## Возвращает
+
+A predicate that checks `{ type: K }` shape.
+
+> (`value`): `value is { type: K }`
+
+### Параметры
+
+#### value
+
+`unknown`
+
+### Возвращает
+
+`value is { type: K }`
+
+## Начиная с версии
+
+0.1.0
+
+## См. также
+
+[isTypedVariantOf](./isTypedVariantOf.md) - Расширяет проверку ключами payload.
+
+## Пример
+
+```ts
+import { isTypedVariant } from '@resultsafe/core-fp-result';
+
+const isCreated = isTypedVariant('created');
+console.log(isCreated({ type: 'created' })); // true
+```

package/dist/docs/api/refiners/isTypedVariantOf.md

@@ -0,0 +1,68 @@
+> [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) / isTypedVariantOf
+
+# Функция: isTypedVariantOf()
+
+> **isTypedVariantOf**\<`K`, `T`\>(`variant`): (`value`) => `value is { type: K } & T`
+
+Создает runtime type guard для варианта с дополнительными ключами payload.
+
+## Параметры типа
+
+### K
+
+`K` *extends* `string`
+
+The discriminant literal type.
+
+### T
+
+`T` *extends* `Record`\<`string`, `unknown`\>
+
+The required payload record shape.
+
+## Параметры
+
+### variant
+
+`K`
+
+Значение дискриминанта для сопоставления.
+
+## Возвращает
+
+A predicate that checks variant and payload key presence.
+
+> (`value`): `value is { type: K } & T`
+
+### Параметры
+
+#### value
+
+`unknown`
+
+### Возвращает
+
+`value is { type: K } & T`
+
+## Начиная с версии
+
+0.1.0
+
+## См. также
+
+[isTypedVariant](./isTypedVariant.md) - Проверяет только дискриминант.
+
+## Пример
+
+```ts
+import { isTypedVariantOf } from '@resultsafe/core-fp-result';
+
+const isCreated = isTypedVariantOf<'created', { id: unknown }>('created');
+console.log(isCreated({ type: 'created', id: 1 })); // true
+```

package/dist/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/dist/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/dist/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/dist/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
+```