@zthun/helpful-web 7.2.0 → 8.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (227) hide show
  1. package/dist/assets/hierarchy.js +1 -1
  2. package/dist/assets/main.js +5 -5
  3. package/dist/assets/navigation.js +1 -1
  4. package/dist/assets/search.js +1 -1
  5. package/dist/assets/style.css +262 -232
  6. package/dist/classes/_zthun_helpful-brands.ZBrandBuilder.html +85 -85
  7. package/dist/classes/_zthun_helpful-fn.ZAssert.html +11 -11
  8. package/dist/classes/_zthun_helpful-fn.ZDeserializeJson.html +7 -7
  9. package/dist/classes/_zthun_helpful-fn.ZDeserializeTry.html +12 -12
  10. package/dist/classes/_zthun_helpful-fn.ZLazy.html +4 -4
  11. package/dist/classes/_zthun_helpful-fn.ZQuadrilateralBuilder.html +34 -34
  12. package/dist/classes/_zthun_helpful-fn.ZQuadrilateralCornersBuilder.html +41 -41
  13. package/dist/classes/_zthun_helpful-fn.ZRectangle.html +36 -36
  14. package/dist/classes/_zthun_helpful-fn.ZSerializeJson.html +5 -5
  15. package/dist/classes/_zthun_helpful-internet.ZCookieBuilder.html +35 -35
  16. package/dist/classes/_zthun_helpful-internet.ZEmailBuilder.html +17 -17
  17. package/dist/classes/_zthun_helpful-internet.ZEmailContactAddressBuilder.html +12 -12
  18. package/dist/classes/_zthun_helpful-internet.ZEmailContactBuilder.html +17 -17
  19. package/dist/classes/_zthun_helpful-internet.ZEmailEnvelopeBuilder.html +24 -24
  20. package/dist/classes/_zthun_helpful-internet.ZServerBuilder.html +18 -18
  21. package/dist/classes/_zthun_helpful-query.ZDataFilterFields.html +7 -7
  22. package/dist/classes/_zthun_helpful-query.ZDataMatchAlways.html +5 -5
  23. package/dist/classes/_zthun_helpful-query.ZDataMatchOptional.html +11 -11
  24. package/dist/classes/_zthun_helpful-query.ZDataRequestBuilder.html +22 -22
  25. package/dist/classes/_zthun_helpful-query.ZDataSearchFields.html +8 -8
  26. package/dist/classes/_zthun_helpful-query.ZDataSearchText.html +5 -5
  27. package/dist/classes/_zthun_helpful-query.ZDataSourceStatic.html +29 -29
  28. package/dist/classes/_zthun_helpful-query.ZDataSourceStaticOptionsBuilder.html +18 -18
  29. package/dist/classes/_zthun_helpful-query.ZFilterBinaryBuilder.html +36 -36
  30. package/dist/classes/_zthun_helpful-query.ZFilterCollectionBuilder.html +23 -23
  31. package/dist/classes/_zthun_helpful-query.ZFilterDeserialize.html +6 -6
  32. package/dist/classes/_zthun_helpful-query.ZFilterLogicBuilder.html +21 -21
  33. package/dist/classes/_zthun_helpful-query.ZFilterSerialize.html +5 -5
  34. package/dist/classes/_zthun_helpful-query.ZFilterUnaryBuilder.html +18 -18
  35. package/dist/classes/_zthun_helpful-query.ZMetadataBuilder.html +52 -52
  36. package/dist/classes/_zthun_helpful-query.ZPageBuilder.html +29 -29
  37. package/dist/classes/_zthun_helpful-query.ZSortBuilder.html +14 -14
  38. package/dist/classes/_zthun_helpful-query.ZSortDeserialize.html +6 -6
  39. package/dist/classes/_zthun_helpful-query.ZSortSerialize.html +5 -5
  40. package/dist/classes/_zthun_helpful-query.ZSorterSingle.html +10 -10
  41. package/dist/classes/_zthun_helpful-query.ZWellKnownIconClasses.html +15 -15
  42. package/dist/classes/_zthun_helpful-react.ZFileSelect.html +6 -6
  43. package/dist/classes/_zthun_helpful-validation.EqualsOtherPropertyValidator.html +5 -5
  44. package/dist/classes/_zthun_helpful-validation.IsDataURILimitValidator.html +5 -5
  45. package/dist/classes/_zthun_helpful-validation.IsNotWhiteSpaceValidator.html +5 -5
  46. package/dist/classes/_zthun_helpful-validation.RequiresOtherPropertyValidator.html +5 -5
  47. package/dist/enums/_zthun_helpful-fn.ZHorizontalAnchor.html +8 -8
  48. package/dist/enums/_zthun_helpful-fn.ZOrientation.html +6 -6
  49. package/dist/enums/_zthun_helpful-fn.ZVerticalAnchor.html +8 -8
  50. package/dist/enums/_zthun_helpful-query.ZMetadataType.html +14 -14
  51. package/dist/enums/_zthun_helpful-query.ZOperatorBinary.html +16 -16
  52. package/dist/enums/_zthun_helpful-query.ZOperatorCollection.html +6 -6
  53. package/dist/enums/_zthun_helpful-query.ZOperatorLogic.html +6 -6
  54. package/dist/enums/_zthun_helpful-query.ZOperatorUnary.html +6 -6
  55. package/dist/enums/_zthun_helpful-query.ZSortDirection.html +6 -6
  56. package/dist/functions/_zthun_helpful-fn.countBuckets.html +3 -3
  57. package/dist/functions/_zthun_helpful-fn.createError.html +3 -3
  58. package/dist/functions/_zthun_helpful-fn.firstDefined.html +8 -8
  59. package/dist/functions/_zthun_helpful-fn.firstTruthy.html +8 -8
  60. package/dist/functions/_zthun_helpful-fn.firstWhere.html +8 -8
  61. package/dist/functions/_zthun_helpful-fn.isEmptyObject.html +2 -2
  62. package/dist/functions/_zthun_helpful-fn.joinDefined.html +5 -5
  63. package/dist/functions/_zthun_helpful-fn.optional.html +15 -15
  64. package/dist/functions/_zthun_helpful-fn.peel.html +5 -5
  65. package/dist/functions/_zthun_helpful-fn.peelBetween.html +4 -4
  66. package/dist/functions/_zthun_helpful-fn.pickBy.html +4 -4
  67. package/dist/functions/_zthun_helpful-fn.pickDataAttributes.html +4 -4
  68. package/dist/functions/_zthun_helpful-fn.pickDefined.html +4 -4
  69. package/dist/functions/_zthun_helpful-fn.purge.html +1 -1
  70. package/dist/functions/_zthun_helpful-fn.required.html +6 -6
  71. package/dist/functions/_zthun_helpful-fn.setFirst.html +7 -7
  72. package/dist/functions/_zthun_helpful-fn.sleep.html +10 -10
  73. package/dist/functions/_zthun_helpful-fn.tag.html +3 -3
  74. package/dist/functions/_zthun_helpful-fn.tryFallback.html +12 -12
  75. package/dist/functions/_zthun_helpful-fn.tryFallbackAsync.html +12 -12
  76. package/dist/functions/_zthun_helpful-query.isBinaryFilter.html +2 -2
  77. package/dist/functions/_zthun_helpful-query.isBinaryOperator.html +2 -2
  78. package/dist/functions/_zthun_helpful-query.isCollectionFilter.html +2 -2
  79. package/dist/functions/_zthun_helpful-query.isCollectionOperator.html +2 -2
  80. package/dist/functions/_zthun_helpful-query.isLogicFilter.html +2 -2
  81. package/dist/functions/_zthun_helpful-query.isLogicOperator.html +2 -2
  82. package/dist/functions/_zthun_helpful-query.isUnaryFilter.html +2 -2
  83. package/dist/functions/_zthun_helpful-query.isUnaryOperator.html +2 -2
  84. package/dist/functions/_zthun_helpful-react.asStateData.html +15 -15
  85. package/dist/functions/_zthun_helpful-react.asStateError.html +5 -5
  86. package/dist/functions/_zthun_helpful-react.createKeyboardActivate.html +4 -4
  87. package/dist/functions/_zthun_helpful-react.isStateErrored.html +4 -4
  88. package/dist/functions/_zthun_helpful-react.isStateLoaded.html +5 -5
  89. package/dist/functions/_zthun_helpful-react.isStateLoading.html +4 -4
  90. package/dist/functions/_zthun_helpful-react.useAmbassadorState.html +17 -17
  91. package/dist/functions/_zthun_helpful-react.useAsyncState.html +5 -5
  92. package/dist/functions/_zthun_helpful-react.useFileSelect.html +2 -2
  93. package/dist/functions/_zthun_helpful-react.useKeyboardActivate.html +4 -4
  94. package/dist/functions/_zthun_helpful-react.useMoreViewState.html +5 -5
  95. package/dist/functions/_zthun_helpful-react.usePageViewState.html +5 -5
  96. package/dist/functions/_zthun_helpful-react.useStateAsArray.html +4 -4
  97. package/dist/functions/_zthun_helpful-react.useWindowService.html +2 -2
  98. package/dist/functions/_zthun_helpful-validation.EqualsOtherProperty.html +3 -3
  99. package/dist/functions/_zthun_helpful-validation.IsDataURILimit.html +2 -2
  100. package/dist/functions/_zthun_helpful-validation.IsNotWhiteSpace.html +2 -2
  101. package/dist/functions/_zthun_helpful-validation.RequiresOtherProperty.html +3 -3
  102. package/dist/hierarchy.html +1 -1
  103. package/dist/index.html +2 -2
  104. package/dist/interfaces/_zthun_helpful-brands.IZBrand.html +11 -11
  105. package/dist/interfaces/_zthun_helpful-fn.IZDeserialize.html +9 -9
  106. package/dist/interfaces/_zthun_helpful-fn.IZPoint2d.html +6 -6
  107. package/dist/interfaces/_zthun_helpful-fn.IZPoint3d.html +8 -8
  108. package/dist/interfaces/_zthun_helpful-fn.IZQuadrilateral.html +11 -11
  109. package/dist/interfaces/_zthun_helpful-fn.IZQuadrilateralCorners.html +7 -7
  110. package/dist/interfaces/_zthun_helpful-fn.IZSerialize.html +8 -8
  111. package/dist/interfaces/_zthun_helpful-internet.IZCookie.html +16 -16
  112. package/dist/interfaces/_zthun_helpful-internet.IZEmail.html +8 -8
  113. package/dist/interfaces/_zthun_helpful-internet.IZEmailContact.html +8 -8
  114. package/dist/interfaces/_zthun_helpful-internet.IZEmailEnvelope.html +10 -10
  115. package/dist/interfaces/_zthun_helpful-internet.IZServer.html +10 -10
  116. package/dist/interfaces/_zthun_helpful-query.IZDataMatch.html +8 -8
  117. package/dist/interfaces/_zthun_helpful-query.IZDataRequest.html +15 -15
  118. package/dist/interfaces/_zthun_helpful-query.IZDataRequestQuery.html +12 -12
  119. package/dist/interfaces/_zthun_helpful-query.IZDataSource.html +8 -8
  120. package/dist/interfaces/_zthun_helpful-query.IZDataSourceStaticOptions.html +8 -8
  121. package/dist/interfaces/_zthun_helpful-query.IZFilterBinary.html +10 -10
  122. package/dist/interfaces/_zthun_helpful-query.IZFilterCollection.html +10 -10
  123. package/dist/interfaces/_zthun_helpful-query.IZFilterLogic.html +8 -8
  124. package/dist/interfaces/_zthun_helpful-query.IZFilterMetadata.html +4 -4
  125. package/dist/interfaces/_zthun_helpful-query.IZFilterOperator.html +7 -7
  126. package/dist/interfaces/_zthun_helpful-query.IZFilterSubject.html +8 -8
  127. package/dist/interfaces/_zthun_helpful-query.IZMetadata.html +24 -24
  128. package/dist/interfaces/_zthun_helpful-query.IZPage.html +7 -7
  129. package/dist/interfaces/_zthun_helpful-query.IZSort.html +6 -6
  130. package/dist/interfaces/_zthun_helpful-query.IZSorter.html +8 -8
  131. package/dist/interfaces/_zthun_helpful-react.IZFileSelect.html +4 -4
  132. package/dist/interfaces/_zthun_helpful-react.IZKeyboardInteraction.html +8 -8
  133. package/dist/modules/_zthun_helpful-brands.html +4 -4
  134. package/dist/modules/_zthun_helpful-fn.html +3 -3
  135. package/dist/modules/_zthun_helpful-internet.html +3 -3
  136. package/dist/modules/_zthun_helpful-node.html +3 -3
  137. package/dist/modules/_zthun_helpful-query.html +4 -4
  138. package/dist/modules/_zthun_helpful-react.html +3 -3
  139. package/dist/modules/_zthun_helpful-validation.html +3 -3
  140. package/dist/modules.html +1 -1
  141. package/dist/types/_zthun_helpful-fn.DeepPartial.html +1 -1
  142. package/dist/types/_zthun_helpful-fn.JoinListInputParameter.html +3 -3
  143. package/dist/types/_zthun_helpful-fn.PickPredicate.html +1 -1
  144. package/dist/types/_zthun_helpful-fn.PickResult.html +1 -1
  145. package/dist/types/_zthun_helpful-fn.RequiredDeep.html +1 -1
  146. package/dist/types/_zthun_helpful-fn.RequiredPick.html +1 -1
  147. package/dist/types/_zthun_helpful-fn.ZAnchor.html +4 -4
  148. package/dist/types/_zthun_helpful-fn.ZCornersHorizontal.html +4 -2
  149. package/dist/types/_zthun_helpful-fn.ZCornersVertical.html +4 -2
  150. package/dist/types/_zthun_helpful-fn.ZObligatedValue.html +3 -3
  151. package/dist/types/_zthun_helpful-fn.ZQuadrilateralCornersLike.html +2 -2
  152. package/dist/types/_zthun_helpful-fn.ZQuadrilateralLike.html +2 -2
  153. package/dist/types/_zthun_helpful-fn.ZSideAnchor.html +2 -2
  154. package/dist/types/_zthun_helpful-fn.ZSupplier.html +2 -2
  155. package/dist/types/_zthun_helpful-fn.ZSupplierAsync.html +2 -2
  156. package/dist/types/_zthun_helpful-query.IZFilter.html +2 -2
  157. package/dist/types/_zthun_helpful-query.IZFilterUnary.html +2 -2
  158. package/dist/types/_zthun_helpful-query.ZOperatorFilter.html +2 -2
  159. package/dist/types/_zthun_helpful-react.ZAmbassadorReducer.html +2 -2
  160. package/dist/types/_zthun_helpful-react.ZAmbassadorReducerRequired.html +2 -2
  161. package/dist/types/_zthun_helpful-react.ZAmbassadorSetCurrent.html +2 -2
  162. package/dist/types/_zthun_helpful-react.ZAsyncDataState.html +2 -2
  163. package/dist/types/_zthun_helpful-react.ZAsyncDataTuple.html +2 -2
  164. package/dist/types/_zthun_helpful-react.ZAsyncUseData.html +2 -2
  165. package/dist/types/_zthun_helpful-react.ZSetStateAsArray.html +1 -1
  166. package/dist/types/_zthun_helpful-react.ZStateAsArrayReducer.html +1 -1
  167. package/dist/variables/_zthun_helpful-brands.ZBrands.html +2 -2
  168. package/dist/variables/_zthun_helpful-fn._global.html +1 -1
  169. package/dist/variables/_zthun_helpful-fn.bash.html +14 -0
  170. package/dist/variables/_zthun_helpful-fn.commaJoinDefined.html +5 -0
  171. package/dist/variables/_zthun_helpful-fn.createGuid.html +11 -0
  172. package/dist/variables/_zthun_helpful-fn.css.html +16 -0
  173. package/dist/variables/_zthun_helpful-fn.cssJoinDefined.html +5 -0
  174. package/dist/variables/_zthun_helpful-fn.html.html +16 -0
  175. package/dist/variables/_zthun_helpful-fn.javascript.html +14 -0
  176. package/dist/variables/_zthun_helpful-fn.js.html +16 -0
  177. package/dist/variables/_zthun_helpful-fn.markdown.html +14 -0
  178. package/dist/variables/_zthun_helpful-fn.md.html +16 -0
  179. package/dist/variables/_zthun_helpful-fn.pipeJoinDefined.html +5 -0
  180. package/dist/variables/_zthun_helpful-fn.semiColonJoinDefined.html +5 -0
  181. package/dist/variables/_zthun_helpful-fn.sh.html +14 -0
  182. package/dist/variables/_zthun_helpful-fn.spaceJoinDefined.html +5 -0
  183. package/dist/variables/_zthun_helpful-fn.ts.html +16 -0
  184. package/dist/variables/_zthun_helpful-fn.typescript.html +14 -0
  185. package/dist/variables/_zthun_helpful-fn.zsh.html +14 -0
  186. package/dist/variables/_zthun_helpful-query.ZBinaryComparators.html +2 -2
  187. package/dist/variables/_zthun_helpful-query.ZCollectionComparators.html +2 -2
  188. package/dist/variables/_zthun_helpful-query.ZOperatorsBinary.html +2 -2
  189. package/dist/variables/_zthun_helpful-query.ZOperatorsCollection.html +2 -2
  190. package/dist/variables/_zthun_helpful-query.ZOperatorsFilter.html +2 -2
  191. package/dist/variables/_zthun_helpful-query.ZOperatorsLogic.html +2 -2
  192. package/dist/variables/_zthun_helpful-query.ZOperatorsUnary.html +2 -2
  193. package/dist/variables/_zthun_helpful-query.ZSortDirections.html +2 -2
  194. package/dist/variables/_zthun_helpful-query.ZUnaryComparators.html +2 -2
  195. package/dist/variables/_zthun_helpful-react.DefaultActivateCodes.html +2 -2
  196. package/dist/variables/_zthun_helpful-react.ZAsyncLoading.html +2 -2
  197. package/dist/variables/_zthun_helpful-react.ZFileSelectContext.html +2 -0
  198. package/dist/variables/_zthun_helpful-react.ZWindowServiceContext.html +2 -0
  199. package/package.json +12 -12
  200. package/dist/classes/_zthun_helpful-node.ZFileSystemNodeBuilder.html +0 -11
  201. package/dist/classes/_zthun_helpful-node.ZFileSystemService.html +0 -12
  202. package/dist/enums/_zthun_helpful-node.ZFileSystemNodeType.html +0 -4
  203. package/dist/functions/_zthun_helpful-fn.bash.html +0 -14
  204. package/dist/functions/_zthun_helpful-fn.commaJoinDefined.html +0 -5
  205. package/dist/functions/_zthun_helpful-fn.createGuid.html +0 -11
  206. package/dist/functions/_zthun_helpful-fn.css.html +0 -16
  207. package/dist/functions/_zthun_helpful-fn.cssJoinDefined.html +0 -5
  208. package/dist/functions/_zthun_helpful-fn.html.html +0 -16
  209. package/dist/functions/_zthun_helpful-fn.javascript.html +0 -14
  210. package/dist/functions/_zthun_helpful-fn.js.html +0 -16
  211. package/dist/functions/_zthun_helpful-fn.markdown.html +0 -14
  212. package/dist/functions/_zthun_helpful-fn.md.html +0 -16
  213. package/dist/functions/_zthun_helpful-fn.pipeJoinDefined.html +0 -5
  214. package/dist/functions/_zthun_helpful-fn.semiColonJoinDefined.html +0 -5
  215. package/dist/functions/_zthun_helpful-fn.sh.html +0 -14
  216. package/dist/functions/_zthun_helpful-fn.spaceJoinDefined.html +0 -5
  217. package/dist/functions/_zthun_helpful-fn.ts.html +0 -16
  218. package/dist/functions/_zthun_helpful-fn.typescript.html +0 -14
  219. package/dist/functions/_zthun_helpful-fn.zsh.html +0 -14
  220. package/dist/functions/_zthun_helpful-node.walk.html +0 -12
  221. package/dist/functions/_zthun_helpful-react.ZFileSelectContext.html +0 -10
  222. package/dist/functions/_zthun_helpful-react.ZWindowServiceContext.html +0 -10
  223. package/dist/interfaces/_zthun_helpful-node.IZFileSystemNode.html +0 -11
  224. package/dist/interfaces/_zthun_helpful-node.IZFileSystemSearchOptions.html +0 -5
  225. package/dist/interfaces/_zthun_helpful-node.IZFileSystemService.html +0 -11
  226. package/dist/interfaces/_zthun_helpful-node.ZWalkOptions.html +0 -13
  227. package/dist/variables/_zthun_helpful-node.ZFileSystemToken.html +0 -3
