@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,60 +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>@zthun/helpful-proxy | 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="_zthun_helpful_proxy.html">@zthun/helpful-proxy</a></li></ul><h1>Module @zthun/helpful-proxy</h1></div><section class="tsd-panel tsd-typography"><a id="md:helpful-proxy" class="tsd-anchor"></a><h1 class="tsd-anchor-link">Helpful Proxy<a href="#md:helpful-proxy" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h1><p>Doing local development can be challenging when your development environment
|
|
3
|
-
differs from a production environment. When working with websites, users will
|
|
4
|
-
usually navigate to your domain. Most websites use a bunch of configuration and
|
|
5
|
-
variables to construct an environment, which can be very tricky and prone to
|
|
6
|
-
error.</p>
|
|
7
|
-
<blockquote>
|
|
8
|
-
<p>The best configuration is no configuration.</p>
|
|
9
|
-
</blockquote>
|
|
10
|
-
<p>It would be nice if we could mimic our local development environment to look
|
|
11
|
-
similar to production, with just a simple change of adding one subdomain to our
|
|
12
|
-
domain.</p>
|
|
13
|
-
<p>Helpful proxy bridges that gap by providing a docker container which routes
|
|
14
|
-
artificial DNS addresses to your local system and then, along with something
|
|
15
|
-
like docker compose, you can simulate an experience similar to what a production
|
|
16
|
-
environment does. It also adds support for https with a self signed certificate
|
|
17
|
-
so you can also add check for how your site operates using TLS.</p>
|
|
18
|
-
<a id="md:installation" class="tsd-anchor"></a><h2 class="tsd-anchor-link">Installation<a href="#md:installation" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h2><p>You can install this through NPM or Yarn, but this is meant to be ran through a
|
|
19
|
-
docker container in a compose setting.</p>
|
|
20
|
-
<pre><code class="sh"><span class="hl-1">npm</span><span class="hl-2"> </span><span class="hl-3">install</span><span class="hl-2"> </span><span class="hl-3">@zthun/helpful-proxy</span><span class="hl-2"> </span><span class="hl-4">--dev</span><br/><span class="hl-1">yarn</span><span class="hl-2"> </span><span class="hl-3">add</span><span class="hl-2"> </span><span class="hl-3">@zthun/helpful-proxy</span><span class="hl-2"> </span><span class="hl-4">--dev</span>
|
|
21
|
-
</code><button type="button">Copy</button></pre>
|
|
22
|
-
|
|
23
|
-
<a id="md:usage" class="tsd-anchor"></a><h2 class="tsd-anchor-link">Usage<a href="#md:usage" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h2><p>This is best used in a mono repo that contains your frontend plus your backend,
|
|
24
|
-
but can be useful whenever you have the need for more than one service running
|
|
25
|
-
for an application to debug, and it includes multiple access points.</p>
|
|
26
|
-
<p>The following is a sample app written in node that has a frontend and a backend
|
|
27
|
-
all in the same repository. Assume that the frontend and backend packages have
|
|
28
|
-
scripts named debug that run a dev server and a nodemon application
|
|
29
|
-
respectively.</p>
|
|
30
|
-
<pre><code class="yaml"><span class="hl-10">services</span><span class="hl-2">:</span><br/><span class="hl-2"> </span><span class="hl-0"># The app proxy here represents the ingress into your system locally.</span><br/><span class="hl-2"> </span><span class="hl-10">app-proxy</span><span class="hl-2">:</span><br/><span class="hl-2"> </span><span class="hl-10">image</span><span class="hl-2">: </span><span class="hl-11">zthun/helpful-proxy</span><br/><span class="hl-2"> </span><span class="hl-10">ports</span><span class="hl-2">:</span><br/><span class="hl-2"> - </span><span class="hl-11">80:80</span><br/><span class="hl-2"> - </span><span class="hl-11">443:443</span><br/><span class="hl-2"> </span><span class="hl-10">volumes</span><span class="hl-2">:</span><br/><span class="hl-2"> - </span><span class="hl-11">./.config:/.config</span><br/><span class="hl-2"> </span><span class="hl-10">depends_on</span><span class="hl-2">:</span><br/><span class="hl-2"> - </span><span class="hl-11">app-frontend</span><br/><span class="hl-2"> - </span><span class="hl-11">app-backend</span><br/><span class="hl-2"> </span><span class="hl-0"># This is your frontend application. We map the current repository directly into</span><br/><span class="hl-2"> </span><span class="hl-0"># the container and run the debug script.</span><br/><span class="hl-2"> </span><span class="hl-10">app-frontend</span><span class="hl-2">:</span><br/><span class="hl-2"> </span><span class="hl-10">image</span><span class="hl-2">: </span><span class="hl-11">node:lts</span><br/><span class="hl-2"> </span><span class="hl-10">volumes</span><span class="hl-2">:</span><br/><span class="hl-2"> - </span><span class="hl-11">./:/usr/dev</span><br/><span class="hl-2"> </span><span class="hl-10">working_dir</span><span class="hl-2">: </span><span class="hl-11">/usr/dev</span><br/><span class="hl-2"> </span><span class="hl-10">command</span><span class="hl-2">: </span><span class="hl-11">npm --workspace app-frontend run debug</span><br/><span class="hl-2"> </span><span class="hl-0"># Same for the backend application. We map the current repository directly into</span><br/><span class="hl-2"> </span><span class="hl-0"># the container and run the debug script.</span><br/><span class="hl-2"> </span><span class="hl-10">app-backend</span><span class="hl-2">:</span><br/><span class="hl-2"> </span><span class="hl-10">image</span><span class="hl-2">: </span><span class="hl-11">node:lts</span><br/><span class="hl-2"> </span><span class="hl-10">volumes</span><span class="hl-2">:</span><br/><span class="hl-2"> - </span><span class="hl-11">./:/usr/dev</span><br/><span class="hl-2"> </span><span class="hl-10">working_dir</span><span class="hl-2">: </span><span class="hl-11">/usr/dev</span><br/><span class="hl-2"> </span><span class="hl-10">command</span><span class="hl-2">: </span><span class="hl-11">npm --workspace app-backend run debug</span><br/><span class="hl-2"> </span><span class="hl-10">depends_on</span><span class="hl-2">:</span><br/><span class="hl-2"> - </span><span class="hl-11">app-database</span><br/><span class="hl-2"> </span><span class="hl-10">environment</span><span class="hl-2">:</span><br/><span class="hl-2"> - </span><span class="hl-11">DATABASE_URL=mongo://app-database</span><br/><span class="hl-2"> </span><span class="hl-0"># Just here for the sake of completion. Simply layered application.</span><br/><span class="hl-2"> </span><span class="hl-10">app-database</span><span class="hl-2">:</span><br/><span class="hl-2"> </span><span class="hl-10">image</span><span class="hl-2">: </span><span class="hl-11">mongo:7</span>
|
|
31
|
-
</code><button type="button">Copy</button></pre>
|
|
32
|
-
|
|
33
|
-
<p><em>Notice the mapping to the .config directory</em>. We need to actually map the proxy
|
|
34
|
-
paths.</p>
|
|
35
|
-
<p>Inside the .config directory in your repository, create a new file,
|
|
36
|
-
<strong>helpful-proxyrc.js</strong>. The domain, <a href="http://app.com" target="_blank" class="external">app.com</a> is just a placeholder here. Replace
|
|
37
|
-
the domain with whatever you want it to be.</p>
|
|
38
|
-
<pre><code class="js"><span class="hl-0">// A few assumptions being made here. Normal http requests to</span><br/><span class="hl-0">// static content will run on port 80 if your frontend is using</span><br/><span class="hl-0">// an nginx docker container with no configuration. We'll just assume</span><br/><span class="hl-0">// your backend runs on port 3000, but this can be anything. It is also</span><br/><span class="hl-0">// assumed that your frontend is connecting to your backend rest service</span><br/><span class="hl-0">// and those all route on the same domain with an /api path.</span><br/><span class="hl-8">module</span><span class="hl-2">.</span><span class="hl-8">exports</span><span class="hl-2"> = {</span><br/><span class="hl-2"> </span><span class="hl-6">domains:</span><span class="hl-2"> [</span><br/><span class="hl-2"> {</span><br/><span class="hl-2"> </span><span class="hl-6">name:</span><span class="hl-2"> </span><span class="hl-3">`local.app.com`</span><span class="hl-2">,</span><br/><span class="hl-2"> </span><span class="hl-6">paths:</span><span class="hl-2"> {</span><br/><span class="hl-2"> </span><span class="hl-3">'/'</span><span class="hl-6">:</span><span class="hl-2"> </span><span class="hl-3">'app-frontend:80'</span><br/><span class="hl-2"> </span><span class="hl-3">'/api'</span><span class="hl-2">: </span><span class="hl-3">'app-backend:3000/api'</span><br/><span class="hl-2"> }</span><br/><span class="hl-2"> }</span><br/><span class="hl-2"> ]</span><br/><span class="hl-2">};</span>
|
|
39
|
-
</code><button type="button">Copy</button></pre>
|
|
40
|
-
|
|
41
|
-
<p>The final step is to make sure that <a href="http://local.app.com" target="_blank" class="external">local.app.com</a> routes to your localhost. We
|
|
42
|
-
can use our hosts file to make sure our operating system fakes this DNS lookup.</p>
|
|
43
|
-
<p>On mac and linux, the hosts file is located at /ect/hosts and on Windows, it's
|
|
44
|
-
located on C:\Windows\System32\drivers\etc\hosts.</p>
|
|
45
|
-
<pre><code class="ini"><span class="hl-0">##</span><br/><span class="hl-0"># Host Database</span><br/><span class="hl-0">#</span><br/><span class="hl-0"># localhost is used to configure the loopback interface</span><br/><span class="hl-0"># when the system is booting. Do not change this entry.</span><br/><span class="hl-0">##</span><br/><span class="hl-2">127.0.0.1 localhost</span><br/><br/><span class="hl-0"># My Local Apps</span><br/><span class="hl-2">127.0.0.1 local.app.com</span><br/><br/><span class="hl-2">::1 localhost</span>
|
|
46
|
-
</code><button type="button">Copy</button></pre>
|
|
47
|
-
|
|
48
|
-
<p>Restart your terminal and IDE and run the compose file.</p>
|
|
49
|
-
<pre><code class="sh"><span class="hl-1">docker</span><span class="hl-2"> </span><span class="hl-3">compose</span><span class="hl-2"> </span><span class="hl-3">up</span>
|
|
50
|
-
</code><button type="button">Copy</button></pre>
|
|
51
|
-
|
|
52
|
-
<p>Now open your browser and navigate to <a href="http://local.app.com" target="_blank" class="external">local.app.com</a>. You should see your
|
|
53
|
-
application frontend running and it should be able to connect to your backend.</p>
|
|
54
|
-
<a id="md:limitations" class="tsd-anchor"></a><h2 class="tsd-anchor-link">Limitations<a href="#md:limitations" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h2><p>The proxy, under the hood uses a self signed certificate, and, depending on your
|
|
55
|
-
browser settings, you may have to allow this cert through. In certain versions
|
|
56
|
-
of different browsers, it may not even let you bypass this. If you encounter
|
|
57
|
-
this, you can simply open the same url in Firefox or Chrome using private
|
|
58
|
-
browsing and there should be an option to white list the self signed certificate
|
|
59
|
-
for the current session.</p>
|
|
60
|
-
</section></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"><a href="#md:helpful-proxy"><span>Helpful <wbr/>Proxy</span></a><ul><li><a href="#md:installation"><span>Installation</span></a></li><li><a href="#md:usage"><span>Usage</span></a></li><li><a href="#md:limitations"><span>Limitations</span></a></li></ul></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,95 +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>@zthun/helpful-query | 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="_zthun_helpful_query.html">@zthun/helpful-query</a></li></ul><h1>Module @zthun/helpful-query</h1></div><section class="tsd-panel tsd-typography"><a id="md:helpful-query" class="tsd-anchor"></a><h1 class="tsd-anchor-link">Helpful Query<a href="#md:helpful-query" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h1><p>Helpful query provides helper classes that solve the problem of trying to create
|
|
3
|
-
components with reusable functionality such as filtering, sorting, searching and
|
|
4
|
-
pagination.</p>
|
|
5
|
-
<a id="md:the-source-pattern" class="tsd-anchor"></a><h2 class="tsd-anchor-link">The Source Pattern<a href="#md:the-source-pattern" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h2><p>At the heart of this package is what we call, <strong>the source pattern</strong>. In most
|
|
6
|
-
designs, we often tell components WHAT the data is. We query a rest endpoint, we
|
|
7
|
-
receive a page of data, and we send that data to the component to display back
|
|
8
|
-
to the end user.</p>
|
|
9
|
-
<p>When done in this manner, specific features, such as filtering, sorting,
|
|
10
|
-
searching, and pagination must be implemented over and over again, as the actual
|
|
11
|
-
implementation of that set of data depends on the rest service being called.
|
|
12
|
-
Many 3rd party libraries that attempt to support this out of box will support
|
|
13
|
-
said features, but they are almost always client side restricted, meaning that
|
|
14
|
-
you must pull down the entire data set instead of just a single page.</p>
|
|
15
|
-
<p>The source pattern solves this problem by telling components HOW to get the data
|
|
16
|
-
instead of WHAT the data is. This simple change in thinking allows us to
|
|
17
|
-
construct components that handle the pagination, sorting, filtering, and
|
|
18
|
-
searching operations for us, and the only responsibility of the caller is to
|
|
19
|
-
explain to the component where and how to retrieve the data.</p>
|
|
20
|
-
<a id="md:data-request-and-source" class="tsd-anchor"></a><h2 class="tsd-anchor-link">Data Request and Source<a href="#md:data-request-and-source" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h2><p>The root of the source pattern lies with two specific contracts - the request
|
|
21
|
-
object and the source implementation. The request object will be provided by the
|
|
22
|
-
component being implemented, and the source implementation describes how to
|
|
23
|
-
retrieve the specific page of data.</p>
|
|
24
|
-
<p>Here is an example of the implementation. The actual implementations provided by
|
|
25
|
-
this library are more robust, but these will illustrate the idea.</p>
|
|
26
|
-
<pre><code class="ts"><span class="hl-5">export</span><span class="hl-2"> </span><span class="hl-4">interface</span><span class="hl-2"> </span><span class="hl-8">IZDataRequest</span><span class="hl-2"> {</span><br/><span class="hl-2"> </span><span class="hl-6">page</span><span class="hl-2">: </span><span class="hl-8">number</span><span class="hl-2">;</span><br/><span class="hl-2"> </span><span class="hl-6">size</span><span class="hl-2">: </span><span class="hl-8">number</span><span class="hl-2">;</span><br/><span class="hl-2"> </span><span class="hl-6">search</span><span class="hl-2">: </span><span class="hl-8">string</span><span class="hl-2">;</span><br/><span class="hl-2"> </span><span class="hl-6">sort</span><span class="hl-2">: </span><span class="hl-8">Array</span><span class="hl-2"><{ </span><span class="hl-6">subject</span><span class="hl-2">: </span><span class="hl-8">string</span><span class="hl-2">; </span><span class="hl-6">direction</span><span class="hl-2">: </span><span class="hl-9">1</span><span class="hl-2"> | </span><span class="hl-9">0</span><span class="hl-2"> }>;</span><br/><span class="hl-2">}</span><br/><br/><span class="hl-5">export</span><span class="hl-2"> </span><span class="hl-4">interface</span><span class="hl-2"> </span><span class="hl-8">IZDataSource</span><span class="hl-2"><</span><span class="hl-8">T</span><span class="hl-2">> {</span><br/><span class="hl-2"> </span><span class="hl-1">count</span><span class="hl-2">(): </span><span class="hl-8">Promise</span><span class="hl-2"><</span><span class="hl-8">number</span><span class="hl-2">>;</span><br/><span class="hl-2"> </span><span class="hl-1">retrieve</span><span class="hl-2">(</span><span class="hl-6">request</span><span class="hl-2">: </span><span class="hl-8">IZDataRequest</span><span class="hl-2">): </span><span class="hl-8">Promise</span><span class="hl-2"><</span><span class="hl-8">T</span><span class="hl-2">[]>;</span><br/><span class="hl-2">}</span>
|
|
27
|
-
</code><button type="button">Copy</button></pre>
|
|
28
|
-
|
|
29
|
-
<p>A component would take as input an object that implements an
|
|
30
|
-
IZDataSource<T> contract, and will pass a request to it when it is ready
|
|
31
|
-
to display the data. It will need to include it's own loading state, how to
|
|
32
|
-
paginate, and what features it will give the user to sort, filter, and search.</p>
|
|
33
|
-
</section><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><h3 class="tsd-index-heading uppercase">Index</h3><section class="tsd-index-section"><h3 class="tsd-index-heading">Enumerations</h3><div class="tsd-index-list"><a href="../enums/_zthun_helpful_query.ZMetadataType.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-8"></use></svg><span>ZMetadata<wbr/>Type</span></a>
|
|
34
|
-
<a href="../enums/_zthun_helpful_query.ZOperatorBinary.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-8"></use></svg><span>ZOperator<wbr/>Binary</span></a>
|
|
35
|
-
<a href="../enums/_zthun_helpful_query.ZOperatorCollection.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-8"></use></svg><span>ZOperator<wbr/>Collection</span></a>
|
|
36
|
-
<a href="../enums/_zthun_helpful_query.ZOperatorLogic.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-8"></use></svg><span>ZOperator<wbr/>Logic</span></a>
|
|
37
|
-
<a href="../enums/_zthun_helpful_query.ZOperatorUnary.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-8"></use></svg><span>ZOperator<wbr/>Unary</span></a>
|
|
38
|
-
<a href="../enums/_zthun_helpful_query.ZSortDirection.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-8"></use></svg><span>ZSort<wbr/>Direction</span></a>
|
|
39
|
-
</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Classes</h3><div class="tsd-index-list"><a href="../classes/_zthun_helpful_query.ZDataFilterFields.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-128"></use></svg><span>ZData<wbr/>Filter<wbr/>Fields</span></a>
|
|
40
|
-
<a href="../classes/_zthun_helpful_query.ZDataMatchAlways.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-128"></use></svg><span>ZData<wbr/>Match<wbr/>Always</span></a>
|
|
41
|
-
<a href="../classes/_zthun_helpful_query.ZDataMatchOptional.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-128"></use></svg><span>ZData<wbr/>Match<wbr/>Optional</span></a>
|
|
42
|
-
<a href="../classes/_zthun_helpful_query.ZDataRequestBuilder.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-128"></use></svg><span>ZData<wbr/>Request<wbr/>Builder</span></a>
|
|
43
|
-
<a href="../classes/_zthun_helpful_query.ZDataSearchFields.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-128"></use></svg><span>ZData<wbr/>Search<wbr/>Fields</span></a>
|
|
44
|
-
<a href="../classes/_zthun_helpful_query.ZDataSearchText.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-128"></use></svg><span>ZData<wbr/>Search<wbr/>Text</span></a>
|
|
45
|
-
<a href="../classes/_zthun_helpful_query.ZDataSourceStatic.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-128"></use></svg><span>ZData<wbr/>Source<wbr/>Static</span></a>
|
|
46
|
-
<a href="../classes/_zthun_helpful_query.ZDataSourceStaticOptionsBuilder.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-128"></use></svg><span>ZData<wbr/>Source<wbr/>Static<wbr/>Options<wbr/>Builder</span></a>
|
|
47
|
-
<a href="../classes/_zthun_helpful_query.ZFilterBinaryBuilder.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-128"></use></svg><span>ZFilter<wbr/>Binary<wbr/>Builder</span></a>
|
|
48
|
-
<a href="../classes/_zthun_helpful_query.ZFilterCollectionBuilder.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-128"></use></svg><span>ZFilter<wbr/>Collection<wbr/>Builder</span></a>
|
|
49
|
-
<a href="../classes/_zthun_helpful_query.ZFilterDeserialize.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-128"></use></svg><span>ZFilter<wbr/>Deserialize</span></a>
|
|
50
|
-
<a href="../classes/_zthun_helpful_query.ZFilterLogicBuilder.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-128"></use></svg><span>ZFilter<wbr/>Logic<wbr/>Builder</span></a>
|
|
51
|
-
<a href="../classes/_zthun_helpful_query.ZFilterSerialize.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-128"></use></svg><span>ZFilter<wbr/>Serialize</span></a>
|
|
52
|
-
<a href="../classes/_zthun_helpful_query.ZFilterUnaryBuilder.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-128"></use></svg><span>ZFilter<wbr/>Unary<wbr/>Builder</span></a>
|
|
53
|
-
<a href="../classes/_zthun_helpful_query.ZMetadataBuilder.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-128"></use></svg><span>ZMetadata<wbr/>Builder</span></a>
|
|
54
|
-
<a href="../classes/_zthun_helpful_query.ZPageBuilder.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-128"></use></svg><span>ZPage<wbr/>Builder</span></a>
|
|
55
|
-
<a href="../classes/_zthun_helpful_query.ZSortBuilder.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-128"></use></svg><span>ZSort<wbr/>Builder</span></a>
|
|
56
|
-
<a href="../classes/_zthun_helpful_query.ZSortDeserialize.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-128"></use></svg><span>ZSort<wbr/>Deserialize</span></a>
|
|
57
|
-
<a href="../classes/_zthun_helpful_query.ZSorterSingle.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-128"></use></svg><span>ZSorter<wbr/>Single</span></a>
|
|
58
|
-
<a href="../classes/_zthun_helpful_query.ZSortSerialize.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-128"></use></svg><span>ZSort<wbr/>Serialize</span></a>
|
|
59
|
-
<a href="../classes/_zthun_helpful_query.ZWellKnownIconClasses.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-128"></use></svg><span>ZWell<wbr/>Known<wbr/>Icon<wbr/>Classes</span></a>
|
|
60
|
-
</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Interfaces</h3><div class="tsd-index-list"><a href="../interfaces/_zthun_helpful_query.IZDataMatch.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-256"></use></svg><span>IZData<wbr/>Match</span></a>
|
|
61
|
-
<a href="../interfaces/_zthun_helpful_query.IZDataRequest.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-256"></use></svg><span>IZData<wbr/>Request</span></a>
|
|
62
|
-
<a href="../interfaces/_zthun_helpful_query.IZDataRequestQuery.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-256"></use></svg><span>IZData<wbr/>Request<wbr/>Query</span></a>
|
|
63
|
-
<a href="../interfaces/_zthun_helpful_query.IZDataSource.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-256"></use></svg><span>IZData<wbr/>Source</span></a>
|
|
64
|
-
<a href="../interfaces/_zthun_helpful_query.IZDataSourceStaticOptions.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-256"></use></svg><span>IZData<wbr/>Source<wbr/>Static<wbr/>Options</span></a>
|
|
65
|
-
<a href="../interfaces/_zthun_helpful_query.IZFilterBinary.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-256"></use></svg><span>IZFilter<wbr/>Binary</span></a>
|
|
66
|
-
<a href="../interfaces/_zthun_helpful_query.IZFilterCollection.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-256"></use></svg><span>IZFilter<wbr/>Collection</span></a>
|
|
67
|
-
<a href="../interfaces/_zthun_helpful_query.IZFilterLogic.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-256"></use></svg><span>IZFilter<wbr/>Logic</span></a>
|
|
68
|
-
<a href="../interfaces/_zthun_helpful_query.IZFilterMetadata.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-256"></use></svg><span>IZFilter<wbr/>Metadata</span></a>
|
|
69
|
-
<a href="../interfaces/_zthun_helpful_query.IZFilterOperator.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-256"></use></svg><span>IZFilter<wbr/>Operator</span></a>
|
|
70
|
-
<a href="../interfaces/_zthun_helpful_query.IZFilterSubject.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-256"></use></svg><span>IZFilter<wbr/>Subject</span></a>
|
|
71
|
-
<a href="../interfaces/_zthun_helpful_query.IZMetadata.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-256"></use></svg><span>IZMetadata</span></a>
|
|
72
|
-
<a href="../interfaces/_zthun_helpful_query.IZPage.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-256"></use></svg><span>IZPage</span></a>
|
|
73
|
-
<a href="../interfaces/_zthun_helpful_query.IZSort.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-256"></use></svg><span>IZSort</span></a>
|
|
74
|
-
<a href="../interfaces/_zthun_helpful_query.IZSorter.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-256"></use></svg><span>IZSorter</span></a>
|
|
75
|
-
</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Type Aliases</h3><div class="tsd-index-list"><a href="../types/_zthun_helpful_query.IZFilter.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2097152"></use></svg><span>IZFilter</span></a>
|
|
76
|
-
<a href="../types/_zthun_helpful_query.IZFilterUnary.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2097152"></use></svg><span>IZFilter<wbr/>Unary</span></a>
|
|
77
|
-
<a href="../types/_zthun_helpful_query.ZOperatorFilter.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2097152"></use></svg><span>ZOperator<wbr/>Filter</span></a>
|
|
78
|
-
</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Variables</h3><div class="tsd-index-list"><a href="../variables/_zthun_helpful_query.ZBinaryComparators.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-32"></use></svg><span>ZBinary<wbr/>Comparators</span></a>
|
|
79
|
-
<a href="../variables/_zthun_helpful_query.ZCollectionComparators.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-32"></use></svg><span>ZCollection<wbr/>Comparators</span></a>
|
|
80
|
-
<a href="../variables/_zthun_helpful_query.ZOperatorsBinary.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-32"></use></svg><span>ZOperators<wbr/>Binary</span></a>
|
|
81
|
-
<a href="../variables/_zthun_helpful_query.ZOperatorsCollection.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-32"></use></svg><span>ZOperators<wbr/>Collection</span></a>
|
|
82
|
-
<a href="../variables/_zthun_helpful_query.ZOperatorsFilter.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-32"></use></svg><span>ZOperators<wbr/>Filter</span></a>
|
|
83
|
-
<a href="../variables/_zthun_helpful_query.ZOperatorsLogic.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-32"></use></svg><span>ZOperators<wbr/>Logic</span></a>
|
|
84
|
-
<a href="../variables/_zthun_helpful_query.ZOperatorsUnary.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-32"></use></svg><span>ZOperators<wbr/>Unary</span></a>
|
|
85
|
-
<a href="../variables/_zthun_helpful_query.ZSortDirections.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-32"></use></svg><span>ZSort<wbr/>Directions</span></a>
|
|
86
|
-
<a href="../variables/_zthun_helpful_query.ZUnaryComparators.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-32"></use></svg><span>ZUnary<wbr/>Comparators</span></a>
|
|
87
|
-
</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Functions</h3><div class="tsd-index-list"><a href="../functions/_zthun_helpful_query.isBinaryFilter.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-64"></use></svg><span>is<wbr/>Binary<wbr/>Filter</span></a>
|
|
88
|
-
<a href="../functions/_zthun_helpful_query.isBinaryOperator.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-64"></use></svg><span>is<wbr/>Binary<wbr/>Operator</span></a>
|
|
89
|
-
<a href="../functions/_zthun_helpful_query.isCollectionFilter.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-64"></use></svg><span>is<wbr/>Collection<wbr/>Filter</span></a>
|
|
90
|
-
<a href="../functions/_zthun_helpful_query.isCollectionOperator.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-64"></use></svg><span>is<wbr/>Collection<wbr/>Operator</span></a>
|
|
91
|
-
<a href="../functions/_zthun_helpful_query.isLogicFilter.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-64"></use></svg><span>is<wbr/>Logic<wbr/>Filter</span></a>
|
|
92
|
-
<a href="../functions/_zthun_helpful_query.isLogicOperator.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-64"></use></svg><span>is<wbr/>Logic<wbr/>Operator</span></a>
|
|
93
|
-
<a href="../functions/_zthun_helpful_query.isUnaryFilter.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-64"></use></svg><span>is<wbr/>Unary<wbr/>Filter</span></a>
|
|
94
|
-
<a href="../functions/_zthun_helpful_query.isUnaryOperator.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-64"></use></svg><span>is<wbr/>Unary<wbr/>Operator</span></a>
|
|
95
|
-
</div></section></section></section></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"><a href="#md:helpful-query"><span>Helpful <wbr/>Query</span></a><ul><li><a href="#md:the-source-pattern"><span>The <wbr/>Source <wbr/>Pattern</span></a></li><li><a href="#md:data-request-and-source"><span>Data <wbr/>Request and <wbr/>Source</span></a></li></ul></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,36 +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>@zthun/helpful-react | 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="_zthun_helpful_react.html">@zthun/helpful-react</a></li></ul><h1>Module @zthun/helpful-react</h1></div><section class="tsd-panel tsd-typography"><a id="md:helpful-react" class="tsd-anchor"></a><h1 class="tsd-anchor-link">Helpful React<a href="#md:helpful-react" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h1><p>This package provides useful hooks and functions that help with frontend
|
|
3
|
-
development using React.</p>
|
|
4
|
-
<a id="md:installation" class="tsd-anchor"></a><h2 class="tsd-anchor-link">Installation<a href="#md:installation" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h2><pre><code class="sh"><span class="hl-1">npm</span><span class="hl-2"> </span><span class="hl-3">install</span><span class="hl-2"> </span><span class="hl-3">@zthun/helpful-react</span><br/><span class="hl-1">yarn</span><span class="hl-2"> </span><span class="hl-3">add</span><span class="hl-2"> </span><span class="hl-3">@zthun/helpful-react</span>
|
|
5
|
-
</code><button type="button">Copy</button></pre>
|
|
6
|
-
|
|
7
|
-
</section><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><h3 class="tsd-index-heading uppercase">Index</h3><section class="tsd-index-section"><h3 class="tsd-index-heading">Classes</h3><div class="tsd-index-list"><a href="../classes/_zthun_helpful_react.ZFileSelect.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-128"></use></svg><span>ZFile<wbr/>Select</span></a>
|
|
8
|
-
</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Interfaces</h3><div class="tsd-index-list"><a href="../interfaces/_zthun_helpful_react.IZFileSelect.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-256"></use></svg><span>IZFile<wbr/>Select</span></a>
|
|
9
|
-
<a href="../interfaces/_zthun_helpful_react.IZKeyboardInteraction.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-256"></use></svg><span>IZKeyboard<wbr/>Interaction</span></a>
|
|
10
|
-
</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Type Aliases</h3><div class="tsd-index-list"><a href="../types/_zthun_helpful_react.ZAmbassadorReducer.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2097152"></use></svg><span>ZAmbassador<wbr/>Reducer</span></a>
|
|
11
|
-
<a href="../types/_zthun_helpful_react.ZAmbassadorReducerRequired.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2097152"></use></svg><span>ZAmbassador<wbr/>Reducer<wbr/>Required</span></a>
|
|
12
|
-
<a href="../types/_zthun_helpful_react.ZAmbassadorSetCurrent.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2097152"></use></svg><span>ZAmbassador<wbr/>Set<wbr/>Current</span></a>
|
|
13
|
-
<a href="../types/_zthun_helpful_react.ZAsyncDataState.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2097152"></use></svg><span>ZAsync<wbr/>Data<wbr/>State</span></a>
|
|
14
|
-
<a href="../types/_zthun_helpful_react.ZAsyncDataTuple.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2097152"></use></svg><span>ZAsync<wbr/>Data<wbr/>Tuple</span></a>
|
|
15
|
-
<a href="../types/_zthun_helpful_react.ZAsyncUseData.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2097152"></use></svg><span>ZAsync<wbr/>Use<wbr/>Data</span></a>
|
|
16
|
-
<a href="../types/_zthun_helpful_react.ZSetStateAsArray.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2097152"></use></svg><span>ZSet<wbr/>State<wbr/>As<wbr/>Array</span></a>
|
|
17
|
-
<a href="../types/_zthun_helpful_react.ZStateAsArrayReducer.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2097152"></use></svg><span>ZState<wbr/>As<wbr/>Array<wbr/>Reducer</span></a>
|
|
18
|
-
</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Variables</h3><div class="tsd-index-list"><a href="../variables/_zthun_helpful_react.DefaultActivateCodes.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-32"></use></svg><span>Default<wbr/>Activate<wbr/>Codes</span></a>
|
|
19
|
-
<a href="../variables/_zthun_helpful_react.ZAsyncLoading.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-32"></use></svg><span>ZAsync<wbr/>Loading</span></a>
|
|
20
|
-
</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Functions</h3><div class="tsd-index-list"><a href="../functions/_zthun_helpful_react.asStateData.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-64"></use></svg><span>as<wbr/>State<wbr/>Data</span></a>
|
|
21
|
-
<a href="../functions/_zthun_helpful_react.asStateError.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-64"></use></svg><span>as<wbr/>State<wbr/>Error</span></a>
|
|
22
|
-
<a href="../functions/_zthun_helpful_react.createKeyboardActivate.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-64"></use></svg><span>create<wbr/>Keyboard<wbr/>Activate</span></a>
|
|
23
|
-
<a href="../functions/_zthun_helpful_react.isStateErrored.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-64"></use></svg><span>is<wbr/>State<wbr/>Errored</span></a>
|
|
24
|
-
<a href="../functions/_zthun_helpful_react.isStateLoaded.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-64"></use></svg><span>is<wbr/>State<wbr/>Loaded</span></a>
|
|
25
|
-
<a href="../functions/_zthun_helpful_react.isStateLoading.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-64"></use></svg><span>is<wbr/>State<wbr/>Loading</span></a>
|
|
26
|
-
<a href="../functions/_zthun_helpful_react.useAmbassadorState.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-64"></use></svg><span>use<wbr/>Ambassador<wbr/>State</span></a>
|
|
27
|
-
<a href="../functions/_zthun_helpful_react.useAsyncState.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-64"></use></svg><span>use<wbr/>Async<wbr/>State</span></a>
|
|
28
|
-
<a href="../functions/_zthun_helpful_react.useFileSelect.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-64"></use></svg><span>use<wbr/>File<wbr/>Select</span></a>
|
|
29
|
-
<a href="../functions/_zthun_helpful_react.useKeyboardActivate.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-64"></use></svg><span>use<wbr/>Keyboard<wbr/>Activate</span></a>
|
|
30
|
-
<a href="../functions/_zthun_helpful_react.useMoreViewState.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-64"></use></svg><span>use<wbr/>More<wbr/>View<wbr/>State</span></a>
|
|
31
|
-
<a href="../functions/_zthun_helpful_react.usePageViewState.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-64"></use></svg><span>use<wbr/>Page<wbr/>View<wbr/>State</span></a>
|
|
32
|
-
<a href="../functions/_zthun_helpful_react.useStateAsArray.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-64"></use></svg><span>use<wbr/>State<wbr/>As<wbr/>Array</span></a>
|
|
33
|
-
<a href="../functions/_zthun_helpful_react.useWindowService.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-64"></use></svg><span>use<wbr/>Window<wbr/>Service</span></a>
|
|
34
|
-
<a href="../functions/_zthun_helpful_react.ZFileSelectContext.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-64"></use></svg><span>ZFile<wbr/>Select<wbr/>Context</span></a>
|
|
35
|
-
<a href="../functions/_zthun_helpful_react.ZWindowServiceContext.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-64"></use></svg><span>ZWindow<wbr/>Service<wbr/>Context</span></a>
|
|
36
|
-
</div></section></section></section></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"><a href="#md:helpful-react"><span>Helpful <wbr/>React</span></a><ul><li><a href="#md:installation"><span>Installation</span></a></li></ul></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>@zthun/helpful-validation | 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="_zthun_helpful_validation.html">@zthun/helpful-validation</a></li></ul><h1>Module @zthun/helpful-validation</h1></div><section class="tsd-panel tsd-typography"><a id="md:helpful-validation" class="tsd-anchor"></a><h1 class="tsd-anchor-link">Helpful Validation<a href="#md:helpful-validation" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h1><p>A basic package that extends
|
|
3
|
-
<a href="https://www.npmjs.com/package/class-validator" target="_blank" class="external">class-validator</a> with additional
|
|
4
|
-
checks that are not supported natively.</p>
|
|
5
|
-
<a id="md:installation" class="tsd-anchor"></a><h2 class="tsd-anchor-link">Installation<a href="#md:installation" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h2><pre><code class="sh"><span class="hl-1">npm</span><span class="hl-2"> </span><span class="hl-3">install</span><span class="hl-2"> </span><span class="hl-3">@zthun/helpful-validation</span><br/><span class="hl-1">yarn</span><span class="hl-2"> </span><span class="hl-3">add</span><span class="hl-2"> </span><span class="hl-3">@zthun/helpful-validation</span>
|
|
6
|
-
</code><button type="button">Copy</button></pre>
|
|
7
|
-
|
|
8
|
-
</section><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><h3 class="tsd-index-heading uppercase">Index</h3><section class="tsd-index-section"><h3 class="tsd-index-heading">Classes</h3><div class="tsd-index-list"><a href="../classes/_zthun_helpful_validation.EqualsOtherPropertyValidator.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-128"></use></svg><span>Equals<wbr/>Other<wbr/>Property<wbr/>Validator</span></a>
|
|
9
|
-
<a href="../classes/_zthun_helpful_validation.IsDataURILimitValidator.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-128"></use></svg><span>Is<wbr/>DataURILimit<wbr/>Validator</span></a>
|
|
10
|
-
<a href="../classes/_zthun_helpful_validation.IsNotWhiteSpaceValidator.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-128"></use></svg><span>Is<wbr/>Not<wbr/>White<wbr/>Space<wbr/>Validator</span></a>
|
|
11
|
-
<a href="../classes/_zthun_helpful_validation.RequiresOtherPropertyValidator.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-128"></use></svg><span>Requires<wbr/>Other<wbr/>Property<wbr/>Validator</span></a>
|
|
12
|
-
</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Functions</h3><div class="tsd-index-list"><a href="../functions/_zthun_helpful_validation.EqualsOtherProperty.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-64"></use></svg><span>Equals<wbr/>Other<wbr/>Property</span></a>
|
|
13
|
-
<a href="../functions/_zthun_helpful_validation.IsDataURILimit.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-64"></use></svg><span>Is<wbr/>DataURILimit</span></a>
|
|
14
|
-
<a href="../functions/_zthun_helpful_validation.IsNotWhiteSpace.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-64"></use></svg><span>Is<wbr/>Not<wbr/>White<wbr/>Space</span></a>
|
|
15
|
-
<a href="../functions/_zthun_helpful_validation.RequiresOtherProperty.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-64"></use></svg><span>Requires<wbr/>Other<wbr/>Property</span></a>
|
|
16
|
-
</div></section></section></section></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"><a href="#md:helpful-validation"><span>Helpful <wbr/>Validation</span></a><ul><li><a href="#md:installation"><span>Installation</span></a></li></ul></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,2 +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>DeepPartial | 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.DeepPartial.html">DeepPartial</a></li></ul><h1>Type Alias DeepPartial<T></h1></div><div class="tsd-signature"><span class="tsd-kind-type-alias">Deep<wbr/>Partial</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful_fn.DeepPartial.html#T">T</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{</span><br/><span> </span><span class="tsd-signature-symbol">[</span><span class="tsd-kind-type-parameter">P</span><span class="tsd-signature-keyword"> in </span><span class="tsd-signature-keyword">keyof </span><a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful_fn.DeepPartial.html#T">T</a><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">?: </span><a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful_fn.DeepPartial.html#T">T</a><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type tsd-kind-type-parameter">P</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-keyword"> extends </span><span class="tsd-signature-type">object</span><br/><span> </span><span class="tsd-signature-symbol">? </span><a href="_zthun_helpful_fn.DeepPartial.html" class="tsd-signature-type tsd-kind-type-alias">DeepPartial</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful_fn.DeepPartial.html#T">T</a><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type tsd-kind-type-parameter">P</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">></span><br/><span> </span><span class="tsd-signature-symbol">: </span><a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful_fn.DeepPartial.html#T">T</a><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type tsd-kind-type-parameter">P</span><span class="tsd-signature-symbol">]</span><br/><span class="tsd-signature-symbol">}</span></div><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a id="T" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">T</span></span></li></ul></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/ce166906b78f0ba06c3593e8b6ff3e5bbb88e101/packages/helpful-fn/src/partial/deep-partial.ts#L1">packages/helpful-fn/src/partial/deep-partial.ts:1</a></li></ul></aside></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></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,7 +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>JoinListInputParameter | 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.JoinListInputParameter.html">JoinListInputParameter</a></li></ul><h1>Type Alias JoinListInputParameter<T></h1></div><div class="tsd-signature"><span class="tsd-kind-type-alias">Join<wbr/>List<wbr/>Input<wbr/>Parameter</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful_fn.JoinListInputParameter.html#T">T</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">:</span> <br/><span> </span><span class="tsd-signature-symbol">| </span><a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful_fn.JoinListInputParameter.html#T">T</a><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-symbol">[</span><a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful_fn.JoinListInputParameter.html#T">T</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">]</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">null</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">undefined</span></div><div class="tsd-comment tsd-typography"><p>A set of parameters that can be used for a string join.</p>
|
|
3
|
-
<p>Join lists can be a regular object, null, undefined, or a tuple where the
|
|
4
|
-
first item is the object to join, and the second item is a boolean that specifies
|
|
5
|
-
whether to include it if the value is truthy.</p>
|
|
6
|
-
</div><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a id="T" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">T</span></span><div class="tsd-comment tsd-typography"><p>The type of data to join.</p>
|
|
7
|
-
</div><div class="tsd-comment tsd-typography"></div></li></ul></section><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/join-defined/join-defined.mts#L11">packages/helpful-fn/src/join-defined/join-defined.mts:11</a></li></ul></aside></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></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,2 +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>PickPredicate | 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.PickPredicate.html">PickPredicate</a></li></ul><h1>Type Alias PickPredicate</h1></div><div class="tsd-signature"><span class="tsd-kind-type-alias">Pick<wbr/>Predicate</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">key</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span>, <span class="tsd-kind-parameter">value</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/ce166906b78f0ba06c3593e8b6ff3e5bbb88e101/packages/helpful-fn/src/pick/pick.mts#L1">packages/helpful-fn/src/pick/pick.mts:1</a></li></ul></aside></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></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,2 +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>PickResult | 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.PickResult.html">PickResult</a></li></ul><h1>Type Alias PickResult<T></h1></div><div class="tsd-signature"><span class="tsd-kind-type-alias">Pick<wbr/>Result</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful_fn.PickResult.html#T">T</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful_fn.PickResult.html#T">T</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span></div><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a id="T" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">T</span></span></li></ul></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/ce166906b78f0ba06c3593e8b6ff3e5bbb88e101/packages/helpful-fn/src/pick/pick.mts#L6">packages/helpful-fn/src/pick/pick.mts:6</a></li></ul></aside></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></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,2 +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>RequiredDeep | 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.RequiredDeep.html">RequiredDeep</a></li></ul><h1>Type Alias RequiredDeep<T></h1></div><div class="tsd-signature"><span class="tsd-kind-type-alias">Required<wbr/>Deep</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful_fn.RequiredDeep.html#T">T</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Required</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{</span><br/><span> </span><span class="tsd-signature-symbol">[</span><span class="tsd-kind-type-parameter">K</span><span class="tsd-signature-keyword"> in </span><span class="tsd-signature-keyword">keyof </span><a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful_fn.RequiredDeep.html#T">T</a><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">: </span><a href="_zthun_helpful_fn.RequiredDeep.html" class="tsd-signature-type tsd-kind-type-alias">RequiredDeep</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful_fn.RequiredDeep.html#T">T</a><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type tsd-kind-type-parameter">K</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">></span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">></span></div><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a id="T" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">T</span></span></li></ul></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/ce166906b78f0ba06c3593e8b6ff3e5bbb88e101/packages/helpful-fn/src/required/required-deep.mts#L1">packages/helpful-fn/src/required/required-deep.mts:1</a></li></ul></aside></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></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,2 +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>RequiredPick | 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.RequiredPick.html">RequiredPick</a></li></ul><h1>Type Alias RequiredPick<T, P></h1></div><div class="tsd-signature"><span class="tsd-kind-type-alias">Required<wbr/>Pick</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful_fn.RequiredPick.html#T">T</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful_fn.RequiredPick.html#P">P</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful_fn.RequiredPick.html#T">T</a><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-type">Required</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Pick</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful_fn.RequiredPick.html#T">T</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful_fn.RequiredPick.html#P">P</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></div><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a id="T" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">T</span></span></li><li><span><a id="P" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">P</span><span class="tsd-signature-keyword"> extends </span><span class="tsd-signature-keyword">keyof </span><a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful_fn.RequiredPick.html#T">T</a></span></li></ul></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/ce166906b78f0ba06c3593e8b6ff3e5bbb88e101/packages/helpful-fn/src/required/required-pick.mts#L1">packages/helpful-fn/src/required/required-pick.mts:1</a></li></ul></aside></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></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>
|