@resultsafe/core-fp-result 0.1.0

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

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

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

package/docs/api/methods/flatten.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) / flatten
+
+# Функция: flatten()
+
+> **flatten**\<`T`, `E`\>(`result`): `Result`\<`T`, `E`\>
+
+Схлопывает вложенный `Result<Result<T, E>, E>` на один уровень.
+
+## Параметры типа
+
+### T
+
+`T`
+
+The inner success value type.
+
+### E
+
+`E`
+
+The shared error value type.
+
+## Параметры
+
+### result
+
+`Result`\<`Result`\<`T`, `E`\>, `E`\>
+
+Вложенный `Result` для схлопывания.
+
+## Возвращает
+
+`Result`\<`T`, `E`\>
+
+A single-layer `Result<T, E>`.
+
+## Начиная с версии
+
+0.1.0
+
+## См. также
+
+[andThen](./andThen.md) - Chains computations that already return `Result`.
+
+## Пример
+
+```ts
+import { Ok, flatten } from '@resultsafe/core-fp-result';
+
+const value = flatten(Ok(Ok(3)));
+console.log(value.ok); // true
+```

package/docs/api/methods/index.md

@@ -0,0 +1,24 @@
+# Методы
+
+> [Back to package README](../../../README.md) | [Back to API index](../index.md)
+
+Символы модуля:
+- [andThen](./andThen.md)
+- [err](./err.md)
+- [expect](./expect.md)
+- [expectErr](./expectErr.md)
+- [flatten](./flatten.md)
+- [inspect](./inspect.md)
+- [inspectErr](./inspectErr.md)
+- [map](./map.md)
+- [mapErr](./mapErr.md)
+- [match](./match.md)
+- [ok](./ok.md)
+- [orElse](./orElse.md)
+- [tap](./tap.md)
+- [tapErr](./tapErr.md)
+- [transpose](./transpose.md)
+- [unwrap](./unwrap.md)
+- [unwrapErr](./unwrapErr.md)
+- [unwrapOr](./unwrapOr.md)
+- [unwrapOrElse](./unwrapOrElse.md)

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

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