package/dist/functions/_zthun_helpful-fn.firstTruthy.html CHANGED
@@ -1,12 +1,12 @@
1
- <!DOCTYPE html><html class="default" lang="en" data-base=".."><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>firstTruthy | Helpful</title><link rel="icon" href="../assets/favicon.svg" type="image/svg+xml"/><meta name="description" content="Documentation for Helpful"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search"><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">Helpful</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../modules.html">Helpful</a></li><li><a href="../modules/_zthun_helpful-fn.html">@zthun/helpful-fn</a></li><li><a href="_zthun_helpful-fn.firstTruthy.html">firstTruthy</a></li></ul><h1>Function firstTruthy</h1></div><section class="tsd-panel"><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="firsttruthy" class="tsd-anchor"></a><span class="tsd-kind-call-signature">firstTruthy</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful-fn.firstTruthy.html#firsttruthyt">T</a> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span><br/>    <span class="tsd-kind-parameter">fallback</span><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful-fn.firstTruthy.html#firsttruthyt">T</a><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">first</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">null</span> <span class="tsd-signature-symbol">|</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful-fn.firstTruthy.html#firsttruthyt">T</a><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">remaining</span><span class="tsd-signature-symbol">:</span> (<span class="tsd-signature-type">undefined</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">null</span> <span class="tsd-signature-symbol">|</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful-fn.firstTruthy.html#firsttruthyt">T</a>)<span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful-fn.firstTruthy.html#firsttruthyt">T</a><a href="#firsttruthy" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns the first value in args such that args is truthy</p>
2
- </div><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a id="firsttruthyt" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">T</span> = <span class="tsd-signature-type">any</span></span><div class="tsd-comment tsd-typography"><p>The type of data that will be enumerated.</p>
3
- </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">fallback</span>: <a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful-fn.firstTruthy.html#firsttruthyt">T</a></span><div class="tsd-comment tsd-typography"><p>The fallback value in the case that all values in args are falsy.</p>
4
- </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">first</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.firstTruthy.html#firsttruthyt">T</a></span><div class="tsd-comment tsd-typography"><p>The first value to check.</p>
5
- </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">remaining</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.firstTruthy.html#firsttruthyt">T</a>)<span class="tsd-signature-symbol">[]</span></span><div class="tsd-comment tsd-typography"><p>The remaining values beyond the first to check.</p>
6
- </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful-fn.firstTruthy.html#firsttruthyt">T</a></h4><p>The first value if it is truthy. If first is falsy, then the first item
1
+ <!DOCTYPE html><html class="default" lang="en" data-base="../"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>firstTruthy | Helpful</title><link rel="icon" href="../assets/favicon.svg" type="image/svg+xml"/><meta name="description" content="Documentation for Helpful"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><a href="../index.html" class="title">Helpful</a><div id="tsd-toolbar-links"></div><button id="tsd-search-trigger" class="tsd-widget" aria-label="Search"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></button><dialog id="tsd-search" aria-label="Search"><input role="combobox" id="tsd-search-input" aria-controls="tsd-search-results" aria-autocomplete="list" aria-expanded="true" autocapitalize="off" autocomplete="off" placeholder="Search the docs" maxLength="100"/><ul role="listbox" id="tsd-search-results"></ul><div id="tsd-search-status" aria-live="polite" aria-atomic="true"><div>Preparing search index...</div></div></dialog><a href="#" class="tsd-widget menu" id="tsd-toolbar-menu-trigger" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb" aria-label="Breadcrumb"><li><a href="../modules/_zthun_helpful-fn.html">@zthun/helpful-fn</a></li><li><a href="" aria-current="page">firstTruthy</a></li></ul><h1>Function firstTruthy</h1></div><section class="tsd-panel"><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="firsttruthy"><span class="tsd-kind-call-signature">firstTruthy</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#firsttruthyt">T</a> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span><br/>    <span class="tsd-kind-parameter">fallback</span><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#firsttruthyt">T</a><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">first</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">null</span> <span class="tsd-signature-symbol">|</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#firsttruthyt">T</a><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">remaining</span><span class="tsd-signature-symbol">:</span> (<span class="tsd-signature-type">undefined</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">null</span> <span class="tsd-signature-symbol">|</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#firsttruthyt">T</a>)<span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#firsttruthyt">T</a><a href="#firsttruthy" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns the first value in args such that args is truthy</p>
2
+ </div><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span id="firsttruthyt"><span class="tsd-kind-type-parameter">T</span> = <span class="tsd-signature-type">any</span></span><div class="tsd-comment tsd-typography"><p>The type of data that will be enumerated.</p>
3
+ </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">fallback</span>: <a class="tsd-signature-type tsd-kind-type-parameter" href="#firsttruthyt">T</a></span><div class="tsd-comment tsd-typography"><p>The fallback value in the case that all values in args are falsy.</p>
4
+ </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">first</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="#firsttruthyt">T</a></span><div class="tsd-comment tsd-typography"><p>The first value to check.</p>
5
+ </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">remaining</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="#firsttruthyt">T</a>)<span class="tsd-signature-symbol">[]</span></span><div class="tsd-comment tsd-typography"><p>The remaining values beyond the first to check.</p>
6
+ </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a class="tsd-signature-type tsd-kind-type-parameter" href="#firsttruthyt">T</a></h4><p>The first value if it is truthy. If first is falsy, then the first item
7
7
  in remaining such that remaining[i] is truthy is returned. If first and
