@resultsafe/core-fp-result 0.1.8 → 0.1.10

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (69) hide show
  1. package/README.md +305 -302
  2. package/README.ru.md +304 -302
  3. package/docs/api/README.md +52 -7
  4. package/docs/api/{constructors → functions}/Err.md +9 -11
  5. package/docs/api/{constructors → functions}/Ok.md +9 -11
  6. package/docs/api/{methods → functions}/andThen.md +9 -11
  7. package/docs/api/{methods/err.md → functions/err-1.md} +9 -11
  8. package/docs/api/{methods → functions}/expect.md +10 -12
  9. package/docs/api/{methods → functions}/expectErr.md +10 -12
  10. package/docs/api/{methods → functions}/flatten.md +9 -11
  11. package/docs/api/{methods → functions}/inspect.md +9 -11
  12. package/docs/api/{methods → functions}/inspectErr.md +9 -11
  13. package/docs/api/{guards → functions}/isErr.md +9 -11
  14. package/docs/api/{guards → functions}/isErrAnd.md +9 -11
  15. package/docs/api/{guards → functions}/isOk.md +9 -11
  16. package/docs/api/{guards → functions}/isOkAnd.md +9 -11
  17. package/docs/api/{refiners → functions}/isTypedVariant.md +11 -13
  18. package/docs/api/{refiners → functions}/isTypedVariantOf.md +11 -13
  19. package/docs/api/{methods → functions}/map.md +9 -11
  20. package/docs/api/{methods → functions}/mapErr.md +9 -11
  21. package/docs/api/{methods → functions}/match.md +9 -11
  22. package/docs/api/{refiners → functions}/matchVariant.md +9 -11
  23. package/docs/api/{refiners → functions}/matchVariantStrict.md +10 -12
  24. package/docs/api/{methods/ok.md → functions/ok-1.md} +9 -11
  25. package/docs/api/{methods → functions}/orElse.md +9 -11
  26. package/docs/api/{refiners → functions}/refineAsyncResult.md +17 -19
  27. package/docs/api/{refiners → functions}/refineAsyncResultU.md +9 -11
  28. package/docs/api/{refiners → functions}/refineResult.md +17 -19
  29. package/docs/api/{refiners → functions}/refineResultU.md +9 -11
  30. package/docs/api/{refiners → functions}/refineVariantMap.md +9 -11
  31. package/docs/api/{methods → functions}/tap.md +9 -11
  32. package/docs/api/{methods → functions}/tapErr.md +9 -11
  33. package/docs/api/{methods → functions}/transpose.md +9 -11
  34. package/docs/api/{methods → functions}/unwrap.md +10 -12
  35. package/docs/api/{methods → functions}/unwrapErr.md +10 -12
  36. package/docs/api/{methods → functions}/unwrapOr.md +9 -11
  37. package/docs/api/{methods → functions}/unwrapOrElse.md +9 -11
  38. package/docs/api/type-aliases/Handler.md +1 -1
  39. package/docs/api/type-aliases/MatchBuilder.md +1 -1
  40. package/docs/api/type-aliases/Matcher.md +1 -1
  41. package/docs/api/type-aliases/SyncRefinedResult.md +1 -1
  42. package/docs/api/type-aliases/SyncRefinedResultUnion.md +1 -1
  43. package/docs/api/type-aliases/SyncValidatorMap.md +1 -1
  44. package/docs/api/type-aliases/UniversalAsyncRefinedResult.md +1 -1
  45. package/docs/api/type-aliases/UniversalRefinedResult.md +1 -1
  46. package/docs/api/type-aliases/VariantOf.md +1 -1
  47. package/docs/examples/auth/index.md +1 -1
  48. package/docs/examples/auth/token.md +1 -1
  49. package/docs/examples/connection/connect.md +1 -1
  50. package/docs/examples/connection/index.md +1 -1
  51. package/docs/examples/connection/reconnect.md +1 -1
  52. package/docs/examples/errors/index.md +1 -1
  53. package/docs/examples/errors/retry.md +1 -1
  54. package/docs/examples/index.md +1 -1
  55. package/docs/examples/streaming/index.md +1 -1
  56. package/docs/examples/streaming/text.md +1 -1
  57. package/docs/meta/AI-AGENT-RULES.md +1 -1
  58. package/docs/meta/CONTEXT.md +1 -1
  59. package/docs/meta/MANIFEST.md +1 -1
  60. package/docs/meta/registry/COUNTERS.md +1 -1
  61. package/docs/meta/registry/ENTITIES.md +1 -1
  62. package/package.json +1 -1
  63. package/docs/api/constructors/index.md +0 -7
  64. package/docs/api/guards/index.md +0 -9
  65. package/docs/api/index.md +0 -9
  66. package/docs/api/methods/index.md +0 -24
  67. package/docs/api/modules.md +0 -10
  68. package/docs/api/refiners/index.md +0 -14
  69. package/docs/api/type-aliases/index.md +0 -14
