@resultsafe/core-fp-result 0.1.8 → 0.1.10

package/docs/api/README.md

@@ -1,9 +1,54 @@
-# API
+**@resultsafe/core-fp-result v0.1.9**
 
-> [Back to package README](../../README.md)
+***
 
-Содержание по модулям:
-- [Конструкторы](./constructors/index.md)
-- [Гарды](./guards/index.md)
-- [Методы](./methods/index.md)
-- [Рефайнеры](./refiners/index.md)
+# @resultsafe/core-fp-result v0.1.9
+
+## Type Aliases
+
+- [Handler](type-aliases/Handler.md)
+- [MatchBuilder](type-aliases/MatchBuilder.md)
+- [Matcher](type-aliases/Matcher.md)
+- [SyncRefinedResult](type-aliases/SyncRefinedResult.md)
+- [SyncRefinedResultUnion](type-aliases/SyncRefinedResultUnion.md)
+- [SyncValidatorMap](type-aliases/SyncValidatorMap.md)
+- [UniversalAsyncRefinedResult](type-aliases/UniversalAsyncRefinedResult.md)
+- [UniversalRefinedResult](type-aliases/UniversalRefinedResult.md)
+- [VariantOf](type-aliases/VariantOf.md)
+
+## Functions
+
+- [Err](functions/Err.md)
+- [Ok](functions/Ok.md)
+- [isErr](functions/isErr.md)
+- [isErrAnd](functions/isErrAnd.md)
+- [isOk](functions/isOk.md)
+- [isOkAnd](functions/isOkAnd.md)
+- [andThen](functions/andThen.md)
+- [err](functions/err-1.md)
+- [expect](functions/expect.md)
+- [expectErr](functions/expectErr.md)
+- [flatten](functions/flatten.md)
+- [inspect](functions/inspect.md)
+- [inspectErr](functions/inspectErr.md)
+- [map](functions/map.md)
+- [mapErr](functions/mapErr.md)
+- [match](functions/match.md)
+- [ok](functions/ok-1.md)
+- [orElse](functions/orElse.md)
+- [tap](functions/tap.md)
+- [tapErr](functions/tapErr.md)
+- [transpose](functions/transpose.md)
+- [unwrap](functions/unwrap.md)
+- [unwrapErr](functions/unwrapErr.md)
+- [unwrapOr](functions/unwrapOr.md)
+- [unwrapOrElse](functions/unwrapOrElse.md)
+- [isTypedVariant](functions/isTypedVariant.md)
+- [isTypedVariantOf](functions/isTypedVariantOf.md)
+- [matchVariant](functions/matchVariant.md)
+- [matchVariantStrict](functions/matchVariantStrict.md)
+- [refineAsyncResult](functions/refineAsyncResult.md)
+- [refineAsyncResultU](functions/refineAsyncResultU.md)
+- [refineResult](functions/refineResult.md)
+- [refineResultU](functions/refineResultU.md)
+- [refineVariantMap](functions/refineVariantMap.md)

package/docs/api/{constructors → functions}/Err.md

@@ -1,18 +1,16 @@
-> [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 v0.1.9**](../README.md)
 
 ***
 
 [@resultsafe/core-fp-result](../README.md) / Err
 
-# Функция: Err()
+# Function: Err()
 
 > **Err**\<`E`, `T`\>(`error`): `Result`\<`T`, `E`\>
 
 Создает ошибочное значение `Result` из переданного payload ошибки.
 
-## Параметры типа
+## Type Parameters
 
 ### E
 
@@ -26,7 +24,7 @@
 
 The success type for the resulting `Result`.
 
-## Параметры
+## Parameters
 
 ### error
 
@@ -34,21 +32,21 @@ The success type for the resulting `Result`.
 
 Payload ошибки для обёртки.
 
-## Возвращает
+## Returns
 
 `Result`\<`T`, `E`\>
 
 A `Result` with `ok: false` and the provided `error`.
 
-## Начиная с версии
+## Since
 
 0.1.0
 