8
8
  all values of remaining are falsy, then fallback is returned.</p>
9
- <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">// &#39;Defined&#39;</span><br/><span class="hl-4">const</span><span class="hl-2"> </span><span class="hl-7">shouldBeDefined</span><span class="hl-2"> = </span><span class="hl-1">firstTruthy</span><span class="hl-2">(</span><span class="hl-3">&#39;Fallback&#39;</span><span class="hl-2">, </span><span class="hl-4">null</span><span class="hl-2">, </span><span class="hl-4">undefined</span><span class="hl-2">, </span><span class="hl-3">&#39;Defined&#39;</span><span class="hl-2">);</span><br/><span class="hl-0">// &#39;Fallback&#39;</span><br/><span class="hl-4">const</span><span class="hl-2"> </span><span class="hl-7">shouldBeFallback</span><span class="hl-2"> = </span><span class="hl-1">firstTruthy</span><span class="hl-2">(</span><span class="hl-3">&#39;Fallback&#39;</span><span class="hl-2">, </span><span class="hl-3">&#39;&#39;</span><span class="hl-2">, </span><span class="hl-4">undefined</span><span class="hl-2">);</span><br/><span class="hl-4">const</span><span class="hl-2"> </span><span class="hl-7">shouldAlsoBeFallback</span><span class="hl-2"> = </span><span class="hl-1">firstDefined</span><span class="hl-2">(</span><span class="hl-3">&#39;Fallback&#39;</span><span class="hl-2">, </span><span class="hl-9">0</span><span class="hl-2">, </span><span class="hl-4">false</span><span class="hl-2">);</span><br/><span class="hl-0">// &#39;First&#39;</span><br/><span class="hl-4">const</span><span class="hl-2"> </span><span class="hl-7">shouldBeFirst</span><span class="hl-2"> = </span><span class="hl-1">firstDefined</span><span class="hl-2">(</span><span class="hl-3">&#39;Fallback&#39;</span><span class="hl-2">, </span><span class="hl-3">&#39;First&#39;</span><span class="hl-2">, </span><span class="hl-4">null</span><span class="hl-2">, </span><span class="hl-4">false</span><span class="hl-2">, </span><span class="hl-9">0</span><span class="hl-2">, </span><span class="hl-4">NaN</span><span class="hl-2">);</span>
9
+ <div class="tsd-comment tsd-typography"><div class="tsd-tag-example"><h4 class="tsd-anchor-link" id="example">Example<a href="#example" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-0">// &#39;Defined&#39;</span><br/><span class="hl-4">const</span><span class="hl-2"> </span><span class="hl-7">shouldBeDefined</span><span class="hl-2"> = </span><span class="hl-1">firstTruthy</span><span class="hl-2">(</span><span class="hl-3">&#39;Fallback&#39;</span><span class="hl-2">, </span><span class="hl-4">null</span><span class="hl-2">, </span><span class="hl-4">undefined</span><span class="hl-2">, </span><span class="hl-3">&#39;Defined&#39;</span><span class="hl-2">);</span><br/><span class="hl-0">// &#39;Fallback&#39;</span><br/><span class="hl-4">const</span><span class="hl-2"> </span><span class="hl-7">shouldBeFallback</span><span class="hl-2"> = </span><span class="hl-1">firstTruthy</span><span class="hl-2">(</span><span class="hl-3">&#39;Fallback&#39;</span><span class="hl-2">, </span><span class="hl-3">&#39;&#39;</span><span class="hl-2">, </span><span class="hl-4">undefined</span><span class="hl-2">);</span><br/><span class="hl-4">const</span><span class="hl-2"> </span><span class="hl-7">shouldAlsoBeFallback</span><span class="hl-2"> = </span><span class="hl-1">firstDefined</span><span class="hl-2">(</span><span class="hl-3">&#39;Fallback&#39;</span><span class="hl-2">, </span><span class="hl-9">0</span><span class="hl-2">, </span><span class="hl-4">false</span><span class="hl-2">);</span><br/><span class="hl-0">// &#39;First&#39;</span><br/><span class="hl-4">const</span><span class="hl-2"> </span><span class="hl-7">shouldBeFirst</span><span class="hl-2"> = </span><span class="hl-1">firstDefined</span><span class="hl-2">(</span><span class="hl-3">&#39;Fallback&#39;</span><span class="hl-2">, </span><span class="hl-3">&#39;First&#39;</span><span class="hl-2">, </span><span class="hl-4">null</span><span class="hl-2">, </span><span class="hl-4">false</span><span class="hl-2">, </span><span class="hl-9">0</span><span class="hl-2">, </span><span class="hl-4">NaN</span><span class="hl-2">);</span>
10
10
  </code><button type="button">Copy</button></pre>