@@ -1,18 +1,16 @@
1
- > [Back to package README](../../../README.md) | [Back to API index](../index.md) | [Back to module](./index.md)
2
-
3
- [**@resultsafe/core-fp-result v0.1.0**](../README.md)
1
+ [**@resultsafe/core-fp-result v0.1.9**](../README.md)
4
2
 
5
3
  ***
6
4
 
7
5
  [@resultsafe/core-fp-result](../README.md) / unwrapErr
8
6
 
9
- # Функция: unwrapErr()
7
+ # Function: unwrapErr()
10
8
 
11
9
  > **unwrapErr**\<`T`, `E`\>(`result`): `E`
12
10
 
13
11
  Возвращает значение ошибки или выбрасывает исключение, если результат `Ok`.
14
12
 
15
- ## Параметры типа
13
+ ## Type Parameters
16
14
 
17
15
  ### T
18
16
 
@@ -26,7 +24,7 @@
26
24
 
27
25
  Тип значения ошибки.
28
26
 
29
- ## Параметры
27
+ ## Parameters
30
28
 
31
29
  ### result
32
30
 
@@ -34,25 +32,25 @@
34
32
 
35
33
  Исходный `Result`.
36
34
 
37
- ## Возвращает
35
+ ## Returns
38
36
 
39
37
  `E`
40
38
 
41
39
  Payload ошибки.
42
40
 
43
- ## Исключения
41
+ ## Throws
44
42
 
45
43
  Error - Выбрасывает исключение при вызове на `Ok`.
46
44
 
47
- ## Начиная с версии
45
+ ## Since
48
46
 
49
47
  0.1.0
50
48
 
51
- ## См. также
49
+ ## See
52
50
 
53
- [unwrapOrElse](./unwrapOrElse.md) - Возвращает fallback успеха без выброса исключения.
51
+ [unwrapOrElse](unwrapOrElse.md) - Возвращает fallback успеха без выброса исключения.
54
52
 
55
- ## Пример
53
+ ## Example
56
54
 
57
55
  ```ts
58
56
  import { Err, unwrapErr } from '@resultsafe/core-fp-result';
@@ -1,18 +1,16 @@
1
- > [Back to package README](../../../README.md) | [Back to API index](../index.md) | [Back to module](./index.md)
2
-
3
- [**@resultsafe/core-fp-result v0.1.0**](../README.md)
1
+ [**@resultsafe/core-fp-result v0.1.9**](../README.md)
4
2
 
5
3
  ***
6
4
 
7
5
  [@resultsafe/core-fp-result](../README.md) / unwrapOr
8
6
 
9
- # Функция: unwrapOr()
7
+ # Function: unwrapOr()
10
8
 
11
9
  > **unwrapOr**\<`T`, `E`\>(`result`, `defaultValue`): `T`
12
10
 
13
11
  Возвращает успешное значение или переданный fallback по умолчанию.
14
12
 
15
- ## Параметры типа
13
+ ## Type Parameters
16
14
 
17
15
  ### T
18
16
 
@@ -26,7 +24,7 @@
26
24
 
27
25
  Тип значения ошибки.
28
26
 
29
- ## Параметры
27
+ ## Parameters
30
28
 
31
29
  ### result
32
30
 
@@ -40,21 +38,21 @@
40
38
 
41
39
  Fallback-значение для `Err`.
42
40
 
43
- ## Возвращает
41
+ ## Returns
44
42
 
45
43
  `T`
46
44
 
47
45
  Payload успеха или `defaultValue`.
48
46
 
49
- ## Начиная с версии
47
+ ## Since
50
48
 
51
49
  0.1.0
52
50
 
53
- ## См. также
51
+ ## See
54
52
 
55
- [unwrapOrElse](./unwrapOrElse.md) - Вычисляет fallback лениво.
53
+ [unwrapOrElse](unwrapOrElse.md) - Вычисляет fallback лениво.
56
54
 
57
- ## Пример
55
+ ## Example
58
56
 
59
57
  ```ts
