@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.
Files changed (320) hide show
  1. package/LICENSE +15 -11
  2. package/dist/assets/hierarchy.js +1 -0
  3. package/dist/assets/highlight.css +0 -14
  4. package/dist/assets/icons.js +1 -1
  5. package/dist/assets/icons.svg +1 -1
  6. package/dist/assets/main.js +5 -5
  7. package/dist/assets/navigation.js +1 -1
  8. package/dist/assets/search.js +1 -1
  9. package/dist/assets/style.css +1405 -1288
  10. package/dist/classes/{_zthun_helpful_brands.ZBrandBuilder.html → _zthun_helpful-brands.ZBrandBuilder.html} +87 -88
  11. package/dist/classes/{_zthun_helpful_fn.ZAssert.html → _zthun_helpful-fn.ZAssert.html} +11 -12
  12. package/dist/classes/_zthun_helpful-fn.ZDeserializeJson.html +10 -0
  13. package/dist/classes/_zthun_helpful-fn.ZDeserializeTry.html +18 -0
  14. package/dist/classes/_zthun_helpful-fn.ZQuadrilateralBuilder.html +43 -0
  15. package/dist/classes/_zthun_helpful-fn.ZQuadrilateralCornersBuilder.html +48 -0
  16. package/dist/classes/_zthun_helpful-fn.ZRectangle.html +64 -0
  17. package/dist/classes/{_zthun_helpful_fn.ZSerializeJson.html → _zthun_helpful-fn.ZSerializeJson.html} +6 -7
  18. package/dist/classes/{_zthun_helpful_internet.ZCookieBuilder.html → _zthun_helpful-internet.ZCookieBuilder.html} +40 -41
  19. package/dist/classes/{_zthun_helpful_internet.ZEmailBuilder.html → _zthun_helpful-internet.ZEmailBuilder.html} +21 -22
  20. package/dist/classes/{_zthun_helpful_internet.ZEmailContactAddressBuilder.html → _zthun_helpful-internet.ZEmailContactAddressBuilder.html} +14 -15
  21. package/dist/classes/{_zthun_helpful_internet.ZEmailContactBuilder.html → _zthun_helpful-internet.ZEmailContactBuilder.html} +20 -21
  22. package/dist/classes/{_zthun_helpful_internet.ZEmailEnvelopeBuilder.html → _zthun_helpful-internet.ZEmailEnvelopeBuilder.html} +43 -44
  23. package/dist/classes/{_zthun_helpful_internet.ZServerBuilder.html → _zthun_helpful-internet.ZServerBuilder.html} +21 -22
  24. package/dist/classes/_zthun_helpful-query.ZDataFilterFields.html +11 -0
  25. package/dist/classes/{_zthun_helpful_query.ZDataMatchAlways.html → _zthun_helpful-query.ZDataMatchAlways.html} +5 -6
  26. package/dist/classes/_zthun_helpful-query.ZDataMatchOptional.html +15 -0
  27. package/dist/classes/{_zthun_helpful_query.ZDataRequestBuilder.html → _zthun_helpful-query.ZDataRequestBuilder.html} +27 -28
  28. package/dist/classes/_zthun_helpful-query.ZDataSearchFields.html +10 -0
  29. package/dist/classes/{_zthun_helpful_query.ZDataSearchText.html → _zthun_helpful-query.ZDataSearchText.html} +5 -6
  30. package/dist/classes/_zthun_helpful-query.ZDataSourceStatic.html +57 -0
  31. package/dist/classes/_zthun_helpful-query.ZDataSourceStaticOptionsBuilder.html +22 -0
  32. package/dist/classes/_zthun_helpful-query.ZFilterBinaryBuilder.html +42 -0
  33. package/dist/classes/{_zthun_helpful_query.ZFilterCollectionBuilder.html → _zthun_helpful-query.ZFilterCollectionBuilder.html} +25 -26
  34. package/dist/classes/{_zthun_helpful_query.ZFilterDeserialize.html → _zthun_helpful-query.ZFilterDeserialize.html} +7 -8
  35. package/dist/classes/{_zthun_helpful_query.ZFilterLogicBuilder.html → _zthun_helpful-query.ZFilterLogicBuilder.html} +25 -26
  36. package/dist/classes/{_zthun_helpful_query.ZFilterSerialize.html → _zthun_helpful-query.ZFilterSerialize.html} +7 -8
  37. package/dist/classes/{_zthun_helpful_query.ZFilterUnaryBuilder.html → _zthun_helpful-query.ZFilterUnaryBuilder.html} +20 -21
  38. package/dist/classes/{_zthun_helpful_query.ZMetadataBuilder.html → _zthun_helpful-query.ZMetadataBuilder.html} +55 -56
  39. package/dist/classes/_zthun_helpful-query.ZPageBuilder.html +30 -0
  40. package/dist/classes/{_zthun_helpful_query.ZSortBuilder.html → _zthun_helpful-query.ZSortBuilder.html} +17 -18
  41. package/dist/classes/{_zthun_helpful_query.ZSortDeserialize.html → _zthun_helpful-query.ZSortDeserialize.html} +7 -8
  42. package/dist/classes/_zthun_helpful-query.ZSortSerialize.html +8 -0
  43. package/dist/classes/{_zthun_helpful_query.ZSorterSingle.html → _zthun_helpful-query.ZSorterSingle.html} +12 -13
  44. package/dist/classes/{_zthun_helpful_query.ZWellKnownIconClasses.html → _zthun_helpful-query.ZWellKnownIconClasses.html} +15 -16
  45. package/dist/classes/{_zthun_helpful_react.ZFileSelect.html → _zthun_helpful-react.ZFileSelect.html} +7 -8
  46. package/dist/classes/{_zthun_helpful_validation.EqualsOtherPropertyValidator.html → _zthun_helpful-validation.EqualsOtherPropertyValidator.html} +5 -6
  47. package/dist/classes/{_zthun_helpful_validation.IsDataURILimitValidator.html → _zthun_helpful-validation.IsDataURILimitValidator.html} +5 -6
  48. package/dist/classes/{_zthun_helpful_validation.IsNotWhiteSpaceValidator.html → _zthun_helpful-validation.IsNotWhiteSpaceValidator.html} +5 -6
  49. package/dist/classes/{_zthun_helpful_validation.RequiresOtherPropertyValidator.html → _zthun_helpful-validation.RequiresOtherPropertyValidator.html} +5 -6
  50. package/dist/enums/{_zthun_helpful_fn.ZHorizontalAnchor.html → _zthun_helpful-fn.ZHorizontalAnchor.html} +8 -9
  51. package/dist/enums/{_zthun_helpful_fn.ZOrientation.html → _zthun_helpful-fn.ZOrientation.html} +6 -7
  52. package/dist/enums/{_zthun_helpful_fn.ZVerticalAnchor.html → _zthun_helpful-fn.ZVerticalAnchor.html} +8 -9
  53. package/dist/enums/{_zthun_helpful_query.ZMetadataType.html → _zthun_helpful-query.ZMetadataType.html} +14 -15
  54. package/dist/enums/{_zthun_helpful_query.ZOperatorBinary.html → _zthun_helpful-query.ZOperatorBinary.html} +16 -17
  55. package/dist/enums/{_zthun_helpful_query.ZOperatorCollection.html → _zthun_helpful-query.ZOperatorCollection.html} +6 -7
  56. package/dist/enums/{_zthun_helpful_query.ZOperatorLogic.html → _zthun_helpful-query.ZOperatorLogic.html} +6 -7
  57. package/dist/enums/{_zthun_helpful_query.ZOperatorUnary.html → _zthun_helpful-query.ZOperatorUnary.html} +6 -7
  58. package/dist/enums/{_zthun_helpful_query.ZSortDirection.html → _zthun_helpful-query.ZSortDirection.html} +6 -7
  59. package/dist/functions/{_zthun_helpful_fn.bash.html → _zthun_helpful-fn.bash.html} +5 -6
  60. package/dist/functions/_zthun_helpful-fn.commaJoinDefined.html +5 -0
  61. package/dist/functions/{_zthun_helpful_fn.countBuckets.html → _zthun_helpful-fn.countBuckets.html} +3 -4
  62. package/dist/functions/{_zthun_helpful_fn.createError.html → _zthun_helpful-fn.createError.html} +3 -4
  63. package/dist/functions/{_zthun_helpful_fn.createGuid.html → _zthun_helpful-fn.createGuid.html} +4 -5
  64. package/dist/functions/{_zthun_helpful_fn.css.html → _zthun_helpful-fn.css.html} +5 -6
  65. package/dist/functions/_zthun_helpful-fn.cssJoinDefined.html +5 -0
  66. package/dist/functions/_zthun_helpful-fn.firstDefined.html +12 -0
  67. package/dist/functions/_zthun_helpful-fn.firstTruthy.html +12 -0
  68. package/dist/functions/_zthun_helpful-fn.firstWhere.html +10 -0
  69. package/dist/functions/{_zthun_helpful_fn.html.html → _zthun_helpful-fn.html.html} +5 -6
  70. package/dist/functions/_zthun_helpful-fn.isEmptyObject.html +8 -0
  71. package/dist/functions/{_zthun_helpful_fn.javascript.html → _zthun_helpful-fn.javascript.html} +5 -6
  72. package/dist/functions/_zthun_helpful-fn.joinDefined.html +9 -0
  73. package/dist/functions/{_zthun_helpful_fn.js.html → _zthun_helpful-fn.js.html} +5 -6
  74. package/dist/functions/{_zthun_helpful_fn.markdown.html → _zthun_helpful-fn.markdown.html} +5 -6
  75. package/dist/functions/{_zthun_helpful_fn.md.html → _zthun_helpful-fn.md.html} +5 -6
  76. package/dist/functions/_zthun_helpful-fn.optional.html +32 -0
  77. package/dist/functions/_zthun_helpful-fn.peel.html +8 -0
  78. package/dist/functions/{_zthun_helpful_fn.peelBetween.html → _zthun_helpful-fn.peelBetween.html} +4 -5
  79. package/dist/functions/_zthun_helpful-fn.pickBy.html +6 -0
  80. package/dist/functions/_zthun_helpful-fn.pickDataAttributes.html +4 -0
  81. package/dist/functions/_zthun_helpful-fn.pickDefined.html +4 -0
  82. package/dist/functions/_zthun_helpful-fn.pipeJoinDefined.html +5 -0
  83. package/dist/functions/_zthun_helpful-fn.required.html +9 -0
  84. package/dist/functions/_zthun_helpful-fn.semiColonJoinDefined.html +5 -0
  85. package/dist/functions/_zthun_helpful-fn.setFirst.html +16 -0
  86. package/dist/functions/{_zthun_helpful_fn.sh.html → _zthun_helpful-fn.sh.html} +5 -6
  87. package/dist/functions/_zthun_helpful-fn.sleep.html +13 -0
  88. package/dist/functions/_zthun_helpful-fn.spaceJoinDefined.html +5 -0
  89. package/dist/functions/{_zthun_helpful_fn.tag.html → _zthun_helpful-fn.tag.html} +4 -5
  90. package/dist/functions/_zthun_helpful-fn.tryFallback.html +13 -0
  91. package/dist/functions/_zthun_helpful-fn.tryFallbackAsync.html +16 -0
  92. package/dist/functions/{_zthun_helpful_fn.ts.html → _zthun_helpful-fn.ts.html} +5 -6
  93. package/dist/functions/{_zthun_helpful_fn.typescript.html → _zthun_helpful-fn.typescript.html} +5 -6
  94. package/dist/functions/{_zthun_helpful_fn.zsh.html → _zthun_helpful-fn.zsh.html} +5 -6
  95. package/dist/functions/{_zthun_helpful_node.walk.html → _zthun_helpful-node.walk.html} +5 -6
  96. package/dist/functions/_zthun_helpful-query.isBinaryFilter.html +4 -0
  97. package/dist/functions/_zthun_helpful-query.isBinaryOperator.html +4 -0
  98. package/dist/functions/_zthun_helpful-query.isCollectionFilter.html +4 -0
  99. package/dist/functions/_zthun_helpful-query.isCollectionOperator.html +4 -0
  100. package/dist/functions/_zthun_helpful-query.isLogicFilter.html +4 -0
  101. package/dist/functions/_zthun_helpful-query.isLogicOperator.html +4 -0
  102. package/dist/functions/_zthun_helpful-query.isUnaryFilter.html +4 -0
  103. package/dist/functions/_zthun_helpful-query.isUnaryOperator.html +4 -0
  104. package/dist/functions/_zthun_helpful-react.ZFileSelectContext.html +10 -0
  105. package/dist/functions/_zthun_helpful-react.ZWindowServiceContext.html +10 -0
  106. package/dist/functions/_zthun_helpful-react.asStateData.html +18 -0
  107. package/dist/functions/_zthun_helpful-react.asStateError.html +6 -0
  108. package/dist/functions/_zthun_helpful-react.createKeyboardActivate.html +7 -0
  109. package/dist/functions/_zthun_helpful-react.isStateErrored.html +5 -0
  110. package/dist/functions/_zthun_helpful-react.isStateLoaded.html +5 -0
  111. package/dist/functions/_zthun_helpful-react.isStateLoading.html +5 -0
  112. package/dist/functions/_zthun_helpful-react.useAmbassadorState.html +38 -0
  113. package/dist/functions/_zthun_helpful-react.useAsyncState.html +7 -0
  114. package/dist/functions/_zthun_helpful-react.useFileSelect.html +3 -0
  115. package/dist/functions/_zthun_helpful-react.useKeyboardActivate.html +12 -0
  116. package/dist/functions/_zthun_helpful-react.useMoreViewState.html +12 -0
  117. package/dist/functions/_zthun_helpful-react.usePageViewState.html +10 -0
  118. package/dist/functions/_zthun_helpful-react.useStateAsArray.html +8 -0
  119. package/dist/functions/_zthun_helpful-react.useWindowService.html +3 -0
  120. package/dist/functions/_zthun_helpful-validation.EqualsOtherProperty.html +5 -0
  121. package/dist/functions/_zthun_helpful-validation.IsDataURILimit.html +6 -0
  122. package/dist/functions/_zthun_helpful-validation.IsNotWhiteSpace.html +4 -0
  123. package/dist/functions/_zthun_helpful-validation.RequiresOtherProperty.html +5 -0
  124. package/dist/hierarchy.html +1 -2
  125. package/dist/index.html +2 -3
  126. package/dist/interfaces/{_zthun_helpful_brands.IZBrand.html → _zthun_helpful-brands.IZBrand.html} +10 -11
  127. package/dist/interfaces/_zthun_helpful-fn.IZDeserialize.html +11 -0
  128. package/dist/interfaces/_zthun_helpful-fn.IZPoint2d.html +6 -0
  129. package/dist/interfaces/_zthun_helpful-fn.IZPoint3d.html +8 -0
  130. package/dist/interfaces/{_zthun_helpful_fn.IZQuadrilateral.html → _zthun_helpful-fn.IZQuadrilateral.html} +11 -12
  131. package/dist/interfaces/_zthun_helpful-fn.IZQuadrilateralCorners.html +9 -0
  132. package/dist/interfaces/_zthun_helpful-fn.IZSerialize.html +9 -0
  133. package/dist/interfaces/{_zthun_helpful_internet.IZCookie.html → _zthun_helpful-internet.IZCookie.html} +15 -16
  134. package/dist/interfaces/{_zthun_helpful_internet.IZEmail.html → _zthun_helpful-internet.IZEmail.html} +8 -9
  135. package/dist/interfaces/{_zthun_helpful_internet.IZEmailContact.html → _zthun_helpful-internet.IZEmailContact.html} +7 -8
  136. package/dist/interfaces/_zthun_helpful-internet.IZEmailEnvelope.html +13 -0
  137. package/dist/interfaces/{_zthun_helpful_internet.IZServer.html → _zthun_helpful-internet.IZServer.html} +9 -10
  138. package/dist/interfaces/{_zthun_helpful_node.ZWalkOptions.html → _zthun_helpful-node.ZWalkOptions.html} +8 -9
  139. package/dist/interfaces/_zthun_helpful-query.IZDataMatch.html +9 -0
  140. package/dist/interfaces/{_zthun_helpful_query.IZDataRequest.html → _zthun_helpful-query.IZDataRequest.html} +15 -16
  141. package/dist/interfaces/{_zthun_helpful_query.IZDataRequestQuery.html → _zthun_helpful-query.IZDataRequestQuery.html} +11 -12
  142. package/dist/interfaces/{_zthun_helpful_query.IZDataSource.html → _zthun_helpful-query.IZDataSource.html} +10 -11
  143. package/dist/interfaces/{_zthun_helpful_query.IZDataSourceStaticOptions.html → _zthun_helpful-query.IZDataSourceStaticOptions.html} +7 -8
  144. package/dist/interfaces/{_zthun_helpful_query.IZFilterBinary.html → _zthun_helpful-query.IZFilterBinary.html} +9 -10
  145. package/dist/interfaces/{_zthun_helpful_query.IZFilterCollection.html → _zthun_helpful-query.IZFilterCollection.html} +9 -10
  146. package/dist/interfaces/{_zthun_helpful_query.IZFilterLogic.html → _zthun_helpful-query.IZFilterLogic.html} +8 -9
  147. package/dist/interfaces/_zthun_helpful-query.IZFilterMetadata.html +6 -0
  148. package/dist/interfaces/_zthun_helpful-query.IZFilterOperator.html +7 -0
  149. package/dist/interfaces/_zthun_helpful-query.IZFilterSubject.html +8 -0
  150. package/dist/interfaces/{_zthun_helpful_query.IZMetadata.html → _zthun_helpful-query.IZMetadata.html} +23 -24
  151. package/dist/interfaces/{_zthun_helpful_query.IZPage.html → _zthun_helpful-query.IZPage.html} +6 -7
  152. package/dist/interfaces/{_zthun_helpful_query.IZSort.html → _zthun_helpful-query.IZSort.html} +6 -7
  153. package/dist/interfaces/_zthun_helpful-query.IZSorter.html +27 -0
  154. package/dist/interfaces/_zthun_helpful-react.IZFileSelect.html +10 -0
  155. package/dist/interfaces/{_zthun_helpful_react.IZKeyboardInteraction.html → _zthun_helpful-react.IZKeyboardInteraction.html} +8 -9
  156. package/dist/modules/_zthun_helpful-brands.html +18 -0
  157. package/dist/modules/_zthun_helpful-fn.html +7 -0
  158. package/dist/modules/_zthun_helpful-internet.html +6 -0
  159. package/dist/modules/_zthun_helpful-node.html +10 -0
  160. package/dist/modules/_zthun_helpful-query.html +32 -0
  161. package/dist/modules/_zthun_helpful-react.html +6 -0
  162. package/dist/modules/_zthun_helpful-validation.html +7 -0
  163. package/dist/modules.html +1 -2
  164. package/dist/types/_zthun_helpful-fn.DeepPartial.html +1 -0
  165. package/dist/types/_zthun_helpful-fn.JoinListInputParameter.html +6 -0
  166. package/dist/types/_zthun_helpful-fn.PickPredicate.html +1 -0
  167. package/dist/types/_zthun_helpful-fn.PickResult.html +1 -0
  168. package/dist/types/_zthun_helpful-fn.RequiredDeep.html +1 -0
  169. package/dist/types/_zthun_helpful-fn.RequiredPick.html +1 -0
  170. package/dist/types/_zthun_helpful-fn.ZAnchor.html +11 -0
  171. package/dist/types/_zthun_helpful-fn.ZCornersHorizontal.html +2 -0
  172. package/dist/types/_zthun_helpful-fn.ZCornersVertical.html +2 -0
  173. package/dist/types/_zthun_helpful-fn.ZObligatedValue.html +3 -0
  174. package/dist/types/_zthun_helpful-fn.ZQuadrilateralCornersLike.html +2 -0
  175. package/dist/types/_zthun_helpful-fn.ZQuadrilateralLike.html +5 -0
  176. package/dist/types/_zthun_helpful-fn.ZSideAnchor.html +2 -0
  177. package/dist/types/_zthun_helpful-query.IZFilter.html +2 -0
  178. package/dist/types/_zthun_helpful-query.IZFilterUnary.html +2 -0
  179. package/dist/types/_zthun_helpful-query.ZOperatorFilter.html +2 -0
  180. package/dist/types/_zthun_helpful-react.ZAmbassadorReducer.html +2 -0
  181. package/dist/types/_zthun_helpful-react.ZAmbassadorReducerRequired.html +2 -0
  182. package/dist/types/_zthun_helpful-react.ZAmbassadorSetCurrent.html +2 -0
  183. package/dist/types/_zthun_helpful-react.ZAsyncDataState.html +8 -0
  184. package/dist/types/_zthun_helpful-react.ZAsyncDataTuple.html +5 -0
  185. package/dist/types/_zthun_helpful-react.ZAsyncUseData.html +2 -0
  186. package/dist/types/_zthun_helpful-react.ZSetStateAsArray.html +1 -0
  187. package/dist/types/_zthun_helpful-react.ZStateAsArrayReducer.html +1 -0
  188. package/dist/variables/_zthun_helpful-brands.ZBrands.html +5 -0
  189. package/dist/variables/_zthun_helpful-fn._global.html +1 -0
  190. package/dist/variables/_zthun_helpful-query.ZBinaryComparators.html +2 -0
  191. package/dist/variables/_zthun_helpful-query.ZCollectionComparators.html +2 -0
  192. package/dist/variables/_zthun_helpful-query.ZOperatorsBinary.html +2 -0
  193. package/dist/variables/_zthun_helpful-query.ZOperatorsCollection.html +2 -0
  194. package/dist/variables/_zthun_helpful-query.ZOperatorsFilter.html +2 -0
  195. package/dist/variables/_zthun_helpful-query.ZOperatorsLogic.html +2 -0
  196. package/dist/variables/_zthun_helpful-query.ZOperatorsUnary.html +2 -0
  197. package/dist/variables/_zthun_helpful-query.ZSortDirections.html +2 -0
  198. package/dist/variables/_zthun_helpful-query.ZUnaryComparators.html +2 -0
  199. package/dist/variables/_zthun_helpful-react.DefaultActivateCodes.html +4 -0
  200. package/dist/variables/_zthun_helpful-react.ZAsyncLoading.html +2 -0
  201. package/package.json +11 -13
  202. package/dist/classes/_zthun_helpful_fn.ZDeserializeJson.html +0 -11
  203. package/dist/classes/_zthun_helpful_fn.ZDeserializeTry.html +0 -19
  204. package/dist/classes/_zthun_helpful_fn.ZQuadrilateralBuilder.html +0 -44
  205. package/dist/classes/_zthun_helpful_fn.ZQuadrilateralCornersBuilder.html +0 -49
  206. package/dist/classes/_zthun_helpful_fn.ZRectangle.html +0 -65
  207. package/dist/classes/_zthun_helpful_query.ZDataFilterFields.html +0 -12
  208. package/dist/classes/_zthun_helpful_query.ZDataMatchOptional.html +0 -16
  209. package/dist/classes/_zthun_helpful_query.ZDataSearchFields.html +0 -11
  210. package/dist/classes/_zthun_helpful_query.ZDataSourceStatic.html +0 -58
  211. package/dist/classes/_zthun_helpful_query.ZDataSourceStaticOptionsBuilder.html +0 -23
  212. package/dist/classes/_zthun_helpful_query.ZFilterBinaryBuilder.html +0 -43
  213. package/dist/classes/_zthun_helpful_query.ZPageBuilder.html +0 -31
  214. package/dist/classes/_zthun_helpful_query.ZSortSerialize.html +0 -9
  215. package/dist/functions/_zthun_helpful_fn.commaJoinDefined.html +0 -6
  216. package/dist/functions/_zthun_helpful_fn.cssJoinDefined.html +0 -6
  217. package/dist/functions/_zthun_helpful_fn.firstDefined.html +0 -13
  218. package/dist/functions/_zthun_helpful_fn.firstTruthy.html +0 -13
  219. package/dist/functions/_zthun_helpful_fn.firstWhere.html +0 -11
  220. package/dist/functions/_zthun_helpful_fn.isEmptyObject.html +0 -9
  221. package/dist/functions/_zthun_helpful_fn.joinDefined.html +0 -10
  222. package/dist/functions/_zthun_helpful_fn.optional.html +0 -33
  223. package/dist/functions/_zthun_helpful_fn.peel.html +0 -9
  224. package/dist/functions/_zthun_helpful_fn.pickBy.html +0 -7
  225. package/dist/functions/_zthun_helpful_fn.pickDataAttributes.html +0 -5
  226. package/dist/functions/_zthun_helpful_fn.pickDefined.html +0 -5
  227. package/dist/functions/_zthun_helpful_fn.pipeJoinDefined.html +0 -6
  228. package/dist/functions/_zthun_helpful_fn.required.html +0 -10
  229. package/dist/functions/_zthun_helpful_fn.semiColonJoinDefined.html +0 -6
  230. package/dist/functions/_zthun_helpful_fn.setFirst.html +0 -17
  231. package/dist/functions/_zthun_helpful_fn.sleep.html +0 -14
  232. package/dist/functions/_zthun_helpful_fn.spaceJoinDefined.html +0 -6
  233. package/dist/functions/_zthun_helpful_fn.tryFallback.html +0 -14
  234. package/dist/functions/_zthun_helpful_fn.tryFallbackAsync.html +0 -17
  235. package/dist/functions/_zthun_helpful_query.isBinaryFilter.html +0 -5
  236. package/dist/functions/_zthun_helpful_query.isBinaryOperator.html +0 -5
  237. package/dist/functions/_zthun_helpful_query.isCollectionFilter.html +0 -5
  238. package/dist/functions/_zthun_helpful_query.isCollectionOperator.html +0 -5
  239. package/dist/functions/_zthun_helpful_query.isLogicFilter.html +0 -5
  240. package/dist/functions/_zthun_helpful_query.isLogicOperator.html +0 -5
  241. package/dist/functions/_zthun_helpful_query.isUnaryFilter.html +0 -5
  242. package/dist/functions/_zthun_helpful_query.isUnaryOperator.html +0 -5
  243. package/dist/functions/_zthun_helpful_react.ZFileSelectContext.html +0 -11
  244. package/dist/functions/_zthun_helpful_react.ZWindowServiceContext.html +0 -11
  245. package/dist/functions/_zthun_helpful_react.asStateData.html +0 -19
  246. package/dist/functions/_zthun_helpful_react.asStateError.html +0 -7
  247. package/dist/functions/_zthun_helpful_react.createKeyboardActivate.html +0 -8
  248. package/dist/functions/_zthun_helpful_react.isStateErrored.html +0 -6
  249. package/dist/functions/_zthun_helpful_react.isStateLoaded.html +0 -6
  250. package/dist/functions/_zthun_helpful_react.isStateLoading.html +0 -6
  251. package/dist/functions/_zthun_helpful_react.useAmbassadorState.html +0 -39
  252. package/dist/functions/_zthun_helpful_react.useAsyncState.html +0 -8
  253. package/dist/functions/_zthun_helpful_react.useFileSelect.html +0 -4
  254. package/dist/functions/_zthun_helpful_react.useKeyboardActivate.html +0 -13
  255. package/dist/functions/_zthun_helpful_react.useMoreViewState.html +0 -13
  256. package/dist/functions/_zthun_helpful_react.usePageViewState.html +0 -11
  257. package/dist/functions/_zthun_helpful_react.useStateAsArray.html +0 -9
  258. package/dist/functions/_zthun_helpful_react.useWindowService.html +0 -4
  259. package/dist/functions/_zthun_helpful_validation.EqualsOtherProperty.html +0 -6
  260. package/dist/functions/_zthun_helpful_validation.IsDataURILimit.html +0 -7
  261. package/dist/functions/_zthun_helpful_validation.IsNotWhiteSpace.html +0 -5
  262. package/dist/functions/_zthun_helpful_validation.RequiresOtherProperty.html +0 -6
  263. package/dist/interfaces/_zthun_helpful_fn.IZDeserialize.html +0 -12
  264. package/dist/interfaces/_zthun_helpful_fn.IZPoint2d.html +0 -7
  265. package/dist/interfaces/_zthun_helpful_fn.IZPoint3d.html +0 -9
  266. package/dist/interfaces/_zthun_helpful_fn.IZQuadrilateralCorners.html +0 -10
  267. package/dist/interfaces/_zthun_helpful_fn.IZSerialize.html +0 -10
  268. package/dist/interfaces/_zthun_helpful_internet.IZEmailEnvelope.html +0 -14
  269. package/dist/interfaces/_zthun_helpful_query.IZDataMatch.html +0 -10
  270. package/dist/interfaces/_zthun_helpful_query.IZFilterMetadata.html +0 -7
  271. package/dist/interfaces/_zthun_helpful_query.IZFilterOperator.html +0 -8
  272. package/dist/interfaces/_zthun_helpful_query.IZFilterSubject.html +0 -9
  273. package/dist/interfaces/_zthun_helpful_query.IZSorter.html +0 -28
  274. package/dist/interfaces/_zthun_helpful_react.IZFileSelect.html +0 -11
  275. package/dist/modules/_zthun_helpful_brands.html +0 -22
  276. package/dist/modules/_zthun_helpful_fn.html +0 -74
  277. package/dist/modules/_zthun_helpful_internet.html +0 -18
  278. package/dist/modules/_zthun_helpful_node.html +0 -13
  279. package/dist/modules/_zthun_helpful_proxy.html +0 -60
  280. package/dist/modules/_zthun_helpful_query.html +0 -95
  281. package/dist/modules/_zthun_helpful_react.html +0 -36
  282. package/dist/modules/_zthun_helpful_validation.html +0 -16
  283. package/dist/types/_zthun_helpful_fn.DeepPartial.html +0 -2
  284. package/dist/types/_zthun_helpful_fn.JoinListInputParameter.html +0 -7
  285. package/dist/types/_zthun_helpful_fn.PickPredicate.html +0 -2
  286. package/dist/types/_zthun_helpful_fn.PickResult.html +0 -2
  287. package/dist/types/_zthun_helpful_fn.RequiredDeep.html +0 -2
  288. package/dist/types/_zthun_helpful_fn.RequiredPick.html +0 -2
  289. package/dist/types/_zthun_helpful_fn.ZAnchor.html +0 -12
  290. package/dist/types/_zthun_helpful_fn.ZCornersHorizontal.html +0 -3
  291. package/dist/types/_zthun_helpful_fn.ZCornersVertical.html +0 -3
  292. package/dist/types/_zthun_helpful_fn.ZObligatedValue.html +0 -4
  293. package/dist/types/_zthun_helpful_fn.ZQuadrilateralCornersLike.html +0 -3
  294. package/dist/types/_zthun_helpful_fn.ZQuadrilateralLike.html +0 -6
  295. package/dist/types/_zthun_helpful_fn.ZSideAnchor.html +0 -3
  296. package/dist/types/_zthun_helpful_query.IZFilter.html +0 -3
  297. package/dist/types/_zthun_helpful_query.IZFilterUnary.html +0 -3
  298. package/dist/types/_zthun_helpful_query.ZOperatorFilter.html +0 -3
  299. package/dist/types/_zthun_helpful_react.ZAmbassadorReducer.html +0 -3
  300. package/dist/types/_zthun_helpful_react.ZAmbassadorReducerRequired.html +0 -3
  301. package/dist/types/_zthun_helpful_react.ZAmbassadorSetCurrent.html +0 -3
  302. package/dist/types/_zthun_helpful_react.ZAsyncDataState.html +0 -9
  303. package/dist/types/_zthun_helpful_react.ZAsyncDataTuple.html +0 -6
  304. package/dist/types/_zthun_helpful_react.ZAsyncUseData.html +0 -3
  305. package/dist/types/_zthun_helpful_react.ZSetStateAsArray.html +0 -2
  306. package/dist/types/_zthun_helpful_react.ZStateAsArrayReducer.html +0 -2
  307. package/dist/variables/_zthun_helpful_brands.ZBrands.html +0 -6
  308. package/dist/variables/_zthun_helpful_fn._global.html +0 -2
  309. package/dist/variables/_zthun_helpful_query.ZBinaryComparators.html +0 -3
  310. package/dist/variables/_zthun_helpful_query.ZCollectionComparators.html +0 -3
  311. package/dist/variables/_zthun_helpful_query.ZOperatorsBinary.html +0 -3
  312. package/dist/variables/_zthun_helpful_query.ZOperatorsCollection.html +0 -3
  313. package/dist/variables/_zthun_helpful_query.ZOperatorsFilter.html +0 -3
  314. package/dist/variables/_zthun_helpful_query.ZOperatorsLogic.html +0 -3
  315. package/dist/variables/_zthun_helpful_query.ZOperatorsUnary.html +0 -3
  316. package/dist/variables/_zthun_helpful_query.ZSortDirections.html +0 -3
  317. package/dist/variables/_zthun_helpful_query.ZUnaryComparators.html +0 -3
  318. package/dist/variables/_zthun_helpful_react.DefaultActivateCodes.html +0 -5
  319. package/dist/variables/_zthun_helpful_react.ZAsyncLoading.html +0 -3
  320. /package/dist/{helpful.svg → assets/favicon.svg} +0 -0