11
11
 
12
- </div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/e0425cedbb61f1914a89cb867f0d1618a11ea537/packages/helpful-fn/src/first-where/first-where.mts#L112">packages/helpful-fn/src/first-where/first-where.mts:112</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">Helpful</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
12
+ </div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/3e88f38b916d0973f2520566526efbd1519ed6af/packages/helpful-fn/src/first-where/first-where.mts#L112">packages/helpful-fn/src/first-where/first-where.mts:112</a></li></ul></aside></div></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"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>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">Helpful</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
package/dist/functions/_zthun_helpful-fn.firstWhere.html CHANGED
@@ -1,10 +1,10 @@
1
- <!DOCTYPE html><html class="default" lang="en" data-base=".."><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>firstWhere | Helpful</title><link rel="icon" href="../assets/favicon.svg" type="image/svg+xml"/><meta name="description" content="Documentation for Helpful"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search"><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">Helpful</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../modules.html">Helpful</a></li><li><a href="../modules/_zthun_helpful-fn.html">@zthun/helpful-fn</a></li><li><a href="_zthun_helpful-fn.firstWhere.html">firstWhere</a></li></ul><h1>Function firstWhere</h1></div><section class="tsd-panel"><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="firstwhere" class="tsd-anchor"></a><span class="tsd-kind-call-signature">firstWhere</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful-fn.firstWhere.html#firstwheret">T</a> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span><br/>    <span class="tsd-kind-parameter">predicate</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">v</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">null</span> <span class="tsd-signature-symbol">|</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful-fn.firstWhere.html#firstwheret">T</a><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">fallback</span><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful-fn.firstWhere.html#firstwheret">T</a><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">first</span><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful-fn.firstWhere.html#firstwheret">T</a><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">remaining</span><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful-fn.firstWhere.html#firstwheret">T</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful-fn.firstWhere.html#firstwheret">T</a><a href="#firstwhere" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns the first value in an argument list that matches a predicate.</p>
2
- </div><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a id="firstwheret" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">T</span> = <span class="tsd-signature-type">any</span></span><div class="tsd-comment tsd-typography"><p>The type of data that will be enumerated.</p>
3
- </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">predicate</span>: <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">v</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">null</span> <span class="tsd-signature-symbol">|</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful-fn.firstWhere.html#firstwheret">T</a><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">boolean</span></span><div class="tsd-comment tsd-typography"><p>The match method against each value argument.</p>
4
- </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">fallback</span>: <a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful-fn.firstWhere.html#firstwheret">T</a></span><div class="tsd-comment tsd-typography"><p>The fallback value in the case that all arguments fail
1
+ <!DOCTYPE html><html class="default" lang="en" data-base="../"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>firstWhere | Helpful</title><link rel="icon" href="../assets/favicon.svg" type="image/svg+xml"/><meta name="description" content="Documentation for Helpful"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><a href="../index.html" class="title">Helpful</a><div id="tsd-toolbar-links"></div><button id="tsd-search-trigger" class="tsd-widget" aria-label="Search"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></button><dialog id="tsd-search" aria-label="Search"><input role="combobox" id="tsd-search-input" aria-controls="tsd-search-results" aria-autocomplete="list" aria-expanded="true" autocapitalize="off" autocomplete="off" placeholder="Search the docs" maxLength="100"/><ul role="listbox" id="tsd-search-results"></ul><div id="tsd-search-status" aria-live="polite" aria-atomic="true"><div>Preparing search index...</div></div></dialog><a href="#" class="tsd-widget menu" id="tsd-toolbar-menu-trigger" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb" aria-label="Breadcrumb"><li><a href="../modules/_zthun_helpful-fn.html">@zthun/helpful-fn</a></li><li><a href="" aria-current="page">firstWhere</a></li></ul><h1>Function firstWhere</h1></div><section class="tsd-panel"><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="firstwhere"><span class="tsd-kind-call-signature">firstWhere</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#firstwheret">T</a> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span><br/>    <span class="tsd-kind-parameter">predicate</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">v</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">null</span> <span class="tsd-signature-symbol">|</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#firstwheret">T</a><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">fallback</span><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#firstwheret">T</a><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">first</span><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#firstwheret">T</a><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">remaining</span><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#firstwheret">T</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#firstwheret">T</a><a href="#firstwhere" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns the first value in an argument list that matches a predicate.</p>
2
+ </div><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span id="firstwheret"><span class="tsd-kind-type-parameter">T</span> = <span class="tsd-signature-type">any</span></span><div class="tsd-comment tsd-typography"><p>The type of data that will be enumerated.</p>
3
+ </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">predicate</span>: <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">v</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">null</span> <span class="tsd-signature-symbol">|</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#firstwheret">T</a><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">boolean</span></span><div class="tsd-comment tsd-typography"><p>The match method against each value argument.</p>
4
+ </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">fallback</span>: <a class="tsd-signature-type tsd-kind-type-parameter" href="#firstwheret">T</a></span><div class="tsd-comment tsd-typography"><p>The fallback value in the case that all arguments fail
5
5
  the predicate.</p>