-## См. также
+## See
 
-[Ok](./Ok.md) - Creates a successful `Result`.
+[Ok](Ok.md) - Creates a successful `Result`.
 
-## Пример
+## Example
 
 ```ts
 import { Err } from '@resultsafe/core-fp-result';

package/docs/api/{constructors → functions}/Ok.md

@@ -1,18 +1,16 @@
-> [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 v0.1.9**](../README.md)
 
 ***
 
 [@resultsafe/core-fp-result](../README.md) / Ok
 
-# Функция: Ok()
+# Function: Ok()
 
 > **Ok**\<`T`, `E`\>(`value`): `Result`\<`T`, `E`\>
 
 Создает успешное значение `Result` из переданного payload.
 
-## Параметры типа
+## Type Parameters
 
 ### T
 
@@ -26,7 +24,7 @@
 
 The error type for the resulting `Result`.
 
-## Параметры
+## Parameters
 
 ### value
 
@@ -34,21 +32,21 @@ The error type for the resulting `Result`.
 
 Payload успеха для обёртки.
 
-## Возвращает
+## Returns
 
 `Result`\<`T`, `E`\>
 
 A `Result` with `ok: true` and the provided `value`.
 
-## Начиная с версии
+## Since
 
 0.1.0
 
-## См. также
+## See
 
-[Err](./Err.md) - Creates an error `Result`.
+[Err](Err.md) - Creates an error `Result`.
 
-## Пример
+## Example
 
 ```ts
 import { Ok } from '@resultsafe/core-fp-result';

package/docs/api/{methods → functions}/andThen.md

@@ -1,18 +1,16 @@
-> [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 v0.1.9**](../README.md)
 
 ***
 
 [@resultsafe/core-fp-result](../README.md) / andThen
 
-# Функция: andThen()
+# Function: andThen()
 
 > **andThen**\<`T`, `U`, `E`\>(`result`, `fn`): `Result`\<`U`, `E`\>
 
 Цепляет вычисление, которое возвращает другой `Result`.
 
-## Параметры типа
+## Type Parameters
 
 ### T
 
@@ -32,7 +30,7 @@ The output success type.
 
 Общий тип ошибки.
 
-## Параметры
+## Parameters
 
 ### result
 
@@ -46,21 +44,21 @@ The output success type.
 
 Функция, применяемая, когда `result` имеет `Ok`.
 
-## Возвращает
+## Returns
 
 `Result`\<`U`, `E`\>
 
 Преобразованный `Result` или исходный `Err`.
 
-## Начиная с версии
+## Since
 
 0.1.0
 
-## См. также
+## See
 
-[map](./map.md) - Преобразует только успешное значение.
+[map](map.md) - Преобразует только успешное значение.
 
-## Пример
+## Example
 
 ```ts
 import { Ok, Err, andThen } from '@resultsafe/core-fp-result';

package/docs/api/{methods/err.md → functions/err-1.md}

@@ -1,18 +1,16 @@
-> [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 v0.1.9**](../README.md)
 
 ***
 
 [@resultsafe/core-fp-result](../README.md) / err
 
-# Функция: err()
+# Function: err()
 
 > **err**\<`T`, `E`\>(`result`): `Option`\<`E`\>
 
 Извлекает ветку ошибки в виде `Option`.
 
-## Параметры типа
+## Type Parameters
 
 ### T
 
@@ -26,7 +24,7 @@
 
 Тип значения ошибки.
 
-## Параметры
+## Parameters
 
 ### result
 
@@ -34,21 +32,21 @@
 
 Исходный `Result`.
 
-## Возвращает
+## Returns
 
 `Option`\<`E`\>
 
 `Some(error)` для `Err`, иначе `None`.
 
-## Начиная с версии
+## Since
 
 0.1.0
 
-## См. также
+## See
 
-[ok](./ok.md) - Извлекает ветку успеха.
+[ok](ok-1.md) - Извлекает ветку успеха.
 
-## Пример
+## Example
 
 ```ts
 import { Err, err } from '@resultsafe/core-fp-result';