60
58
  import { Err, unwrapOr } from '@resultsafe/core-fp-result';
@@ -1,18 +1,16 @@
1
- > [Back to package README](../../../README.md) | [Back to API index](../index.md) | [Back to module](./index.md)
2
-
3
- [**@resultsafe/core-fp-result v0.1.0**](../README.md)
1
+ [**@resultsafe/core-fp-result v0.1.9**](../README.md)
4
2
 
5
3
  ***
6
4
 
7
5
  [@resultsafe/core-fp-result](../README.md) / unwrapOrElse
8
6
 
9
- # Функция: unwrapOrElse()
7
+ # Function: unwrapOrElse()
10
8
 
11
9
  > **unwrapOrElse**\<`T`, `E`\>(`result`, `fn`): `T`
12
10
 
13
11
  Возвращает успешное значение или вычисляет fallback из ошибки.
14
12
 
15
- ## Параметры типа
13
+ ## Type Parameters
16
14
 
17
15
  ### T
18
16
 
@@ -26,7 +24,7 @@
26
24
 
27
25
  Тип значения ошибки.
28
26
 
29
- ## Параметры
27
+ ## Parameters
30
28
 
31
29
  ### result
32
30
 
@@ -40,21 +38,21 @@
40
38
 
41
39
  Функция-поставщик fallback для `Err`.
42
40
 
43
- ## Возвращает
41
+ ## Returns
44
42
 
45
43
  `T`
46
44
 
47
45
  Payload успеха или вычисленный fallback.
48
46
 
49
- ## Начиная с версии
47
+ ## Since
50
48
 
51
49
  0.1.0
52
50
 
53
- ## См. также
51
+ ## See
54
52
 
55
- [unwrapOr](./unwrapOr.md) - Использует eager fallback-значение.
53
+ [unwrapOr](unwrapOr.md) - Использует eager fallback-значение.
56
54
 
57
- ## Пример
55
+ ## Example
58
56
 