6
- </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">first</span>: <a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful-fn.firstWhere.html#firstwheret">T</a></span><div class="tsd-comment tsd-typography"><p>The first value to check.</p>
7
- </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">remaining</span>: <a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful-fn.firstWhere.html#firstwheret">T</a><span class="tsd-signature-symbol">[]</span></span><div class="tsd-comment tsd-typography"><p>The remaining values beyond the first to check.</p>
8
- </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.firstWhere.html#firstwheret">T</a></h4><p>The first value for where predicate returns true for the given argument value.
6
+ </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">first</span>: <a class="tsd-signature-type tsd-kind-type-parameter" href="#firstwheret">T</a></span><div class="tsd-comment tsd-typography"><p>The first value to check.</p>
7
+ </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">remaining</span>: <a class="tsd-signature-type tsd-kind-type-parameter" href="#firstwheret">T</a><span class="tsd-signature-symbol">[]</span></span><div class="tsd-comment tsd-typography"><p>The remaining values beyond the first to check.</p>
8
+ </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="#firstwheret">T</a></h4><p>The first value for where predicate returns true for the given argument value.
9
9
  If first and all values of remaining fail the predicate then fallback is returned.</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/e0425cedbb61f1914a89cb867f0d1618a11ea537/packages/helpful-fn/src/first-where/first-where.mts#L20">packages/helpful-fn/src/first-where/first-where.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">Helpful</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
