@zthun/helpful-web 6.7.2 → 7.0.1
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 +15 -11
- package/dist/assets/hierarchy.js +1 -0
- package/dist/assets/highlight.css +0 -14
- package/dist/assets/icons.js +1 -1
- package/dist/assets/icons.svg +1 -1
- package/dist/assets/main.js +5 -5
- package/dist/assets/navigation.js +1 -1
- package/dist/assets/search.js +1 -1
- package/dist/assets/style.css +1405 -1288
- package/dist/classes/{_zthun_helpful_brands.ZBrandBuilder.html → _zthun_helpful-brands.ZBrandBuilder.html} +87 -88
- package/dist/classes/{_zthun_helpful_fn.ZAssert.html → _zthun_helpful-fn.ZAssert.html} +11 -12
- package/dist/classes/_zthun_helpful-fn.ZDeserializeJson.html +10 -0
- package/dist/classes/_zthun_helpful-fn.ZDeserializeTry.html +18 -0
- package/dist/classes/_zthun_helpful-fn.ZQuadrilateralBuilder.html +43 -0
- package/dist/classes/_zthun_helpful-fn.ZQuadrilateralCornersBuilder.html +48 -0
- package/dist/classes/_zthun_helpful-fn.ZRectangle.html +64 -0
- package/dist/classes/{_zthun_helpful_fn.ZSerializeJson.html → _zthun_helpful-fn.ZSerializeJson.html} +6 -7
- package/dist/classes/{_zthun_helpful_internet.ZCookieBuilder.html → _zthun_helpful-internet.ZCookieBuilder.html} +40 -41
- package/dist/classes/{_zthun_helpful_internet.ZEmailBuilder.html → _zthun_helpful-internet.ZEmailBuilder.html} +21 -22
- package/dist/classes/{_zthun_helpful_internet.ZEmailContactAddressBuilder.html → _zthun_helpful-internet.ZEmailContactAddressBuilder.html} +14 -15
- package/dist/classes/{_zthun_helpful_internet.ZEmailContactBuilder.html → _zthun_helpful-internet.ZEmailContactBuilder.html} +20 -21
- package/dist/classes/{_zthun_helpful_internet.ZEmailEnvelopeBuilder.html → _zthun_helpful-internet.ZEmailEnvelopeBuilder.html} +43 -44
- package/dist/classes/{_zthun_helpful_internet.ZServerBuilder.html → _zthun_helpful-internet.ZServerBuilder.html} +21 -22
- package/dist/classes/_zthun_helpful-query.ZDataFilterFields.html +11 -0
- package/dist/classes/{_zthun_helpful_query.ZDataMatchAlways.html → _zthun_helpful-query.ZDataMatchAlways.html} +5 -6
- package/dist/classes/_zthun_helpful-query.ZDataMatchOptional.html +15 -0
- package/dist/classes/{_zthun_helpful_query.ZDataRequestBuilder.html → _zthun_helpful-query.ZDataRequestBuilder.html} +27 -28
- package/dist/classes/_zthun_helpful-query.ZDataSearchFields.html +10 -0
- package/dist/classes/{_zthun_helpful_query.ZDataSearchText.html → _zthun_helpful-query.ZDataSearchText.html} +5 -6
- package/dist/classes/_zthun_helpful-query.ZDataSourceStatic.html +57 -0
- package/dist/classes/_zthun_helpful-query.ZDataSourceStaticOptionsBuilder.html +22 -0
- package/dist/classes/_zthun_helpful-query.ZFilterBinaryBuilder.html +42 -0
- package/dist/classes/{_zthun_helpful_query.ZFilterCollectionBuilder.html → _zthun_helpful-query.ZFilterCollectionBuilder.html} +25 -26
- package/dist/classes/{_zthun_helpful_query.ZFilterDeserialize.html → _zthun_helpful-query.ZFilterDeserialize.html} +7 -8
- package/dist/classes/{_zthun_helpful_query.ZFilterLogicBuilder.html → _zthun_helpful-query.ZFilterLogicBuilder.html} +25 -26
- package/dist/classes/{_zthun_helpful_query.ZFilterSerialize.html → _zthun_helpful-query.ZFilterSerialize.html} +7 -8
- package/dist/classes/{_zthun_helpful_query.ZFilterUnaryBuilder.html → _zthun_helpful-query.ZFilterUnaryBuilder.html} +20 -21
- package/dist/classes/{_zthun_helpful_query.ZMetadataBuilder.html → _zthun_helpful-query.ZMetadataBuilder.html} +55 -56
- package/dist/classes/_zthun_helpful-query.ZPageBuilder.html +30 -0
- package/dist/classes/{_zthun_helpful_query.ZSortBuilder.html → _zthun_helpful-query.ZSortBuilder.html} +17 -18
- package/dist/classes/{_zthun_helpful_query.ZSortDeserialize.html → _zthun_helpful-query.ZSortDeserialize.html} +7 -8
- package/dist/classes/_zthun_helpful-query.ZSortSerialize.html +8 -0
- package/dist/classes/{_zthun_helpful_query.ZSorterSingle.html → _zthun_helpful-query.ZSorterSingle.html} +12 -13
- package/dist/classes/{_zthun_helpful_query.ZWellKnownIconClasses.html → _zthun_helpful-query.ZWellKnownIconClasses.html} +15 -16
- package/dist/classes/{_zthun_helpful_react.ZFileSelect.html → _zthun_helpful-react.ZFileSelect.html} +7 -8
- package/dist/classes/{_zthun_helpful_validation.EqualsOtherPropertyValidator.html → _zthun_helpful-validation.EqualsOtherPropertyValidator.html} +5 -6
- package/dist/classes/{_zthun_helpful_validation.IsDataURILimitValidator.html → _zthun_helpful-validation.IsDataURILimitValidator.html} +5 -6
- package/dist/classes/{_zthun_helpful_validation.IsNotWhiteSpaceValidator.html → _zthun_helpful-validation.IsNotWhiteSpaceValidator.html} +5 -6
- package/dist/classes/{_zthun_helpful_validation.RequiresOtherPropertyValidator.html → _zthun_helpful-validation.RequiresOtherPropertyValidator.html} +5 -6
- package/dist/enums/{_zthun_helpful_fn.ZHorizontalAnchor.html → _zthun_helpful-fn.ZHorizontalAnchor.html} +8 -9
- package/dist/enums/{_zthun_helpful_fn.ZOrientation.html → _zthun_helpful-fn.ZOrientation.html} +6 -7
- package/dist/enums/{_zthun_helpful_fn.ZVerticalAnchor.html → _zthun_helpful-fn.ZVerticalAnchor.html} +8 -9
- package/dist/enums/{_zthun_helpful_query.ZMetadataType.html → _zthun_helpful-query.ZMetadataType.html} +14 -15
- package/dist/enums/{_zthun_helpful_query.ZOperatorBinary.html → _zthun_helpful-query.ZOperatorBinary.html} +16 -17
- package/dist/enums/{_zthun_helpful_query.ZOperatorCollection.html → _zthun_helpful-query.ZOperatorCollection.html} +6 -7
- package/dist/enums/{_zthun_helpful_query.ZOperatorLogic.html → _zthun_helpful-query.ZOperatorLogic.html} +6 -7
- package/dist/enums/{_zthun_helpful_query.ZOperatorUnary.html → _zthun_helpful-query.ZOperatorUnary.html} +6 -7
- package/dist/enums/{_zthun_helpful_query.ZSortDirection.html → _zthun_helpful-query.ZSortDirection.html} +6 -7
- package/dist/functions/{_zthun_helpful_fn.bash.html → _zthun_helpful-fn.bash.html} +5 -6
- package/dist/functions/_zthun_helpful-fn.commaJoinDefined.html +5 -0
- package/dist/functions/{_zthun_helpful_fn.countBuckets.html → _zthun_helpful-fn.countBuckets.html} +3 -4
- package/dist/functions/{_zthun_helpful_fn.createError.html → _zthun_helpful-fn.createError.html} +3 -4
- package/dist/functions/{_zthun_helpful_fn.createGuid.html → _zthun_helpful-fn.createGuid.html} +4 -5
- package/dist/functions/{_zthun_helpful_fn.css.html → _zthun_helpful-fn.css.html} +5 -6
- package/dist/functions/_zthun_helpful-fn.cssJoinDefined.html +5 -0
- package/dist/functions/_zthun_helpful-fn.firstDefined.html +12 -0
- package/dist/functions/_zthun_helpful-fn.firstTruthy.html +12 -0
- package/dist/functions/_zthun_helpful-fn.firstWhere.html +10 -0
- package/dist/functions/{_zthun_helpful_fn.html.html → _zthun_helpful-fn.html.html} +5 -6
- package/dist/functions/_zthun_helpful-fn.isEmptyObject.html +8 -0
- package/dist/functions/{_zthun_helpful_fn.javascript.html → _zthun_helpful-fn.javascript.html} +5 -6
- package/dist/functions/_zthun_helpful-fn.joinDefined.html +9 -0
- package/dist/functions/{_zthun_helpful_fn.js.html → _zthun_helpful-fn.js.html} +5 -6
- package/dist/functions/{_zthun_helpful_fn.markdown.html → _zthun_helpful-fn.markdown.html} +5 -6
- package/dist/functions/{_zthun_helpful_fn.md.html → _zthun_helpful-fn.md.html} +5 -6
- package/dist/functions/_zthun_helpful-fn.optional.html +32 -0
- package/dist/functions/_zthun_helpful-fn.peel.html +8 -0
- package/dist/functions/{_zthun_helpful_fn.peelBetween.html → _zthun_helpful-fn.peelBetween.html} +4 -5
- package/dist/functions/_zthun_helpful-fn.pickBy.html +6 -0
- package/dist/functions/_zthun_helpful-fn.pickDataAttributes.html +4 -0
- package/dist/functions/_zthun_helpful-fn.pickDefined.html +4 -0
- package/dist/functions/_zthun_helpful-fn.pipeJoinDefined.html +5 -0
- package/dist/functions/_zthun_helpful-fn.required.html +9 -0
- package/dist/functions/_zthun_helpful-fn.semiColonJoinDefined.html +5 -0
- package/dist/functions/_zthun_helpful-fn.setFirst.html +16 -0
- package/dist/functions/{_zthun_helpful_fn.sh.html → _zthun_helpful-fn.sh.html} +5 -6
- package/dist/functions/_zthun_helpful-fn.sleep.html +13 -0
- package/dist/functions/_zthun_helpful-fn.spaceJoinDefined.html +5 -0
- package/dist/functions/{_zthun_helpful_fn.tag.html → _zthun_helpful-fn.tag.html} +4 -5
- package/dist/functions/_zthun_helpful-fn.tryFallback.html +13 -0
- package/dist/functions/_zthun_helpful-fn.tryFallbackAsync.html +16 -0
- package/dist/functions/{_zthun_helpful_fn.ts.html → _zthun_helpful-fn.ts.html} +5 -6
- package/dist/functions/{_zthun_helpful_fn.typescript.html → _zthun_helpful-fn.typescript.html} +5 -6
- package/dist/functions/{_zthun_helpful_fn.zsh.html → _zthun_helpful-fn.zsh.html} +5 -6
- package/dist/functions/{_zthun_helpful_node.walk.html → _zthun_helpful-node.walk.html} +5 -6
- package/dist/functions/_zthun_helpful-query.isBinaryFilter.html +4 -0
- package/dist/functions/_zthun_helpful-query.isBinaryOperator.html +4 -0
- package/dist/functions/_zthun_helpful-query.isCollectionFilter.html +4 -0
- package/dist/functions/_zthun_helpful-query.isCollectionOperator.html +4 -0
- package/dist/functions/_zthun_helpful-query.isLogicFilter.html +4 -0
- package/dist/functions/_zthun_helpful-query.isLogicOperator.html +4 -0
- package/dist/functions/_zthun_helpful-query.isUnaryFilter.html +4 -0
- package/dist/functions/_zthun_helpful-query.isUnaryOperator.html +4 -0
- package/dist/functions/_zthun_helpful-react.ZFileSelectContext.html +10 -0
- package/dist/functions/_zthun_helpful-react.ZWindowServiceContext.html +10 -0
- package/dist/functions/_zthun_helpful-react.asStateData.html +18 -0
- package/dist/functions/_zthun_helpful-react.asStateError.html +6 -0
- package/dist/functions/_zthun_helpful-react.createKeyboardActivate.html +7 -0
- package/dist/functions/_zthun_helpful-react.isStateErrored.html +5 -0
- package/dist/functions/_zthun_helpful-react.isStateLoaded.html +5 -0
- package/dist/functions/_zthun_helpful-react.isStateLoading.html +5 -0
- package/dist/functions/_zthun_helpful-react.useAmbassadorState.html +38 -0
- package/dist/functions/_zthun_helpful-react.useAsyncState.html +7 -0
- package/dist/functions/_zthun_helpful-react.useFileSelect.html +3 -0
- package/dist/functions/_zthun_helpful-react.useKeyboardActivate.html +12 -0
- package/dist/functions/_zthun_helpful-react.useMoreViewState.html +12 -0
- package/dist/functions/_zthun_helpful-react.usePageViewState.html +10 -0
- package/dist/functions/_zthun_helpful-react.useStateAsArray.html +8 -0
- package/dist/functions/_zthun_helpful-react.useWindowService.html +3 -0
- package/dist/functions/_zthun_helpful-validation.EqualsOtherProperty.html +5 -0
- package/dist/functions/_zthun_helpful-validation.IsDataURILimit.html +6 -0
- package/dist/functions/_zthun_helpful-validation.IsNotWhiteSpace.html +4 -0
- package/dist/functions/_zthun_helpful-validation.RequiresOtherProperty.html +5 -0
- package/dist/hierarchy.html +1 -2
- package/dist/index.html +2 -3
- package/dist/interfaces/{_zthun_helpful_brands.IZBrand.html → _zthun_helpful-brands.IZBrand.html} +10 -11
- package/dist/interfaces/_zthun_helpful-fn.IZDeserialize.html +11 -0
- package/dist/interfaces/_zthun_helpful-fn.IZPoint2d.html +6 -0
- package/dist/interfaces/_zthun_helpful-fn.IZPoint3d.html +8 -0
- package/dist/interfaces/{_zthun_helpful_fn.IZQuadrilateral.html → _zthun_helpful-fn.IZQuadrilateral.html} +11 -12
- package/dist/interfaces/_zthun_helpful-fn.IZQuadrilateralCorners.html +9 -0
- package/dist/interfaces/_zthun_helpful-fn.IZSerialize.html +9 -0
- package/dist/interfaces/{_zthun_helpful_internet.IZCookie.html → _zthun_helpful-internet.IZCookie.html} +15 -16
- package/dist/interfaces/{_zthun_helpful_internet.IZEmail.html → _zthun_helpful-internet.IZEmail.html} +8 -9
- package/dist/interfaces/{_zthun_helpful_internet.IZEmailContact.html → _zthun_helpful-internet.IZEmailContact.html} +7 -8
- package/dist/interfaces/_zthun_helpful-internet.IZEmailEnvelope.html +13 -0
- package/dist/interfaces/{_zthun_helpful_internet.IZServer.html → _zthun_helpful-internet.IZServer.html} +9 -10
- package/dist/interfaces/{_zthun_helpful_node.ZWalkOptions.html → _zthun_helpful-node.ZWalkOptions.html} +8 -9
- package/dist/interfaces/_zthun_helpful-query.IZDataMatch.html +9 -0
- package/dist/interfaces/{_zthun_helpful_query.IZDataRequest.html → _zthun_helpful-query.IZDataRequest.html} +15 -16
- package/dist/interfaces/{_zthun_helpful_query.IZDataRequestQuery.html → _zthun_helpful-query.IZDataRequestQuery.html} +11 -12
- package/dist/interfaces/{_zthun_helpful_query.IZDataSource.html → _zthun_helpful-query.IZDataSource.html} +10 -11
- package/dist/interfaces/{_zthun_helpful_query.IZDataSourceStaticOptions.html → _zthun_helpful-query.IZDataSourceStaticOptions.html} +7 -8
- package/dist/interfaces/{_zthun_helpful_query.IZFilterBinary.html → _zthun_helpful-query.IZFilterBinary.html} +9 -10
- package/dist/interfaces/{_zthun_helpful_query.IZFilterCollection.html → _zthun_helpful-query.IZFilterCollection.html} +9 -10
- package/dist/interfaces/{_zthun_helpful_query.IZFilterLogic.html → _zthun_helpful-query.IZFilterLogic.html} +8 -9
- package/dist/interfaces/_zthun_helpful-query.IZFilterMetadata.html +6 -0
- package/dist/interfaces/_zthun_helpful-query.IZFilterOperator.html +7 -0
- package/dist/interfaces/_zthun_helpful-query.IZFilterSubject.html +8 -0
- package/dist/interfaces/{_zthun_helpful_query.IZMetadata.html → _zthun_helpful-query.IZMetadata.html} +23 -24
- package/dist/interfaces/{_zthun_helpful_query.IZPage.html → _zthun_helpful-query.IZPage.html} +6 -7
- package/dist/interfaces/{_zthun_helpful_query.IZSort.html → _zthun_helpful-query.IZSort.html} +6 -7
- package/dist/interfaces/_zthun_helpful-query.IZSorter.html +27 -0
- package/dist/interfaces/_zthun_helpful-react.IZFileSelect.html +10 -0
- package/dist/interfaces/{_zthun_helpful_react.IZKeyboardInteraction.html → _zthun_helpful-react.IZKeyboardInteraction.html} +8 -9
- package/dist/modules/_zthun_helpful-brands.html +18 -0
- package/dist/modules/_zthun_helpful-fn.html +7 -0
- package/dist/modules/_zthun_helpful-internet.html +6 -0
- package/dist/modules/_zthun_helpful-node.html +10 -0
- package/dist/modules/_zthun_helpful-query.html +32 -0
- package/dist/modules/_zthun_helpful-react.html +6 -0
- package/dist/modules/_zthun_helpful-validation.html +7 -0
- package/dist/modules.html +1 -2
- package/dist/types/_zthun_helpful-fn.DeepPartial.html +1 -0
- package/dist/types/_zthun_helpful-fn.JoinListInputParameter.html +6 -0
- package/dist/types/_zthun_helpful-fn.PickPredicate.html +1 -0
- package/dist/types/_zthun_helpful-fn.PickResult.html +1 -0
- package/dist/types/_zthun_helpful-fn.RequiredDeep.html +1 -0
- package/dist/types/_zthun_helpful-fn.RequiredPick.html +1 -0
- package/dist/types/_zthun_helpful-fn.ZAnchor.html +11 -0
- package/dist/types/_zthun_helpful-fn.ZCornersHorizontal.html +2 -0
- package/dist/types/_zthun_helpful-fn.ZCornersVertical.html +2 -0
- package/dist/types/_zthun_helpful-fn.ZObligatedValue.html +3 -0
- package/dist/types/_zthun_helpful-fn.ZQuadrilateralCornersLike.html +2 -0
- package/dist/types/_zthun_helpful-fn.ZQuadrilateralLike.html +5 -0
- package/dist/types/_zthun_helpful-fn.ZSideAnchor.html +2 -0
- package/dist/types/_zthun_helpful-query.IZFilter.html +2 -0
- package/dist/types/_zthun_helpful-query.IZFilterUnary.html +2 -0
- package/dist/types/_zthun_helpful-query.ZOperatorFilter.html +2 -0
- package/dist/types/_zthun_helpful-react.ZAmbassadorReducer.html +2 -0
- package/dist/types/_zthun_helpful-react.ZAmbassadorReducerRequired.html +2 -0
- package/dist/types/_zthun_helpful-react.ZAmbassadorSetCurrent.html +2 -0
- package/dist/types/_zthun_helpful-react.ZAsyncDataState.html +8 -0
- package/dist/types/_zthun_helpful-react.ZAsyncDataTuple.html +5 -0
- package/dist/types/_zthun_helpful-react.ZAsyncUseData.html +2 -0
- package/dist/types/_zthun_helpful-react.ZSetStateAsArray.html +1 -0
- package/dist/types/_zthun_helpful-react.ZStateAsArrayReducer.html +1 -0
- package/dist/variables/_zthun_helpful-brands.ZBrands.html +5 -0
- package/dist/variables/_zthun_helpful-fn._global.html +1 -0
- package/dist/variables/_zthun_helpful-query.ZBinaryComparators.html +2 -0
- package/dist/variables/_zthun_helpful-query.ZCollectionComparators.html +2 -0
- package/dist/variables/_zthun_helpful-query.ZOperatorsBinary.html +2 -0
- package/dist/variables/_zthun_helpful-query.ZOperatorsCollection.html +2 -0
- package/dist/variables/_zthun_helpful-query.ZOperatorsFilter.html +2 -0
- package/dist/variables/_zthun_helpful-query.ZOperatorsLogic.html +2 -0
- package/dist/variables/_zthun_helpful-query.ZOperatorsUnary.html +2 -0
- package/dist/variables/_zthun_helpful-query.ZSortDirections.html +2 -0
- package/dist/variables/_zthun_helpful-query.ZUnaryComparators.html +2 -0
- package/dist/variables/_zthun_helpful-react.DefaultActivateCodes.html +4 -0
- package/dist/variables/_zthun_helpful-react.ZAsyncLoading.html +2 -0
- package/package.json +11 -13
- package/dist/classes/_zthun_helpful_fn.ZDeserializeJson.html +0 -11
- package/dist/classes/_zthun_helpful_fn.ZDeserializeTry.html +0 -19
- package/dist/classes/_zthun_helpful_fn.ZQuadrilateralBuilder.html +0 -44
- package/dist/classes/_zthun_helpful_fn.ZQuadrilateralCornersBuilder.html +0 -49
- package/dist/classes/_zthun_helpful_fn.ZRectangle.html +0 -65
- package/dist/classes/_zthun_helpful_query.ZDataFilterFields.html +0 -12
- package/dist/classes/_zthun_helpful_query.ZDataMatchOptional.html +0 -16
- package/dist/classes/_zthun_helpful_query.ZDataSearchFields.html +0 -11
- package/dist/classes/_zthun_helpful_query.ZDataSourceStatic.html +0 -58
- package/dist/classes/_zthun_helpful_query.ZDataSourceStaticOptionsBuilder.html +0 -23
- package/dist/classes/_zthun_helpful_query.ZFilterBinaryBuilder.html +0 -43
- package/dist/classes/_zthun_helpful_query.ZPageBuilder.html +0 -31
- package/dist/classes/_zthun_helpful_query.ZSortSerialize.html +0 -9
- package/dist/functions/_zthun_helpful_fn.commaJoinDefined.html +0 -6
- package/dist/functions/_zthun_helpful_fn.cssJoinDefined.html +0 -6
- package/dist/functions/_zthun_helpful_fn.firstDefined.html +0 -13
- package/dist/functions/_zthun_helpful_fn.firstTruthy.html +0 -13
- package/dist/functions/_zthun_helpful_fn.firstWhere.html +0 -11
- package/dist/functions/_zthun_helpful_fn.isEmptyObject.html +0 -9
- package/dist/functions/_zthun_helpful_fn.joinDefined.html +0 -10
- package/dist/functions/_zthun_helpful_fn.optional.html +0 -33
- package/dist/functions/_zthun_helpful_fn.peel.html +0 -9
- package/dist/functions/_zthun_helpful_fn.pickBy.html +0 -7
- package/dist/functions/_zthun_helpful_fn.pickDataAttributes.html +0 -5
- package/dist/functions/_zthun_helpful_fn.pickDefined.html +0 -5
- package/dist/functions/_zthun_helpful_fn.pipeJoinDefined.html +0 -6
- package/dist/functions/_zthun_helpful_fn.required.html +0 -10
- package/dist/functions/_zthun_helpful_fn.semiColonJoinDefined.html +0 -6
- package/dist/functions/_zthun_helpful_fn.setFirst.html +0 -17
- package/dist/functions/_zthun_helpful_fn.sleep.html +0 -14
- package/dist/functions/_zthun_helpful_fn.spaceJoinDefined.html +0 -6
- package/dist/functions/_zthun_helpful_fn.tryFallback.html +0 -14
- package/dist/functions/_zthun_helpful_fn.tryFallbackAsync.html +0 -17
- package/dist/functions/_zthun_helpful_query.isBinaryFilter.html +0 -5
- package/dist/functions/_zthun_helpful_query.isBinaryOperator.html +0 -5
- package/dist/functions/_zthun_helpful_query.isCollectionFilter.html +0 -5
- package/dist/functions/_zthun_helpful_query.isCollectionOperator.html +0 -5
- package/dist/functions/_zthun_helpful_query.isLogicFilter.html +0 -5
- package/dist/functions/_zthun_helpful_query.isLogicOperator.html +0 -5
- package/dist/functions/_zthun_helpful_query.isUnaryFilter.html +0 -5
- package/dist/functions/_zthun_helpful_query.isUnaryOperator.html +0 -5
- package/dist/functions/_zthun_helpful_react.ZFileSelectContext.html +0 -11
- package/dist/functions/_zthun_helpful_react.ZWindowServiceContext.html +0 -11
- package/dist/functions/_zthun_helpful_react.asStateData.html +0 -19
- package/dist/functions/_zthun_helpful_react.asStateError.html +0 -7
- package/dist/functions/_zthun_helpful_react.createKeyboardActivate.html +0 -8
- package/dist/functions/_zthun_helpful_react.isStateErrored.html +0 -6
- package/dist/functions/_zthun_helpful_react.isStateLoaded.html +0 -6
- package/dist/functions/_zthun_helpful_react.isStateLoading.html +0 -6
- package/dist/functions/_zthun_helpful_react.useAmbassadorState.html +0 -39
- package/dist/functions/_zthun_helpful_react.useAsyncState.html +0 -8
- package/dist/functions/_zthun_helpful_react.useFileSelect.html +0 -4
- package/dist/functions/_zthun_helpful_react.useKeyboardActivate.html +0 -13
- package/dist/functions/_zthun_helpful_react.useMoreViewState.html +0 -13
- package/dist/functions/_zthun_helpful_react.usePageViewState.html +0 -11
- package/dist/functions/_zthun_helpful_react.useStateAsArray.html +0 -9
- package/dist/functions/_zthun_helpful_react.useWindowService.html +0 -4
- package/dist/functions/_zthun_helpful_validation.EqualsOtherProperty.html +0 -6
- package/dist/functions/_zthun_helpful_validation.IsDataURILimit.html +0 -7
- package/dist/functions/_zthun_helpful_validation.IsNotWhiteSpace.html +0 -5
- package/dist/functions/_zthun_helpful_validation.RequiresOtherProperty.html +0 -6
- package/dist/interfaces/_zthun_helpful_fn.IZDeserialize.html +0 -12
- package/dist/interfaces/_zthun_helpful_fn.IZPoint2d.html +0 -7
- package/dist/interfaces/_zthun_helpful_fn.IZPoint3d.html +0 -9
- package/dist/interfaces/_zthun_helpful_fn.IZQuadrilateralCorners.html +0 -10
- package/dist/interfaces/_zthun_helpful_fn.IZSerialize.html +0 -10
- package/dist/interfaces/_zthun_helpful_internet.IZEmailEnvelope.html +0 -14
- package/dist/interfaces/_zthun_helpful_query.IZDataMatch.html +0 -10
- package/dist/interfaces/_zthun_helpful_query.IZFilterMetadata.html +0 -7
- package/dist/interfaces/_zthun_helpful_query.IZFilterOperator.html +0 -8
- package/dist/interfaces/_zthun_helpful_query.IZFilterSubject.html +0 -9
- package/dist/interfaces/_zthun_helpful_query.IZSorter.html +0 -28
- package/dist/interfaces/_zthun_helpful_react.IZFileSelect.html +0 -11
- package/dist/modules/_zthun_helpful_brands.html +0 -22
- package/dist/modules/_zthun_helpful_fn.html +0 -74
- package/dist/modules/_zthun_helpful_internet.html +0 -18
- package/dist/modules/_zthun_helpful_node.html +0 -13
- package/dist/modules/_zthun_helpful_proxy.html +0 -60
- package/dist/modules/_zthun_helpful_query.html +0 -95
- package/dist/modules/_zthun_helpful_react.html +0 -36
- package/dist/modules/_zthun_helpful_validation.html +0 -16
- package/dist/types/_zthun_helpful_fn.DeepPartial.html +0 -2
- package/dist/types/_zthun_helpful_fn.JoinListInputParameter.html +0 -7
- package/dist/types/_zthun_helpful_fn.PickPredicate.html +0 -2
- package/dist/types/_zthun_helpful_fn.PickResult.html +0 -2
- package/dist/types/_zthun_helpful_fn.RequiredDeep.html +0 -2
- package/dist/types/_zthun_helpful_fn.RequiredPick.html +0 -2
- package/dist/types/_zthun_helpful_fn.ZAnchor.html +0 -12
- package/dist/types/_zthun_helpful_fn.ZCornersHorizontal.html +0 -3
- package/dist/types/_zthun_helpful_fn.ZCornersVertical.html +0 -3
- package/dist/types/_zthun_helpful_fn.ZObligatedValue.html +0 -4
- package/dist/types/_zthun_helpful_fn.ZQuadrilateralCornersLike.html +0 -3
- package/dist/types/_zthun_helpful_fn.ZQuadrilateralLike.html +0 -6
- package/dist/types/_zthun_helpful_fn.ZSideAnchor.html +0 -3
- package/dist/types/_zthun_helpful_query.IZFilter.html +0 -3
- package/dist/types/_zthun_helpful_query.IZFilterUnary.html +0 -3
- package/dist/types/_zthun_helpful_query.ZOperatorFilter.html +0 -3
- package/dist/types/_zthun_helpful_react.ZAmbassadorReducer.html +0 -3
- package/dist/types/_zthun_helpful_react.ZAmbassadorReducerRequired.html +0 -3
- package/dist/types/_zthun_helpful_react.ZAmbassadorSetCurrent.html +0 -3
- package/dist/types/_zthun_helpful_react.ZAsyncDataState.html +0 -9
- package/dist/types/_zthun_helpful_react.ZAsyncDataTuple.html +0 -6
- package/dist/types/_zthun_helpful_react.ZAsyncUseData.html +0 -3
- package/dist/types/_zthun_helpful_react.ZSetStateAsArray.html +0 -2
- package/dist/types/_zthun_helpful_react.ZStateAsArrayReducer.html +0 -2
- package/dist/variables/_zthun_helpful_brands.ZBrands.html +0 -6
- package/dist/variables/_zthun_helpful_fn._global.html +0 -2
- package/dist/variables/_zthun_helpful_query.ZBinaryComparators.html +0 -3
- package/dist/variables/_zthun_helpful_query.ZCollectionComparators.html +0 -3
- package/dist/variables/_zthun_helpful_query.ZOperatorsBinary.html +0 -3
- package/dist/variables/_zthun_helpful_query.ZOperatorsCollection.html +0 -3
- package/dist/variables/_zthun_helpful_query.ZOperatorsFilter.html +0 -3
- package/dist/variables/_zthun_helpful_query.ZOperatorsLogic.html +0 -3
- package/dist/variables/_zthun_helpful_query.ZOperatorsUnary.html +0 -3
- package/dist/variables/_zthun_helpful_query.ZSortDirections.html +0 -3
- package/dist/variables/_zthun_helpful_query.ZUnaryComparators.html +0 -3
- package/dist/variables/_zthun_helpful_react.DefaultActivateCodes.html +0 -5
- package/dist/variables/_zthun_helpful_react.ZAsyncLoading.html +0 -3
- /package/dist/{helpful.svg → assets/favicon.svg} +0 -0
|
@@ -1,19 +1,18 @@
|
|
|
1
|
-
<!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>ZAssert | Helpful</title><meta name="description" content="Documentation for Helpful"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><
|
|
2
|
-
</
|
|
3
|
-
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-Example"><h4 class="tsd-anchor-link"><a id="Example" class="tsd-anchor"></a>Example<a href="#Example" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-5">import</span><span class="hl-2"> { </span><span class="hl-6">ZAssert</span><span class="hl-2">, </span><span class="hl-6">createError</span><span class="hl-2"> } </span><span class="hl-5">from</span><span class="hl-2"> </span><span class="hl-3">'@zthun/helpful-fn'</span><span class="hl-2">;</span><br/><br/><span class="hl-4">const</span><span class="hl-2"> </span><span class="hl-7">user</span><span class="hl-2"> = </span><span class="hl-1">readUser</span><span class="hl-2">();</span><br/><br/><span class="hl-6">ZAssert</span><br/><span class="hl-2"> .</span><span class="hl-1">claim</span><span class="hl-2">(</span><span class="hl-6">user</span><span class="hl-2">.</span><span class="hl-6">name</span><span class="hl-2"> != </span><span class="hl-4">null</span><span class="hl-2">, </span><span class="hl-3">'User name is required'</span><span class="hl-2">)</span><br/><span class="hl-2"> .</span><span class="hl-1">claim</span><span class="hl-2">(</span><span class="hl-6">user</span><span class="hl-2">.</span><span class="hl-6">email</span><span class="hl-2"> != </span><span class="hl-4">null</span><span class="hl-2">, </span><span class="hl-3">'User email is required'</span><span class="hl-2">)</span><br/><span class="hl-2"> .</span><span class="hl-1">assert</span><span class="hl-2">((</span><span class="hl-6">m</span><span class="hl-2">) </span><span class="hl-4">=></span><span class="hl-2"> </span><span class="hl-1">createError</span><span class="hl-2">(</span><span class="hl-6">m</span><span class="hl-2">));</span>
|
|
1
|
+
<!DOCTYPE html><html class="default" lang="en" data-base=".."><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>ZAssert | Helpful</title><link rel="icon" href="../assets/favicon.svg" type="image/svg+xml"/><meta name="description" content="Documentation for Helpful"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search"><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">Helpful</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../modules.html">Helpful</a></li><li><a href="../modules/_zthun_helpful-fn.html">@zthun/helpful-fn</a></li><li><a href="_zthun_helpful-fn.ZAssert.html">ZAssert</a></li></ul><h1>Class ZAssert</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>Represents an object that can be used to build a list of assertions.</p>
|
|
2
|
+
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-example"><h4 class="tsd-anchor-link"><a id="example" class="tsd-anchor"></a>Example<a href="#example" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-5">import</span><span class="hl-2"> { </span><span class="hl-6">ZAssert</span><span class="hl-2">, </span><span class="hl-6">createError</span><span class="hl-2"> } </span><span class="hl-5">from</span><span class="hl-2"> </span><span class="hl-3">'@zthun/helpful-fn'</span><span class="hl-2">;</span><br/><br/><span class="hl-4">const</span><span class="hl-2"> </span><span class="hl-7">user</span><span class="hl-2"> = </span><span class="hl-1">readUser</span><span class="hl-2">();</span><br/><br/><span class="hl-6">ZAssert</span><br/><span class="hl-2"> .</span><span class="hl-1">claim</span><span class="hl-2">(</span><span class="hl-6">user</span><span class="hl-2">.</span><span class="hl-6">name</span><span class="hl-2"> != </span><span class="hl-4">null</span><span class="hl-2">, </span><span class="hl-3">'User name is required'</span><span class="hl-2">)</span><br/><span class="hl-2"> .</span><span class="hl-1">claim</span><span class="hl-2">(</span><span class="hl-6">user</span><span class="hl-2">.</span><span class="hl-6">email</span><span class="hl-2"> != </span><span class="hl-4">null</span><span class="hl-2">, </span><span class="hl-3">'User email is required'</span><span class="hl-2">)</span><br/><span class="hl-2"> .</span><span class="hl-1">assert</span><span class="hl-2">((</span><span class="hl-6">m</span><span class="hl-2">) </span><span class="hl-4">=></span><span class="hl-2"> </span><span class="hl-1">createError</span><span class="hl-2">(</span><span class="hl-6">m</span><span class="hl-2">));</span>
|
|
4
3
|
</code><button type="button">Copy</button></pre>
|
|
5
4
|
|
|
6
|
-
</div></div></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/
|
|
7
|
-
<a href="
|
|
8
|
-
<a href="
|
|
9
|
-
</div></section></div></details></section></section><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Methods"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Methods</h2></summary><section><section class="tsd-panel tsd-member"><a id="assert" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>assert</span><a href="#assert" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="assert
|
|
10
|
-
</div><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a id="
|
|
11
|
-
</div><div class="tsd-comment tsd-typography"></div
|
|
5
|
+
</div></div></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/4242131c3dc8013a1721169b7d58b0c9201a9ea8/packages/helpful-fn/src/assert/assert.mts#L17">packages/helpful-fn/src/assert/assert.mts:17</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Methods</h3><div class="tsd-index-list"><a href="_zthun_helpful-fn.ZAssert.html#assert" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>assert</span></a>
|
|
6
|
+
<a href="_zthun_helpful-fn.ZAssert.html#claim" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>claim</span></a>
|
|
7
|
+
<a href="_zthun_helpful-fn.ZAssert.html#claim-2" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>claim</span></a>
|
|
8
|
+
</div></section></div></details></section></section><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Methods"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Methods</h2></summary><section><section class="tsd-panel tsd-member"><a id="assert" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>assert</span><a href="#assert" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="assert-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">assert</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful-fn.ZAssert.html#asserte">E</a> <span class="tsd-signature-keyword">extends</span> <span class="tsd-signature-type">Error</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">fail</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">message</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=></span> <a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful-fn.ZAssert.html#asserte">E</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#assert-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Runs the assertion.</p>
|
|
9
|
+
</div><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a id="asserte" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">E</span><span class="tsd-signature-keyword"> extends </span><span class="tsd-signature-type">Error</span></span></li></ul></section><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">fail</span>: <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">message</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=></span> <a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful-fn.ZAssert.html#asserte">E</a></span><div class="tsd-comment tsd-typography"><p>The factory that is responsible for returning the specified error to throw.</p>
|
|
10
|
+
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/4242131c3dc8013a1721169b7d58b0c9201a9ea8/packages/helpful-fn/src/assert/assert.mts#L63">packages/helpful-fn/src/assert/assert.mts:63</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="claim" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>claim</span><a href="#claim" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="claim-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">claim</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">claim</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">msg</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">this</span><a href="#claim-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Adds a claim.</p>
|
|
12
11
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">claim</span>: <span class="tsd-signature-type">boolean</span></span><div class="tsd-comment tsd-typography"><p>The claim predicate.</p>
|
|
13
12
|
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">msg</span>: <span class="tsd-signature-type">any</span></span><div class="tsd-comment tsd-typography"><p>The message to add if the claim fails.</p>
|
|
14
13
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4><p>This object.</p>
|
|
15
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/
|
|
14
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/4242131c3dc8013a1721169b7d58b0c9201a9ea8/packages/helpful-fn/src/assert/assert.mts#L50">packages/helpful-fn/src/assert/assert.mts:50</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="claim-2" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Static</code><span>claim</span><a href="#claim-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="claim-3" class="tsd-anchor"></a><span class="tsd-kind-call-signature">claim</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">claim</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">msg</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="_zthun_helpful-fn.ZAssert.html" class="tsd-signature-type tsd-kind-class">ZAssert</a><a href="#claim-3" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Initializes a new instance of a ZAssert with one claim.</p>
|
|
16
15
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">claim</span>: <span class="tsd-signature-type">boolean</span></span><div class="tsd-comment tsd-typography"><p>The claim to make.</p>
|
|
17
16
|
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">msg</span>: <span class="tsd-signature-type">any</span></span><div class="tsd-comment tsd-typography"><p>The message to throw if the claim is false.</p>
|
|
18
|
-
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="
|
|
19
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/
|
|
17
|
+
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="_zthun_helpful-fn.ZAssert.html" class="tsd-signature-type tsd-kind-class">ZAssert</a></h4><p>A new ZAssert object with an initial claim.</p>
|
|
18
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/4242131c3dc8013a1721169b7d58b0c9201a9ea8/packages/helpful-fn/src/assert/assert.mts#L29">packages/helpful-fn/src/assert/assert.mts:29</a></li></ul></aside></li></ul></section></section></details></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Methods"><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Methods</summary><div><a href="#assert" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>assert</span></a><a href="#claim" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>claim</span></a><a href="#claim-2" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>claim</span></a></div></details></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html">Helpful</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
<!DOCTYPE html><html class="default" lang="en" data-base=".."><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>ZDeserializeJson | Helpful</title><link rel="icon" href="../assets/favicon.svg" type="image/svg+xml"/><meta name="description" content="Documentation for Helpful"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search"><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">Helpful</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../modules.html">Helpful</a></li><li><a href="../modules/_zthun_helpful-fn.html">@zthun/helpful-fn</a></li><li><a href="_zthun_helpful-fn.ZDeserializeJson.html">ZDeserializeJson</a></li></ul><h1>Class ZDeserializeJson<T></h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>A deserializer that deserializes a JSON string.</p>
|
|
2
|
+
</div><div class="tsd-comment tsd-typography"></div></section> <section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a id="t" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">T</span></span></li></ul></section> <section class="tsd-panel"><h4>Implements</h4><ul class="tsd-hierarchy"><li><a href="../interfaces/_zthun_helpful-fn.IZDeserialize.html" class="tsd-signature-type tsd-kind-interface">IZDeserialize</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful-fn.ZDeserializeJson.html#constructorzdeserializejsont">T</a><span class="tsd-signature-symbol">></span></li></ul></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/4242131c3dc8013a1721169b7d58b0c9201a9ea8/packages/helpful-fn/src/serialize/deserialize-json.mts#L6">packages/helpful-fn/src/serialize/deserialize-json.mts:6</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Constructors</h3><div class="tsd-index-list"><a href="_zthun_helpful-fn.ZDeserializeJson.html#constructor" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a>
|
|
3
|
+
</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Methods</h3><div class="tsd-index-list"><a href="_zthun_helpful-fn.ZDeserializeJson.html#deserialize" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>deserialize</span></a>
|
|
4
|
+
</div></section></div></details></section></section><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Constructors"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Constructors</h2></summary><section><section class="tsd-panel tsd-member"><a id="constructor" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>constructor</span><a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="constructorzdeserializejson" class="tsd-anchor"></a><span class="tsd-signature-keyword">new</span> <span class="tsd-kind-constructor-signature">ZDeserializeJson</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful-fn.ZDeserializeJson.html#constructorzdeserializejsont">T</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">_schema</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">k</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=></span> <span class="tsd-kind-parameter">k</span> <span class="tsd-signature-keyword">is</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful-fn.ZDeserializeJson.html#constructorzdeserializejsont">T</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="_zthun_helpful-fn.ZDeserializeJson.html" class="tsd-signature-type tsd-kind-class">ZDeserializeJson</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful-fn.ZDeserializeJson.html#constructorzdeserializejsont">T</a><span class="tsd-signature-symbol">></span><a href="#constructorzdeserializejson" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a id="constructorzdeserializejsont" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">T</span></span></li></ul></section><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">_schema</span>: <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">k</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=></span> <span class="tsd-kind-parameter">k</span> <span class="tsd-signature-keyword">is</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful-fn.ZDeserializeJson.html#constructorzdeserializejsont">T</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <a href="_zthun_helpful-fn.ZDeserializeJson.html" class="tsd-signature-type tsd-kind-class">ZDeserializeJson</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful-fn.ZDeserializeJson.html#constructorzdeserializejsont">T</a><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/4242131c3dc8013a1721169b7d58b0c9201a9ea8/packages/helpful-fn/src/serialize/deserialize-json.mts#L7">packages/helpful-fn/src/serialize/deserialize-json.mts:7</a></li></ul></aside></li></ul></section></section></details><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Methods"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Methods</h2></summary><section><section class="tsd-panel tsd-member"><a id="deserialize" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>deserialize</span><a href="#deserialize" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="deserialize-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">deserialize</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">candidate</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful-fn.ZDeserializeJson.html#constructorzdeserializejsont">T</a><a href="#deserialize-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Deserializes a candidate string to an object T.</p>
|
|
5
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">candidate</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The candidate string to deserialize.</p>
|
|
6
|
+
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful-fn.ZDeserializeJson.html#constructorzdeserializejsont">T</a></h4><p>The object that was deserialized.</p>
|
|
7
|
+
<div class="tsd-comment tsd-typography"><div class="tsd-tag-throws"><h4 class="tsd-anchor-link"><a id="throws" class="tsd-anchor"></a>Throws<a href="#throws" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>An error if the candidate contains
|
|
8
|
+
semantic errors and cannot be deserialized
|
|
9
|
+
to the given target type.</p>
|
|
10
|
+
</div></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/_zthun_helpful-fn.IZDeserialize.html">IZDeserialize</a>.<a href="../interfaces/_zthun_helpful-fn.IZDeserialize.html#deserialize">deserialize</a></p><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/4242131c3dc8013a1721169b7d58b0c9201a9ea8/packages/helpful-fn/src/serialize/deserialize-json.mts#L9">packages/helpful-fn/src/serialize/deserialize-json.mts:9</a></li></ul></aside></li></ul></section></section></details></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Constructors"><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Constructors</summary><div><a href="#constructor" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a></div></details><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Methods"><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Methods</summary><div><a href="#deserialize" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>deserialize</span></a></div></details></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html">Helpful</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
<!DOCTYPE html><html class="default" lang="en" data-base=".."><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>ZDeserializeTry | Helpful</title><link rel="icon" href="../assets/favicon.svg" type="image/svg+xml"/><meta name="description" content="Documentation for Helpful"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search"><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">Helpful</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../modules.html">Helpful</a></li><li><a href="../modules/_zthun_helpful-fn.html">@zthun/helpful-fn</a></li><li><a href="_zthun_helpful-fn.ZDeserializeTry.html">ZDeserializeTry</a></li></ul><h1>Class ZDeserializeTry<T, S></h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>A deserializer that attempts to deserialize multiple times through a series of supported languages.</p>
|
|
2
|
+
</div><div class="tsd-comment tsd-typography"></div></section> <section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a id="t" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">T</span></span><div class="tsd-comment tsd-typography"><p>The type of data to deserialize.</p>
|
|
3
|
+
</div><div class="tsd-comment tsd-typography"></div></li><li><span><a id="s" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">S</span> = <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The input type</p>
|
|
4
|
+
</div><div class="tsd-comment tsd-typography"></div></li></ul></section> <section class="tsd-panel"><h4>Implements</h4><ul class="tsd-hierarchy"><li><a href="../interfaces/_zthun_helpful-fn.IZDeserialize.html" class="tsd-signature-type tsd-kind-interface">IZDeserialize</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful-fn.ZDeserializeTry.html#constructorzdeserializetryt">T</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful-fn.ZDeserializeTry.html#constructorzdeserializetrys">S</a><span class="tsd-signature-symbol">></span></li></ul></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/4242131c3dc8013a1721169b7d58b0c9201a9ea8/packages/helpful-fn/src/serialize/deserialize-try.mts#L11">packages/helpful-fn/src/serialize/deserialize-try.mts:11</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Constructors</h3><div class="tsd-index-list"><a href="_zthun_helpful-fn.ZDeserializeTry.html#constructor" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a>
|
|
5
|
+
</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Methods</h3><div class="tsd-index-list"><a href="_zthun_helpful-fn.ZDeserializeTry.html#deserialize" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>deserialize</span></a>
|
|
6
|
+
</div></section></div></details></section></section><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Constructors"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Constructors</h2></summary><section><section class="tsd-panel tsd-member"><a id="constructor" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>constructor</span><a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="constructorzdeserializetry" class="tsd-anchor"></a><span class="tsd-signature-keyword">new</span> <span class="tsd-kind-constructor-signature">ZDeserializeTry</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful-fn.ZDeserializeTry.html#constructorzdeserializetryt">T</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful-fn.ZDeserializeTry.html#constructorzdeserializetrys">S</a> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">_children</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/_zthun_helpful-fn.IZDeserialize.html" class="tsd-signature-type tsd-kind-interface">IZDeserialize</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful-fn.ZDeserializeTry.html#constructorzdeserializetryt">T</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful-fn.ZDeserializeTry.html#constructorzdeserializetrys">S</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="_zthun_helpful-fn.ZDeserializeTry.html" class="tsd-signature-type tsd-kind-class">ZDeserializeTry</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful-fn.ZDeserializeTry.html#constructorzdeserializetryt">T</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful-fn.ZDeserializeTry.html#constructorzdeserializetrys">S</a><span class="tsd-signature-symbol">></span><a href="#constructorzdeserializetry" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Initializes a new instance of this object.</p>
|
|
7
|
+
</div><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a id="constructorzdeserializetryt" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">T</span></span></li><li><span><a id="constructorzdeserializetrys" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">S</span> = <span class="tsd-signature-type">string</span></span></li></ul></section><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">_children</span>: <a href="../interfaces/_zthun_helpful-fn.IZDeserialize.html" class="tsd-signature-type tsd-kind-interface">IZDeserialize</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful-fn.ZDeserializeTry.html#constructorzdeserializetryt">T</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful-fn.ZDeserializeTry.html#constructorzdeserializetrys">S</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">[]</span></span><div class="tsd-comment tsd-typography"><p>The list of deserializer objects to try on a specific candidate.
|
|
8
|
+
The first deserializer to succeed will return the target object.
|
|
9
|
+
If no deserializer is able to deserialize the candidate, then an
|
|
10
|
+
error is throw with a mapping of serialization errors between each
|
|
11
|
+
deserializer.</p>
|
|
12
|
+
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="_zthun_helpful-fn.ZDeserializeTry.html" class="tsd-signature-type tsd-kind-class">ZDeserializeTry</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful-fn.ZDeserializeTry.html#constructorzdeserializetryt">T</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful-fn.ZDeserializeTry.html#constructorzdeserializetrys">S</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/4242131c3dc8013a1721169b7d58b0c9201a9ea8/packages/helpful-fn/src/serialize/deserialize-try.mts#L22">packages/helpful-fn/src/serialize/deserialize-try.mts:22</a></li></ul></aside></li></ul></section></section></details><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Methods"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Methods</h2></summary><section><section class="tsd-panel tsd-member"><a id="deserialize" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>deserialize</span><a href="#deserialize" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="deserialize-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">deserialize</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">candidate</span><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful-fn.ZDeserializeTry.html#constructorzdeserializetrys">S</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful-fn.ZDeserializeTry.html#constructorzdeserializetryt">T</a><a href="#deserialize-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Deserializes a candidate string to an object T.</p>
|
|
13
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">candidate</span>: <a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful-fn.ZDeserializeTry.html#constructorzdeserializetrys">S</a></span><div class="tsd-comment tsd-typography"><p>The candidate string to deserialize.</p>
|
|
14
|
+
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful-fn.ZDeserializeTry.html#constructorzdeserializetryt">T</a></h4><p>The object that was deserialized.</p>
|
|
15
|
+
<div class="tsd-comment tsd-typography"><div class="tsd-tag-throws"><h4 class="tsd-anchor-link"><a id="throws" class="tsd-anchor"></a>Throws<a href="#throws" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>An error if the candidate contains
|
|
16
|
+
semantic errors and cannot be deserialized
|
|
17
|
+
to the given target type.</p>
|
|
18
|
+
</div></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/_zthun_helpful-fn.IZDeserialize.html">IZDeserialize</a>.<a href="../interfaces/_zthun_helpful-fn.IZDeserialize.html#deserialize">deserialize</a></p><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/4242131c3dc8013a1721169b7d58b0c9201a9ea8/packages/helpful-fn/src/serialize/deserialize-try.mts#L24">packages/helpful-fn/src/serialize/deserialize-try.mts:24</a></li></ul></aside></li></ul></section></section></details></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Constructors"><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Constructors</summary><div><a href="#constructor" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a></div></details><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Methods"><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Methods</summary><div><a href="#deserialize" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>deserialize</span></a></div></details></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html">Helpful</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
|
|
@@ -0,0 +1,43 @@
|
|
|
1
|
+
<!DOCTYPE html><html class="default" lang="en" data-base=".."><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>ZQuadrilateralBuilder | Helpful</title><link rel="icon" href="../assets/favicon.svg" type="image/svg+xml"/><meta name="description" content="Documentation for Helpful"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search"><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">Helpful</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../modules.html">Helpful</a></li><li><a href="../modules/_zthun_helpful-fn.html">@zthun/helpful-fn</a></li><li><a href="_zthun_helpful-fn.ZQuadrilateralBuilder.html">ZQuadrilateralBuilder</a></li></ul><h1>Class ZQuadrilateralBuilder<T></h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>Represents a builder for a quadrilateral object.</p>
|
|
2
|
+
</div><div class="tsd-comment tsd-typography"></div></section> <section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a id="t" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">T</span> = <span class="tsd-signature-type">number</span></span></li></ul></section> <aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/4242131c3dc8013a1721169b7d58b0c9201a9ea8/packages/helpful-fn/src/geometry/quadrilateral.mts#L47">packages/helpful-fn/src/geometry/quadrilateral.mts:47</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Constructors</h3><div class="tsd-index-list"><a href="_zthun_helpful-fn.ZQuadrilateralBuilder.html#constructor" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a>
|
|
3
|
+
</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Methods</h3><div class="tsd-index-list"><a href="_zthun_helpful-fn.ZQuadrilateralBuilder.html#bottom" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>bottom</span></a>
|
|
4
|
+
<a href="_zthun_helpful-fn.ZQuadrilateralBuilder.html#build" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>build</span></a>
|
|
5
|
+
<a href="_zthun_helpful-fn.ZQuadrilateralBuilder.html#copy" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>copy</span></a>
|
|
6
|
+
<a href="_zthun_helpful-fn.ZQuadrilateralBuilder.html#from" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>from</span></a>
|
|
7
|
+
<a href="_zthun_helpful-fn.ZQuadrilateralBuilder.html#left" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>left</span></a>
|
|
8
|
+
<a href="_zthun_helpful-fn.ZQuadrilateralBuilder.html#right" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>right</span></a>
|
|
9
|
+
<a href="_zthun_helpful-fn.ZQuadrilateralBuilder.html#top" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>top</span></a>
|
|
10
|
+
<a href="_zthun_helpful-fn.ZQuadrilateralBuilder.html#x" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>x</span></a>
|
|
11
|
+
<a href="_zthun_helpful-fn.ZQuadrilateralBuilder.html#y" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>y</span></a>
|
|
12
|
+
</div></section></div></details></section></section><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Constructors"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Constructors</h2></summary><section><section class="tsd-panel tsd-member"><a id="constructor" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>constructor</span><a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="constructorzquadrilateralbuilder" class="tsd-anchor"></a><span class="tsd-signature-keyword">new</span> <span class="tsd-kind-constructor-signature">ZQuadrilateralBuilder</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful-fn.ZQuadrilateralBuilder.html#constructorzquadrilateralbuildert">T</a> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">start</span><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful-fn.ZQuadrilateralBuilder.html#constructorzquadrilateralbuildert">T</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="_zthun_helpful-fn.ZQuadrilateralBuilder.html" class="tsd-signature-type tsd-kind-class">ZQuadrilateralBuilder</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful-fn.ZQuadrilateralBuilder.html#constructorzquadrilateralbuildert">T</a><span class="tsd-signature-symbol">></span><a href="#constructorzquadrilateralbuilder" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Initializes a new instance of this object.</p>
|
|
13
|
+
</div><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a id="constructorzquadrilateralbuildert" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">T</span> = <span class="tsd-signature-type">number</span></span></li></ul></section><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">start</span>: <a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful-fn.ZQuadrilateralBuilder.html#constructorzquadrilateralbuildert">T</a></span><div class="tsd-comment tsd-typography"><p>The starting value.</p>
|
|
14
|
+
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="_zthun_helpful-fn.ZQuadrilateralBuilder.html" class="tsd-signature-type tsd-kind-class">ZQuadrilateralBuilder</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful-fn.ZQuadrilateralBuilder.html#constructorzquadrilateralbuildert">T</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/4242131c3dc8013a1721169b7d58b0c9201a9ea8/packages/helpful-fn/src/geometry/quadrilateral.mts#L56">packages/helpful-fn/src/geometry/quadrilateral.mts:56</a></li></ul></aside></li></ul></section></section></details><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Methods"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Methods</h2></summary><section><section class="tsd-panel tsd-member"><a id="bottom" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>bottom</span><a href="#bottom" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="bottom-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">bottom</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">bottom</span><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful-fn.ZQuadrilateralBuilder.html#constructorzquadrilateralbuildert">T</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">this</span><a href="#bottom-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Sets the bottom value.</p>
|
|
15
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">bottom</span>: <a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful-fn.ZQuadrilateralBuilder.html#constructorzquadrilateralbuildert">T</a></span><div class="tsd-comment tsd-typography"><p>The bottom value.</p>
|
|
16
|
+
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4><p>This object.</p>
|
|
17
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/4242131c3dc8013a1721169b7d58b0c9201a9ea8/packages/helpful-fn/src/geometry/quadrilateral.mts#L74">packages/helpful-fn/src/geometry/quadrilateral.mts:74</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="build" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>build</span><a href="#build" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="build-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">build</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/_zthun_helpful-fn.IZQuadrilateral.html" class="tsd-signature-type tsd-kind-interface">IZQuadrilateral</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful-fn.ZQuadrilateralBuilder.html#constructorzquadrilateralbuildert">T</a><span class="tsd-signature-symbol">></span><a href="#build-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns the built quadrilateral object.</p>
|
|
18
|
+
</div><h4 class="tsd-returns-title">Returns <a href="../interfaces/_zthun_helpful-fn.IZQuadrilateral.html" class="tsd-signature-type tsd-kind-interface">IZQuadrilateral</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful-fn.ZQuadrilateralBuilder.html#constructorzquadrilateralbuildert">T</a><span class="tsd-signature-symbol">></span></h4><p>The built quadrilateral.</p>
|
|
19
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/4242131c3dc8013a1721169b7d58b0c9201a9ea8/packages/helpful-fn/src/geometry/quadrilateral.mts#L236">packages/helpful-fn/src/geometry/quadrilateral.mts:236</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="copy" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>copy</span><a href="#copy" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="copy-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">copy</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">other</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/_zthun_helpful-fn.IZQuadrilateral.html" class="tsd-signature-type tsd-kind-interface">IZQuadrilateral</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful-fn.ZQuadrilateralBuilder.html#constructorzquadrilateralbuildert">T</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">this</span><a href="#copy-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Copies another quadrilateral object into the current instance.</p>
|
|
20
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">other</span>: <a href="../interfaces/_zthun_helpful-fn.IZQuadrilateral.html" class="tsd-signature-type tsd-kind-interface">IZQuadrilateral</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful-fn.ZQuadrilateralBuilder.html#constructorzquadrilateralbuildert">T</a><span class="tsd-signature-symbol">></span></span><div class="tsd-comment tsd-typography"><p>The quadrilateral object to copy.</p>
|
|
21
|
+
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4><p>This object.</p>
|
|
22
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/4242131c3dc8013a1721169b7d58b0c9201a9ea8/packages/helpful-fn/src/geometry/quadrilateral.mts#L218">packages/helpful-fn/src/geometry/quadrilateral.mts:218</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="from" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>from</span><a href="#from" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="from-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">from</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">other</span><span class="tsd-signature-symbol">:</span> <a href="../types/_zthun_helpful-fn.ZQuadrilateralLike.html" class="tsd-signature-type tsd-kind-type-alias">ZQuadrilateralLike</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful-fn.ZQuadrilateralBuilder.html#constructorzquadrilateralbuildert">T</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">this</span><a href="#from-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Constructs a full quadrilateral from an object that describes a quadrilateral.</p>
|
|
23
|
+
<p>Note the limitations of this method. If T is of type Quadrilateral or Point2d,
|
|
24
|
+
then this method's behavior is undefined and it will most likely build a
|
|
25
|
+
corrupt object.</p>
|
|
26
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">other</span>: <a href="../types/_zthun_helpful-fn.ZQuadrilateralLike.html" class="tsd-signature-type tsd-kind-type-alias">ZQuadrilateralLike</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful-fn.ZQuadrilateralBuilder.html#constructorzquadrilateralbuildert">T</a><span class="tsd-signature-symbol">></span></span><div class="tsd-comment tsd-typography"><p>The object to build from.</p>
|
|
27
|
+
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4><p>This object.</p>
|
|
28
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/4242131c3dc8013a1721169b7d58b0c9201a9ea8/packages/helpful-fn/src/geometry/quadrilateral.mts#L160">packages/helpful-fn/src/geometry/quadrilateral.mts:160</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="left" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>left</span><a href="#left" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="left-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">left</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">left</span><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful-fn.ZQuadrilateralBuilder.html#constructorzquadrilateralbuildert">T</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">this</span><a href="#left-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Sets the left value.</p>
|
|
29
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">left</span>: <a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful-fn.ZQuadrilateralBuilder.html#constructorzquadrilateralbuildert">T</a></span><div class="tsd-comment tsd-typography"><p>The left value.</p>
|
|
30
|
+
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4><p>This object.</p>
|
|
31
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/4242131c3dc8013a1721169b7d58b0c9201a9ea8/packages/helpful-fn/src/geometry/quadrilateral.mts#L88">packages/helpful-fn/src/geometry/quadrilateral.mts:88</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="right" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>right</span><a href="#right" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="right-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">right</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">right</span><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful-fn.ZQuadrilateralBuilder.html#constructorzquadrilateralbuildert">T</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">this</span><a href="#right-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Sets the right value.</p>
|
|
32
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">right</span>: <a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful-fn.ZQuadrilateralBuilder.html#constructorzquadrilateralbuildert">T</a></span><div class="tsd-comment tsd-typography"><p>The right value.</p>
|
|
33
|
+
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4><p>This object.</p>
|
|
34
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/4242131c3dc8013a1721169b7d58b0c9201a9ea8/packages/helpful-fn/src/geometry/quadrilateral.mts#L102">packages/helpful-fn/src/geometry/quadrilateral.mts:102</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="top" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>top</span><a href="#top" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="top-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">top</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">top</span><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful-fn.ZQuadrilateralBuilder.html#constructorzquadrilateralbuildert">T</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">this</span><a href="#top-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Sets the top value.</p>
|
|
35
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">top</span>: <a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful-fn.ZQuadrilateralBuilder.html#constructorzquadrilateralbuildert">T</a></span><div class="tsd-comment tsd-typography"><p>The top value.</p>
|
|
36
|
+
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4><p>This object.</p>
|
|
37
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/4242131c3dc8013a1721169b7d58b0c9201a9ea8/packages/helpful-fn/src/geometry/quadrilateral.mts#L116">packages/helpful-fn/src/geometry/quadrilateral.mts:116</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="x" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>x</span><a href="#x" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="x-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">x</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">x</span><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful-fn.ZQuadrilateralBuilder.html#constructorzquadrilateralbuildert">T</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">this</span><a href="#x-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Sets the left and right value.</p>
|
|
38
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">x</span>: <a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful-fn.ZQuadrilateralBuilder.html#constructorzquadrilateralbuildert">T</a></span><div class="tsd-comment tsd-typography"><p>The left and right value.</p>
|
|
39
|
+
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4><p>This object.</p>
|
|
40
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/4242131c3dc8013a1721169b7d58b0c9201a9ea8/packages/helpful-fn/src/geometry/quadrilateral.mts#L130">packages/helpful-fn/src/geometry/quadrilateral.mts:130</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="y" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>y</span><a href="#y" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="y-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">y</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">y</span><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful-fn.ZQuadrilateralBuilder.html#constructorzquadrilateralbuildert">T</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">this</span><a href="#y-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Sets the top and bottom value.</p>
|
|
41
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">y</span>: <a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful-fn.ZQuadrilateralBuilder.html#constructorzquadrilateralbuildert">T</a></span><div class="tsd-comment tsd-typography"><p>The top and bottom value.</p>
|
|
42
|
+
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4><p>This object.</p>
|
|
43
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/4242131c3dc8013a1721169b7d58b0c9201a9ea8/packages/helpful-fn/src/geometry/quadrilateral.mts#L143">packages/helpful-fn/src/geometry/quadrilateral.mts:143</a></li></ul></aside></li></ul></section></section></details></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Constructors"><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Constructors</summary><div><a href="#constructor" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a></div></details><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Methods"><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Methods</summary><div><a href="#bottom" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>bottom</span></a><a href="#build" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>build</span></a><a href="#copy" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>copy</span></a><a href="#from" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>from</span></a><a href="#left" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>left</span></a><a href="#right" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>right</span></a><a href="#top" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>top</span></a><a href="#x" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>x</span></a><a href="#y" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>y</span></a></div></details></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html">Helpful</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
|