@resultsafe/core-fp-result 0.1.0
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.
- package/LICENSE +21 -0
- package/README.md +273 -0
- package/README.ru.md +266 -0
- package/dist/LICENSE +21 -0
- package/dist/README.md +273 -0
- package/dist/cjs/constructors/Err.js +4 -0
- package/dist/cjs/constructors/Err.js.map +1 -0
- package/dist/cjs/constructors/Ok.js +4 -0
- package/dist/cjs/constructors/Ok.js.map +1 -0
- package/dist/cjs/guards/isErr.js +4 -0
- package/dist/cjs/guards/isErr.js.map +1 -0
- package/dist/cjs/guards/isErrAnd.js +5 -0
- package/dist/cjs/guards/isErrAnd.js.map +1 -0
- package/dist/cjs/guards/isOk.js +4 -0
- package/dist/cjs/guards/isOk.js.map +1 -0
- package/dist/cjs/guards/isOkAnd.js +5 -0
- package/dist/cjs/guards/isOkAnd.js.map +1 -0
- package/dist/cjs/index.js +70 -0
- package/dist/cjs/index.js.map +1 -0
- package/dist/cjs/internal/object.js +6 -0
- package/dist/cjs/internal/object.js.map +1 -0
- package/dist/cjs/internal/option.js +6 -0
- package/dist/cjs/internal/option.js.map +1 -0
- package/dist/cjs/methods/andThen.js +5 -0
- package/dist/cjs/methods/andThen.js.map +1 -0
- package/dist/cjs/methods/err.js +6 -0
- package/dist/cjs/methods/err.js.map +1 -0
- package/dist/cjs/methods/expect.js +10 -0
- package/dist/cjs/methods/expect.js.map +1 -0
- package/dist/cjs/methods/expectErr.js +10 -0
- package/dist/cjs/methods/expectErr.js.map +1 -0
- package/dist/cjs/methods/flatten.js +4 -0
- package/dist/cjs/methods/flatten.js.map +1 -0
- package/dist/cjs/methods/inspect.js +10 -0
- package/dist/cjs/methods/inspect.js.map +1 -0
- package/dist/cjs/methods/inspectErr.js +10 -0
- package/dist/cjs/methods/inspectErr.js.map +1 -0
- package/dist/cjs/methods/map.js +5 -0
- package/dist/cjs/methods/map.js.map +1 -0
- package/dist/cjs/methods/mapErr.js +5 -0
- package/dist/cjs/methods/mapErr.js.map +1 -0
- package/dist/cjs/methods/match.js +11 -0
- package/dist/cjs/methods/match.js.map +1 -0
- package/dist/cjs/methods/ok.js +6 -0
- package/dist/cjs/methods/ok.js.map +1 -0
- package/dist/cjs/methods/orElse.js +5 -0
- package/dist/cjs/methods/orElse.js.map +1 -0
- package/dist/cjs/methods/tap.js +9 -0
- package/dist/cjs/methods/tap.js.map +1 -0
- package/dist/cjs/methods/tapErr.js +10 -0
- package/dist/cjs/methods/tapErr.js.map +1 -0
- package/dist/cjs/methods/transpose.js +10 -0
- package/dist/cjs/methods/transpose.js.map +1 -0
- package/dist/cjs/methods/unwrap.js +10 -0
- package/dist/cjs/methods/unwrap.js.map +1 -0
- package/dist/cjs/methods/unwrapErr.js +10 -0
- package/dist/cjs/methods/unwrapErr.js.map +1 -0
- package/dist/cjs/methods/unwrapOr.js +5 -0
- package/dist/cjs/methods/unwrapOr.js.map +1 -0
- package/dist/cjs/methods/unwrapOrElse.js +10 -0
- package/dist/cjs/methods/unwrapOrElse.js.map +1 -0
- package/dist/cjs/package.json +3 -0
- package/dist/cjs/refiners/isTypedVariant.js +9 -0
- package/dist/cjs/refiners/isTypedVariant.js.map +1 -0
- package/dist/cjs/refiners/isTypedVariantOf.js +14 -0
- package/dist/cjs/refiners/isTypedVariantOf.js.map +1 -0
- package/dist/cjs/refiners/matchVariant.js +57 -0
- package/dist/cjs/refiners/matchVariant.js.map +1 -0
- package/dist/cjs/refiners/matchVariantStrict.js +37 -0
- package/dist/cjs/refiners/matchVariantStrict.js.map +1 -0
- package/dist/cjs/refiners/refineAsyncResult.js +26 -0
- package/dist/cjs/refiners/refineAsyncResult.js.map +1 -0
- package/dist/cjs/refiners/refineAsyncResultU.js +28 -0
- package/dist/cjs/refiners/refineAsyncResultU.js.map +1 -0
- package/dist/cjs/refiners/refineResult.js +21 -0
- package/dist/cjs/refiners/refineResult.js.map +1 -0
- package/dist/cjs/refiners/refineResultU.js +5 -0
- package/dist/cjs/refiners/refineResultU.js.map +1 -0
- package/dist/cjs/refiners/refineVariantMap.js +25 -0
- package/dist/cjs/refiners/refineVariantMap.js.map +1 -0
- package/dist/cjs/refiners/utils/getPayloadKeys.js +8 -0
- package/dist/cjs/refiners/utils/getPayloadKeys.js.map +1 -0
- package/dist/docs/api/README.md +9 -0
- package/dist/docs/api/constructors/Err.md +58 -0
- package/dist/docs/api/constructors/Ok.md +58 -0
- package/dist/docs/api/constructors/index.md +7 -0
- package/dist/docs/api/guards/index.md +9 -0
- package/dist/docs/api/guards/isErr.md +58 -0
- package/dist/docs/api/guards/isErrAnd.md +64 -0
- package/dist/docs/api/guards/isOk.md +58 -0
- package/dist/docs/api/guards/isOkAnd.md +64 -0
- package/dist/docs/api/index.md +9 -0
- package/dist/docs/api/methods/andThen.md +73 -0
- package/dist/docs/api/methods/err.md +58 -0
- package/dist/docs/api/methods/expect.md +68 -0
- package/dist/docs/api/methods/expectErr.md +68 -0
- package/dist/docs/api/methods/flatten.md +58 -0
- package/dist/docs/api/methods/index.md +24 -0
- package/dist/docs/api/methods/inspect.md +64 -0
- package/dist/docs/api/methods/inspectErr.md +64 -0
- package/dist/docs/api/methods/map.md +70 -0
- package/dist/docs/api/methods/mapErr.md +70 -0
- package/dist/docs/api/methods/match.md +76 -0
- package/dist/docs/api/methods/ok.md +58 -0
- package/dist/docs/api/methods/orElse.md +70 -0
- package/dist/docs/api/methods/tap.md +64 -0
- package/dist/docs/api/methods/tapErr.md +64 -0
- package/dist/docs/api/methods/transpose.md +58 -0
- package/dist/docs/api/methods/unwrap.md +62 -0
- package/dist/docs/api/methods/unwrapErr.md +62 -0
- package/dist/docs/api/methods/unwrapOr.md +64 -0
- package/dist/docs/api/methods/unwrapOrElse.md +64 -0
- package/dist/docs/api/modules.md +10 -0
- package/dist/docs/api/refiners/index.md +14 -0
- package/dist/docs/api/refiners/isTypedVariant.md +62 -0
- package/dist/docs/api/refiners/isTypedVariantOf.md +68 -0
- package/dist/docs/api/refiners/matchVariant.md +59 -0
- package/dist/docs/api/refiners/matchVariantStrict.md +63 -0
- package/dist/docs/api/refiners/refineAsyncResult.md +98 -0
- package/dist/docs/api/refiners/refineAsyncResultU.md +86 -0
- package/dist/docs/api/refiners/refineResult.md +98 -0
- package/dist/docs/api/refiners/refineResultU.md +86 -0
- package/dist/docs/api/refiners/refineVariantMap.md +79 -0
- package/dist/docs/api/type-aliases/Handler.md +49 -0
- package/dist/docs/api/type-aliases/MatchBuilder.md +57 -0
- package/dist/docs/api/type-aliases/Matcher.md +71 -0
- package/dist/docs/api/type-aliases/SyncRefinedResult.md +31 -0
- package/dist/docs/api/type-aliases/SyncRefinedResultUnion.md +21 -0
- package/dist/docs/api/type-aliases/SyncValidatorMap.md +17 -0
- package/dist/docs/api/type-aliases/UniversalAsyncRefinedResult.md +31 -0
- package/dist/docs/api/type-aliases/UniversalRefinedResult.md +31 -0
- package/dist/docs/api/type-aliases/VariantOf.md +23 -0
- package/dist/docs/api/type-aliases/index.md +14 -0
- package/dist/esm/constructors/Err.js +7 -0
- package/dist/esm/constructors/Err.js.map +1 -0
- package/dist/esm/constructors/Ok.js +7 -0
- package/dist/esm/constructors/Ok.js.map +1 -0
- package/dist/esm/guards/isErr.js +7 -0
- package/dist/esm/guards/isErr.js.map +1 -0
- package/dist/esm/guards/isErrAnd.js +8 -0
- package/dist/esm/guards/isErrAnd.js.map +1 -0
- package/dist/esm/guards/isOk.js +7 -0
- package/dist/esm/guards/isOk.js.map +1 -0
- package/dist/esm/guards/isOkAnd.js +8 -0
- package/dist/esm/guards/isOkAnd.js.map +1 -0
- package/dist/esm/index.js +71 -0
- package/dist/esm/index.js.map +1 -0
- package/dist/esm/internal/object.js +9 -0
- package/dist/esm/internal/object.js.map +1 -0
- package/dist/esm/internal/option.js +9 -0
- package/dist/esm/internal/option.js.map +1 -0
- package/dist/esm/methods/andThen.js +8 -0
- package/dist/esm/methods/andThen.js.map +1 -0
- package/dist/esm/methods/err.js +9 -0
- package/dist/esm/methods/err.js.map +1 -0
- package/dist/esm/methods/expect.js +13 -0
- package/dist/esm/methods/expect.js.map +1 -0
- package/dist/esm/methods/expectErr.js +13 -0
- package/dist/esm/methods/expectErr.js.map +1 -0
- package/dist/esm/methods/flatten.js +7 -0
- package/dist/esm/methods/flatten.js.map +1 -0
- package/dist/esm/methods/inspect.js +13 -0
- package/dist/esm/methods/inspect.js.map +1 -0
- package/dist/esm/methods/inspectErr.js +13 -0
- package/dist/esm/methods/inspectErr.js.map +1 -0
- package/dist/esm/methods/map.js +8 -0
- package/dist/esm/methods/map.js.map +1 -0
- package/dist/esm/methods/mapErr.js +8 -0
- package/dist/esm/methods/mapErr.js.map +1 -0
- package/dist/esm/methods/match.js +14 -0
- package/dist/esm/methods/match.js.map +1 -0
- package/dist/esm/methods/ok.js +9 -0
- package/dist/esm/methods/ok.js.map +1 -0
- package/dist/esm/methods/orElse.js +8 -0
- package/dist/esm/methods/orElse.js.map +1 -0
- package/dist/esm/methods/tap.js +12 -0
- package/dist/esm/methods/tap.js.map +1 -0
- package/dist/esm/methods/tapErr.js +13 -0
- package/dist/esm/methods/tapErr.js.map +1 -0
- package/dist/esm/methods/transpose.js +13 -0
- package/dist/esm/methods/transpose.js.map +1 -0
- package/dist/esm/methods/unwrap.js +13 -0
- package/dist/esm/methods/unwrap.js.map +1 -0
- package/dist/esm/methods/unwrapErr.js +13 -0
- package/dist/esm/methods/unwrapErr.js.map +1 -0
- package/dist/esm/methods/unwrapOr.js +8 -0
- package/dist/esm/methods/unwrapOr.js.map +1 -0
- package/dist/esm/methods/unwrapOrElse.js +13 -0
- package/dist/esm/methods/unwrapOrElse.js.map +1 -0
- package/dist/esm/refiners/isTypedVariant.js +12 -0
- package/dist/esm/refiners/isTypedVariant.js.map +1 -0
- package/dist/esm/refiners/isTypedVariantOf.js +17 -0
- package/dist/esm/refiners/isTypedVariantOf.js.map +1 -0
- package/dist/esm/refiners/matchVariant.js +60 -0
- package/dist/esm/refiners/matchVariant.js.map +1 -0
- package/dist/esm/refiners/matchVariantStrict.js +40 -0
- package/dist/esm/refiners/matchVariantStrict.js.map +1 -0
- package/dist/esm/refiners/refineAsyncResult.js +29 -0
- package/dist/esm/refiners/refineAsyncResult.js.map +1 -0
- package/dist/esm/refiners/refineAsyncResultU.js +31 -0
- package/dist/esm/refiners/refineAsyncResultU.js.map +1 -0
- package/dist/esm/refiners/refineResult.js +24 -0
- package/dist/esm/refiners/refineResult.js.map +1 -0
- package/dist/esm/refiners/refineResultU.js +8 -0
- package/dist/esm/refiners/refineResultU.js.map +1 -0
- package/dist/esm/refiners/refineVariantMap.js +29 -0
- package/dist/esm/refiners/refineVariantMap.js.map +1 -0
- package/dist/esm/refiners/utils/getPayloadKeys.js +11 -0
- package/dist/esm/refiners/utils/getPayloadKeys.js.map +1 -0
- package/dist/package.json +36 -0
- package/dist/types/constructors/Err.d.ts +21 -0
- package/dist/types/constructors/Err.d.ts.map +1 -0
- package/dist/types/constructors/Ok.d.ts +21 -0
- package/dist/types/constructors/Ok.d.ts.map +1 -0
- package/dist/types/constructors/index.d.ts +3 -0
- package/dist/types/constructors/index.d.ts.map +1 -0
- package/dist/types/guards/index.d.ts +5 -0
- package/dist/types/guards/index.d.ts.map +1 -0
- package/dist/types/guards/isErr.d.ts +24 -0
- package/dist/types/guards/isErr.d.ts.map +1 -0
- package/dist/types/guards/isErrAnd.d.ts +22 -0
- package/dist/types/guards/isErrAnd.d.ts.map +1 -0
- package/dist/types/guards/isOk.d.ts +24 -0
- package/dist/types/guards/isOk.d.ts.map +1 -0
- package/dist/types/guards/isOkAnd.d.ts +22 -0
- package/dist/types/guards/isOkAnd.d.ts.map +1 -0
- package/dist/types/index.d.ts +5 -0
- package/dist/types/index.d.ts.map +1 -0
- package/dist/types/internal/object.d.ts +5 -0
- package/dist/types/internal/object.d.ts.map +1 -0
- package/dist/types/internal/option.d.ts +10 -0
- package/dist/types/internal/option.d.ts.map +1 -0
- package/dist/types/methods/andThen.d.ts +26 -0
- package/dist/types/methods/andThen.d.ts.map +1 -0
- package/dist/types/methods/err.d.ts +22 -0
- package/dist/types/methods/err.d.ts.map +1 -0
- package/dist/types/methods/expect.d.ts +23 -0
- package/dist/types/methods/expect.d.ts.map +1 -0
- package/dist/types/methods/expectErr.d.ts +23 -0
- package/dist/types/methods/expectErr.d.ts.map +1 -0
- package/dist/types/methods/flatten.d.ts +21 -0
- package/dist/types/methods/flatten.d.ts.map +1 -0
- package/dist/types/methods/index.d.ts +20 -0
- package/dist/types/methods/index.d.ts.map +1 -0
- package/dist/types/methods/inspect.d.ts +22 -0
- package/dist/types/methods/inspect.d.ts.map +1 -0
- package/dist/types/methods/inspectErr.d.ts +22 -0
- package/dist/types/methods/inspectErr.d.ts.map +1 -0
- package/dist/types/methods/map.d.ts +23 -0
- package/dist/types/methods/map.d.ts.map +1 -0
- package/dist/types/methods/mapErr.d.ts +23 -0
- package/dist/types/methods/mapErr.d.ts.map +1 -0
- package/dist/types/methods/match.d.ts +24 -0
- package/dist/types/methods/match.d.ts.map +1 -0
- package/dist/types/methods/ok.d.ts +22 -0
- package/dist/types/methods/ok.d.ts.map +1 -0
- package/dist/types/methods/orElse.d.ts +23 -0
- package/dist/types/methods/orElse.d.ts.map +1 -0
- package/dist/types/methods/tap.d.ts +22 -0
- package/dist/types/methods/tap.d.ts.map +1 -0
- package/dist/types/methods/tapErr.d.ts +22 -0
- package/dist/types/methods/tapErr.d.ts.map +1 -0
- package/dist/types/methods/transpose.d.ts +22 -0
- package/dist/types/methods/transpose.d.ts.map +1 -0
- package/dist/types/methods/unwrap.d.ts +22 -0
- package/dist/types/methods/unwrap.d.ts.map +1 -0
- package/dist/types/methods/unwrapErr.d.ts +22 -0
- package/dist/types/methods/unwrapErr.d.ts.map +1 -0
- package/dist/types/methods/unwrapOr.d.ts +22 -0
- package/dist/types/methods/unwrapOr.d.ts.map +1 -0
- package/dist/types/methods/unwrapOrElse.d.ts +22 -0
- package/dist/types/methods/unwrapOrElse.d.ts.map +1 -0
- package/dist/types/refiners/index.d.ts +11 -0
- package/dist/types/refiners/index.d.ts.map +1 -0
- package/dist/types/refiners/isTypedVariant.d.ts +21 -0
- package/dist/types/refiners/isTypedVariant.d.ts.map +1 -0
- package/dist/types/refiners/isTypedVariantOf.d.ts +22 -0
- package/dist/types/refiners/isTypedVariantOf.d.ts.map +1 -0
- package/dist/types/refiners/matchVariant.d.ts +27 -0
- package/dist/types/refiners/matchVariant.d.ts.map +1 -0
- package/dist/types/refiners/matchVariantStrict.d.ts +28 -0
- package/dist/types/refiners/matchVariantStrict.d.ts.map +1 -0
- package/dist/types/refiners/refineAsyncResult.d.ts +54 -0
- package/dist/types/refiners/refineAsyncResult.d.ts.map +1 -0
- package/dist/types/refiners/refineAsyncResultU.d.ts +30 -0
- package/dist/types/refiners/refineAsyncResultU.d.ts.map +1 -0
- package/dist/types/refiners/refineResult.d.ts +54 -0
- package/dist/types/refiners/refineResult.d.ts.map +1 -0
- package/dist/types/refiners/refineResultU.d.ts +30 -0
- package/dist/types/refiners/refineResultU.d.ts.map +1 -0
- package/dist/types/refiners/refineVariantMap.d.ts +34 -0
- package/dist/types/refiners/refineVariantMap.d.ts.map +1 -0
- package/dist/types/refiners/types/Handler.d.ts +9 -0
- package/dist/types/refiners/types/Handler.d.ts.map +1 -0
- package/dist/types/refiners/types/MatchBuilder.d.ts +9 -0
- package/dist/types/refiners/types/MatchBuilder.d.ts.map +1 -0
- package/dist/types/refiners/types/Matcher.d.ts +11 -0
- package/dist/types/refiners/types/Matcher.d.ts.map +1 -0
- package/dist/types/refiners/types/SyncRefinedResult.d.ts +6 -0
- package/dist/types/refiners/types/SyncRefinedResult.d.ts.map +1 -0
- package/dist/types/refiners/types/SyncRefinedResultUnion.d.ts +8 -0
- package/dist/types/refiners/types/SyncRefinedResultUnion.d.ts.map +1 -0
- package/dist/types/refiners/types/SyncValidatorMap.d.ts +6 -0
- package/dist/types/refiners/types/SyncValidatorMap.d.ts.map +1 -0
- package/dist/types/refiners/types/UniversalAsyncRefinedResult.d.ts +6 -0
- package/dist/types/refiners/types/UniversalAsyncRefinedResult.d.ts.map +1 -0
- package/dist/types/refiners/types/UniversalRefinedResult.d.ts +6 -0
- package/dist/types/refiners/types/UniversalRefinedResult.d.ts.map +1 -0
- package/dist/types/refiners/types/VariantOf.d.ts +5 -0
- package/dist/types/refiners/types/VariantOf.d.ts.map +1 -0
- package/dist/types/refiners/types/index.d.ts +10 -0
- package/dist/types/refiners/types/index.d.ts.map +1 -0
- package/dist/types/refiners/utils/getPayloadKeys.d.ts +19 -0
- package/dist/types/refiners/utils/getPayloadKeys.d.ts.map +1 -0
- package/dist/types/refiners/utils/index.d.ts +2 -0
- package/dist/types/refiners/utils/index.d.ts.map +1 -0
- package/dist/types/shared-types.d.ts +22 -0
- package/dist/types/shared-types.d.ts.map +1 -0
- package/dist/umd/resultsafe-monorepo-core-fp-result.umd.js +2 -0
- package/dist/umd/resultsafe-monorepo-core-fp-result.umd.js.map +1 -0
- package/docs/_category_.json +6 -0
- package/docs/api/README.md +9 -0
- package/docs/api/constructors/Err.md +58 -0
- package/docs/api/constructors/Ok.md +58 -0
- package/docs/api/constructors/index.md +7 -0
- package/docs/api/guards/index.md +9 -0
- package/docs/api/guards/isErr.md +58 -0
- package/docs/api/guards/isErrAnd.md +64 -0
- package/docs/api/guards/isOk.md +58 -0
- package/docs/api/guards/isOkAnd.md +64 -0
- package/docs/api/index.md +9 -0
- package/docs/api/methods/andThen.md +73 -0
- package/docs/api/methods/err.md +58 -0
- package/docs/api/methods/expect.md +68 -0
- package/docs/api/methods/expectErr.md +68 -0
- package/docs/api/methods/flatten.md +58 -0
- package/docs/api/methods/index.md +24 -0
- package/docs/api/methods/inspect.md +64 -0
- package/docs/api/methods/inspectErr.md +64 -0
- package/docs/api/methods/map.md +70 -0
- package/docs/api/methods/mapErr.md +70 -0
- package/docs/api/methods/match.md +76 -0
- package/docs/api/methods/ok.md +58 -0
- package/docs/api/methods/orElse.md +70 -0
- package/docs/api/methods/tap.md +64 -0
- package/docs/api/methods/tapErr.md +64 -0
- package/docs/api/methods/transpose.md +58 -0
- package/docs/api/methods/unwrap.md +62 -0
- package/docs/api/methods/unwrapErr.md +62 -0
- package/docs/api/methods/unwrapOr.md +64 -0
- package/docs/api/methods/unwrapOrElse.md +64 -0
- package/docs/api/modules.md +10 -0
- package/docs/api/refiners/index.md +14 -0
- package/docs/api/refiners/isTypedVariant.md +62 -0
- package/docs/api/refiners/isTypedVariantOf.md +68 -0
- package/docs/api/refiners/matchVariant.md +59 -0
- package/docs/api/refiners/matchVariantStrict.md +63 -0
- package/docs/api/refiners/refineAsyncResult.md +98 -0
- package/docs/api/refiners/refineAsyncResultU.md +86 -0
- package/docs/api/refiners/refineResult.md +98 -0
- package/docs/api/refiners/refineResultU.md +86 -0
- package/docs/api/refiners/refineVariantMap.md +79 -0
- package/docs/api/type-aliases/Handler.md +49 -0
- package/docs/api/type-aliases/MatchBuilder.md +57 -0
- package/docs/api/type-aliases/Matcher.md +71 -0
- package/docs/api/type-aliases/SyncRefinedResult.md +31 -0
- package/docs/api/type-aliases/SyncRefinedResultUnion.md +21 -0
- package/docs/api/type-aliases/SyncValidatorMap.md +17 -0
- package/docs/api/type-aliases/UniversalAsyncRefinedResult.md +31 -0
- package/docs/api/type-aliases/UniversalRefinedResult.md +31 -0
- package/docs/api/type-aliases/VariantOf.md +23 -0
- package/docs/api/type-aliases/index.md +14 -0
- package/docs/assets/logo.svg +153 -0
- package/docs/examples/_category_.json +4 -0
- package/docs/examples/auth/_category_.json +4 -0
- package/docs/examples/auth/index.md +3 -0
- package/docs/examples/auth/token.md +5 -0
- package/docs/examples/connection/_category_.json +4 -0
- package/docs/examples/connection/connect.md +5 -0
- package/docs/examples/connection/index.md +3 -0
- package/docs/examples/connection/reconnect.md +5 -0
- package/docs/examples/errors/_category_.json +4 -0
- package/docs/examples/errors/index.md +3 -0
- package/docs/examples/errors/retry.md +5 -0
- package/docs/examples/index.md +9 -0
- package/docs/examples/streaming/_category_.json +4 -0
- package/docs/examples/streaming/index.md +3 -0
- package/docs/examples/streaming/text.md +5 -0
- package/package.json +70 -0
|
@@ -0,0 +1,98 @@
|
|
|
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)
|
|
4
|
+
|
|
5
|
+
***
|
|
6
|
+
|
|
7
|
+
[@resultsafe/core-fp-result](../README.md) / refineResult
|
|
8
|
+
|
|
9
|
+
# Функция: refineResult()
|
|
10
|
+
|
|
11
|
+
> **refineResult**\<`TMap`\>(`variantMap`): \<`K`\>(`variant`) => \<`TValidators`\>(`validators`) => (`value`) => `null` \| [`UniversalRefinedResult`](../type-aliases/UniversalRefinedResult.md)\<`K`, `TMap`, `TValidators`\>
|
|
12
|
+
|
|
13
|
+
Создает синхронный refiner варианта с валидаторами payload.
|
|
14
|
+
|
|
15
|
+
## Параметры типа
|
|
16
|
+
|
|
17
|
+
### TMap
|
|
18
|
+
|
|
19
|
+
`TMap` *extends* `Record`\<`string`, `VariantConfig`\>
|
|
20
|
+
|
|
21
|
+
Тип карты конфигурации вариантов.
|
|
22
|
+
|
|
23
|
+
## Параметры
|
|
24
|
+
|
|
25
|
+
### variantMap
|
|
26
|
+
|
|
27
|
+
`TMap`
|
|
28
|
+
|
|
29
|
+
Карта, описывающая допустимые варианты и поля payload.
|
|
30
|
+
|
|
31
|
+
## Возвращает
|
|
32
|
+
|
|
33
|
+
A curried refiner factory bound to `variantMap`.
|
|
34
|
+
|
|
35
|
+
> \<`K`\>(`variant`): \<`TValidators`\>(`validators`) => (`value`) => `null` \| [`UniversalRefinedResult`](../type-aliases/UniversalRefinedResult.md)\<`K`, `TMap`, `TValidators`\>
|
|
36
|
+
|
|
37
|
+
### Параметры типа
|
|
38
|
+
|
|
39
|
+
#### K
|
|
40
|
+
|
|
41
|
+
`K` *extends* `string`
|
|
42
|
+
|
|
43
|
+
### Параметры
|
|
44
|
+
|
|
45
|
+
#### variant
|
|
46
|
+
|
|
47
|
+
`K`
|
|
48
|
+
|
|
49
|
+
### Возвращает
|
|
50
|
+
|
|
51
|
+
> \<`TValidators`\>(`validators`): (`value`) => `null` \| [`UniversalRefinedResult`](../type-aliases/UniversalRefinedResult.md)\<`K`, `TMap`, `TValidators`\>
|
|
52
|
+
|
|
53
|
+
#### Параметры типа
|
|
54
|
+
|
|
55
|
+
##### TValidators
|
|
56
|
+
|
|
57
|
+
`TValidators` *extends* `Partial`\<`Record`\<`PayloadKeys`\<`TMap`\[`K`\]\>, `ValidatorFn`\>\>
|
|
58
|
+
|
|
59
|
+
#### Параметры
|
|
60
|
+
|
|
61
|
+
##### validators
|
|
62
|
+
|
|
63
|
+
`TValidators`
|
|
64
|
+
|
|
65
|
+
#### Возвращает
|
|
66
|
+
|
|
67
|
+
> (`value`): `null` \| [`UniversalRefinedResult`](../type-aliases/UniversalRefinedResult.md)\<`K`, `TMap`, `TValidators`\>
|
|
68
|
+
|
|
69
|
+
##### Параметры
|
|
70
|
+
|
|
71
|
+
###### value
|
|
72
|
+
|
|
73
|
+
`unknown`
|
|
74
|
+
|
|
75
|
+
##### Возвращает
|
|
76
|
+
|
|
77
|
+
`null` \| [`UniversalRefinedResult`](../type-aliases/UniversalRefinedResult.md)\<`K`, `TMap`, `TValidators`\>
|
|
78
|
+
|
|
79
|
+
## Начиная с версии
|
|
80
|
+
|
|
81
|
+
0.1.0
|
|
82
|
+
|
|
83
|
+
## См. также
|
|
84
|
+
|
|
85
|
+
[refineResultU](./refineResultU.md) - Непосредственный (не-curry) вариант helper.
|
|
86
|
+
|
|
87
|
+
## Пример
|
|
88
|
+
|
|
89
|
+
```ts
|
|
90
|
+
import { refineResult } from '@resultsafe/core-fp-result';
|
|
91
|
+
|
|
92
|
+
const map = { ok: { payload: 'value' } } as const;
|
|
93
|
+
const refineOk = refineResult(map)('ok')({
|
|
94
|
+
value: (x: unknown): x is number => typeof x === 'number',
|
|
95
|
+
});
|
|
96
|
+
|
|
97
|
+
console.log(refineOk({ type: 'ok', value: 1 })); // { type: 'ok', value: 1 }
|
|
98
|
+
```
|
|
@@ -0,0 +1,86 @@
|
|
|
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)
|
|
4
|
+
|
|
5
|
+
***
|
|
6
|
+
|
|
7
|
+
[@resultsafe/core-fp-result](../README.md) / refineResultU
|
|
8
|
+
|
|
9
|
+
# Функция: refineResultU()
|
|
10
|
+
|
|
11
|
+
> **refineResultU**\<`TMap`, `K`, `TValidators`\>(`value`, `variant`, `variantMap`, `validators`): `null` \| [`SyncRefinedResult`](../type-aliases/SyncRefinedResult.md)\<`K`, `TMap`, `TValidators`\>
|
|
12
|
+
|
|
13
|
+
Уточняет значение по карте вариантов в не-curry стиле вызова.
|
|
14
|
+
|
|
15
|
+
## Параметры типа
|
|
16
|
+
|
|
17
|
+
### TMap
|
|
18
|
+
|
|
19
|
+
`TMap` *extends* `Record`\<`string`, `VariantConfig`\>
|
|
20
|
+
|
|
21
|
+
Тип карты конфигурации вариантов.
|
|
22
|
+
|
|
23
|
+
### K
|
|
24
|
+
|
|
25
|
+
`K` *extends* `string`
|
|
26
|
+
|
|
27
|
+
Ключ целевого варианта.
|
|
28
|
+
|
|
29
|
+
### TValidators
|
|
30
|
+
|
|
31
|
+
`TValidators` *extends* `Partial`\<`Record`\<`PayloadKeys`\<`TMap`\[`K`\]\>, `ValidatorFn`\>\>
|
|
32
|
+
|
|
33
|
+
Карта валидаторов для полей payload.
|
|
34
|
+
|
|
35
|
+
## Параметры
|
|
36
|
+
|
|
37
|
+
### value
|
|
38
|
+
|
|
39
|
+
`unknown`
|
|
40
|
+
|
|
41
|
+
Значение для валидации и уточнения.
|
|
42
|
+
|
|
43
|
+
### variant
|
|
44
|
+
|
|
45
|
+
`K`
|
|
46
|
+
|
|
47
|
+
Ключ целевого варианта.
|
|
48
|
+
|
|
49
|
+
### variantMap
|
|
50
|
+
|
|
51
|
+
`TMap`
|
|
52
|
+
|
|
53
|
+
Карта конфигурации вариантов.
|
|
54
|
+
|
|
55
|
+
### validators
|
|
56
|
+
|
|
57
|
+
`TValidators`
|
|
58
|
+
|
|
59
|
+
Валидаторы payload для целевого варианта.
|
|
60
|
+
|
|
61
|
+
## Возвращает
|
|
62
|
+
|
|
63
|
+
`null` \| [`SyncRefinedResult`](../type-aliases/SyncRefinedResult.md)\<`K`, `TMap`, `TValidators`\>
|
|
64
|
+
|
|
65
|
+
Уточненное значение или `null`.
|
|
66
|
+
|
|
67
|
+
## Начиная с версии
|
|
68
|
+
|
|
69
|
+
0.1.0
|
|
70
|
+
|
|
71
|
+
## См. также
|
|
72
|
+
|
|
73
|
+
[refineResult](./refineResult.md) - Curry-конструктор refiner.
|
|
74
|
+
|
|
75
|
+
## Пример
|
|
76
|
+
|
|
77
|
+
```ts
|
|
78
|
+
import { refineResultU } from '@resultsafe/core-fp-result';
|
|
79
|
+
|
|
80
|
+
const map = { ok: { payload: 'value' } } as const;
|
|
81
|
+
const out = refineResultU({ type: 'ok', value: 1 }, 'ok', map, {
|
|
82
|
+
value: (x: unknown): x is number => typeof x === 'number',
|
|
83
|
+
});
|
|
84
|
+
|
|
85
|
+
console.log(out?.type); // ok
|
|
86
|
+
```
|
|
@@ -0,0 +1,79 @@
|
|
|
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)
|
|
4
|
+
|
|
5
|
+
***
|
|
6
|
+
|
|
7
|
+
[@resultsafe/core-fp-result](../README.md) / refineVariantMap
|
|
8
|
+
|
|
9
|
+
# Функция: refineVariantMap()
|
|
10
|
+
|
|
11
|
+
> **refineVariantMap**\<`TMap`, `TValidators`\>(`value`, `variantMap`, `validators`): `null` \| [`SyncRefinedResultUnion`](../type-aliases/SyncRefinedResultUnion.md)\<`TMap`, `TValidators`\>
|
|
12
|
+
|
|
13
|
+
Уточняет значение дискриминированного объединения по полной карте вариантов.
|
|
14
|
+
|
|
15
|
+
## Параметры типа
|
|
16
|
+
|
|
17
|
+
### TMap
|
|
18
|
+
|
|
19
|
+
`TMap` *extends* `Record`\<`string`, `VariantConfig`\>
|
|
20
|
+
|
|
21
|
+
Тип карты конфигурации вариантов.
|
|
22
|
+
|
|
23
|
+
### TValidators
|
|
24
|
+
|
|
25
|
+
`TValidators` *extends* [`SyncValidatorMap`](../type-aliases/SyncValidatorMap.md)\<`TMap`\>
|
|
26
|
+
|
|
27
|
+
Тип карты валидаторов по вариантам.
|
|
28
|
+
|
|
29
|
+
## Параметры
|
|
30
|
+
|
|
31
|
+
### value
|
|
32
|
+
|
|
33
|
+
`unknown`
|
|
34
|
+
|
|
35
|
+
Значение для валидации и уточнения.
|
|
36
|
+
|
|
37
|
+
### variantMap
|
|
38
|
+
|
|
39
|
+
`TMap`
|
|
40
|
+
|
|
41
|
+
Полная карта конфигурации вариантов.
|
|
42
|
+
|
|
43
|
+
### validators
|
|
44
|
+
|
|
45
|
+
`TValidators`
|
|
46
|
+
|
|
47
|
+
Валидаторы, сгруппированные по ключу варианта.
|
|
48
|
+
|
|
49
|
+
## Возвращает
|
|
50
|
+
|
|
51
|
+
`null` \| [`SyncRefinedResultUnion`](../type-aliases/SyncRefinedResultUnion.md)\<`TMap`, `TValidators`\>
|
|
52
|
+
|
|
53
|
+
Уточненный элемент объединения или `null`.
|
|
54
|
+
|
|
55
|
+
## Начиная с версии
|
|
56
|
+
|
|
57
|
+
0.1.0
|
|
58
|
+
|
|
59
|
+
## См. также
|
|
60
|
+
|
|
61
|
+
[refineResult](./refineResult.md) - Refines one concrete variant key.
|
|
62
|
+
|
|
63
|
+
## Пример
|
|
64
|
+
|
|
65
|
+
```ts
|
|
66
|
+
import { refineVariantMap } from '@resultsafe/core-fp-result';
|
|
67
|
+
|
|
68
|
+
const map = {
|
|
69
|
+
created: { payload: 'id' },
|
|
70
|
+
failed: { payload: 'reason' },
|
|
71
|
+
} as const;
|
|
72
|
+
|
|
73
|
+
const out = refineVariantMap({ type: 'created', id: '1' }, map, {
|
|
74
|
+
created: { id: (x: unknown): x is string => typeof x === 'string' },
|
|
75
|
+
failed: { reason: (x: unknown): x is string => typeof x === 'string' },
|
|
76
|
+
});
|
|
77
|
+
|
|
78
|
+
console.log(out?.type); // created
|
|
79
|
+
```
|
|
@@ -0,0 +1,49 @@
|
|
|
1
|
+
[**@resultsafe/core-fp-result v0.1.0**](../README.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[@resultsafe/core-fp-result](../README.md) / Handler
|
|
6
|
+
|
|
7
|
+
# Type Alias: Handler\<K, T, R\>
|
|
8
|
+
|
|
9
|
+
> **Handler**\<`K`, `T`, `R`\> = `object`
|
|
10
|
+
|
|
11
|
+
**`Internal`**
|
|
12
|
+
|
|
13
|
+
Описывает запись обработчика варианта во внутренних механизмах matcher.
|
|
14
|
+
|
|
15
|
+
## Type Parameters
|
|
16
|
+
|
|
17
|
+
### K
|
|
18
|
+
|
|
19
|
+
`K` *extends* `string`
|
|
20
|
+
|
|
21
|
+
### T
|
|
22
|
+
|
|
23
|
+
`T` *extends* [`VariantOf`](VariantOf.md)\<`K`\>
|
|
24
|
+
|
|
25
|
+
### R
|
|
26
|
+
|
|
27
|
+
`R`
|
|
28
|
+
|
|
29
|
+
## Properties
|
|
30
|
+
|
|
31
|
+
### variant
|
|
32
|
+
|
|
33
|
+
> `readonly` **variant**: `K`
|
|
34
|
+
|
|
35
|
+
***
|
|
36
|
+
|
|
37
|
+
### fn()
|
|
38
|
+
|
|
39
|
+
> `readonly` **fn**: (`value`) => `R`
|
|
40
|
+
|
|
41
|
+
#### Parameters
|
|
42
|
+
|
|
43
|
+
##### value
|
|
44
|
+
|
|
45
|
+
`Extract`\<`T`, \{ `type`: `K`; \}\>
|
|
46
|
+
|
|
47
|
+
#### Returns
|
|
48
|
+
|
|
49
|
+
`R`
|
|
@@ -0,0 +1,57 @@
|
|
|
1
|
+
[**@resultsafe/core-fp-result v0.1.0**](../README.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[@resultsafe/core-fp-result](../README.md) / MatchBuilder
|
|
6
|
+
|
|
7
|
+
# Type Alias: MatchBuilder\<T, R, Handled\>
|
|
8
|
+
|
|
9
|
+
> **MatchBuilder**\<`T`, `R`, `Handled`\> = `object`
|
|
10
|
+
|
|
11
|
+
Описывает форму строгого builder для matcher.
|
|
12
|
+
|
|
13
|
+
## Type Parameters
|
|
14
|
+
|
|
15
|
+
### T
|
|
16
|
+
|
|
17
|
+
`T` *extends* [`VariantOf`](VariantOf.md)
|
|
18
|
+
|
|
19
|
+
### R
|
|
20
|
+
|
|
21
|
+
`R`
|
|
22
|
+
|
|
23
|
+
### Handled
|
|
24
|
+
|
|
25
|
+
`Handled` *extends* `T`\[`"type"`\] = `never`
|
|
26
|
+
|
|
27
|
+
## Properties
|
|
28
|
+
|
|
29
|
+
### with()
|
|
30
|
+
|
|
31
|
+
> `readonly` **with**: \<`K`\>(`variant`, `fn`) => `MatchBuilder`\<`T`, `R`, `Handled` \| `K`\>
|
|
32
|
+
|
|
33
|
+
#### Type Parameters
|
|
34
|
+
|
|
35
|
+
##### K
|
|
36
|
+
|
|
37
|
+
`K` *extends* `Exclude`\<`T`\[`"type"`\], `Handled`\>
|
|
38
|
+
|
|
39
|
+
#### Parameters
|
|
40
|
+
|
|
41
|
+
##### variant
|
|
42
|
+
|
|
43
|
+
`K`
|
|
44
|
+
|
|
45
|
+
##### fn
|
|
46
|
+
|
|
47
|
+
(`value`) => `R`
|
|
48
|
+
|
|
49
|
+
#### Returns
|
|
50
|
+
|
|
51
|
+
`MatchBuilder`\<`T`, `R`, `Handled` \| `K`\>
|
|
52
|
+
|
|
53
|
+
***
|
|
54
|
+
|
|
55
|
+
### run
|
|
56
|
+
|
|
57
|
+
> `readonly` **run**: `Handled` *extends* `T`\[`"type"`\] ? () => `R` : `never`
|
|
@@ -0,0 +1,71 @@
|
|
|
1
|
+
[**@resultsafe/core-fp-result v0.1.0**](../README.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[@resultsafe/core-fp-result](../README.md) / Matcher
|
|
6
|
+
|
|
7
|
+
# Type Alias: Matcher\<T, R\>
|
|
8
|
+
|
|
9
|
+
> **Matcher**\<`T`, `R`\> = `object`
|
|
10
|
+
|
|
11
|
+
Описывает форму нестрогого builder для matcher.
|
|
12
|
+
|
|
13
|
+
## Type Parameters
|
|
14
|
+
|
|
15
|
+
### T
|
|
16
|
+
|
|
17
|
+
`T` *extends* [`VariantOf`](VariantOf.md)
|
|
18
|
+
|
|
19
|
+
### R
|
|
20
|
+
|
|
21
|
+
`R`
|
|
22
|
+
|
|
23
|
+
## Properties
|
|
24
|
+
|
|
25
|
+
### with()
|
|
26
|
+
|
|
27
|
+
> `readonly` **with**: \<`K`\>(`variant`, `fn`) => `Matcher`\<`T`, `R`\>
|
|
28
|
+
|
|
29
|
+
#### Type Parameters
|
|
30
|
+
|
|
31
|
+
##### K
|
|
32
|
+
|
|
33
|
+
`K` *extends* `T`\[`"type"`\]
|
|
34
|
+
|
|
35
|
+
#### Parameters
|
|
36
|
+
|
|
37
|
+
##### variant
|
|
38
|
+
|
|
39
|
+
`K`
|
|
40
|
+
|
|
41
|
+
##### fn
|
|
42
|
+
|
|
43
|
+
(`value`) => `R`
|
|
44
|
+
|
|
45
|
+
#### Returns
|
|
46
|
+
|
|
47
|
+
`Matcher`\<`T`, `R`\>
|
|
48
|
+
|
|
49
|
+
***
|
|
50
|
+
|
|
51
|
+
### otherwise()
|
|
52
|
+
|
|
53
|
+
> `readonly` **otherwise**: (`fn`) => `object`
|
|
54
|
+
|
|
55
|
+
#### Parameters
|
|
56
|
+
|
|
57
|
+
##### fn
|
|
58
|
+
|
|
59
|
+
(`value`) => `R`
|
|
60
|
+
|
|
61
|
+
#### Returns
|
|
62
|
+
|
|
63
|
+
`object`
|
|
64
|
+
|
|
65
|
+
##### run()
|
|
66
|
+
|
|
67
|
+
> `readonly` **run**: () => `R`
|
|
68
|
+
|
|
69
|
+
###### Returns
|
|
70
|
+
|
|
71
|
+
`R`
|
|
@@ -0,0 +1,31 @@
|
|
|
1
|
+
[**@resultsafe/core-fp-result v0.1.0**](../README.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[@resultsafe/core-fp-result](../README.md) / SyncRefinedResult
|
|
6
|
+
|
|
7
|
+
# Type Alias: SyncRefinedResult\<K, TMap, _TValidators\>
|
|
8
|
+
|
|
9
|
+
> **SyncRefinedResult**\<`K`, `TMap`, `_TValidators`\> = `object` & `Record`\<`PayloadKeys`\<`TMap`\[`K`\]\>, `unknown`\>
|
|
10
|
+
|
|
11
|
+
Описывает синхронно уточненное конкретное значение варианта.
|
|
12
|
+
|
|
13
|
+
## Type Declaration
|
|
14
|
+
|
|
15
|
+
### type
|
|
16
|
+
|
|
17
|
+
> **type**: `K`
|
|
18
|
+
|
|
19
|
+
## Type Parameters
|
|
20
|
+
|
|
21
|
+
### K
|
|
22
|
+
|
|
23
|
+
`K` *extends* keyof `TMap` & `string`
|
|
24
|
+
|
|
25
|
+
### TMap
|
|
26
|
+
|
|
27
|
+
`TMap` *extends* `Record`\<`string`, `VariantConfig`\>
|
|
28
|
+
|
|
29
|
+
### _TValidators
|
|
30
|
+
|
|
31
|
+
`_TValidators` *extends* `Partial`\<`Record`\<`PayloadKeys`\<`TMap`\[`K`\]\>, `ValidatorFn`\>\>
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
[**@resultsafe/core-fp-result v0.1.0**](../README.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[@resultsafe/core-fp-result](../README.md) / SyncRefinedResultUnion
|
|
6
|
+
|
|
7
|
+
# Type Alias: SyncRefinedResultUnion\<TMap, TValidators\>
|
|
8
|
+
|
|
9
|
+
> **SyncRefinedResultUnion**\<`TMap`, `TValidators`\> = `{ [K in keyof TMap & string]: SyncRefinedResult<K, TMap, NonNullable<TValidators[K]>> }`\[keyof `TMap` & `string`\]
|
|
10
|
+
|
|
11
|
+
Описывает объединение синхронно уточненных вариантов.
|
|
12
|
+
|
|
13
|
+
## Type Parameters
|
|
14
|
+
|
|
15
|
+
### TMap
|
|
16
|
+
|
|
17
|
+
`TMap` *extends* `Record`\<`string`, `VariantConfig`\>
|
|
18
|
+
|
|
19
|
+
### TValidators
|
|
20
|
+
|
|
21
|
+
`TValidators` *extends* [`SyncValidatorMap`](SyncValidatorMap.md)\<`TMap`\>
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
[**@resultsafe/core-fp-result v0.1.0**](../README.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[@resultsafe/core-fp-result](../README.md) / SyncValidatorMap
|
|
6
|
+
|
|
7
|
+
# Type Alias: SyncValidatorMap\<TMap\>
|
|
8
|
+
|
|
9
|
+
> **SyncValidatorMap**\<`TMap`\> = `{ [K in keyof TMap]?: Partial<Record<PayloadKeys<TMap[K]>, ValidatorFn>> }`
|
|
10
|
+
|
|
11
|
+
Описывает наборы валидаторов, сгруппированные по ключу варианта.
|
|
12
|
+
|
|
13
|
+
## Type Parameters
|
|
14
|
+
|
|
15
|
+
### TMap
|
|
16
|
+
|
|
17
|
+
`TMap` *extends* `Record`\<`string`, `VariantConfig`\>
|
|
@@ -0,0 +1,31 @@
|
|
|
1
|
+
[**@resultsafe/core-fp-result v0.1.0**](../README.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[@resultsafe/core-fp-result](../README.md) / UniversalAsyncRefinedResult
|
|
6
|
+
|
|
7
|
+
# Type Alias: UniversalAsyncRefinedResult\<K, TMap, _TValidators\>
|
|
8
|
+
|
|
9
|
+
> **UniversalAsyncRefinedResult**\<`K`, `TMap`, `_TValidators`\> = `object` & `Record`\<`string`, `unknown`\>
|
|
10
|
+
|
|
11
|
+
Описывает обобщенное асинхронно уточненное значение варианта.
|
|
12
|
+
|
|
13
|
+
## Type Declaration
|
|
14
|
+
|
|
15
|
+
### type
|
|
16
|
+
|
|
17
|
+
> **type**: `K`
|
|
18
|
+
|
|
19
|
+
## Type Parameters
|
|
20
|
+
|
|
21
|
+
### K
|
|
22
|
+
|
|
23
|
+
`K` *extends* keyof `TMap` & `string`
|
|
24
|
+
|
|
25
|
+
### TMap
|
|
26
|
+
|
|
27
|
+
`TMap` *extends* `Record`\<`string`, `VariantConfig`\>
|
|
28
|
+
|
|
29
|
+
### _TValidators
|
|
30
|
+
|
|
31
|
+
`_TValidators` *extends* `Record`\<`string`, `unknown`\>
|
|
@@ -0,0 +1,31 @@
|
|
|
1
|
+
[**@resultsafe/core-fp-result v0.1.0**](../README.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[@resultsafe/core-fp-result](../README.md) / UniversalRefinedResult
|
|
6
|
+
|
|
7
|
+
# Type Alias: UniversalRefinedResult\<K, TMap, _TValidators\>
|
|
8
|
+
|
|
9
|
+
> **UniversalRefinedResult**\<`K`, `TMap`, `_TValidators`\> = `object` & `Record`\<`string`, `unknown`\>
|
|
10
|
+
|
|
11
|
+
Описывает обобщенное синхронно уточненное значение варианта.
|
|
12
|
+
|
|
13
|
+
## Type Declaration
|
|
14
|
+
|
|
15
|
+
### type
|
|
16
|
+
|
|
17
|
+
> **type**: `K`
|
|
18
|
+
|
|
19
|
+
## Type Parameters
|
|
20
|
+
|
|
21
|
+
### K
|
|
22
|
+
|
|
23
|
+
`K` *extends* keyof `TMap` & `string`
|
|
24
|
+
|
|
25
|
+
### TMap
|
|
26
|
+
|
|
27
|
+
`TMap` *extends* `Record`\<`string`, `VariantConfig`\>
|
|
28
|
+
|
|
29
|
+
### _TValidators
|
|
30
|
+
|
|
31
|
+
`_TValidators` *extends* `Record`\<`string`, `unknown`\>
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
[**@resultsafe/core-fp-result v0.1.0**](../README.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[@resultsafe/core-fp-result](../README.md) / VariantOf
|
|
6
|
+
|
|
7
|
+
# Type Alias: VariantOf\<K\>
|
|
8
|
+
|
|
9
|
+
> **VariantOf**\<`K`\> = `object`
|
|
10
|
+
|
|
11
|
+
Описывает минимальный контракт дискриминированного объединения.
|
|
12
|
+
|
|
13
|
+
## Type Parameters
|
|
14
|
+
|
|
15
|
+
### K
|
|
16
|
+
|
|
17
|
+
`K` *extends* `string` = `string`
|
|
18
|
+
|
|
19
|
+
## Properties
|
|
20
|
+
|
|
21
|
+
### type
|
|
22
|
+
|
|
23
|
+
> **type**: `K`
|
|
@@ -0,0 +1,14 @@
|
|
|
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)
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"Err.js","sources":["../../../src/constructors/Err.ts"],"sourcesContent":["import type { Result } from '../shared-types.js';\n\n/**\n * Создает ошибочное значение `Result` из переданного payload ошибки.\n *\n * @typeParam E - Тип значения ошибки.\n * @typeParam T - The success type for the resulting `Result`.\n * @param error - Payload ошибки для обёртки.\n * @returns A `Result` with `ok: false` and the provided `error`.\n * @since 0.1.0\n * @see {@link Ok} - Creates a successful `Result`.\n * @example\n * ```ts\n * import { Err } from '@resultsafe/core-fp-result';\n *\n * const result = Err<string, number>('boom');\n * console.log(result.ok); // false\n * ```\n * @public\n */\nexport const Err = <E, T = never>(error: E): Result<T, E> =>\n ({ ok: false, error }) as const;\n\r\n\r\n"],"names":[],"mappings":";;AAoBO,MAAM,MAAM,wBAAe,WAC/B,EAAE,IAAI,OAAO,MAAA,IADG;"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"Ok.js","sources":["../../../src/constructors/Ok.ts"],"sourcesContent":["import type { Result } from '../shared-types.js';\n\n/**\n * Создает успешное значение `Result` из переданного payload.\n *\n * @typeParam T - Тип успешного значения.\n * @typeParam E - The error type for the resulting `Result`.\n * @param value - Payload успеха для обёртки.\n * @returns A `Result` with `ok: true` and the provided `value`.\n * @since 0.1.0\n * @see {@link Err} - Creates an error `Result`.\n * @example\n * ```ts\n * import { Ok } from '@resultsafe/core-fp-result';\n *\n * const result = Ok<number, string>(42);\n * console.log(result.ok); // true\n * ```\n * @public\n */\nexport const Ok = <T, E = never>(value: T): Result<T, E> =>\n ({ ok: true, value }) as const;\n\r\n\r\n"],"names":[],"mappings":";;AAoBO,MAAM,KAAK,wBAAe,WAC9B,EAAE,IAAI,MAAM,MAAA,IADG;"}
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
var __defProp = Object.defineProperty;
|
|
2
|
+
var __name = (target, value) => __defProp(target, "name", { value, configurable: true });
|
|
3
|
+
const isErr = /* @__PURE__ */ __name((result) => result.ok === false, "isErr");
|
|
4
|
+
export {
|
|
5
|
+
isErr
|
|
6
|
+
};
|
|
7
|
+
//# sourceMappingURL=isErr.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"isErr.js","sources":["../../../src/guards/isErr.ts"],"sourcesContent":["import type { Result } from '../shared-types.js';\n\n/**\n * Проверяет, находится ли `Result` в ветке ошибки.\n *\n * @typeParam T - Тип успешного значения.\n * @typeParam E - Тип значения ошибки.\n * @param result - `Result` для проверки.\n * @returns `true` when `result.ok` equals `false`.\n * @since 0.1.0\n * @see {@link isOk} - Checks the success branch.\n * @example\n * ```ts\n * import { Err, isErr } from '@resultsafe/core-fp-result';\n *\n * const result = Err('boom');\n * console.log(isErr(result)); // true\n * ```\n * @public\n */\nexport const isErr = <T, E>(\n result: Result<T, E>,\n): result is { ok: false; error: E } => result.ok === false;\n\r\n\r\n"],"names":[],"mappings":";;AAoBO,MAAM,QAAQ,wBACnB,WACsC,OAAO,OAAO,OAFjC;"}
|
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
var __defProp = Object.defineProperty;
|
|
2
|
+
var __name = (target, value) => __defProp(target, "name", { value, configurable: true });
|
|
3
|
+
import { isErr } from "./isErr.js";
|
|
4
|
+
const isErrAnd = /* @__PURE__ */ __name((result, predicate) => isErr(result) && predicate(result.error), "isErrAnd");
|
|
5
|
+
export {
|
|
6
|
+
isErrAnd
|
|
7
|
+
};
|
|
8
|
+
//# sourceMappingURL=isErrAnd.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"isErrAnd.js","sources":["../../../src/guards/isErrAnd.ts"],"sourcesContent":["import { type Result } from '../shared-types.js';\n\nimport { isErr } from './isErr.js';\n\n/**\n * Проверяет, что `Result` завершился ошибкой и удовлетворяет предикату.\n *\n * @typeParam T - Тип успешного значения.\n * @typeParam E - Тип значения ошибки.\n * @param result - `Result` для проверки.\n * @param predicate - Предикат, применяемый к значению ошибки.\n * @returns `true` when the value is `Err` and the predicate returns `true`.\n * @since 0.1.0\n * @see {@link isErr} - Performs the base error check.\n * @example\n * ```ts\n * import { Err, isErrAnd } from '@resultsafe/core-fp-result';\n *\n * const result = Err({ code: 503 });\n * console.log(isErrAnd(result, (error) => error.code >= 500)); // true\n * ```\n * @public\n */\nexport const isErrAnd = <T, E>(\n result: Result<T, E>,\n predicate: (error: E) => boolean,\n): boolean => isErr(result) && predicate(result.error);\n\r\n\r\n"],"names":[],"mappings":";;;AAuBO,MAAM,WAAW,wBACtB,QACA,cACY,MAAM,MAAM,KAAK,UAAU,OAAO,KAAK,GAH7B;"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"isOk.js","sources":["../../../src/guards/isOk.ts"],"sourcesContent":["import type { Result } from '../shared-types.js';\n\n/**\n * Проверяет, находится ли `Result` в ветке успеха.\n *\n * @typeParam T - Тип успешного значения.\n * @typeParam E - Тип значения ошибки.\n * @param result - `Result` для проверки.\n * @returns `true` when `result.ok` equals `true`.\n * @since 0.1.0\n * @see {@link isErr} - Checks the error branch.\n * @example\n * ```ts\n * import { Ok, isOk } from '@resultsafe/core-fp-result';\n *\n * const result = Ok(10);\n * console.log(isOk(result)); // true\n * ```\n * @public\n */\nexport const isOk = <T, E>(\n result: Result<T, E>,\n): result is { ok: true; value: T } => result.ok === true;\n\r\n\r\n"],"names":[],"mappings":";;AAoBO,MAAM,OAAO,wBAClB,WACqC,OAAO,OAAO,MAFjC;"}
|