10
+ <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/3e88f38b916d0973f2520566526efbd1519ed6af/packages/helpful-fn/src/first-where/first-where.mts#L20">packages/helpful-fn/src/first-where/first-where.mts:20</a></li></ul></aside></div></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"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>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">Helpful</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
package/dist/functions/_zthun_helpful-fn.isEmptyObject.html CHANGED
@@ -1,8 +1,8 @@
1
- <!DOCTYPE html><html class="default" lang="en" data-base=".."><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>isEmptyObject | Helpful</title><link rel="icon" href="../assets/favicon.svg" type="image/svg+xml"/><meta name="description" content="Documentation for Helpful"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search"><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">Helpful</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../modules.html">Helpful</a></li><li><a href="../modules/_zthun_helpful-fn.html">@zthun/helpful-fn</a></li><li><a href="_zthun_helpful-fn.isEmptyObject.html">isEmptyObject</a></li></ul><h1>Function isEmptyObject</h1></div><section class="tsd-panel"><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="isemptyobject" class="tsd-anchor"></a><span class="tsd-kind-call-signature">isEmptyObject</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">candidate</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-kind-parameter">candidate</span> <span class="tsd-signature-keyword">is</span> <span class="tsd-signature-symbol">{}</span><a href="#isemptyobject" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns true if an object is empty, null, or undefined.</p>
1
+ <!DOCTYPE html><html class="default" lang="en" data-base="../"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>isEmptyObject | Helpful</title><link rel="icon" href="../assets/favicon.svg" type="image/svg+xml"/><meta name="description" content="Documentation for Helpful"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><a href="../index.html" class="title">Helpful</a><div id="tsd-toolbar-links"></div><button id="tsd-search-trigger" class="tsd-widget" aria-label="Search"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></button><dialog id="tsd-search" aria-label="Search"><input role="combobox" id="tsd-search-input" aria-controls="tsd-search-results" aria-autocomplete="list" aria-expanded="true" autocapitalize="off" autocomplete="off" placeholder="Search the docs" maxLength="100"/><ul role="listbox" id="tsd-search-results"></ul><div id="tsd-search-status" aria-live="polite" aria-atomic="true"><div>Preparing search index...</div></div></dialog><a href="#" class="tsd-widget menu" id="tsd-toolbar-menu-trigger" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb" aria-label="Breadcrumb"><li><a href="../modules/_zthun_helpful-fn.html">@zthun/helpful-fn</a></li><li><a href="" aria-current="page">isEmptyObject</a></li></ul><h1>Function isEmptyObject</h1></div><section class="tsd-panel"><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="isemptyobject"><span class="tsd-kind-call-signature">isEmptyObject</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">candidate</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-kind-parameter">candidate</span> <span class="tsd-signature-keyword">is</span> <span class="tsd-signature-symbol">{}</span><a href="#isemptyobject" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns true if an object is empty, null, or undefined.</p>
2
2
  <p>Note that this is different than lodash's isEmpty method.
3
3
  Checking an empty array or empty string will result
4
4
  in false.</p>
5
5
  </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">candidate</span>: <span class="tsd-signature-type">any</span></span><div class="tsd-comment tsd-typography"><p>The object to test.</p>
6
6
  </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-kind-parameter">candidate</span> <span class="tsd-signature-keyword">is</span> <span class="tsd-signature-symbol">{}</span></h4><p>True if candidate is the empty object or
7
7
  null. False otherwise.</p>
8
- <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/e0425cedbb61f1914a89cb867f0d1618a11ea537/packages/helpful-fn/src/empty/is-empty-object.mts#L15">packages/helpful-fn/src/empty/is-empty-object.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">Helpful</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
8
+ <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/3e88f38b916d0973f2520566526efbd1519ed6af/packages/helpful-fn/src/empty/is-empty-object.mts#L15">packages/helpful-fn/src/empty/is-empty-object.mts:15</a></li></ul></aside></div></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"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>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">Helpful</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
package/dist/functions/_zthun_helpful-fn.joinDefined.html CHANGED
@@ -1,9 +1,9 @@
1
- <!DOCTYPE html><html class="default" lang="en" data-base=".."><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>joinDefined | Helpful</title><link rel="icon" href="../assets/favicon.svg" type="image/svg+xml"/><meta name="description" content="Documentation for Helpful"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search"><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">Helpful</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../modules.html">Helpful</a></li><li><a href="../modules/_zthun_helpful-fn.html">@zthun/helpful-fn</a></li><li><a href="_zthun_helpful-fn.joinDefined.html">joinDefined</a></li></ul><h1>Function joinDefined</h1></div><section class="tsd-panel"><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="joindefined" class="tsd-anchor"></a><span class="tsd-kind-call-signature">joinDefined</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful-fn.joinDefined.html#joindefinedt">T</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">delimiter</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">items</span><span class="tsd-signature-symbol">:</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.joinDefined.html#joindefinedt">T</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><a href="#joindefined" 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>Similar to Array.join but filters out null and undefined items.</p>
2
- </div><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a id="joindefinedt" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">T</span></span><div class="tsd-comment tsd-typography"><p>The type of data to join.</p>
1
+ <!DOCTYPE html><html class="default" lang="en" data-base="../"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>joinDefined | Helpful</title><link rel="icon" href="../assets/favicon.svg" type="image/svg+xml"/><meta name="description" content="Documentation for Helpful"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><a href="../index.html" class="title">Helpful</a><div id="tsd-toolbar-links"></div><button id="tsd-search-trigger" class="tsd-widget" aria-label="Search"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></button><dialog id="tsd-search" aria-label="Search"><input role="combobox" id="tsd-search-input" aria-controls="tsd-search-results" aria-autocomplete="list" aria-expanded="true" autocapitalize="off" autocomplete="off" placeholder="Search the docs" maxLength="100"/><ul role="listbox" id="tsd-search-results"></ul><div id="tsd-search-status" aria-live="polite" aria-atomic="true"><div>Preparing search index...</div></div></dialog><a href="#" class="tsd-widget menu" id="tsd-toolbar-menu-trigger" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb" aria-label="Breadcrumb"><li><a href="../modules/_zthun_helpful-fn.html">@zthun/helpful-fn</a></li><li><a href="" aria-current="page">joinDefined</a></li></ul><h1>Function joinDefined</h1></div><section class="tsd-panel"><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="joindefined"><span class="tsd-kind-call-signature">joinDefined</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#joindefinedt">T</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">delimiter</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">items</span><span class="tsd-signature-symbol">:</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="#joindefinedt">T</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><a href="#joindefined" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Similar to Array.join but filters out null and undefined items.</p>
2
+ </div><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span id="joindefinedt"><span class="tsd-kind-type-parameter">T</span></span><div class="tsd-comment tsd-typography"><p>The type of data to join.</p>
3
3
  </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">delimiter</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The delimiter that separates the items.</p>
