@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,49 +0,0 @@
|
|
|
1
|
-
<!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>ZQuadrilateralCornersBuilder | 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><link rel="icon" href="../helpful.svg" />
|
|
2
|
-
</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" data-base=".."><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.ZQuadrilateralCornersBuilder.html">ZQuadrilateralCornersBuilder</a></li></ul><h1>Class ZQuadrilateralCornersBuilder<T></h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>An object that can be used to build an <a href="../interfaces/_zthun_helpful_fn.IZQuadrilateralCorners.html" class="tsd-kind-interface">IZQuadrilateralCorners</a> object.</p>
|
|
3
|
-
</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><div class="tsd-comment tsd-typography"><p>The type of data to associate to each corner.</p>
|
|
4
|
-
</div><div class="tsd-comment tsd-typography"></div></li></ul></section> <aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/ce166906b78f0ba06c3593e8b6ff3e5bbb88e101/packages/helpful-fn/src/geometry/quadrilateral-corners.mts#L53">packages/helpful-fn/src/geometry/quadrilateral-corners.mts:53</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.ZQuadrilateralCornersBuilder.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.ZQuadrilateralCornersBuilder.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>
|
|
6
|
-
<a href="_zthun_helpful_fn.ZQuadrilateralCornersBuilder.html#bottomLeft" 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<wbr/>Left</span></a>
|
|
7
|
-
<a href="_zthun_helpful_fn.ZQuadrilateralCornersBuilder.html#bottomRight" 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<wbr/>Right</span></a>
|
|
8
|
-
<a href="_zthun_helpful_fn.ZQuadrilateralCornersBuilder.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>
|
|
9
|
-
<a href="_zthun_helpful_fn.ZQuadrilateralCornersBuilder.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>
|
|
10
|
-
<a href="_zthun_helpful_fn.ZQuadrilateralCornersBuilder.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>
|
|
11
|
-
<a href="_zthun_helpful_fn.ZQuadrilateralCornersBuilder.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>
|
|
12
|
-
<a href="_zthun_helpful_fn.ZQuadrilateralCornersBuilder.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>
|
|
13
|
-
<a href="_zthun_helpful_fn.ZQuadrilateralCornersBuilder.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>
|
|
14
|
-
<a href="_zthun_helpful_fn.ZQuadrilateralCornersBuilder.html#topLeft" 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<wbr/>Left</span></a>
|
|
15
|
-
<a href="_zthun_helpful_fn.ZQuadrilateralCornersBuilder.html#topRight" 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<wbr/>Right</span></a>
|
|
16
|
-
</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="constructor.new_ZQuadrilateralCornersBuilder" class="tsd-anchor"></a><span class="tsd-kind-constructor-signature">new ZQuadrilateral<wbr/>Corners<wbr/>Builder</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful_fn.ZQuadrilateralCornersBuilder.html#constructor.new_ZQuadrilateralCornersBuilder.T-1">T</a><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><span class="tsd-signature-symbol">: </span><a href="_zthun_helpful_fn.ZQuadrilateralCornersBuilder.html" class="tsd-signature-type tsd-kind-class">ZQuadrilateralCornersBuilder</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful_fn.ZQuadrilateralCornersBuilder.html#constructor.new_ZQuadrilateralCornersBuilder.T-1">T</a><span class="tsd-signature-symbol">></span><a href="#constructor.new_ZQuadrilateralCornersBuilder" 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="constructor.new_ZQuadrilateralCornersBuilder.T-1" 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.ZQuadrilateralCornersBuilder.html#constructor.new_ZQuadrilateralCornersBuilder.T-1">T</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <a href="_zthun_helpful_fn.ZQuadrilateralCornersBuilder.html" class="tsd-signature-type tsd-kind-class">ZQuadrilateralCornersBuilder</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful_fn.ZQuadrilateralCornersBuilder.html#constructor.new_ZQuadrilateralCornersBuilder.T-1">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/ce166906b78f0ba06c3593e8b6ff3e5bbb88e101/packages/helpful-fn/src/geometry/quadrilateral-corners.mts#L56">packages/helpful-fn/src/geometry/quadrilateral-corners.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.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">value</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">this</span><a href="#bottom.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 left and bottom right values.</p>
|
|
17
|
-
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">value</span>: <a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful_fn.ZQuadrilateralCornersBuilder.html#constructor.new_ZQuadrilateralCornersBuilder.T-1">T</a></span><div class="tsd-comment tsd-typography"><p>The value for bottom left and bottom right.</p>
|
|
18
|
-
</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>
|
|
19
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/ce166906b78f0ba06c3593e8b6ff3e5bbb88e101/packages/helpful-fn/src/geometry/quadrilateral-corners.mts#L130">packages/helpful-fn/src/geometry/quadrilateral-corners.mts:130</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="bottomLeft" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>bottom<wbr/>Left</span><a href="#bottomLeft" 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="bottomLeft.bottomLeft-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">bottom<wbr/>Left</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">value</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">this</span><a href="#bottomLeft.bottomLeft-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 left corner value.</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">value</span>: <a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful_fn.ZQuadrilateralCornersBuilder.html#constructor.new_ZQuadrilateralCornersBuilder.T-1">T</a></span><div class="tsd-comment tsd-typography"><p>The value to set.</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/ce166906b78f0ba06c3593e8b6ff3e5bbb88e101/packages/helpful-fn/src/geometry/quadrilateral-corners.mts#L74">packages/helpful-fn/src/geometry/quadrilateral-corners.mts:74</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="bottomRight" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>bottom<wbr/>Right</span><a href="#bottomRight" 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="bottomRight.bottomRight-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">bottom<wbr/>Right</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">value</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">this</span><a href="#bottomRight.bottomRight-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 right corner value.</p>
|
|
23
|
-
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">value</span>: <a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful_fn.ZQuadrilateralCornersBuilder.html#constructor.new_ZQuadrilateralCornersBuilder.T-1">T</a></span><div class="tsd-comment tsd-typography"><p>The value to set.</p>
|
|
24
|
-
</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>
|
|
25
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/ce166906b78f0ba06c3593e8b6ff3e5bbb88e101/packages/helpful-fn/src/geometry/quadrilateral-corners.mts#L88">packages/helpful-fn/src/geometry/quadrilateral-corners.mts:88</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.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><span class="tsd-signature-symbol">: </span><a href="../interfaces/_zthun_helpful_fn.IZQuadrilateralCorners.html" class="tsd-signature-type tsd-kind-interface">IZQuadrilateralCorners</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful_fn.ZQuadrilateralCornersBuilder.html#constructor.new_ZQuadrilateralCornersBuilder.T-1">T</a><span class="tsd-signature-symbol">></span><a href="#build.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>Builds the corners.</p>
|
|
26
|
-
</div><h4 class="tsd-returns-title">Returns <a href="../interfaces/_zthun_helpful_fn.IZQuadrilateralCorners.html" class="tsd-signature-type tsd-kind-interface">IZQuadrilateralCorners</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful_fn.ZQuadrilateralCornersBuilder.html#constructor.new_ZQuadrilateralCornersBuilder.T-1">T</a><span class="tsd-signature-symbol">></span></h4><p>The built corners.</p>
|
|
27
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/ce166906b78f0ba06c3593e8b6ff3e5bbb88e101/packages/helpful-fn/src/geometry/quadrilateral-corners.mts#L272">packages/helpful-fn/src/geometry/quadrilateral-corners.mts:272</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.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><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">this</span><a href="#copy.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 corners object into this builder.</p>
|
|
28
|
-
</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.IZQuadrilateralCorners.html" class="tsd-signature-type tsd-kind-interface">IZQuadrilateralCorners</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful_fn.ZQuadrilateralCornersBuilder.html#constructor.new_ZQuadrilateralCornersBuilder.T-1">T</a><span class="tsd-signature-symbol">></span></span><div class="tsd-comment tsd-typography"><p>The corners object to copy.</p>
|
|
29
|
-
</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>
|
|
30
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/ce166906b78f0ba06c3593e8b6ff3e5bbb88e101/packages/helpful-fn/src/geometry/quadrilateral-corners.mts#L261">packages/helpful-fn/src/geometry/quadrilateral-corners.mts:261</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.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><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">this</span><a href="#from.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>Sets the corner values based on an object that
|
|
31
|
-
describes a set of quadrilateral corners.</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">other</span>: <a href="../types/_zthun_helpful_fn.ZQuadrilateralCornersLike.html" class="tsd-signature-type tsd-kind-type-alias">ZQuadrilateralCornersLike</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful_fn.ZQuadrilateralCornersBuilder.html#constructor.new_ZQuadrilateralCornersBuilder.T-1">T</a><span class="tsd-signature-symbol">></span></span><div class="tsd-comment tsd-typography"><p>The object that describes the corners.</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/ce166906b78f0ba06c3593e8b6ff3e5bbb88e101/packages/helpful-fn/src/geometry/quadrilateral-corners.mts#L183">packages/helpful-fn/src/geometry/quadrilateral-corners.mts:183</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.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">value</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">this</span><a href="#left.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 bottom left and top left values.</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">value</span>: <a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful_fn.ZQuadrilateralCornersBuilder.html#constructor.new_ZQuadrilateralCornersBuilder.T-1">T</a></span><div class="tsd-comment tsd-typography"><p>The value for bottom left and top left.</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/ce166906b78f0ba06c3593e8b6ff3e5bbb88e101/packages/helpful-fn/src/geometry/quadrilateral-corners.mts#L143">packages/helpful-fn/src/geometry/quadrilateral-corners.mts:143</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.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">value</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">this</span><a href="#right.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 bottom right and top right values.</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">value</span>: <a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful_fn.ZQuadrilateralCornersBuilder.html#constructor.new_ZQuadrilateralCornersBuilder.T-1">T</a></span><div class="tsd-comment tsd-typography"><p>The value for bottom right and top right.</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/ce166906b78f0ba06c3593e8b6ff3e5bbb88e101/packages/helpful-fn/src/geometry/quadrilateral-corners.mts#L156">packages/helpful-fn/src/geometry/quadrilateral-corners.mts:156</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.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">value</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">this</span><a href="#top.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 left and top right values.</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">value</span>: <a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful_fn.ZQuadrilateralCornersBuilder.html#constructor.new_ZQuadrilateralCornersBuilder.T-1">T</a></span><div class="tsd-comment tsd-typography"><p>The value for top left and top right.</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/ce166906b78f0ba06c3593e8b6ff3e5bbb88e101/packages/helpful-fn/src/geometry/quadrilateral-corners.mts#L169">packages/helpful-fn/src/geometry/quadrilateral-corners.mts:169</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="topLeft" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>top<wbr/>Left</span><a href="#topLeft" 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="topLeft.topLeft-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">top<wbr/>Left</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">value</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">this</span><a href="#topLeft.topLeft-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 left corner value.</p>
|
|
44
|
-
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">value</span>: <a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful_fn.ZQuadrilateralCornersBuilder.html#constructor.new_ZQuadrilateralCornersBuilder.T-1">T</a></span><div class="tsd-comment tsd-typography"><p>The value to set.</p>
|
|
45
|
-
</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>
|
|
46
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/ce166906b78f0ba06c3593e8b6ff3e5bbb88e101/packages/helpful-fn/src/geometry/quadrilateral-corners.mts#L102">packages/helpful-fn/src/geometry/quadrilateral-corners.mts:102</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="topRight" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>top<wbr/>Right</span><a href="#topRight" 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="topRight.topRight-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">top<wbr/>Right</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">value</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">this</span><a href="#topRight.topRight-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 right corner value.</p>
|
|
47
|
-
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">value</span>: <a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful_fn.ZQuadrilateralCornersBuilder.html#constructor.new_ZQuadrilateralCornersBuilder.T-1">T</a></span><div class="tsd-comment tsd-typography"><p>The value to set.</p>
|
|
48
|
-
</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>
|
|
49
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/ce166906b78f0ba06c3593e8b6ff3e5bbb88e101/packages/helpful-fn/src/geometry/quadrilateral-corners.mts#L116">packages/helpful-fn/src/geometry/quadrilateral-corners.mts:116</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="tsd-otp-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="tsd-otp-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="#bottomLeft" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>bottom<wbr/>Left</span></a><a href="#bottomRight" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>bottom<wbr/>Right</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="#topLeft" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>top<wbr/>Left</span></a><a href="#topRight" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>top<wbr/>Right</span></a></div></details></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>Helpful</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><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>
|
|
@@ -1,65 +0,0 @@
|
|
|
1
|
-
<!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>ZRectangle | 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><link rel="icon" href="../helpful.svg" />
|
|
2
|
-
</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" data-base=".."><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.ZRectangle.html">ZRectangle</a></li></ul><h1>Class ZRectangle</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>Represents a helper object that can run calculations on a numeric quadrilateral.</p>
|
|
3
|
-
</div><div class="tsd-comment tsd-typography"></div></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/ce166906b78f0ba06c3593e8b6ff3e5bbb88e101/packages/helpful-fn/src/geometry/rectangle.mts#L12">packages/helpful-fn/src/geometry/rectangle.mts:12</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.ZRectangle.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>
|
|
4
|
-
</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="_zthun_helpful_fn.ZRectangle.html#bottomCenter" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>bottom<wbr/>Center</span></a>
|
|
5
|
-
<a href="_zthun_helpful_fn.ZRectangle.html#bottomLeft" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>bottom<wbr/>Left</span></a>
|
|
6
|
-
<a href="_zthun_helpful_fn.ZRectangle.html#bottomRight" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>bottom<wbr/>Right</span></a>
|
|
7
|
-
<a href="_zthun_helpful_fn.ZRectangle.html#middleCenter" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>middle<wbr/>Center</span></a>
|
|
8
|
-
<a href="_zthun_helpful_fn.ZRectangle.html#middleLeft" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>middle<wbr/>Left</span></a>
|
|
9
|
-
<a href="_zthun_helpful_fn.ZRectangle.html#middleRight" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>middle<wbr/>Right</span></a>
|
|
10
|
-
<a href="_zthun_helpful_fn.ZRectangle.html#sides" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>sides</span></a>
|
|
11
|
-
<a href="_zthun_helpful_fn.ZRectangle.html#topCenter" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>top<wbr/>Center</span></a>
|
|
12
|
-
<a href="_zthun_helpful_fn.ZRectangle.html#topLeft" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>top<wbr/>Left</span></a>
|
|
13
|
-
<a href="_zthun_helpful_fn.ZRectangle.html#topRight" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>top<wbr/>Right</span></a>
|
|
14
|
-
</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Methods</h3><div class="tsd-index-list"><a href="_zthun_helpful_fn.ZRectangle.html#area" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>area</span></a>
|
|
15
|
-
<a href="_zthun_helpful_fn.ZRectangle.html#attach" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>attach</span></a>
|
|
16
|
-
<a href="_zthun_helpful_fn.ZRectangle.html#height" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>height</span></a>
|
|
17
|
-
<a href="_zthun_helpful_fn.ZRectangle.html#offsetToFit" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>offset<wbr/>To<wbr/>Fit</span></a>
|
|
18
|
-
<a href="_zthun_helpful_fn.ZRectangle.html#point" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>point</span></a>
|
|
19
|
-
<a href="_zthun_helpful_fn.ZRectangle.html#width" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>width</span></a>
|
|
20
|
-
</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="constructor.new_ZRectangle" class="tsd-anchor"></a><span class="tsd-kind-constructor-signature">new ZRectangle</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">sides</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_zthun_helpful_fn.ZRectangle.html" class="tsd-signature-type tsd-kind-class">ZRectangle</a><a href="#constructor.new_ZRectangle" 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>
|
|
21
|
-
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">sides</span>: <a href="../interfaces/_zthun_helpful_fn.IZQuadrilateral.html" class="tsd-signature-type tsd-kind-interface">IZQuadrilateral</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">></span></span><div class="tsd-comment tsd-typography"><p>The numeric sides of a quadrilateral.</p>
|
|
22
|
-
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="_zthun_helpful_fn.ZRectangle.html" class="tsd-signature-type tsd-kind-class">ZRectangle</a></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/ce166906b78f0ba06c3593e8b6ff3e5bbb88e101/packages/helpful-fn/src/geometry/rectangle.mts#L19">packages/helpful-fn/src/geometry/rectangle.mts:19</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-Properties"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Properties</h2></summary><section><section class="tsd-panel tsd-member"><a id="bottomCenter" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>bottom<wbr/>Center</span><a href="#bottomCenter" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">bottom<wbr/>Center</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">args</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><a href="../interfaces/_zthun_helpful_fn.IZPoint2d.html" class="tsd-signature-type tsd-kind-interface">IZPoint2d</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-signature-symbol"> = ...</span></div><div class="tsd-comment tsd-typography"><p>Calculates the bottom center point of the rectangle.</p>
|
|
23
|
-
</div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature" id="bottomCenter.__type.__type-1"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">args</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/_zthun_helpful_fn.IZPoint2d.html" class="tsd-signature-type tsd-kind-interface">IZPoint2d</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">></span></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><code class="tsd-tag">Rest</code><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">args</span>: <span class="tsd-signature-symbol">[</span><span class="tsd-signature-symbol">]</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <a href="../interfaces/_zthun_helpful_fn.IZPoint2d.html" class="tsd-signature-type tsd-kind-interface">IZPoint2d</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">></span></h4><p>The bottom center point of the rectangle.</p>
|
|
24
|
-
<div class="tsd-comment tsd-typography"></div></li></ul></li></ul></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/ce166906b78f0ba06c3593e8b6ff3e5bbb88e101/packages/helpful-fn/src/geometry/rectangle.mts#L284">packages/helpful-fn/src/geometry/rectangle.mts:284</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="bottomLeft" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>bottom<wbr/>Left</span><a href="#bottomLeft" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">bottom<wbr/>Left</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">args</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><a href="../interfaces/_zthun_helpful_fn.IZPoint2d.html" class="tsd-signature-type tsd-kind-interface">IZPoint2d</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-signature-symbol"> = ...</span></div><div class="tsd-comment tsd-typography"><p>Calculates the bottom left point of the rectangle.</p>
|
|
25
|
-
</div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature" id="bottomLeft.__type-2.__type-3"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">args</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/_zthun_helpful_fn.IZPoint2d.html" class="tsd-signature-type tsd-kind-interface">IZPoint2d</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">></span></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><code class="tsd-tag">Rest</code><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">args</span>: <span class="tsd-signature-symbol">[</span><span class="tsd-signature-symbol">]</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <a href="../interfaces/_zthun_helpful_fn.IZPoint2d.html" class="tsd-signature-type tsd-kind-interface">IZPoint2d</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">></span></h4><p>The bottom left point of the rectangle.</p>
|
|
26
|
-
<div class="tsd-comment tsd-typography"></div></li></ul></li></ul></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/ce166906b78f0ba06c3593e8b6ff3e5bbb88e101/packages/helpful-fn/src/geometry/rectangle.mts#L273">packages/helpful-fn/src/geometry/rectangle.mts:273</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="bottomRight" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>bottom<wbr/>Right</span><a href="#bottomRight" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">bottom<wbr/>Right</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">args</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><a href="../interfaces/_zthun_helpful_fn.IZPoint2d.html" class="tsd-signature-type tsd-kind-interface">IZPoint2d</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-signature-symbol"> = ...</span></div><div class="tsd-comment tsd-typography"><p>Calculates the bottom right point of the rectangle.</p>
|
|
27
|
-
</div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature" id="bottomRight.__type-4.__type-5"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">args</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/_zthun_helpful_fn.IZPoint2d.html" class="tsd-signature-type tsd-kind-interface">IZPoint2d</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">></span></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><code class="tsd-tag">Rest</code><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">args</span>: <span class="tsd-signature-symbol">[</span><span class="tsd-signature-symbol">]</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <a href="../interfaces/_zthun_helpful_fn.IZPoint2d.html" class="tsd-signature-type tsd-kind-interface">IZPoint2d</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">></span></h4><p>The bottom right point of the rectangle.</p>
|
|
28
|
-
<div class="tsd-comment tsd-typography"></div></li></ul></li></ul></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/ce166906b78f0ba06c3593e8b6ff3e5bbb88e101/packages/helpful-fn/src/geometry/rectangle.mts#L295">packages/helpful-fn/src/geometry/rectangle.mts:295</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="middleCenter" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>middle<wbr/>Center</span><a href="#middleCenter" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">middle<wbr/>Center</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">args</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><a href="../interfaces/_zthun_helpful_fn.IZPoint2d.html" class="tsd-signature-type tsd-kind-interface">IZPoint2d</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-signature-symbol"> = ...</span></div><div class="tsd-comment tsd-typography"><p>Calculates the middle center point of the rectangle.</p>
|
|
29
|
-
</div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature" id="middleCenter.__type-6.__type-7"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">args</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/_zthun_helpful_fn.IZPoint2d.html" class="tsd-signature-type tsd-kind-interface">IZPoint2d</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">></span></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><code class="tsd-tag">Rest</code><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">args</span>: <span class="tsd-signature-symbol">[</span><span class="tsd-signature-symbol">]</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <a href="../interfaces/_zthun_helpful_fn.IZPoint2d.html" class="tsd-signature-type tsd-kind-interface">IZPoint2d</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">></span></h4><p>The middle center point of the rectangle.</p>
|
|
30
|
-
<div class="tsd-comment tsd-typography"></div></li></ul></li></ul></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/ce166906b78f0ba06c3593e8b6ff3e5bbb88e101/packages/helpful-fn/src/geometry/rectangle.mts#L251">packages/helpful-fn/src/geometry/rectangle.mts:251</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="middleLeft" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>middle<wbr/>Left</span><a href="#middleLeft" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">middle<wbr/>Left</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">args</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><a href="../interfaces/_zthun_helpful_fn.IZPoint2d.html" class="tsd-signature-type tsd-kind-interface">IZPoint2d</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-signature-symbol"> = ...</span></div><div class="tsd-comment tsd-typography"><p>Calculates the middle left point of the rectangle.</p>
|
|
31
|
-
</div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature" id="middleLeft.__type-8.__type-9"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">args</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/_zthun_helpful_fn.IZPoint2d.html" class="tsd-signature-type tsd-kind-interface">IZPoint2d</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">></span></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><code class="tsd-tag">Rest</code><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">args</span>: <span class="tsd-signature-symbol">[</span><span class="tsd-signature-symbol">]</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <a href="../interfaces/_zthun_helpful_fn.IZPoint2d.html" class="tsd-signature-type tsd-kind-interface">IZPoint2d</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">></span></h4><p>The middle left point of the rectangle.</p>
|
|
32
|
-
<div class="tsd-comment tsd-typography"></div></li></ul></li></ul></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/ce166906b78f0ba06c3593e8b6ff3e5bbb88e101/packages/helpful-fn/src/geometry/rectangle.mts#L240">packages/helpful-fn/src/geometry/rectangle.mts:240</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="middleRight" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>middle<wbr/>Right</span><a href="#middleRight" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">middle<wbr/>Right</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">args</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><a href="../interfaces/_zthun_helpful_fn.IZPoint2d.html" class="tsd-signature-type tsd-kind-interface">IZPoint2d</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-signature-symbol"> = ...</span></div><div class="tsd-comment tsd-typography"><p>Calculates the middle right point of the rectangle.</p>
|
|
33
|
-
</div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature" id="middleRight.__type-10.__type-11"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">args</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/_zthun_helpful_fn.IZPoint2d.html" class="tsd-signature-type tsd-kind-interface">IZPoint2d</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">></span></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><code class="tsd-tag">Rest</code><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">args</span>: <span class="tsd-signature-symbol">[</span><span class="tsd-signature-symbol">]</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <a href="../interfaces/_zthun_helpful_fn.IZPoint2d.html" class="tsd-signature-type tsd-kind-interface">IZPoint2d</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">></span></h4><p>The middle right point of the rectangle.</p>
|
|
34
|
-
<div class="tsd-comment tsd-typography"></div></li></ul></li></ul></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/ce166906b78f0ba06c3593e8b6ff3e5bbb88e101/packages/helpful-fn/src/geometry/rectangle.mts#L262">packages/helpful-fn/src/geometry/rectangle.mts:262</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="sides" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Readonly</code><span>sides</span><a href="#sides" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">sides</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><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">></span></div><div class="tsd-comment tsd-typography"><p>The numeric sides of a quadrilateral.</p>
|
|
35
|
-
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/ce166906b78f0ba06c3593e8b6ff3e5bbb88e101/packages/helpful-fn/src/geometry/rectangle.mts#L19">packages/helpful-fn/src/geometry/rectangle.mts:19</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="topCenter" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>top<wbr/>Center</span><a href="#topCenter" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">top<wbr/>Center</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">args</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><a href="../interfaces/_zthun_helpful_fn.IZPoint2d.html" class="tsd-signature-type tsd-kind-interface">IZPoint2d</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-signature-symbol"> = ...</span></div><div class="tsd-comment tsd-typography"><p>Calculates the top center point of the rectangle.</p>
|
|
36
|
-
</div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature" id="topCenter.__type-12.__type-13"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">args</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/_zthun_helpful_fn.IZPoint2d.html" class="tsd-signature-type tsd-kind-interface">IZPoint2d</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">></span></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><code class="tsd-tag">Rest</code><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">args</span>: <span class="tsd-signature-symbol">[</span><span class="tsd-signature-symbol">]</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <a href="../interfaces/_zthun_helpful_fn.IZPoint2d.html" class="tsd-signature-type tsd-kind-interface">IZPoint2d</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">></span></h4><p>The top center point of the rectangle.</p>
|
|
37
|
-
<div class="tsd-comment tsd-typography"></div></li></ul></li></ul></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/ce166906b78f0ba06c3593e8b6ff3e5bbb88e101/packages/helpful-fn/src/geometry/rectangle.mts#L218">packages/helpful-fn/src/geometry/rectangle.mts:218</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="topLeft" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>top<wbr/>Left</span><a href="#topLeft" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">top<wbr/>Left</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">args</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><a href="../interfaces/_zthun_helpful_fn.IZPoint2d.html" class="tsd-signature-type tsd-kind-interface">IZPoint2d</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-signature-symbol"> = ...</span></div><div class="tsd-comment tsd-typography"><p>Calculates the top left point of the rectangle.</p>
|
|
38
|
-
</div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature" id="topLeft.__type-14.__type-15"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">args</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/_zthun_helpful_fn.IZPoint2d.html" class="tsd-signature-type tsd-kind-interface">IZPoint2d</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">></span></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><code class="tsd-tag">Rest</code><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">args</span>: <span class="tsd-signature-symbol">[</span><span class="tsd-signature-symbol">]</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <a href="../interfaces/_zthun_helpful_fn.IZPoint2d.html" class="tsd-signature-type tsd-kind-interface">IZPoint2d</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">></span></h4><p>The top left point of the rectangle.</p>
|
|
39
|
-
<div class="tsd-comment tsd-typography"></div></li></ul></li></ul></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/ce166906b78f0ba06c3593e8b6ff3e5bbb88e101/packages/helpful-fn/src/geometry/rectangle.mts#L207">packages/helpful-fn/src/geometry/rectangle.mts:207</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="topRight" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>top<wbr/>Right</span><a href="#topRight" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">top<wbr/>Right</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">args</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><a href="../interfaces/_zthun_helpful_fn.IZPoint2d.html" class="tsd-signature-type tsd-kind-interface">IZPoint2d</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-signature-symbol"> = ...</span></div><div class="tsd-comment tsd-typography"><p>Calculates the top right point of the rectangle.</p>
|
|
40
|
-
</div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature" id="topRight.__type-16.__type-17"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">args</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/_zthun_helpful_fn.IZPoint2d.html" class="tsd-signature-type tsd-kind-interface">IZPoint2d</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">></span></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><code class="tsd-tag">Rest</code><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">args</span>: <span class="tsd-signature-symbol">[</span><span class="tsd-signature-symbol">]</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <a href="../interfaces/_zthun_helpful_fn.IZPoint2d.html" class="tsd-signature-type tsd-kind-interface">IZPoint2d</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">></span></h4><p>The top right point of the rectangle.</p>
|
|
41
|
-
<div class="tsd-comment tsd-typography"></div></li></ul></li></ul></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/ce166906b78f0ba06c3593e8b6ff3e5bbb88e101/packages/helpful-fn/src/geometry/rectangle.mts#L229">packages/helpful-fn/src/geometry/rectangle.mts:229</a></li></ul></aside></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="area" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>area</span><a href="#area" 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="area.area-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">area</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><a href="#area.area-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>Calculates the area of the rectangle.</p>
|
|
42
|
-
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4><p>The numeric area of the rectangle.</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/ce166906b78f0ba06c3593e8b6ff3e5bbb88e101/packages/helpful-fn/src/geometry/rectangle.mts#L49">packages/helpful-fn/src/geometry/rectangle.mts:49</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="attach" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>attach</span><a href="#attach" 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="attach.attach-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">attach</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">anchor</span>, <span class="tsd-kind-parameter">candidate</span>, <span class="tsd-kind-parameter">candidateAnchor</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><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">></span><a href="#attach.attach-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>Takes a candidate and attaches it to this rectangle that matches the anchor points.</p>
|
|
44
|
-
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">anchor</span>: <a href="../types/_zthun_helpful_fn.ZAnchor.html" class="tsd-signature-type tsd-kind-type-alias">ZAnchor</a></span><div class="tsd-comment tsd-typography"><p>The anchor point of this rectangle.</p>
|
|
45
|
-
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">candidate</span>: <a href="../interfaces/_zthun_helpful_fn.IZQuadrilateral.html" class="tsd-signature-type tsd-kind-interface">IZQuadrilateral</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">></span></span><div class="tsd-comment tsd-typography"><p>The candidate rectangle to move</p>
|
|
46
|
-
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">candidateAnchor</span>: <a href="../types/_zthun_helpful_fn.ZAnchor.html" class="tsd-signature-type tsd-kind-type-alias">ZAnchor</a></span><div class="tsd-comment tsd-typography"><p>The anchor point of the candidate rectangle.</p>
|
|
47
|
-
</div><div class="tsd-comment tsd-typography"></div></li></ul></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><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">></span></h4><p>A new quadrilateral that has it's placement such that if candidate was moved
|
|
48
|
-
to this resulting position, would have its candidateAnchor be in the same
|
|
49
|
-
place as this rectangles specified anchor.</p>
|
|
50
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/ce166906b78f0ba06c3593e8b6ff3e5bbb88e101/packages/helpful-fn/src/geometry/rectangle.mts#L68">packages/helpful-fn/src/geometry/rectangle.mts:68</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="height" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>height</span><a href="#height" 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="height.height-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">height</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><a href="#height.height-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>Calculates the height of the rectangle.</p>
|
|
51
|
-
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4><p>The numeric height of the rectangle.</p>
|
|
52
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/ce166906b78f0ba06c3593e8b6ff3e5bbb88e101/packages/helpful-fn/src/geometry/rectangle.mts#L38">packages/helpful-fn/src/geometry/rectangle.mts:38</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="offsetToFit" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>offset<wbr/>To<wbr/>Fit</span><a href="#offsetToFit" 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="offsetToFit.offsetToFit-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">offset<wbr/>To<wbr/>Fit</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">candidate</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><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">></span><a href="#offsetToFit.offsetToFit-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>Takes the candidate quadrilateral and adjusts it's coordinates to fit inside this rectangle.</p>
|
|
53
|
-
<p>This is done by shifting the rectangle left, right, up, and down to make sure it is bounded
|
|
54
|
-
inside.</p>
|
|
55
|
-
<p>If the candidate width or height is larger than this rectangle, thus it cannot fit, then
|
|
56
|
-
the candidate will be centered on the dimension where it is too big to fit.</p>
|
|
57
|
-
</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 href="../interfaces/_zthun_helpful_fn.IZQuadrilateral.html" class="tsd-signature-type tsd-kind-interface">IZQuadrilateral</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">></span></span><div class="tsd-comment tsd-typography"><p>The candidate quadrilateral to fit.</p>
|
|
58
|
-
</div><div class="tsd-comment tsd-typography"></div></li></ul></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><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">></span></h4><p>A new quadrilateral that offsets candidate so that it can fit inside this
|
|
59
|
-
rectangle.</p>
|
|
60
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/ce166906b78f0ba06c3593e8b6ff3e5bbb88e101/packages/helpful-fn/src/geometry/rectangle.mts#L106">packages/helpful-fn/src/geometry/rectangle.mts:106</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="point" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>point</span><a href="#point" 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="point.point-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">point</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">anchor</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/_zthun_helpful_fn.IZPoint2d.html" class="tsd-signature-type tsd-kind-interface">IZPoint2d</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">></span><a href="#point.point-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>Calculates the (x, y) point given an anchor target.</p>
|
|
61
|
-
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">anchor</span>: <a href="../types/_zthun_helpful_fn.ZAnchor.html" class="tsd-signature-type tsd-kind-type-alias">ZAnchor</a></span><div class="tsd-comment tsd-typography"><p>The anchor target to calculate the point for.</p>
|
|
62
|
-
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="../interfaces/_zthun_helpful_fn.IZPoint2d.html" class="tsd-signature-type tsd-kind-interface">IZPoint2d</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">></span></h4><p>The numeric width of the rectangle.</p>
|
|
63
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/ce166906b78f0ba06c3593e8b6ff3e5bbb88e101/packages/helpful-fn/src/geometry/rectangle.mts#L182">packages/helpful-fn/src/geometry/rectangle.mts:182</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="width" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>width</span><a href="#width" 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="width.width-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">width</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><a href="#width.width-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>Calculates the width of the rectangle.</p>
|
|
64
|
-
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4><p>The numeric width of the rectangle.</p>
|
|
65
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/ce166906b78f0ba06c3593e8b6ff3e5bbb88e101/packages/helpful-fn/src/geometry/rectangle.mts#L27">packages/helpful-fn/src/geometry/rectangle.mts:27</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="tsd-otp-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="tsd-otp-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Properties</summary><div><a href="#bottomCenter" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>bottom<wbr/>Center</span></a><a href="#bottomLeft" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>bottom<wbr/>Left</span></a><a href="#bottomRight" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>bottom<wbr/>Right</span></a><a href="#middleCenter" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>middle<wbr/>Center</span></a><a href="#middleLeft" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>middle<wbr/>Left</span></a><a href="#middleRight" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>middle<wbr/>Right</span></a><a href="#sides" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>sides</span></a><a href="#topCenter" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>top<wbr/>Center</span></a><a href="#topLeft" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>top<wbr/>Left</span></a><a href="#topRight" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>top<wbr/>Right</span></a></div></details><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="tsd-otp-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="#area" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>area</span></a><a href="#attach" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>attach</span></a><a href="#height" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>height</span></a><a href="#offsetToFit" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>offset<wbr/>To<wbr/>Fit</span></a><a href="#point" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>point</span></a><a href="#width" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>width</span></a></div></details></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>Helpful</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><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>
|
|
@@ -1,12 +0,0 @@
|
|
|
1
|
-
<!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>ZDataFilterFields | 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><link rel="icon" href="../helpful.svg" />
|
|
2
|
-
</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" data-base=".."><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_query.html">@zthun/helpful-query</a></li><li><a href="_zthun_helpful_query.ZDataFilterFields.html">ZDataFilterFields</a></li></ul><h1>Class ZDataFilterFields<TData></h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>Represents a data match object that applies a filter.</p>
|
|
3
|
-
<p>This implementation of a data match will search against fields on the given target
|
|
4
|
-
object where the filter subject matches a property on said object.</p>
|
|
5
|
-
</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="TData" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">TData</span></span><div class="tsd-comment tsd-typography"><p>The type of data being filtered.</p>
|
|
6
|
-
</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_query.IZDataMatch.html" class="tsd-signature-type tsd-kind-interface">IZDataMatch</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful_query.ZDataFilterFields.html#constructor.new_ZDataFilterFields.TData-1">TData</a><span class="tsd-signature-symbol">, </span><a href="../types/_zthun_helpful_query.IZFilter.html" class="tsd-signature-type tsd-kind-type-alias">IZFilter</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/ce166906b78f0ba06c3593e8b6ff3e5bbb88e101/packages/helpful-query/src/filter/data-filter-fields.mts#L26">packages/helpful-query/src/filter/data-filter-fields.mts:26</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_query.ZDataFilterFields.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>
|
|
7
|
-
</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Methods</h3><div class="tsd-index-list"><a href="_zthun_helpful_query.ZDataFilterFields.html#match" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>match</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-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="constructor.new_ZDataFilterFields" class="tsd-anchor"></a><span class="tsd-kind-constructor-signature">new ZData<wbr/>Filter<wbr/>Fields</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful_query.ZDataFilterFields.html#constructor.new_ZDataFilterFields.TData-1">TData</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_zthun_helpful_query.ZDataFilterFields.html" class="tsd-signature-type tsd-kind-class">ZDataFilterFields</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful_query.ZDataFilterFields.html#constructor.new_ZDataFilterFields.TData-1">TData</a><span class="tsd-signature-symbol">></span><a href="#constructor.new_ZDataFilterFields" 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="constructor.new_ZDataFilterFields.TData-1" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">TData</span></span></li></ul></section><h4 class="tsd-returns-title">Returns <a href="_zthun_helpful_query.ZDataFilterFields.html" class="tsd-signature-type tsd-kind-class">ZDataFilterFields</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful_query.ZDataFilterFields.html#constructor.new_ZDataFilterFields.TData-1">TData</a><span class="tsd-signature-symbol">></span></h4></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="match" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>match</span><a href="#match" 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="match.match-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">match</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">data</span>, <span class="tsd-kind-parameter">filter</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><a href="#match.match-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>Gets whether the given data matches the given filter.</p>
|
|
9
|
-
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">data</span>: <a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful_query.ZDataFilterFields.html#constructor.new_ZDataFilterFields.TData-1">TData</a></span><div class="tsd-comment tsd-typography"><p>The data to check.</p>
|
|
10
|
-
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">filter</span>: <a href="../types/_zthun_helpful_query.IZFilter.html" class="tsd-signature-type tsd-kind-type-alias">IZFilter</a></span><div class="tsd-comment tsd-typography"><p>The filter to match against.</p>
|
|
11
|
-
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><p>True if the data matches the filter.</p>
|
|
12
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/_zthun_helpful_query.IZDataMatch.html">IZDataMatch</a>.<a href="../interfaces/_zthun_helpful_query.IZDataMatch.html#match">match</a></p><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/ce166906b78f0ba06c3593e8b6ff3e5bbb88e101/packages/helpful-query/src/filter/data-filter-fields.mts#L46">packages/helpful-query/src/filter/data-filter-fields.mts:46</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="tsd-otp-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="tsd-otp-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="#match" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>match</span></a></div></details></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>Helpful</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><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>
|
|
@@ -1,16 +0,0 @@
|
|
|
1
|
-
<!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>ZDataMatchOptional | 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><link rel="icon" href="../helpful.svg" />
|
|
2
|
-
</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" data-base=".."><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_query.html">@zthun/helpful-query</a></li><li><a href="_zthun_helpful_query.ZDataMatchOptional.html">ZDataMatchOptional</a></li></ul><h1>Class ZDataMatchOptional<TData, TFilter></h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>Represents a data match that forwards to an inner match if the filter is null or undefined.</p>
|
|
3
|
-
</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="TData" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">TData</span></span><div class="tsd-comment tsd-typography"><p>The type of data being matched.</p>
|
|
4
|
-
</div><div class="tsd-comment tsd-typography"></div></li><li><span><a id="TFilter" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">TFilter</span></span><div class="tsd-comment tsd-typography"><p>The type of filter performing the match.</p>
|
|
5
|
-
</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_query.IZDataMatch.html" class="tsd-signature-type tsd-kind-interface">IZDataMatch</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful_query.ZDataMatchOptional.html#constructor.new_ZDataMatchOptional.TData-1">TData</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful_query.ZDataMatchOptional.html#constructor.new_ZDataMatchOptional.TFilter-1">TFilter</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span><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/ce166906b78f0ba06c3593e8b6ff3e5bbb88e101/packages/helpful-query/src/match/data-match-optional.mts#L11">packages/helpful-query/src/match/data-match-optional.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_query.ZDataMatchOptional.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>
|
|
6
|
-
</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Methods</h3><div class="tsd-index-list"><a href="_zthun_helpful_query.ZDataMatchOptional.html#match" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>match</span></a>
|
|
7
|
-
</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="constructor.new_ZDataMatchOptional" class="tsd-anchor"></a><span class="tsd-kind-constructor-signature">new ZData<wbr/>Match<wbr/>Optional</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful_query.ZDataMatchOptional.html#constructor.new_ZDataMatchOptional.TData-1">TData</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful_query.ZDataMatchOptional.html#constructor.new_ZDataMatchOptional.TFilter-1">TFilter</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">_match</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_zthun_helpful_query.ZDataMatchOptional.html" class="tsd-signature-type tsd-kind-class">ZDataMatchOptional</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful_query.ZDataMatchOptional.html#constructor.new_ZDataMatchOptional.TData-1">TData</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful_query.ZDataMatchOptional.html#constructor.new_ZDataMatchOptional.TFilter-1">TFilter</a><span class="tsd-signature-symbol">></span><a href="#constructor.new_ZDataMatchOptional" 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>
|
|
8
|
-
</div><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a id="constructor.new_ZDataMatchOptional.TData-1" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">TData</span></span></li><li><span><a id="constructor.new_ZDataMatchOptional.TFilter-1" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">TFilter</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">_match</span>: <a href="../interfaces/_zthun_helpful_query.IZDataMatch.html" class="tsd-signature-type tsd-kind-interface">IZDataMatch</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful_query.ZDataMatchOptional.html#constructor.new_ZDataMatchOptional.TData-1">TData</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful_query.ZDataMatchOptional.html#constructor.new_ZDataMatchOptional.TFilter-1">TFilter</a><span class="tsd-signature-symbol">></span></span><div class="tsd-comment tsd-typography"><p>The inner match object which does not support
|
|
9
|
-
null or undefined filters.</p>
|
|
10
|
-
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="_zthun_helpful_query.ZDataMatchOptional.html" class="tsd-signature-type tsd-kind-class">ZDataMatchOptional</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful_query.ZDataMatchOptional.html#constructor.new_ZDataMatchOptional.TData-1">TData</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful_query.ZDataMatchOptional.html#constructor.new_ZDataMatchOptional.TFilter-1">TFilter</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/ce166906b78f0ba06c3593e8b6ff3e5bbb88e101/packages/helpful-query/src/match/data-match-optional.mts#L21">packages/helpful-query/src/match/data-match-optional.mts:21</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="match" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>match</span><a href="#match" 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="match.match-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">match</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">data</span>, <span class="tsd-kind-parameter">filter</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><a href="#match.match-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>Gets whether the given data matches the given filter.</p>
|
|
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">data</span>: <a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful_query.ZDataMatchOptional.html#constructor.new_ZDataMatchOptional.TData-1">TData</a></span><div class="tsd-comment tsd-typography"><p>The data to check.</p>
|
|
12
|
-
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">filter</span>: <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful_query.ZDataMatchOptional.html#constructor.new_ZDataMatchOptional.TFilter-1">TFilter</a></span><div class="tsd-comment tsd-typography"><p>The filter to match against.</p>
|
|
13
|
-
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><p>True if filter is null or undefined. Otherwise,
|
|
14
|
-
the result from the inner match with data and filter
|
|
15
|
-
is returned.</p>
|
|
16
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/_zthun_helpful_query.IZDataMatch.html">IZDataMatch</a>.<a href="../interfaces/_zthun_helpful_query.IZDataMatch.html#match">match</a></p><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/ce166906b78f0ba06c3593e8b6ff3e5bbb88e101/packages/helpful-query/src/match/data-match-optional.mts#L36">packages/helpful-query/src/match/data-match-optional.mts:36</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="tsd-otp-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="tsd-otp-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="#match" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>match</span></a></div></details></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>Helpful</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><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>
|