package/docs/api/{methods → functions}/expect.md

@@ -1,18 +1,16 @@
-> [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 v0.1.9**](../README.md)
 
 ***
 
 [@resultsafe/core-fp-result](../README.md) / expect
 
-# Функция: expect()
+# Function: expect()
 
 > **expect**\<`T`, `E`\>(`result`, `msg`): `T`
 
 Возвращает успешное значение или выбрасывает исключение с пользовательским сообщением.
 
-## Параметры типа
+## Type Parameters
 
 ### T
 
@@ -26,7 +24,7 @@
 
 Тип значения ошибки.
 
-## Параметры
+## Parameters
 
 ### result
 
@@ -40,25 +38,25 @@
 
 Сообщение об ошибке, используемое когда `result` имеет `Err`.
 
-## Возвращает
+## Returns
 
 `T`
 
 Распакованное успешное значение.
 
-## Исключения
+## Throws
 
 Error - Выбрасывает исключение, когда `result` имеет `Err`.
 
-## Начиная с версии
+## Since
 
 0.1.0
 
-## См. также
+## See
 
-[expectErr](./expectErr.md) - Симметричный helper для ветки ошибки.
+[expectErr](expectErr.md) - Симметричный helper для ветки ошибки.
 
-## Пример
+## Example
 
 ```ts
 import { Ok, expect } from '@resultsafe/core-fp-result';

package/docs/api/{methods → functions}/expectErr.md

@@ -1,18 +1,16 @@
-> [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 v0.1.9**](../README.md)
 
 ***
 
 [@resultsafe/core-fp-result](../README.md) / expectErr
 
-# Функция: expectErr()
+# Function: expectErr()
 
 > **expectErr**\<`T`, `E`\>(`result`, `msg`): `E`
 
 Возвращает значение ошибки или выбрасывает исключение с пользовательским сообщением.
 
-## Параметры типа
+## Type Parameters
 
 ### T
 
@@ -26,7 +24,7 @@
 
 Тип значения ошибки.
 
-## Параметры
+## Parameters
 
 ### result
 
@@ -40,25 +38,25 @@
 
 Сообщение об ошибке, используемое когда `result` имеет `Ok`.
 
-## Возвращает
+## Returns
 
 `E`
 
 Распакованное значение ошибки.
 
-## Исключения
+## Throws
 
 Error - Выбрасывает исключение, когда `result` имеет `Ok`.
 
-## Начиная с версии
+## Since
 
 0.1.0
 
-## См. также
+## See
 
-[expect](./expect.md) - Симметричный helper для ветки успеха.
+[expect](expect.md) - Симметричный helper для ветки успеха.
 
-## Пример
+## Example
 
 ```ts
 import { Err, expectErr } from '@resultsafe/core-fp-result';

package/docs/api/{methods → functions}/flatten.md

@@ -1,18 +1,16 @@
-> [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 v0.1.9**](../README.md)
 
 ***
 
 [@resultsafe/core-fp-result](../README.md) / flatten
 
-# Функция: flatten()
+# Function: flatten()
 
 > **flatten**\<`T`, `E`\>(`result`): `Result`\<`T`, `E`\>
 
 Схлопывает вложенный `Result<Result<T, E>, E>` на один уровень.
 
-## Параметры типа
+## Type Parameters
 
 ### T
 
@@ -26,7 +24,7 @@ The inner success value type.
 
 The shared error value type.
 
-## Параметры
+## Parameters
 
 ### result
 
@@ -34,21 +32,21 @@ The shared error value type.
 
 Вложенный `Result` для схлопывания.
 
-## Возвращает
+## Returns
 
 `Result`\<`T`, `E`\>
 
 A single-layer `Result<T, E>`.
 
-## Начиная с версии
+## Since
 
 0.1.0
 
-## См. также
+## See
 
-[andThen](./andThen.md) - Chains computations that already return `Result`.
+[andThen](andThen.md) - Chains computations that already return `Result`.
 