4
- </div><div class="tsd-comment tsd-typography"></div></li><li><span><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.joinDefined.html#joindefinedt">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>
4
+ </div><div class="tsd-comment tsd-typography"></div></li><li><span><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="#joindefinedt">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
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 delimiter.</p>
6
- <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">// &#39;a b d&#39;</span><br/><span class="hl-4">const</span><span class="hl-2"> </span><span class="hl-7">joinBySpace</span><span class="hl-2"> = </span><span class="hl-1">joinDefined</span><span class="hl-2">(</span><span class="hl-3">&#39; &#39;</span><span class="hl-2">, </span><span class="hl-3">&#39;a&#39;</span><span class="hl-2">, </span><span class="hl-3">&#39;b&#39;</span><span class="hl-2">, [</span><span class="hl-3">&#39;c&#39;</span><span class="hl-2">, </span><span class="hl-4">false</span><span class="hl-2">], </span><span class="hl-4">null</span><span class="hl-2">, </span><span class="hl-4">undefined</span><span class="hl-2">, [</span><span class="hl-3">&#39;d&#39;</span><span class="hl-2">, </span><span class="hl-4">true</span><span class="hl-2">]);</span><br/><span class="hl-0">// (Empty String)</span><br/><span class="hl-4">const</span><span class="hl-2"> </span><span class="hl-7">joinEmpty</span><span class="hl-2"> = </span><span class="hl-1">joinDefined</span><span class="hl-2">(</span><span class="hl-3">&#39;?&#39;</span><span class="hl-2">);</span>
6
+ <div class="tsd-comment tsd-typography"><div class="tsd-tag-example"><h4 class="tsd-anchor-link" id="example">Example<a href="#example" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-0">// &#39;a b d&#39;</span><br/><span class="hl-4">const</span><span class="hl-2"> </span><span class="hl-7">joinBySpace</span><span class="hl-2"> = </span><span class="hl-1">joinDefined</span><span class="hl-2">(</span><span class="hl-3">&#39; &#39;</span><span class="hl-2">, </span><span class="hl-3">&#39;a&#39;</span><span class="hl-2">, </span><span class="hl-3">&#39;b&#39;</span><span class="hl-2">, [</span><span class="hl-3">&#39;c&#39;</span><span class="hl-2">, </span><span class="hl-4">false</span><span class="hl-2">], </span><span class="hl-4">null</span><span class="hl-2">, </span><span class="hl-4">undefined</span><span class="hl-2">, [</span><span class="hl-3">&#39;d&#39;</span><span class="hl-2">, </span><span class="hl-4">true</span><span class="hl-2">]);</span><br/><span class="hl-0">// (Empty String)</span><br/><span class="hl-4">const</span><span class="hl-2"> </span><span class="hl-7">joinEmpty</span><span class="hl-2"> = </span><span class="hl-1">joinDefined</span><span class="hl-2">(</span><span class="hl-3">&#39;?&#39;</span><span class="hl-2">);</span>
7
7
  </code><button type="button">Copy</button></pre>
8
8
 
9
- </div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/e0425cedbb61f1914a89cb867f0d1618a11ea537/packages/helpful-fn/src/join-defined/join-defined.mts#L35">packages/helpful-fn/src/join-defined/join-defined.mts:35</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">Helpful</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
9
+ </div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/3e88f38b916d0973f2520566526efbd1519ed6af/packages/helpful-fn/src/join-defined/join-defined.mts#L35">packages/helpful-fn/src/join-defined/join-defined.mts:35</a></li></ul></aside></div></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"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>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">Helpful</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
package/dist/functions/_zthun_helpful-fn.optional.html CHANGED
@@ -1,32 +1,32 @@
1
- <!DOCTYPE html><html class="default" lang="en" data-base=".."><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>optional | Helpful</title><link rel="icon" href="../assets/favicon.svg" type="image/svg+xml"/><meta name="description" content="Documentation for Helpful"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search"><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">Helpful</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../modules.html">Helpful</a></li><li><a href="../modules/_zthun_helpful-fn.html">@zthun/helpful-fn</a></li><li><a href="_zthun_helpful-fn.optional.html">optional</a></li></ul><h1>Function optional</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>Allows a value to be null or undefined and has a fallback.</p>
2
- </div><div class="tsd-comment tsd-typography"><div class="tsd-tag-param"><h4 class="tsd-anchor-link"><a id="param-val" class="tsd-anchor"></a>Param: val<a href="#param-val" 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 value to check. This can be a promise
1
+ <!DOCTYPE html><html class="default" lang="en" data-base="../"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>optional | Helpful</title><link rel="icon" href="../assets/favicon.svg" type="image/svg+xml"/><meta name="description" content="Documentation for Helpful"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><a href="../index.html" class="title">Helpful</a><div id="tsd-toolbar-links"></div><button id="tsd-search-trigger" class="tsd-widget" aria-label="Search"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></button><dialog id="tsd-search" aria-label="Search"><input role="combobox" id="tsd-search-input" aria-controls="tsd-search-results" aria-autocomplete="list" aria-expanded="true" autocapitalize="off" autocomplete="off" placeholder="Search the docs" maxLength="100"/><ul role="listbox" id="tsd-search-results"></ul><div id="tsd-search-status" aria-live="polite" aria-atomic="true"><div>Preparing search index...</div></div></dialog><a href="#" class="tsd-widget menu" id="tsd-toolbar-menu-trigger" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb" aria-label="Breadcrumb"><li><a href="../modules/_zthun_helpful-fn.html">@zthun/helpful-fn</a></li><li><a href="" aria-current="page">optional</a></li></ul><h1>Function optional</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>Allows a value to be null or undefined and has a fallback.</p>
2
+ </div><div class="tsd-comment tsd-typography"><div class="tsd-tag-param"><h4 class="tsd-anchor-link" id="param-val">Param: val<a href="#param-val" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>The value to check. This can be a promise
3
3
  that can return null or undefined in addition to the
4
4
  value.</p>
5
- </div><div class="tsd-tag-param"><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 in the case that val is
5
+ </div><div class="tsd-tag-param"><h4 class="tsd-anchor-link" id="param-fallback">Param: fallback<a href="#param-fallback" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>The fallback value in the case that val is
6
6
  null or undefined.</p>
7
- </div><div class="tsd-tag-param"><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 is being checked.</p>
8
- </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>This method returns val if it is not null
7
+ </div><div class="tsd-tag-param"><h4 class="tsd-anchor-link" id="param-t">Param: T<a href="#param-t" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>The type of value that is being checked.</p>
8
+ </div><div class="tsd-tag-returns"><h4 class="tsd-anchor-link" id="returns">Returns<a href="#returns" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>This method returns val if it is not null
9
9
  or undefined, otherwise, the fallback is returned.
10
10
  If val is a promise and rejects, then fallback is
11
11
  also returned.</p>
