@resultsafe/core-fp-result 0.1.0

package/dist/docs/api/guards/isErr.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) / isErr
+
+# Функция: isErr()
+
+> **isErr**\<`T`, `E`\>(`result`): `result is { ok: false; error: E }`
+
+Проверяет, находится ли `Result` в ветке ошибки.
+
+## Параметры типа
+
+### T
+
+`T`
+
+Тип успешного значения.
+
+### E
+
+`E`
+
+Тип значения ошибки.
+
+## Параметры
+
+### result
+
+`Result`\<`T`, `E`\>
+
+`Result` для проверки.
+
+## Возвращает
+
+`result is { ok: false; error: E }`
+
+`true` when `result.ok` equals `false`.
+
+## Начиная с версии
+
+0.1.0
+
+## См. также
+
+[isOk](./isOk.md) - Checks the success branch.
+
+## Пример
+
+```ts
+import { Err, isErr } from '@resultsafe/core-fp-result';
+
+const result = Err('boom');
+console.log(isErr(result)); // true
+```

package/dist/docs/api/guards/isErrAnd.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) / isErrAnd
+
+# Функция: isErrAnd()
+
+> **isErrAnd**\<`T`, `E`\>(`result`, `predicate`): `boolean`
+
+Проверяет, что `Result` завершился ошибкой и удовлетворяет предикату.
+
+## Параметры типа
+
+### T
+
+`T`
+
+Тип успешного значения.
+
+### E
+
+`E`
+
+Тип значения ошибки.
+
+## Параметры
+
+### result
+
+`Result`\<`T`, `E`\>
+
+`Result` для проверки.
+
+### predicate
+
+(`error`) => `boolean`
+
+Предикат, применяемый к значению ошибки.
+
+## Возвращает
+
+`boolean`
+
+`true` when the value is `Err` and the predicate returns `true`.
+
+## Начиная с версии
+
+0.1.0
+
+## См. также
+
+[isErr](./isErr.md) - Performs the base error check.
+
+## Пример
+
+```ts
+import { Err, isErrAnd } from '@resultsafe/core-fp-result';
+
+const result = Err({ code: 503 });
+console.log(isErrAnd(result, (error) => error.code >= 500)); // true
+```

package/dist/docs/api/guards/isOk.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) / isOk
+
+# Функция: isOk()
+
+> **isOk**\<`T`, `E`\>(`result`): `result is { ok: true; value: T }`
+
+Проверяет, находится ли `Result` в ветке успеха.
+
+## Параметры типа
+
+### T
+
+`T`
+
+Тип успешного значения.
+
+### E
+
+`E`
+
+Тип значения ошибки.
+
+## Параметры
+
+### result
+
+`Result`\<`T`, `E`\>
+
+`Result` для проверки.
+
+## Возвращает
+
+`result is { ok: true; value: T }`
+
+`true` when `result.ok` equals `true`.
+
+## Начиная с версии
+
+0.1.0
+
+## См. также
+
+[isErr](./isErr.md) - Checks the error branch.
+
+## Пример
+
+```ts
+import { Ok, isOk } from '@resultsafe/core-fp-result';
+
+const result = Ok(10);
+console.log(isOk(result)); // true
+```

package/dist/docs/api/guards/isOkAnd.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) / isOkAnd
+
+# Функция: isOkAnd()
+
+> **isOkAnd**\<`T`, `E`\>(`result`, `predicate`): `boolean`
+
+Проверяет, что `Result` успешен и удовлетворяет предикату.
+
+## Параметры типа
+
+### T
+
+`T`
+
+Тип успешного значения.
+
+### E
+
+`E`
+
+Тип значения ошибки.
+
+## Параметры
+
+### result
+
+`Result`\<`T`, `E`\>
+
+`Result` для проверки.
+
+### predicate
+
+(`value`) => `boolean`
+
+Предикат, применяемый к успешному значению.
+
+## Возвращает
+
+`boolean`
+
+`true` when the value is `Ok` and the predicate returns `true`.
+
+## Начиная с версии
+
+0.1.0
+
+## См. также
+
+[isOk](./isOk.md) - Performs the base success check.
+
+## Пример
+
+```ts
+import { Ok, isOkAnd } from '@resultsafe/core-fp-result';
+
+const result = Ok(8);
+console.log(isOkAnd(result, (value) => value % 2 === 0)); // true
+```

package/dist/docs/api/index.md

@@ -0,0 +1,9 @@
+# API
+
+> [Back to package README](../../README.md)
+
+Содержание по модулям:
+- [Конструкторы](./constructors/index.md)
+- [Гарды](./guards/index.md)
+- [Методы](./methods/index.md)
+- [Рефайнеры](./refiners/index.md)

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

@@ -0,0 +1,73 @@
+> [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) / andThen
+
+# Функция: andThen()
+
+> **andThen**\<`T`, `U`, `E`\>(`result`, `fn`): `Result`\<`U`, `E`\>
+
+Цепляет вычисление, которое возвращает другой `Result`.
+
+## Параметры типа
+
+### T
+
+`T`
+
+The input success type.
+
+### U
+
+`U`
+
+The output success type.
+
+### E
+
+`E`
+
+Общий тип ошибки.
+
+## Параметры
+
+### result
+
+`Result`\<`T`, `E`\>
+
+Исходный `Result`.
+
+### fn
+
+(`value`) => `Result`\<`U`, `E`\>
+
+Функция, применяемая, когда `result` имеет `Ok`.
+
+## Возвращает
+
+`Result`\<`U`, `E`\>
+
+Преобразованный `Result` или исходный `Err`.
+
+## Начиная с версии
+
+0.1.0
+
+## См. также
+
+[map](./map.md) - Преобразует только успешное значение.
+
+## Пример
+
+```ts
+import { Ok, Err, andThen } from '@resultsafe/core-fp-result';
+
+const parsed = andThen(Ok('12'), (value) => {
+  const n = Number(value);
+  return Number.isNaN(n) ? Err('invalid') : Ok(n);
+});
+console.log(parsed.ok); // true
+```

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