-## Пример
+## Example
 
 ```ts
 import { Ok, flatten } from '@resultsafe/core-fp-result';

package/docs/api/{methods → functions}/inspect.md

@@ -1,18 +1,16 @@
-> [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 v0.1.9**](../README.md)
 
 ***
 
 [@resultsafe/core-fp-result](../README.md) / inspect
 
-# Функция: inspect()
+# Function: inspect()
 
 > **inspect**\<`T`, `E`\>(`result`, `fn`): `Result`\<`T`, `E`\>
 
 Выполняет побочный эффект для успешного значения и возвращает исходный `Result`.
 
-## Параметры типа
+## Type Parameters
 
 ### T
 
@@ -26,7 +24,7 @@
 
 Тип значения ошибки.
 
-## Параметры
+## Parameters
 
 ### result
 
@@ -40,21 +38,21 @@
 
 Функция побочного эффекта для ветки успеха.
 
-## Возвращает
+## Returns
 
 `Result`\<`T`, `E`\>
 
 Тот же экземпляр `Result`.
 
-## Начиная с версии
+## Since
 
 0.1.0
 
-## См. также
+## See
 
-[tap](./tap.md) - Эквивалентный helper для ветки успеха.
+[tap](tap.md) - Эквивалентный helper для ветки успеха.
 
-## Пример
+## Example
 
 ```ts
 import { Ok, inspect } from '@resultsafe/core-fp-result';

package/docs/api/{methods → functions}/inspectErr.md

@@ -1,18 +1,16 @@
-> [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 v0.1.9**](../README.md)
 
 ***
 
 [@resultsafe/core-fp-result](../README.md) / inspectErr
 
-# Функция: inspectErr()
+# Function: inspectErr()
 
 > **inspectErr**\<`T`, `E`\>(`result`, `fn`): `Result`\<`T`, `E`\>
 
 Выполняет побочный эффект для значения ошибки и возвращает исходный `Result`.
 
-## Параметры типа
+## Type Parameters
 
 ### T
 
@@ -26,7 +24,7 @@
 
 Тип значения ошибки.
 
-## Параметры
+## Parameters
 
 ### result
 
@@ -40,21 +38,21 @@
 
 Функция побочного эффекта для ветки ошибки.
 
-## Возвращает
+## Returns
 
 `Result`\<`T`, `E`\>
 
 Тот же экземпляр `Result`.
 
-## Начиная с версии
+## Since
 
 0.1.0
 
-## См. также
+## See
 
-[tapErr](./tapErr.md) - Эквивалентный helper для ветки ошибки.
+[tapErr](tapErr.md) - Эквивалентный helper для ветки ошибки.
 
-## Пример
+## Example
 
 ```ts
 import { Err, inspectErr } from '@resultsafe/core-fp-result';

package/docs/api/{guards → functions}/isErr.md

@@ -1,18 +1,16 @@
-> [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 v0.1.9**](../README.md)
 
 ***
 
 [@resultsafe/core-fp-result](../README.md) / isErr
 
-# Функция: isErr()
+# Function: isErr()
 
 > **isErr**\<`T`, `E`\>(`result`): `result is { ok: false; error: E }`
 
 Проверяет, находится ли `Result` в ветке ошибки.
 
-## Параметры типа
+## Type Parameters
 
 ### T
 
@@ -26,7 +24,7 @@
 
 Тип значения ошибки.
 
-## Параметры
+## Parameters
 
 ### result
 
@@ -34,21 +32,21 @@
 
 `Result` для проверки.
 
-## Возвращает
+## Returns
 
 `result is { ok: false; error: E }`
 
 `true` when `result.ok` equals `false`.
 
-## Начиная с версии
+## Since
 
 0.1.0
 
-## См. также
+## See
 
-[isOk](./isOk.md) - Checks the success branch.
+[isOk](isOk.md) - Checks the success branch.
 
-## Пример
+## Example
 
 ```ts
 import { Err, isErr } from '@resultsafe/core-fp-result';