12
- </div></div></section><section class="tsd-panel"><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="optional" class="tsd-anchor"></a><span class="tsd-kind-call-signature">optional</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful-fn.optional.html#optionalt">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> <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.optional.html#optionalt">T</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">fallback</span><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful-fn.optional.html#optionalt">T</a><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.optional.html#optionalt">T</a><span class="tsd-signature-symbol">&gt;</span><a href="#optional" 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>Allows a value to be null or undefined and has a fallback.</p>
13
- </div><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a id="optionalt" 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>
14
- </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.optional.html#optionalt">T</a><span class="tsd-signature-symbol">&gt;</span></span><div class="tsd-comment tsd-typography"><p>The value to check. This can be a promise
12
+ </div></div></section><section class="tsd-panel"><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="optional"><span class="tsd-kind-call-signature">optional</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#optionalt">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> <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="#optionalt">T</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">fallback</span><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#optionalt">T</a><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="#optionalt">T</a><span class="tsd-signature-symbol">&gt;</span><a href="#optional" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Allows a value to be null or undefined and has a fallback.</p>
13
+ </div><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span id="optionalt"><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>
14
+ </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="#optionalt">T</a><span class="tsd-signature-symbol">&gt;</span></span><div class="tsd-comment tsd-typography"><p>The value to check. This can be a promise
15
15
  that can return null or undefined in addition to the
16
16
  value.</p>
17
- </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">fallback</span>: <a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful-fn.optional.html#optionalt">T</a></span><div class="tsd-comment tsd-typography"><p>The fallback value in the case that val is
17
+ </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">fallback</span>: <a class="tsd-signature-type tsd-kind-type-parameter" href="#optionalt">T</a></span><div class="tsd-comment tsd-typography"><p>The fallback value in the case that val is
18
18
  null or undefined.</p>
19
- </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.optional.html#optionalt">T</a><span class="tsd-signature-symbol">&gt;</span></h4><p>This method returns val if it is not null
19
+ </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="#optionalt">T</a><span class="tsd-signature-symbol">&gt;</span></h4><p>This method returns val if it is not null
20
20
  or undefined, otherwise, the fallback is returned.
21
21
  If val is a promise and rejects, then fallback is
22
22
  also returned.</p>
23
- <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/e0425cedbb61f1914a89cb867f0d1618a11ea537/packages/helpful-fn/src/obligation/obligation.mts#L63">packages/helpful-fn/src/obligation/obligation.mts:63</a></li></ul></aside></li><li class="tsd-signature tsd-anchor-link"><a id="optional-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">optional</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful-fn.optional.html#optionalt-1">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> <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.optional.html#optionalt-1">T</a><span class="tsd-signature-symbol">&gt;</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.optional.html#optionalt-1">T</a> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol">&gt;</span><a href="#optional-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>Allows a value to be null or undefined and has a fallback.</p>
24
- </div><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a id="optionalt-1" 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>
25
- </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.optional.html#optionalt-1">T</a><span class="tsd-signature-symbol">&gt;</span></span><div class="tsd-comment tsd-typography"><p>The value to check. This can be a promise
23
+ <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/3e88f38b916d0973f2520566526efbd1519ed6af/packages/helpful-fn/src/obligation/obligation.mts#L63">packages/helpful-fn/src/obligation/obligation.mts:63</a></li></ul></aside></div></li><li class=""><div class="tsd-signature tsd-anchor-link" id="optional-1"><span class="tsd-kind-call-signature">optional</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#optionalt-1">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> <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="#optionalt-1">T</a><span class="tsd-signature-symbol">&gt;</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">null</span> <span class="tsd-signature-symbol">|</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#optionalt-1">T</a><span class="tsd-signature-symbol">&gt;</span><a href="#optional-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Allows a value to be null or undefined and has a fallback.</p>
24
+ </div><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span id="optionalt-1"><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>
25
+ </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="#optionalt-1">T</a><span class="tsd-signature-symbol">&gt;</span></span><div class="tsd-comment tsd-typography"><p>The value to check. This can be a promise
26
26
  that can return null or undefined in addition to the
27
27
  value.</p>
28
- </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.optional.html#optionalt-1">T</a> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol">&gt;</span></h4><p>This method returns val if it is not null
28
+ </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">null</span> <span class="tsd-signature-symbol">|</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#optionalt-1">T</a><span class="tsd-signature-symbol">&gt;</span></h4><p>This method returns val if it is not null
29
29
  or undefined, otherwise, null is returned.
30
30
  If val is a promise and rejects, then null is
31
31
  also returned.</p>
32
- <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/e0425cedbb61f1914a89cb867f0d1618a11ea537/packages/helpful-fn/src/obligation/obligation.mts#L81">packages/helpful-fn/src/obligation/obligation.mts:81</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">Helpful</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
32
+ <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/3e88f38b916d0973f2520566526efbd1519ed6af/packages/helpful-fn/src/obligation/obligation.mts#L81">packages/helpful-fn/src/obligation/obligation.mts:81</a></li></ul></aside></div></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"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>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">Helpful</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
package/dist/functions/_zthun_helpful-fn.peel.html CHANGED
@@ -1,8 +1,8 @@
1
- <!DOCTYPE html><html class="default" lang="en" data-base=".."><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>peel | Helpful</title><link rel="icon" href="../assets/favicon.svg" type="image/svg+xml"/><meta name="description" content="Documentation for Helpful"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search"><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">Helpful</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../modules.html">Helpful</a></li><li><a href="../modules/_zthun_helpful-fn.html">@zthun/helpful-fn</a></li><li><a href="_zthun_helpful-fn.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#peelt">T</a> <span class="tsd-signature-keyword">extends</span> <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span><br/>    <span class="tsd-kind-parameter">str</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">candidates</span><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful-fn.peel.html#peelt">T</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">[</span><a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful-fn.peel.html#peelt">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>
2
- </div><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a id="peelt" 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>
3
- </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#peelt">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>
4
- </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#peelt">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
1
+ <!DOCTYPE html><html class="default" lang="en" data-base="../"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>peel | Helpful</title><link rel="icon" href="../assets/favicon.svg" type="image/svg+xml"/><meta name="description" content="Documentation for Helpful"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><a href="../index.html" class="title">Helpful</a><div id="tsd-toolbar-links"></div><button id="tsd-search-trigger" class="tsd-widget" aria-label="Search"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></button><dialog id="tsd-search" aria-label="Search"><input role="combobox" id="tsd-search-input" aria-controls="tsd-search-results" aria-autocomplete="list" aria-expanded="true" autocapitalize="off" autocomplete="off" placeholder="Search the docs" maxLength="100"/><ul role="listbox" id="tsd-search-results"></ul><div id="tsd-search-status" aria-live="polite" aria-atomic="true"><div>Preparing search index...</div></div></dialog><a href="#" class="tsd-widget menu" id="tsd-toolbar-menu-trigger" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb" aria-label="Breadcrumb"><li><a href="../modules/_zthun_helpful-fn.html">@zthun/helpful-fn</a></li><li><a href="" aria-current="page">peel</a></li></ul><h1>Function peel</h1></div><section class="tsd-panel"><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="peel"><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="#peelt">T</a> <span class="tsd-signature-keyword">extends</span> <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span><br/>    <span class="tsd-kind-parameter">str</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">candidates</span><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#peelt">T</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <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="#peelt">T</a><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" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div 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>
2
+ </div><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span id="peelt"><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>
3
+ </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="#peelt">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>
4
+ </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <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="#peelt">T</a><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
5
5
  the second item is the remainder of the string. If the string
6
6
  does not start with any given candidates, then the first
7
7
  item will be null and the second item will be str.</p>
8
- <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/e0425cedbb61f1914a89cb867f0d1618a11ea537/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">Helpful</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
8
+ <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/3e88f38b916d0973f2520566526efbd1519ed6af/packages/helpful-fn/src/peel/peel.mts#L15">packages/helpful-fn/src/peel/peel.mts:15</a></li></ul></aside></div></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"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>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">Helpful</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>