@resultsafe/core-fp-result 0.1.0

package/dist/docs/api/methods/inspectErr.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) / inspectErr
+
+# Функция: inspectErr()
+
+> **inspectErr**\<`T`, `E`\>(`result`, `fn`): `Result`\<`T`, `E`\>
+
+Выполняет побочный эффект для значения ошибки и возвращает исходный `Result`.
+
+## Параметры типа
+
+### T
+
+`T`
+
+Тип успешного значения.
+
+### E
+
+`E`
+
+Тип значения ошибки.
+
+## Параметры
+
+### result
+
+`Result`\<`T`, `E`\>
+
+Исходный `Result`.
+
+### fn
+
+(`error`) => `void`
+
+Функция побочного эффекта для ветки ошибки.
+
+## Возвращает
+
+`Result`\<`T`, `E`\>
+
+Тот же экземпляр `Result`.
+
+## Начиная с версии
+
+0.1.0
+
+## См. также
+
+[tapErr](./tapErr.md) - Эквивалентный helper для ветки ошибки.
+
+## Пример
+
+```ts
+import { Err, inspectErr } from '@resultsafe/core-fp-result';
+
+const result = inspectErr(Err('boom'), (error) => console.log(error)); // boom
+console.log(result.ok); // false
+```

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

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

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

@@ -0,0 +1,70 @@
+> [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) / mapErr
+
+# Функция: mapErr()
+
+> **mapErr**\<`T`, `E`, `F`\>(`result`, `fn`): `Result`\<`T`, `F`\>
+
+Преобразует значение ошибки, сохраняя ветку успеха.
+
+## Параметры типа
+
+### T
+
+`T`
+
+Тип успешного значения.
+
+### E
+
+`E`
+
+Тип входного значения ошибки.
+
+### F
+
+`F`
+
+Тип выходного значения ошибки.
+
+## Параметры
+
+### result
+
+`Result`\<`T`, `E`\>
+
+Исходный `Result`.
+
+### fn
+
+(`error`) => `F`
+
+Функция преобразования значения ошибки.
+
+## Возвращает
+
+`Result`\<`T`, `F`\>
+
+Преобразованный `Err` или исходный `Ok`.
+
+## Начиная с версии
+
+0.1.0
+
+## См. также
+
+[map](./map.md) - Transforms the success branch.
+
+## Пример
+
+```ts
+import { Err, mapErr } from '@resultsafe/core-fp-result';
+
+const result = mapErr(Err('e1'), (error) => `mapped:${error}`);
+console.log(result.ok); // false
+```

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

@@ -0,0 +1,76 @@
+> [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) / match
+
+# Функция: match()
+
+> **match**\<`T`, `E`, `U`\>(`result`, `okFn`, `errFn`): `U`
+
+Выполняет сопоставление `Result` в единое выходное значение.
+
+## Параметры типа
+
+### T
+
+`T`
+
+Тип успешного значения.
+
+### E
+
+`E`
+
+Тип значения ошибки.
+
+### U
+
+`U`
+
+The output type returned by both handlers.
+
+## Параметры
+
+### result
+
+`Result`\<`T`, `E`\>
+
+Исходный `Result`.
+
+### okFn
+
+(`value`) => `U`
+
+Обработчик для ветки успеха.
+
+### errFn
+
+(`error`) => `U`
+
+Обработчик для ветки ошибки.
+
+## Возвращает
+
+`U`
+
+Выходное значение, полученное от выбранного обработчика.
+
+## Начиная с версии
+
+0.1.0
+
+## См. также
+
+[unwrapOrElse](./unwrapOrElse.md) - Similar shape with default fallback semantics.
+
+## Пример
+
+```ts
+import { Ok, match } from '@resultsafe/core-fp-result';
+
+const value = match(Ok(3), (x) => `ok:${x}`, (e) => `err:${e}`);
+console.log(value); // ok:3
+```

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

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

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

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

package/dist/docs/api/methods/tap.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) / tap
+
+# Функция: tap()
+
+> **tap**\<`T`, `E`\>(`result`, `fn`): `Result`\<`T`, `E`\>
+
+Выполняет побочный эффект для значения `Ok` и возвращает входной `Result`.
+
+## Параметры типа
+
+### T
+
+`T`
+
+Тип успешного значения.
+
+### E
+
+`E`
+
+Тип значения ошибки.
+
+## Параметры
+
+### result
+
+`Result`\<`T`, `E`\>
+
+Исходный `Result`.
+
+### fn
+
+(`value`) => `void`
+
+Колбэк побочного эффекта для ветки успеха.
+
+## Возвращает
+
+`Result`\<`T`, `E`\>
+
+Неизмененный `Result`.
+
+## Начиная с версии
+
+0.1.0
+
+## См. также
+
+[tapErr](./tapErr.md) - Executes a side effect for the error branch.
+
+## Пример
+
+```ts
+import { Ok, tap } from '@resultsafe/core-fp-result';
+
+const result = tap(Ok(1), (value) => console.log(value)); // 1
+console.log(result.ok); // true
+```

package/dist/docs/api/methods/tapErr.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) / tapErr
+
+# Функция: tapErr()
+
+> **tapErr**\<`T`, `E`\>(`result`, `fn`): `Result`\<`T`, `E`\>
+
+Выполняет побочный эффект для значения `Err` и возвращает входной `Result`.
+
+## Параметры типа
+
+### T
+
+`T`
+
+Тип успешного значения.
+
+### E
+
+`E`
+
+Тип значения ошибки.
+
+## Параметры
+
+### result
+
+`Result`\<`T`, `E`\>
+
+Исходный `Result`.
+
+### fn
+
+(`error`) => `void`
+
+Колбэк побочного эффекта для ветки ошибки.
+
+## Возвращает
+
+`Result`\<`T`, `E`\>
+
+Неизмененный `Result`.
+
+## Начиная с версии
+
+0.1.0
+
+## См. также
+
+[tap](./tap.md) - Executes a side effect for the success branch.
+
+## Пример
+
+```ts
+import { Err, tapErr } from '@resultsafe/core-fp-result';
+
+const result = tapErr(Err('boom'), (error) => console.log(error)); // boom
+console.log(result.ok); // false
+```

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

@@ -0,0 +1,58 @@
+> [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) / transpose
+
+# Функция: transpose()
+
+> **transpose**\<`T`, `E`\>(`result`): `Option`\<`Result`\<`T`, `E`\>\>
+
+Преобразует `Result<Option<T>, E>` в `Option<Result<T, E>>`.
+
+## Параметры типа
+
+### T
+
+`T`
+
+The success value type inside `Option`.
+
+### E
+
+`E`
+
+Тип значения ошибки.
+
+## Параметры
+
+### result
+
+`Result`\<`Option`\<`T`\>, `E`\>
+
+Исходный `Result`, содержащий `Option`.
+
+## Возвращает
+
+`Option`\<`Result`\<`T`, `E`\>\>
+
+Транспонированный `Option<Result<T, E>>`.
+
+## Начиная с версии
+
+0.1.0
+
+## См. также
+
+[flatten](./flatten.md) - Collapses nested `Result` values.
+
+## Пример
+
+```ts
+import { Ok, transpose } from '@resultsafe/core-fp-result';
+
+const value = transpose(Ok({ some: true, value: 2 }));
+console.log(value.some); // true
+```

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