59
57
  ```ts
60
58
  import { Err, unwrapOrElse } from '@resultsafe/core-fp-result';
@@ -1,4 +1,4 @@
1
- [**@resultsafe/core-fp-result v0.1.0**](../README.md)
1
+ [**@resultsafe/core-fp-result v0.1.9**](../README.md)
2
2
 
3
3
  ***
4
4
 
@@ -1,4 +1,4 @@
1
- [**@resultsafe/core-fp-result v0.1.0**](../README.md)
1
+ [**@resultsafe/core-fp-result v0.1.9**](../README.md)
2
2
 
3
3
  ***
4
4
 
@@ -1,4 +1,4 @@
1
- [**@resultsafe/core-fp-result v0.1.0**](../README.md)
1
+ [**@resultsafe/core-fp-result v0.1.9**](../README.md)
2
2
 
3
3
  ***
4
4
 
@@ -1,4 +1,4 @@
1
- [**@resultsafe/core-fp-result v0.1.0**](../README.md)
1
+ [**@resultsafe/core-fp-result v0.1.9**](../README.md)
2
2
 
3
3
  ***
4
4
 
@@ -1,4 +1,4 @@
1
- [**@resultsafe/core-fp-result v0.1.0**](../README.md)
1
+ [**@resultsafe/core-fp-result v0.1.9**](../README.md)
2
2
 
3
3
  ***
4
4
 
@@ -1,4 +1,4 @@
1
- [**@resultsafe/core-fp-result v0.1.0**](../README.md)
1
+ [**@resultsafe/core-fp-result v0.1.9**](../README.md)
2
2
 
3
3
  ***
4
4
 
@@ -1,4 +1,4 @@
1
- [**@resultsafe/core-fp-result v0.1.0**](../README.md)
1
+ [**@resultsafe/core-fp-result v0.1.9**](../README.md)
2
2
 
3
3
  ***
4
4
 
@@ -1,4 +1,4 @@
1
- [**@resultsafe/core-fp-result v0.1.0**](../README.md)
1
+ [**@resultsafe/core-fp-result v0.1.9**](../README.md)
2
2
 
3
3
  ***
4
4
 
@@ -1,4 +1,4 @@
1
- [**@resultsafe/core-fp-result v0.1.0**](../README.md)
1
+ [**@resultsafe/core-fp-result v0.1.9**](../README.md)
2
2
 
3
3
  ***
4
4
 
@@ -1,3 +1,3 @@
1
- # Примеры auth
1
+ # Примеры auth
2
2
 
3
3
  Используйте Result для получения валидированных auth-значений.
@@ -1,4 +1,4 @@
1
- # token
1
+ # token
2
2
 
3
3
  Скрипт: `__examples__/auth/token.js`
4
4
 
@@ -1,4 +1,4 @@
1
- # connect
1
+ # connect
2
2
 
3
3
  Скрипт: `__examples__/connection/connect.js`
4
4
 
@@ -1,3 +1,3 @@
1
- # Примеры connection
1
+ # Примеры connection
2
2
 
3
3
  Используйте утилиты Result для моделирования потоков connect/reconnect.
@@ -1,4 +1,4 @@
1
- # reconnect
1
+ # reconnect
2
2
 
3
3
  Скрипт: `__examples__/connection/reconnect.js`
4
4
 
@@ -1,3 +1,3 @@
1
- # Примеры errors
1
+ # Примеры errors
2
2
 
3
3
  Используйте fallback-утилиты Result для устойчивой стратегии повторов.
@@ -1,4 +1,4 @@
1
- # retry
1
+ # retry
2
2
 
3
3
  Скрипт: `__examples__/errors/retry.js`
4
4
 
@@ -1,4 +1,4 @@
1
- # Карта примеров
1
+ # Карта примеров
2
2
 
3
3
  Пакет предоставляет каноничную реализацию `Result<T, E>` и набор утилит.
4
4
 
@@ -1,3 +1,3 @@
1
- # Примеры streaming
1
+ # Примеры streaming
2
2
 
3
3
  Используйте сопоставление Result для безопасной обработки чанков потока.
@@ -1,4 +1,4 @@
1
- # text
1
+ # text
2
2
 
3
3
  Скрипт: `__examples__/streaming/text.js`
4
4
 
@@ -1,4 +1,4 @@
1
- # AI-Agent Rules for @resultsafe/core-fp-result
1
+ # AI-Agent Rules for @resultsafe/core-fp-result
2
2
 
3
3
  > Quick reference for AI agents and developers working on this package.
4
4
  > Read this before modifying any code in `src/`.
@@ -1,4 +1,4 @@
1
- ---
1
+ ---
2
2
  id: CONTEXT
3
3
  uuid: 3143ad43-830e-4a51-9795-c484204e0e00
4
4
  title: "@resultsafe/core-fp-result — Package Context"
@@ -1,4 +1,4 @@
1
- ---
1
+ ---
2
2
  id: MANIFEST
3
3
  uuid: 971ffb6b-68db-4465-b286-21659fca5c17
4
4
  title: "@resultsafe/core-fp-result — Documentation Map"
@@ -1,4 +1,4 @@
1
- ---
1
+ ---
2
2
  id: COUNTERS
3
3
  uuid: 95199988-2bae-4ad9-8040-8a1aa86b803a
4
4
  title: "@resultsafe/core-fp-result — Local ID Counters"
@@ -1,4 +1,4 @@
1
- ---
1
+ ---
2
2
  id: ENTITIES
3
3
  uuid: a02a4468-3a62-442e-827a-c9a40fbeaaa2
4
4
  title: "@resultsafe/core-fp-result — Package Entities"
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@resultsafe/core-fp-result",
3
- "version": "0.1.8",
3
+ "version": "0.1.10",
4
4
  "type": "module",
5
5
  "sideEffects": false,
6
6
  "main": "./cjs/index.js",
@@ -1,7 +0,0 @@
1
- # Конструкторы
2
-
3
- > [Back to package README](../../../README.md) | [Back to API index](../index.md)
4
-
5
- Символы модуля:
6
- - [Err](./Err.md)
7
- - [Ok](./Ok.md)
@@ -1,9 +0,0 @@
1
- # Гарды
2
-
3
- > [Back to package README](../../../README.md) | [Back to API index](../index.md)
4
-
5
- Символы модуля:
6
- - [isErr](./isErr.md)
7
- - [isErrAnd](./isErrAnd.md)
8
- - [isOk](./isOk.md)
9
- - [isOkAnd](./isOkAnd.md)
package/docs/api/index.md DELETED
@@ -1,9 +0,0 @@
1
- # API
2
-
3
- > [Back to package README](../../README.md)
4
-
5
- Содержание по модулям:
6
- - [Конструкторы](./constructors/index.md)
7
- - [Гарды](./guards/index.md)
8
- - [Методы](./methods/index.md)
9
- - [Рефайнеры](./refiners/index.md)
@@ -1,24 +0,0 @@
1
- # Методы
2
-
3
- > [Back to package README](../../../README.md) | [Back to API index](../index.md)
4
-
5
- Символы модуля:
6
- - [andThen](./andThen.md)
7
- - [err](./err.md)
8
- - [expect](./expect.md)
9
- - [expectErr](./expectErr.md)
10
- - [flatten](./flatten.md)
11
- - [inspect](./inspect.md)
12
- - [inspectErr](./inspectErr.md)
13
- - [map](./map.md)
14
- - [mapErr](./mapErr.md)
15
- - [match](./match.md)
16
- - [ok](./ok.md)
17
- - [orElse](./orElse.md)
18
- - [tap](./tap.md)
19
- - [tapErr](./tapErr.md)
20
- - [transpose](./transpose.md)
21
- - [unwrap](./unwrap.md)
22
- - [unwrapErr](./unwrapErr.md)
23
- - [unwrapOr](./unwrapOr.md)
24
- - [unwrapOrElse](./unwrapOrElse.md)
@@ -1,10 +0,0 @@
1
- # Modules
2
-
3
- > [Back to package README](../../README.md) | [Back to API index](./index.md)
4
-
5
- Module entry points:
6
- - [Конструкторы](./constructors/index.md)
7
- - [Гарды](./guards/index.md)
8
- - [Методы](./methods/index.md)
9
- - [Рефайнеры](./refiners/index.md)
10
- - [Type Aliases](./type-aliases/index.md)
@@ -1,14 +0,0 @@
1
- # Рефайнеры
2
-
3
- > [Back to package README](../../../README.md) | [Back to API index](../index.md)
4
-
5
- Символы модуля:
6
- - [isTypedVariant](./isTypedVariant.md)
7
- - [isTypedVariantOf](./isTypedVariantOf.md)
8
- - [matchVariant](./matchVariant.md)
9
- - [matchVariantStrict](./matchVariantStrict.md)
10
- - [refineAsyncResult](./refineAsyncResult.md)
11
- - [refineAsyncResultU](./refineAsyncResultU.md)
12
- - [refineResult](./refineResult.md)
13
- - [refineResultU](./refineResultU.md)
14
- - [refineVariantMap](./refineVariantMap.md)
@@ -1,14 +0,0 @@
1
- # Type Aliases
2
-
3
- > [Back to package README](../../../README.md) | [Back to API index](../index.md)
4
-
5
- Published helper type aliases:
6
- - [Handler](./Handler.md)
7
- - [MatchBuilder](./MatchBuilder.md)
8
- - [Matcher](./Matcher.md)
9
- - [SyncRefinedResult](./SyncRefinedResult.md)
10
- - [SyncRefinedResultUnion](./SyncRefinedResultUnion.md)
11
- - [SyncValidatorMap](./SyncValidatorMap.md)
12
- - [UniversalAsyncRefinedResult](./UniversalAsyncRefinedResult.md)
13
- - [UniversalRefinedResult](./UniversalRefinedResult.md)
14
- - [VariantOf](./VariantOf.md)