package/dist/functions/_zthun_helpful_fn.peel.html DELETED
@@ -1,9 +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>peel | 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.peel.html">peel</a></li></ul><h1>Function peel</h1></div><section class="tsd-panel"><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="peel" class="tsd-anchor"></a><span class="tsd-kind-call-signature">peel</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful_fn.peel.html#peel.T">T</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">str</span>, <span class="tsd-kind-parameter">candidates</span><span class="tsd-signature-symbol">)</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.peel.html#peel.T">T</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]</span><a href="#peel" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Peels a candidate string from the start of a string and splits it into two segments.</p>
3
- </div><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a id="peel.T" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">T</span><span class="tsd-signature-keyword"> extends </span><span class="tsd-signature-type">string</span> = <span class="tsd-signature-type">string</span></span></li></ul></section><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">str</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The string to peel from.</p>
4
- </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">candidates</span>: <a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful_fn.peel.html#peel.T">T</a><span class="tsd-signature-symbol">[]</span></span><div class="tsd-comment tsd-typography"><p>The candidate list of values to peel from str.</p>
5
- </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">[</span><a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful_fn.peel.html#peel.T">T</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]</span></h4><p>A tuple where the first item is the peeled string and
6
- the second item is the remainder of the string. If the string
7
- does not start with any given candidates, then the first
8
- item will be null and the second item will be str.</p>
9
- <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/peel/peel.mts#L15">packages/helpful-fn/src/peel/peel.mts:15</a></li></ul></aside></li></ul></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></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>
package/dist/functions/_zthun_helpful_fn.pickBy.html DELETED
@@ -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>pickBy | 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.pickBy.html">pickBy</a></li></ul><h1>Function pickBy</h1></div><section class="tsd-panel"><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="pickBy" class="tsd-anchor"></a><span class="tsd-kind-call-signature">pick<wbr/>By</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful_fn.pickBy.html#pickBy.T">T</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">predicate</span>, <span class="tsd-kind-parameter">target</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../types/_zthun_helpful_fn.PickResult.html" class="tsd-signature-type tsd-kind-type-alias">PickResult</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful_fn.pickBy.html#pickBy.T">T</a><span class="tsd-signature-symbol">&gt;</span><a href="#pickBy" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>A function that reduces an object to keys and values that match a predicate.</p>
3
- </div><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a id="pickBy.T" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">T</span> = <span class="tsd-signature-type">unknown</span></span></li></ul></section><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">predicate</span>: <a href="../types/_zthun_helpful_fn.PickPredicate.html" class="tsd-signature-type tsd-kind-type-alias">PickPredicate</a></span><div class="tsd-comment tsd-typography"><p>The predicate to match the key and value against.</p>
4
- </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">target</span>: <span class="tsd-signature-type">object</span></span><div class="tsd-comment tsd-typography"><p>The object to reduce.</p>
5
- </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="../types/_zthun_helpful_fn.PickResult.html" class="tsd-signature-type tsd-kind-type-alias">PickResult</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful_fn.pickBy.html#pickBy.T">T</a><span class="tsd-signature-symbol">&gt;</span></h4><p>A reduced object that only contains key-value pairs that match
6
- the predicate.</p>
7
- <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/pick/pick.mts#L20">packages/helpful-fn/src/pick/pick.mts:20</a></li></ul></aside></li></ul></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></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>
package/dist/functions/_zthun_helpful_fn.pickDataAttributes.html DELETED
@@ -1,5 +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>pickDataAttributes | 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.pickDataAttributes.html">pickDataAttributes</a></li></ul><h1>Function pickDataAttributes</h1></div><section class="tsd-panel"><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="pickDataAttributes" class="tsd-anchor"></a><span class="tsd-kind-call-signature">pick<wbr/>Data<wbr/>Attributes</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful_fn.pickDataAttributes.html#pickDataAttributes.T">T</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">target</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../types/_zthun_helpful_fn.PickResult.html" class="tsd-signature-type tsd-kind-type-alias">PickResult</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful_fn.pickDataAttributes.html#pickDataAttributes.T">T</a><span class="tsd-signature-symbol">&gt;</span><a href="#pickDataAttributes" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>An alias to pickBy((k) =&gt; k.startsWith('data-')).</p>
3
- </div><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a id="pickDataAttributes.T" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">T</span> = <span class="tsd-signature-type">unknown</span></span></li></ul></section><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">target</span>: <span class="tsd-signature-type">object</span></span><div class="tsd-comment tsd-typography"><p>The target object to reduce.</p>
4
- </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="../types/_zthun_helpful_fn.PickResult.html" class="tsd-signature-type tsd-kind-type-alias">PickResult</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful_fn.pickDataAttributes.html#pickDataAttributes.T">T</a><span class="tsd-signature-symbol">&gt;</span></h4><p>The reduced object.</p>
5
- <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/pick/pick.mts#L59">packages/helpful-fn/src/pick/pick.mts:59</a></li></ul></aside></li></ul></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></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>
package/dist/functions/_zthun_helpful_fn.pickDefined.html DELETED
@@ -1,5 +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>pickDefined | 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.pickDefined.html">pickDefined</a></li></ul><h1>Function pickDefined</h1></div><section class="tsd-panel"><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="pickDefined" class="tsd-anchor"></a><span class="tsd-kind-call-signature">pick<wbr/>Defined</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful_fn.pickDefined.html#pickDefined.T">T</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">target</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../types/_zthun_helpful_fn.PickResult.html" class="tsd-signature-type tsd-kind-type-alias">PickResult</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful_fn.pickDefined.html#pickDefined.T">T</a><span class="tsd-signature-symbol">&gt;</span><a href="#pickDefined" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>An alias to pickBy with a predicate of (_, v) =&gt; v != null.</p>
3
- </div><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a id="pickDefined.T" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">T</span> = <span class="tsd-signature-type">unknown</span></span></li></ul></section><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">target</span>: <span class="tsd-signature-type">object</span></span><div class="tsd-comment tsd-typography"><p>The target object to reduce.</p>
4
- </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="../types/_zthun_helpful_fn.PickResult.html" class="tsd-signature-type tsd-kind-type-alias">PickResult</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful_fn.pickDefined.html#pickDefined.T">T</a><span class="tsd-signature-symbol">&gt;</span></h4><p>The reduced object.</p>
5
- <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/pick/pick.mts#L46">packages/helpful-fn/src/pick/pick.mts:46</a></li></ul></aside></li></ul></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></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>
package/dist/functions/_zthun_helpful_fn.pipeJoinDefined.html DELETED
@@ -1,6 +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>pipeJoinDefined | 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.pipeJoinDefined.html">pipeJoinDefined</a></li></ul><h1>Function pipeJoinDefined</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>Alias of joinList with a pipe delimiter.</p>
3
- </div><div class="tsd-comment tsd-typography"><div class="tsd-tag-See"><h4 class="tsd-anchor-link"><a id="See" class="tsd-anchor"></a>See<a href="#See" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p><a href="_zthun_helpful_fn.joinDefined.html" class="tsd-kind-function">joinDefined</a> for more information and examples.</p>
4
- </div></div></section><section class="tsd-panel"><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="pipeJoinDefined" class="tsd-anchor"></a><span class="tsd-kind-call-signature">pipe<wbr/>Join<wbr/>Defined</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful_fn.pipeJoinDefined.html#pipeJoinDefined.T">T</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">items</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#pipeJoinDefined" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a id="pipeJoinDefined.T" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">T</span></span></li></ul></section><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><code class="tsd-tag">Rest</code><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">items</span>: <a href="../types/_zthun_helpful_fn.JoinListInputParameter.html" class="tsd-signature-type tsd-kind-type-alias">JoinListInputParameter</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful_fn.pipeJoinDefined.html#pipeJoinDefined.T">T</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">[]</span></span><div class="tsd-comment tsd-typography"><p>The items to join.</p>
5
- </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><p>A string that joins the items that are defined, separated by a pipe delimiter.</p>
6
- <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#L121">packages/helpful-fn/src/join-defined/join-defined.mts:121</a></li></ul></aside></li></ul></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></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>
package/dist/functions/_zthun_helpful_fn.required.html DELETED
@@ -1,10 +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>required | 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.required.html">required</a></li></ul><h1>Function required</h1></div><section class="tsd-panel"><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="required" class="tsd-anchor"></a><span class="tsd-kind-call-signature">required</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful_fn.required.html#required.T">T</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">val</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful_fn.required.html#required.T">T</a><span class="tsd-signature-symbol">&gt;</span><a href="#required" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Requires a value to be non null.</p>
3
- </div><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a id="required.T" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">T</span></span><div class="tsd-comment tsd-typography"><p>The type of value that is being checked.</p>
4
- </div><div class="tsd-comment tsd-typography"></div></li></ul></section><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">val</span>: <a href="../types/_zthun_helpful_fn.ZObligatedValue.html" class="tsd-signature-type tsd-kind-type-alias">ZObligatedValue</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful_fn.required.html#required.T">T</a><span class="tsd-signature-symbol">&gt;</span></span><div class="tsd-comment tsd-typography"><p>The value to require. This can be a promise
5
- that can return null or undefined in addition to the
6
- value.</p>
7
- </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful_fn.required.html#required.T">T</a><span class="tsd-signature-symbol">&gt;</span></h4><p>This method returns val if it is not null
8
- or undefined, otherwise, an error is thrown.</p>
9
- <div class="tsd-comment tsd-typography"><div class="tsd-tag-Throws"><h4 class="tsd-anchor-link"><a id="Throws" class="tsd-anchor"></a>Throws<a href="#Throws" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>An error if the value is null or undefined.</p>
10
- </div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/ce166906b78f0ba06c3593e8b6ff3e5bbb88e101/packages/helpful-fn/src/obligation/obligation.mts#L30">packages/helpful-fn/src/obligation/obligation.mts:30</a></li></ul></aside></li></ul></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></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>
package/dist/functions/_zthun_helpful_fn.semiColonJoinDefined.html DELETED
@@ -1,6 +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>semiColonJoinDefined | 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.semiColonJoinDefined.html">semiColonJoinDefined</a></li></ul><h1>Function semiColonJoinDefined</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>Alias of joinList with a semi-colon delimiter.</p>
3
- </div><div class="tsd-comment tsd-typography"><div class="tsd-tag-See"><h4 class="tsd-anchor-link"><a id="See" class="tsd-anchor"></a>See<a href="#See" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p><a href="_zthun_helpful_fn.joinDefined.html" class="tsd-kind-function">joinDefined</a> for more information and examples.</p>
4
- </div></div></section><section class="tsd-panel"><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="semiColonJoinDefined" class="tsd-anchor"></a><span class="tsd-kind-call-signature">semi<wbr/>Colon<wbr/>Join<wbr/>Defined</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful_fn.semiColonJoinDefined.html#semiColonJoinDefined.T">T</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">items</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#semiColonJoinDefined" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a id="semiColonJoinDefined.T" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">T</span></span></li></ul></section><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><code class="tsd-tag">Rest</code><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">items</span>: <a href="../types/_zthun_helpful_fn.JoinListInputParameter.html" class="tsd-signature-type tsd-kind-type-alias">JoinListInputParameter</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful_fn.semiColonJoinDefined.html#semiColonJoinDefined.T">T</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">[]</span></span><div class="tsd-comment tsd-typography"><p>The items to join.</p>
5
- </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><p>A string that joins the items that are defined, separated by a semi-colon delimiter.</p>
6
- <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#L105">packages/helpful-fn/src/join-defined/join-defined.mts:105</a></li></ul></aside></li></ul></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></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>
package/dist/functions/_zthun_helpful_fn.setFirst.html DELETED
@@ -1,17 +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>setFirst | 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.setFirst.html">setFirst</a></li></ul><h1>Function setFirst</h1></div><section class="tsd-panel"><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="setFirst" class="tsd-anchor"></a><span class="tsd-kind-call-signature">set<wbr/>First</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful_fn.setFirst.html#setFirst.T">T</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">setValue</span>, <span class="tsd-kind-parameter">fallback</span>, <span class="tsd-kind-parameter">value</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#setFirst" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Represents a setter function for when you want to set a single value,
3
- but you have an array instead.</p>
4
- <p>This is useful when you want to support lists of items, but you need
5
- backwards compatibility for setting a single item. This is primarily meant
6
- to be use with bind to construct a new method setter that takes an array
7
- and forwards it to a setter method which will accept a single value of the
8
- first item in the target value.</p>
9
- </div><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a id="setFirst.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 that the array holds.</p>
10
- </div><div class="tsd-comment tsd-typography"></div></li></ul></section><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">setValue</span>: <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">val</span><span class="tsd-signature-symbol">: </span><a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful_fn.setFirst.html#setFirst.T">T</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span></span><div class="tsd-comment tsd-typography"><p>The setter function that takes a single value. This will receive
11
- the first item of the value list.</p>
12
- </div><div class="tsd-comment tsd-typography"></div><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">val</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">val</span>: <a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful_fn.setFirst.html#setFirst.T">T</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4></li></ul></li></ul></li><li><span><span class="tsd-kind-parameter">fallback</span>: <a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful_fn.setFirst.html#setFirst.T">T</a></span><div class="tsd-comment tsd-typography"><p>The fallback value in the case that there are no values.</p>
13
- </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">value</span>: <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful_fn.setFirst.html#setFirst.T">T</a><span class="tsd-signature-symbol">[]</span></span><div class="tsd-comment tsd-typography"><p>The value list to retrieve the first item from.</p>
14
- </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-Example"><h4 class="tsd-anchor-link"><a id="Example" class="tsd-anchor"></a>Example<a href="#Example" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-0">// An example of a react component that needs a value of an array, but you only care about a single selection.</span><br/><span class="hl-4">const</span><span class="hl-2"> [</span><span class="hl-7">value</span><span class="hl-2">, </span><span class="hl-7">setValue</span><span class="hl-2">] = </span><span class="hl-1">useState</span><span class="hl-2">&lt;</span><span class="hl-8">TypesOfPie</span><span class="hl-2">&gt;();</span><br/><span class="hl-4">const</span><span class="hl-2"> </span><span class="hl-7">_values</span><span class="hl-2"> = </span><span class="hl-1">useMemo</span><span class="hl-2">(() </span><span class="hl-4">=&gt;</span><span class="hl-2"> </span><span class="hl-6">value</span><span class="hl-2"> ? [</span><span class="hl-6">value</span><span class="hl-2">] : [], [</span><span class="hl-6">value</span><span class="hl-2">]);</span><br/><span class="hl-4">const</span><span class="hl-2"> </span><span class="hl-7">_setValues</span><span class="hl-2"> = </span><span class="hl-6">setFirst</span><span class="hl-2">.</span><span class="hl-1">bind</span><span class="hl-2">(</span><span class="hl-4">null</span><span class="hl-2">, </span><span class="hl-6">setValue</span><span class="hl-2">, </span><span class="hl-4">undefined</span><span class="hl-2">);</span><br/><br/><span class="hl-5">return</span><span class="hl-2"> &lt;</span><span class="hl-8">ComponentWithMultiSelectSupport</span><span class="hl-2"> </span><span class="hl-8">values</span><span class="hl-2">={</span><span class="hl-6">_values</span><span class="hl-2">} </span><span class="hl-8">onValuesChange</span><span class="hl-2">={</span><span class="hl-6">_setValues</span><span class="hl-2">} /&gt;</span>
15
- </code><button type="button">Copy</button></pre>
16
-
17
- </div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/ce166906b78f0ba06c3593e8b6ff3e5bbb88e101/packages/helpful-fn/src/set-first/set-first.mts#L32">packages/helpful-fn/src/set-first/set-first.mts:32</a></li></ul></aside></li></ul></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></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>
package/dist/functions/_zthun_helpful_fn.sleep.html DELETED
@@ -1,14 +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>sleep | 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.sleep.html">sleep</a></li></ul><h1>Function sleep</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>Halts the current thread to invoke an event loop.</p>
3
- </div><div class="tsd-comment tsd-typography"><div class="tsd-tag-Param: ms"><h4 class="tsd-anchor-link"><a id="Param: ms" class="tsd-anchor"></a>Param: ms<a href="#Param: ms" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>The total number of milliseconds to sleep.</p>
4
- </div><div class="tsd-tag-Param: T"><h4 class="tsd-anchor-link"><a id="Param: T" class="tsd-anchor"></a>Param: T<a href="#Param: T" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>The type of value that will be resolved.</p>
5
- </div><div class="tsd-tag-Returns"><h4 class="tsd-anchor-link"><a id="Returns" class="tsd-anchor"></a>Returns<a href="#Returns" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>A promise that resolves with val after ms milliseconds.</p>
6
- </div></div></section><section class="tsd-panel"><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="sleep" class="tsd-anchor"></a><span class="tsd-kind-call-signature">sleep</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">ms</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span><a href="#sleep" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Halts the current thread to invoke an event loop.</p>
7
- </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">ms</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>The total number of milliseconds to sleep.</p>
8
- </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4><p>A promise that resolves after ms milliseconds.</p>
9
- <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/sleep/sleep.mts#L10">packages/helpful-fn/src/sleep/sleep.mts:10</a></li></ul></aside></li><li class="tsd-signature tsd-anchor-link"><a id="sleep-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">sleep</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful_fn.sleep.html#sleep-1.T">T</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">ms</span>, <span class="tsd-kind-parameter">val</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful_fn.sleep.html#sleep-1.T">T</a><span class="tsd-signature-symbol">&gt;</span><a href="#sleep-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Halts the current thread to invoke an event loop.</p>
10
- </div><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a id="sleep-1.T" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">T</span></span><div class="tsd-comment tsd-typography"><p>The type of value that will be resolved.</p>
11
- </div><div class="tsd-comment tsd-typography"></div></li></ul></section><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">ms</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>The total number of milliseconds to sleep.</p>
12
- </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">val</span>: <a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful_fn.sleep.html#sleep-1.T">T</a></span><div class="tsd-comment tsd-typography"><p>The value to resolve with.</p>
13
- </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful_fn.sleep.html#sleep-1.T">T</a><span class="tsd-signature-symbol">&gt;</span></h4><p>A promise that resolves with val after ms milliseconds.</p>
14
- <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/sleep/sleep.mts#L25">packages/helpful-fn/src/sleep/sleep.mts:25</a></li></ul></aside></li></ul></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></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>
package/dist/functions/_zthun_helpful_fn.spaceJoinDefined.html DELETED
@@ -1,6 +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>spaceJoinDefined | 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.spaceJoinDefined.html">spaceJoinDefined</a></li></ul><h1>Function spaceJoinDefined</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>Alias to joinList with a space delimiter.</p>
3
- </div><div class="tsd-comment tsd-typography"><div class="tsd-tag-See"><h4 class="tsd-anchor-link"><a id="See" class="tsd-anchor"></a>See<a href="#See" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p><a href="_zthun_helpful_fn.joinDefined.html" class="tsd-kind-function">joinDefined</a> for more information and examples.</p>
4
- </div></div></section><section class="tsd-panel"><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="spaceJoinDefined" class="tsd-anchor"></a><span class="tsd-kind-call-signature">space<wbr/>Join<wbr/>Defined</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful_fn.spaceJoinDefined.html#spaceJoinDefined.T">T</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">items</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#spaceJoinDefined" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a id="spaceJoinDefined.T" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">T</span></span></li></ul></section><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><code class="tsd-tag">Rest</code><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">items</span>: <a href="../types/_zthun_helpful_fn.JoinListInputParameter.html" class="tsd-signature-type tsd-kind-type-alias">JoinListInputParameter</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful_fn.spaceJoinDefined.html#spaceJoinDefined.T">T</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">[]</span></span><div class="tsd-comment tsd-typography"><p>The items to join.</p>
5
- </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><p>A string that joins the items that are defined, separated by space delimiter.</p>
6
- <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#L57">packages/helpful-fn/src/join-defined/join-defined.mts:57</a></li></ul></aside></li></ul></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></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>
package/dist/functions/_zthun_helpful_fn.tryFallback.html DELETED
@@ -1,14 +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>tryFallback | 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.tryFallback.html">tryFallback</a></li></ul><h1>Function tryFallback</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>Invokes the candidate function and returns fallback if an error is thrown from it.</p>
3
- </div><div class="tsd-comment tsd-typography"><div class="tsd-tag-Param: candidate"><h4 class="tsd-anchor-link"><a id="Param: candidate" class="tsd-anchor"></a>Param: candidate<a href="#Param: candidate" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>The candidate function to run.</p>
4
- </div><div class="tsd-tag-Param: fallback"><h4 class="tsd-anchor-link"><a id="Param: fallback" class="tsd-anchor"></a>Param: fallback<a href="#Param: fallback" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>The fallback value to return if candidate throws an error.</p>
5
- </div><div class="tsd-tag-Returns"><h4 class="tsd-anchor-link"><a id="Returns" class="tsd-anchor"></a>Returns<a href="#Returns" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>The result from candidate. Returns fallback if candidate throws an Error.
6
- If no fallback value is provided, then undefined is returned.</p>
7
- </div></div></section><section class="tsd-panel"><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="tryFallback" class="tsd-anchor"></a><span class="tsd-kind-call-signature">try<wbr/>Fallback</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful_fn.tryFallback.html#tryFallback.T">T</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">candidate</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful_fn.tryFallback.html#tryFallback.T">T</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span><a href="#tryFallback" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Invokes the candidate function and returns undefined if an error is thrown from it.</p>
8
- </div><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a id="tryFallback.T" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">T</span></span></li></ul></section><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">candidate</span>: <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful_fn.tryFallback.html#tryFallback.T">T</a><span class="tsd-signature-symbol">)</span></span><div class="tsd-comment tsd-typography"><p>The candidate function to run.</p>
9
- </div><div class="tsd-comment tsd-typography"></div><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature"><span class="tsd-signature-symbol">(</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.tryFallback.html#tryFallback.T">T</a></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful_fn.tryFallback.html#tryFallback.T">T</a></h4></li></ul></li></ul></li></ul></div><h4 class="tsd-returns-title">Returns <a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful_fn.tryFallback.html#tryFallback.T">T</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span></h4><p>The result from candidate. Returns undefined if candidate throws an Error.</p>
10
- <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/try-fallback/try-fallback.mts#L10">packages/helpful-fn/src/try-fallback/try-fallback.mts:10</a></li></ul></aside></li><li class="tsd-signature tsd-anchor-link"><a id="tryFallback-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">try<wbr/>Fallback</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful_fn.tryFallback.html#tryFallback-1.T-1">T</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">candidate</span>, <span class="tsd-kind-parameter">fallback</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.tryFallback.html#tryFallback-1.T-1">T</a><a href="#tryFallback-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Invokes the candidate function and returns fallback if an error is thrown from it.</p>
11
- </div><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a id="tryFallback-1.T-1" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">T</span></span></li></ul></section><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">candidate</span>: <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful_fn.tryFallback.html#tryFallback-1.T-1">T</a><span class="tsd-signature-symbol">)</span></span><div class="tsd-comment tsd-typography"><p>The candidate function to run.</p>
12
- </div><div class="tsd-comment tsd-typography"></div><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature"><span class="tsd-signature-symbol">(</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.tryFallback.html#tryFallback-1.T-1">T</a></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful_fn.tryFallback.html#tryFallback-1.T-1">T</a></h4></li></ul></li></ul></li><li><span><span class="tsd-kind-parameter">fallback</span>: <a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful_fn.tryFallback.html#tryFallback-1.T-1">T</a></span><div class="tsd-comment tsd-typography"><p>The fallback value to return if candidate throws an error.</p>
13
- </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful_fn.tryFallback.html#tryFallback-1.T-1">T</a></h4><p>The result from candidate. Returns fallback if candidate throws an Error.</p>
14
- <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/try-fallback/try-fallback.mts#L23">packages/helpful-fn/src/try-fallback/try-fallback.mts:23</a></li></ul></aside></li></ul></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></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>
package/dist/functions/_zthun_helpful_fn.tryFallbackAsync.html DELETED
@@ -1,17 +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>tryFallbackAsync | 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.tryFallbackAsync.html">tryFallbackAsync</a></li></ul><h1>Function tryFallbackAsync</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>Invokes the candidate function and returns undefined if an rejected promise is returned from it.</p>
3
- </div><div class="tsd-comment tsd-typography"><div class="tsd-tag-Param: candidate"><h4 class="tsd-anchor-link"><a id="Param: candidate" class="tsd-anchor"></a>Param: candidate<a href="#Param: candidate" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>The candidate function to run.</p>
4
- </div><div class="tsd-tag-Param: fallback"><h4 class="tsd-anchor-link"><a id="Param: fallback" class="tsd-anchor"></a>Param: fallback<a href="#Param: fallback" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>The optional fallback value to return if the candidate throws an Error.</p>
5
- </div><div class="tsd-tag-Returns"><h4 class="tsd-anchor-link"><a id="Returns" class="tsd-anchor"></a>Returns<a href="#Returns" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>A promise that resolves with the result from candidate or fallback
6
- if candidate returns a rejected promise. Resolves with undefined
7
- if no fallback is provided.</p>
8
- </div></div></section><section class="tsd-panel"><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="tryFallbackAsync" class="tsd-anchor"></a><span class="tsd-kind-call-signature">try<wbr/>Fallback<wbr/>Async</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful_fn.tryFallbackAsync.html#tryFallbackAsync.T">T</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">candidate</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful_fn.tryFallbackAsync.html#tryFallbackAsync.T">T</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">&gt;</span><a href="#tryFallbackAsync" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Invokes the candidate function and returns undefined if an rejected promise is returned from it.</p>
9
- </div><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a id="tryFallbackAsync.T" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">T</span></span></li></ul></section><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">candidate</span>: <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful_fn.tryFallbackAsync.html#tryFallbackAsync.T">T</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span></span><div class="tsd-comment tsd-typography"><p>The candidate function to run.</p>
10
- </div><div class="tsd-comment tsd-typography"></div><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful_fn.tryFallbackAsync.html#tryFallbackAsync.T">T</a><span class="tsd-signature-symbol">&gt;</span></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful_fn.tryFallbackAsync.html#tryFallbackAsync.T">T</a><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></li></ul></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful_fn.tryFallbackAsync.html#tryFallbackAsync.T">T</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">&gt;</span></h4><p>A promise that resolves with the result from candidate. Returns undefined
11
- if candidate returns a rejected promise.</p>
12
- <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/try-fallback/try-fallback.mts#L58">packages/helpful-fn/src/try-fallback/try-fallback.mts:58</a></li></ul></aside></li><li class="tsd-signature tsd-anchor-link"><a id="tryFallbackAsync-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">try<wbr/>Fallback<wbr/>Async</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful_fn.tryFallbackAsync.html#tryFallbackAsync-1.T-1">T</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">candidate</span>, <span class="tsd-kind-parameter">fallback</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful_fn.tryFallbackAsync.html#tryFallbackAsync-1.T-1">T</a><span class="tsd-signature-symbol">&gt;</span><a href="#tryFallbackAsync-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Invokes the candidate function and returns undefined if an rejected promise is returned from it.</p>
13
- </div><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a id="tryFallbackAsync-1.T-1" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">T</span></span></li></ul></section><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">candidate</span>: <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful_fn.tryFallbackAsync.html#tryFallbackAsync-1.T-1">T</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span></span><div class="tsd-comment tsd-typography"><p>The candidate function to run.</p>
14
- </div><div class="tsd-comment tsd-typography"></div><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful_fn.tryFallbackAsync.html#tryFallbackAsync-1.T-1">T</a><span class="tsd-signature-symbol">&gt;</span></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful_fn.tryFallbackAsync.html#tryFallbackAsync-1.T-1">T</a><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></li></ul></li><li><span><span class="tsd-kind-parameter">fallback</span>: <a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful_fn.tryFallbackAsync.html#tryFallbackAsync-1.T-1">T</a></span><div class="tsd-comment tsd-typography"><p>The fallback value that will be returned if candidate returns a rejected promise.</p>
15
- </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful_fn.tryFallbackAsync.html#tryFallbackAsync-1.T-1">T</a><span class="tsd-signature-symbol">&gt;</span></h4><p>A promise that resolves with the result from candidate. Returns fallback
16
- if candidate returns a rejected promise.</p>
17
- <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/ce166906b78f0ba06c3593e8b6ff3e5bbb88e101/packages/helpful-fn/src/try-fallback/try-fallback.mts#L74">packages/helpful-fn/src/try-fallback/try-fallback.mts:74</a></li></ul></aside></li></ul></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></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>
package/dist/functions/_zthun_helpful_query.isBinaryFilter.html DELETED
@@ -1,5 +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>isBinaryFilter | Helpful</title><meta name="description" content="Documentation for Helpful"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><link rel="icon" href="../helpful.svg" />
2
- </head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">Helpful</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../modules.html">Helpful</a></li><li><a href="../modules/_zthun_helpful_query.html">@zthun/helpful-query</a></li><li><a href="_zthun_helpful_query.isBinaryFilter.html">isBinaryFilter</a></li></ul><h1>Function isBinaryFilter</h1></div><section class="tsd-panel"><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="isBinaryFilter" class="tsd-anchor"></a><span class="tsd-kind-call-signature">is<wbr/>Binary<wbr/>Filter</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">filter</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-kind-parameter">filter</span><span class="tsd-signature-keyword"> is </span><a href="../interfaces/_zthun_helpful_query.IZFilterBinary.html" class="tsd-signature-type tsd-kind-interface">IZFilterBinary</a><a href="#isBinaryFilter" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Type guard for determining if a target filter is a binary filter.</p>
3
- </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">filter</span>: <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="../interfaces/_zthun_helpful_query.IZFilterMetadata.html" class="tsd-signature-type tsd-kind-interface">IZFilterMetadata</a></span><div class="tsd-comment tsd-typography"><p>The filter to test.</p>
4
- </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-kind-parameter">filter</span><span class="tsd-signature-keyword"> is </span><a href="../interfaces/_zthun_helpful_query.IZFilterBinary.html" class="tsd-signature-type tsd-kind-interface">IZFilterBinary</a></h4><p>True if filters type is a binary filter. False otherwise.</p>
5
- <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/ce166906b78f0ba06c3593e8b6ff3e5bbb88e101/packages/helpful-query/src/filter/filter-binary.mts#L194">packages/helpful-query/src/filter/filter-binary.mts:194</a></li></ul></aside></li></ul></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></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>