@zthun/helpful-web 6.7.2 → 7.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (320) hide show
  1. package/LICENSE +15 -11
  2. package/dist/assets/hierarchy.js +1 -0
  3. package/dist/assets/highlight.css +0 -14
  4. package/dist/assets/icons.js +1 -1
  5. package/dist/assets/icons.svg +1 -1
  6. package/dist/assets/main.js +5 -5
  7. package/dist/assets/navigation.js +1 -1
  8. package/dist/assets/search.js +1 -1
  9. package/dist/assets/style.css +1405 -1288
  10. package/dist/classes/{_zthun_helpful_brands.ZBrandBuilder.html → _zthun_helpful-brands.ZBrandBuilder.html} +87 -88
  11. package/dist/classes/{_zthun_helpful_fn.ZAssert.html → _zthun_helpful-fn.ZAssert.html} +11 -12
  12. package/dist/classes/_zthun_helpful-fn.ZDeserializeJson.html +10 -0
  13. package/dist/classes/_zthun_helpful-fn.ZDeserializeTry.html +18 -0
  14. package/dist/classes/_zthun_helpful-fn.ZQuadrilateralBuilder.html +43 -0
  15. package/dist/classes/_zthun_helpful-fn.ZQuadrilateralCornersBuilder.html +48 -0
  16. package/dist/classes/_zthun_helpful-fn.ZRectangle.html +64 -0
  17. package/dist/classes/{_zthun_helpful_fn.ZSerializeJson.html → _zthun_helpful-fn.ZSerializeJson.html} +6 -7
  18. package/dist/classes/{_zthun_helpful_internet.ZCookieBuilder.html → _zthun_helpful-internet.ZCookieBuilder.html} +40 -41
  19. package/dist/classes/{_zthun_helpful_internet.ZEmailBuilder.html → _zthun_helpful-internet.ZEmailBuilder.html} +21 -22
  20. package/dist/classes/{_zthun_helpful_internet.ZEmailContactAddressBuilder.html → _zthun_helpful-internet.ZEmailContactAddressBuilder.html} +14 -15
  21. package/dist/classes/{_zthun_helpful_internet.ZEmailContactBuilder.html → _zthun_helpful-internet.ZEmailContactBuilder.html} +20 -21
  22. package/dist/classes/{_zthun_helpful_internet.ZEmailEnvelopeBuilder.html → _zthun_helpful-internet.ZEmailEnvelopeBuilder.html} +43 -44
  23. package/dist/classes/{_zthun_helpful_internet.ZServerBuilder.html → _zthun_helpful-internet.ZServerBuilder.html} +21 -22
  24. package/dist/classes/_zthun_helpful-query.ZDataFilterFields.html +11 -0
  25. package/dist/classes/{_zthun_helpful_query.ZDataMatchAlways.html → _zthun_helpful-query.ZDataMatchAlways.html} +5 -6
  26. package/dist/classes/_zthun_helpful-query.ZDataMatchOptional.html +15 -0
  27. package/dist/classes/{_zthun_helpful_query.ZDataRequestBuilder.html → _zthun_helpful-query.ZDataRequestBuilder.html} +27 -28
  28. package/dist/classes/_zthun_helpful-query.ZDataSearchFields.html +10 -0
  29. package/dist/classes/{_zthun_helpful_query.ZDataSearchText.html → _zthun_helpful-query.ZDataSearchText.html} +5 -6
  30. package/dist/classes/_zthun_helpful-query.ZDataSourceStatic.html +57 -0
  31. package/dist/classes/_zthun_helpful-query.ZDataSourceStaticOptionsBuilder.html +22 -0
  32. package/dist/classes/_zthun_helpful-query.ZFilterBinaryBuilder.html +42 -0
  33. package/dist/classes/{_zthun_helpful_query.ZFilterCollectionBuilder.html → _zthun_helpful-query.ZFilterCollectionBuilder.html} +25 -26
  34. package/dist/classes/{_zthun_helpful_query.ZFilterDeserialize.html → _zthun_helpful-query.ZFilterDeserialize.html} +7 -8
  35. package/dist/classes/{_zthun_helpful_query.ZFilterLogicBuilder.html → _zthun_helpful-query.ZFilterLogicBuilder.html} +25 -26
  36. package/dist/classes/{_zthun_helpful_query.ZFilterSerialize.html → _zthun_helpful-query.ZFilterSerialize.html} +7 -8
  37. package/dist/classes/{_zthun_helpful_query.ZFilterUnaryBuilder.html → _zthun_helpful-query.ZFilterUnaryBuilder.html} +20 -21
  38. package/dist/classes/{_zthun_helpful_query.ZMetadataBuilder.html → _zthun_helpful-query.ZMetadataBuilder.html} +55 -56
  39. package/dist/classes/_zthun_helpful-query.ZPageBuilder.html +30 -0
  40. package/dist/classes/{_zthun_helpful_query.ZSortBuilder.html → _zthun_helpful-query.ZSortBuilder.html} +17 -18
  41. package/dist/classes/{_zthun_helpful_query.ZSortDeserialize.html → _zthun_helpful-query.ZSortDeserialize.html} +7 -8
  42. package/dist/classes/_zthun_helpful-query.ZSortSerialize.html +8 -0
  43. package/dist/classes/{_zthun_helpful_query.ZSorterSingle.html → _zthun_helpful-query.ZSorterSingle.html} +12 -13
  44. package/dist/classes/{_zthun_helpful_query.ZWellKnownIconClasses.html → _zthun_helpful-query.ZWellKnownIconClasses.html} +15 -16
  45. package/dist/classes/{_zthun_helpful_react.ZFileSelect.html → _zthun_helpful-react.ZFileSelect.html} +7 -8
  46. package/dist/classes/{_zthun_helpful_validation.EqualsOtherPropertyValidator.html → _zthun_helpful-validation.EqualsOtherPropertyValidator.html} +5 -6
  47. package/dist/classes/{_zthun_helpful_validation.IsDataURILimitValidator.html → _zthun_helpful-validation.IsDataURILimitValidator.html} +5 -6
  48. package/dist/classes/{_zthun_helpful_validation.IsNotWhiteSpaceValidator.html → _zthun_helpful-validation.IsNotWhiteSpaceValidator.html} +5 -6
  49. package/dist/classes/{_zthun_helpful_validation.RequiresOtherPropertyValidator.html → _zthun_helpful-validation.RequiresOtherPropertyValidator.html} +5 -6
  50. package/dist/enums/{_zthun_helpful_fn.ZHorizontalAnchor.html → _zthun_helpful-fn.ZHorizontalAnchor.html} +8 -9
  51. package/dist/enums/{_zthun_helpful_fn.ZOrientation.html → _zthun_helpful-fn.ZOrientation.html} +6 -7
  52. package/dist/enums/{_zthun_helpful_fn.ZVerticalAnchor.html → _zthun_helpful-fn.ZVerticalAnchor.html} +8 -9
  53. package/dist/enums/{_zthun_helpful_query.ZMetadataType.html → _zthun_helpful-query.ZMetadataType.html} +14 -15
  54. package/dist/enums/{_zthun_helpful_query.ZOperatorBinary.html → _zthun_helpful-query.ZOperatorBinary.html} +16 -17
  55. package/dist/enums/{_zthun_helpful_query.ZOperatorCollection.html → _zthun_helpful-query.ZOperatorCollection.html} +6 -7
  56. package/dist/enums/{_zthun_helpful_query.ZOperatorLogic.html → _zthun_helpful-query.ZOperatorLogic.html} +6 -7
  57. package/dist/enums/{_zthun_helpful_query.ZOperatorUnary.html → _zthun_helpful-query.ZOperatorUnary.html} +6 -7
  58. package/dist/enums/{_zthun_helpful_query.ZSortDirection.html → _zthun_helpful-query.ZSortDirection.html} +6 -7
  59. package/dist/functions/{_zthun_helpful_fn.bash.html → _zthun_helpful-fn.bash.html} +5 -6
  60. package/dist/functions/_zthun_helpful-fn.commaJoinDefined.html +5 -0
  61. package/dist/functions/{_zthun_helpful_fn.countBuckets.html → _zthun_helpful-fn.countBuckets.html} +3 -4
  62. package/dist/functions/{_zthun_helpful_fn.createError.html → _zthun_helpful-fn.createError.html} +3 -4
  63. package/dist/functions/{_zthun_helpful_fn.createGuid.html → _zthun_helpful-fn.createGuid.html} +4 -5
  64. package/dist/functions/{_zthun_helpful_fn.css.html → _zthun_helpful-fn.css.html} +5 -6
  65. package/dist/functions/_zthun_helpful-fn.cssJoinDefined.html +5 -0
  66. package/dist/functions/_zthun_helpful-fn.firstDefined.html +12 -0
  67. package/dist/functions/_zthun_helpful-fn.firstTruthy.html +12 -0
  68. package/dist/functions/_zthun_helpful-fn.firstWhere.html +10 -0
  69. package/dist/functions/{_zthun_helpful_fn.html.html → _zthun_helpful-fn.html.html} +5 -6
  70. package/dist/functions/_zthun_helpful-fn.isEmptyObject.html +8 -0
  71. package/dist/functions/{_zthun_helpful_fn.javascript.html → _zthun_helpful-fn.javascript.html} +5 -6
  72. package/dist/functions/_zthun_helpful-fn.joinDefined.html +9 -0
  73. package/dist/functions/{_zthun_helpful_fn.js.html → _zthun_helpful-fn.js.html} +5 -6
  74. package/dist/functions/{_zthun_helpful_fn.markdown.html → _zthun_helpful-fn.markdown.html} +5 -6
  75. package/dist/functions/{_zthun_helpful_fn.md.html → _zthun_helpful-fn.md.html} +5 -6
  76. package/dist/functions/_zthun_helpful-fn.optional.html +32 -0
  77. package/dist/functions/_zthun_helpful-fn.peel.html +8 -0
  78. package/dist/functions/{_zthun_helpful_fn.peelBetween.html → _zthun_helpful-fn.peelBetween.html} +4 -5
  79. package/dist/functions/_zthun_helpful-fn.pickBy.html +6 -0
  80. package/dist/functions/_zthun_helpful-fn.pickDataAttributes.html +4 -0
  81. package/dist/functions/_zthun_helpful-fn.pickDefined.html +4 -0
  82. package/dist/functions/_zthun_helpful-fn.pipeJoinDefined.html +5 -0
  83. package/dist/functions/_zthun_helpful-fn.required.html +9 -0
  84. package/dist/functions/_zthun_helpful-fn.semiColonJoinDefined.html +5 -0
  85. package/dist/functions/_zthun_helpful-fn.setFirst.html +16 -0
  86. package/dist/functions/{_zthun_helpful_fn.sh.html → _zthun_helpful-fn.sh.html} +5 -6
  87. package/dist/functions/_zthun_helpful-fn.sleep.html +13 -0
  88. package/dist/functions/_zthun_helpful-fn.spaceJoinDefined.html +5 -0
  89. package/dist/functions/{_zthun_helpful_fn.tag.html → _zthun_helpful-fn.tag.html} +4 -5
  90. package/dist/functions/_zthun_helpful-fn.tryFallback.html +13 -0
  91. package/dist/functions/_zthun_helpful-fn.tryFallbackAsync.html +16 -0
  92. package/dist/functions/{_zthun_helpful_fn.ts.html → _zthun_helpful-fn.ts.html} +5 -6
  93. package/dist/functions/{_zthun_helpful_fn.typescript.html → _zthun_helpful-fn.typescript.html} +5 -6
  94. package/dist/functions/{_zthun_helpful_fn.zsh.html → _zthun_helpful-fn.zsh.html} +5 -6
  95. package/dist/functions/{_zthun_helpful_node.walk.html → _zthun_helpful-node.walk.html} +5 -6
  96. package/dist/functions/_zthun_helpful-query.isBinaryFilter.html +4 -0
  97. package/dist/functions/_zthun_helpful-query.isBinaryOperator.html +4 -0
  98. package/dist/functions/_zthun_helpful-query.isCollectionFilter.html +4 -0
  99. package/dist/functions/_zthun_helpful-query.isCollectionOperator.html +4 -0
  100. package/dist/functions/_zthun_helpful-query.isLogicFilter.html +4 -0
  101. package/dist/functions/_zthun_helpful-query.isLogicOperator.html +4 -0
  102. package/dist/functions/_zthun_helpful-query.isUnaryFilter.html +4 -0
  103. package/dist/functions/_zthun_helpful-query.isUnaryOperator.html +4 -0
  104. package/dist/functions/_zthun_helpful-react.ZFileSelectContext.html +10 -0
  105. package/dist/functions/_zthun_helpful-react.ZWindowServiceContext.html +10 -0
  106. package/dist/functions/_zthun_helpful-react.asStateData.html +18 -0
  107. package/dist/functions/_zthun_helpful-react.asStateError.html +6 -0
  108. package/dist/functions/_zthun_helpful-react.createKeyboardActivate.html +7 -0
  109. package/dist/functions/_zthun_helpful-react.isStateErrored.html +5 -0
  110. package/dist/functions/_zthun_helpful-react.isStateLoaded.html +5 -0
  111. package/dist/functions/_zthun_helpful-react.isStateLoading.html +5 -0
  112. package/dist/functions/_zthun_helpful-react.useAmbassadorState.html +38 -0
  113. package/dist/functions/_zthun_helpful-react.useAsyncState.html +7 -0
  114. package/dist/functions/_zthun_helpful-react.useFileSelect.html +3 -0
  115. package/dist/functions/_zthun_helpful-react.useKeyboardActivate.html +12 -0
  116. package/dist/functions/_zthun_helpful-react.useMoreViewState.html +12 -0
  117. package/dist/functions/_zthun_helpful-react.usePageViewState.html +10 -0
  118. package/dist/functions/_zthun_helpful-react.useStateAsArray.html +8 -0
  119. package/dist/functions/_zthun_helpful-react.useWindowService.html +3 -0
  120. package/dist/functions/_zthun_helpful-validation.EqualsOtherProperty.html +5 -0
  121. package/dist/functions/_zthun_helpful-validation.IsDataURILimit.html +6 -0
  122. package/dist/functions/_zthun_helpful-validation.IsNotWhiteSpace.html +4 -0
  123. package/dist/functions/_zthun_helpful-validation.RequiresOtherProperty.html +5 -0
  124. package/dist/hierarchy.html +1 -2
  125. package/dist/index.html +2 -3
  126. package/dist/interfaces/{_zthun_helpful_brands.IZBrand.html → _zthun_helpful-brands.IZBrand.html} +10 -11
  127. package/dist/interfaces/_zthun_helpful-fn.IZDeserialize.html +11 -0
  128. package/dist/interfaces/_zthun_helpful-fn.IZPoint2d.html +6 -0
  129. package/dist/interfaces/_zthun_helpful-fn.IZPoint3d.html +8 -0
  130. package/dist/interfaces/{_zthun_helpful_fn.IZQuadrilateral.html → _zthun_helpful-fn.IZQuadrilateral.html} +11 -12
  131. package/dist/interfaces/_zthun_helpful-fn.IZQuadrilateralCorners.html +9 -0
  132. package/dist/interfaces/_zthun_helpful-fn.IZSerialize.html +9 -0
  133. package/dist/interfaces/{_zthun_helpful_internet.IZCookie.html → _zthun_helpful-internet.IZCookie.html} +15 -16
  134. package/dist/interfaces/{_zthun_helpful_internet.IZEmail.html → _zthun_helpful-internet.IZEmail.html} +8 -9
  135. package/dist/interfaces/{_zthun_helpful_internet.IZEmailContact.html → _zthun_helpful-internet.IZEmailContact.html} +7 -8
  136. package/dist/interfaces/_zthun_helpful-internet.IZEmailEnvelope.html +13 -0
  137. package/dist/interfaces/{_zthun_helpful_internet.IZServer.html → _zthun_helpful-internet.IZServer.html} +9 -10
  138. package/dist/interfaces/{_zthun_helpful_node.ZWalkOptions.html → _zthun_helpful-node.ZWalkOptions.html} +8 -9
  139. package/dist/interfaces/_zthun_helpful-query.IZDataMatch.html +9 -0
  140. package/dist/interfaces/{_zthun_helpful_query.IZDataRequest.html → _zthun_helpful-query.IZDataRequest.html} +15 -16
  141. package/dist/interfaces/{_zthun_helpful_query.IZDataRequestQuery.html → _zthun_helpful-query.IZDataRequestQuery.html} +11 -12
  142. package/dist/interfaces/{_zthun_helpful_query.IZDataSource.html → _zthun_helpful-query.IZDataSource.html} +10 -11
  143. package/dist/interfaces/{_zthun_helpful_query.IZDataSourceStaticOptions.html → _zthun_helpful-query.IZDataSourceStaticOptions.html} +7 -8
  144. package/dist/interfaces/{_zthun_helpful_query.IZFilterBinary.html → _zthun_helpful-query.IZFilterBinary.html} +9 -10
  145. package/dist/interfaces/{_zthun_helpful_query.IZFilterCollection.html → _zthun_helpful-query.IZFilterCollection.html} +9 -10
  146. package/dist/interfaces/{_zthun_helpful_query.IZFilterLogic.html → _zthun_helpful-query.IZFilterLogic.html} +8 -9
  147. package/dist/interfaces/_zthun_helpful-query.IZFilterMetadata.html +6 -0
  148. package/dist/interfaces/_zthun_helpful-query.IZFilterOperator.html +7 -0
  149. package/dist/interfaces/_zthun_helpful-query.IZFilterSubject.html +8 -0
  150. package/dist/interfaces/{_zthun_helpful_query.IZMetadata.html → _zthun_helpful-query.IZMetadata.html} +23 -24
  151. package/dist/interfaces/{_zthun_helpful_query.IZPage.html → _zthun_helpful-query.IZPage.html} +6 -7
  152. package/dist/interfaces/{_zthun_helpful_query.IZSort.html → _zthun_helpful-query.IZSort.html} +6 -7
  153. package/dist/interfaces/_zthun_helpful-query.IZSorter.html +27 -0
  154. package/dist/interfaces/_zthun_helpful-react.IZFileSelect.html +10 -0
  155. package/dist/interfaces/{_zthun_helpful_react.IZKeyboardInteraction.html → _zthun_helpful-react.IZKeyboardInteraction.html} +8 -9
  156. package/dist/modules/_zthun_helpful-brands.html +18 -0
  157. package/dist/modules/_zthun_helpful-fn.html +7 -0
  158. package/dist/modules/_zthun_helpful-internet.html +6 -0
  159. package/dist/modules/_zthun_helpful-node.html +10 -0
  160. package/dist/modules/_zthun_helpful-query.html +32 -0
  161. package/dist/modules/_zthun_helpful-react.html +6 -0
  162. package/dist/modules/_zthun_helpful-validation.html +7 -0
  163. package/dist/modules.html +1 -2
  164. package/dist/types/_zthun_helpful-fn.DeepPartial.html +1 -0
  165. package/dist/types/_zthun_helpful-fn.JoinListInputParameter.html +6 -0
  166. package/dist/types/_zthun_helpful-fn.PickPredicate.html +1 -0
  167. package/dist/types/_zthun_helpful-fn.PickResult.html +1 -0
  168. package/dist/types/_zthun_helpful-fn.RequiredDeep.html +1 -0
  169. package/dist/types/_zthun_helpful-fn.RequiredPick.html +1 -0
  170. package/dist/types/_zthun_helpful-fn.ZAnchor.html +11 -0
  171. package/dist/types/_zthun_helpful-fn.ZCornersHorizontal.html +2 -0
  172. package/dist/types/_zthun_helpful-fn.ZCornersVertical.html +2 -0
  173. package/dist/types/_zthun_helpful-fn.ZObligatedValue.html +3 -0
  174. package/dist/types/_zthun_helpful-fn.ZQuadrilateralCornersLike.html +2 -0
  175. package/dist/types/_zthun_helpful-fn.ZQuadrilateralLike.html +5 -0
  176. package/dist/types/_zthun_helpful-fn.ZSideAnchor.html +2 -0
  177. package/dist/types/_zthun_helpful-query.IZFilter.html +2 -0
  178. package/dist/types/_zthun_helpful-query.IZFilterUnary.html +2 -0
  179. package/dist/types/_zthun_helpful-query.ZOperatorFilter.html +2 -0
  180. package/dist/types/_zthun_helpful-react.ZAmbassadorReducer.html +2 -0
  181. package/dist/types/_zthun_helpful-react.ZAmbassadorReducerRequired.html +2 -0
  182. package/dist/types/_zthun_helpful-react.ZAmbassadorSetCurrent.html +2 -0
  183. package/dist/types/_zthun_helpful-react.ZAsyncDataState.html +8 -0
  184. package/dist/types/_zthun_helpful-react.ZAsyncDataTuple.html +5 -0
  185. package/dist/types/_zthun_helpful-react.ZAsyncUseData.html +2 -0
  186. package/dist/types/_zthun_helpful-react.ZSetStateAsArray.html +1 -0
  187. package/dist/types/_zthun_helpful-react.ZStateAsArrayReducer.html +1 -0
  188. package/dist/variables/_zthun_helpful-brands.ZBrands.html +5 -0
  189. package/dist/variables/_zthun_helpful-fn._global.html +1 -0
  190. package/dist/variables/_zthun_helpful-query.ZBinaryComparators.html +2 -0
  191. package/dist/variables/_zthun_helpful-query.ZCollectionComparators.html +2 -0
  192. package/dist/variables/_zthun_helpful-query.ZOperatorsBinary.html +2 -0
  193. package/dist/variables/_zthun_helpful-query.ZOperatorsCollection.html +2 -0
  194. package/dist/variables/_zthun_helpful-query.ZOperatorsFilter.html +2 -0
  195. package/dist/variables/_zthun_helpful-query.ZOperatorsLogic.html +2 -0
  196. package/dist/variables/_zthun_helpful-query.ZOperatorsUnary.html +2 -0
  197. package/dist/variables/_zthun_helpful-query.ZSortDirections.html +2 -0
  198. package/dist/variables/_zthun_helpful-query.ZUnaryComparators.html +2 -0
  199. package/dist/variables/_zthun_helpful-react.DefaultActivateCodes.html +4 -0
  200. package/dist/variables/_zthun_helpful-react.ZAsyncLoading.html +2 -0
  201. package/package.json +11 -13
  202. package/dist/classes/_zthun_helpful_fn.ZDeserializeJson.html +0 -11
  203. package/dist/classes/_zthun_helpful_fn.ZDeserializeTry.html +0 -19
  204. package/dist/classes/_zthun_helpful_fn.ZQuadrilateralBuilder.html +0 -44
  205. package/dist/classes/_zthun_helpful_fn.ZQuadrilateralCornersBuilder.html +0 -49
  206. package/dist/classes/_zthun_helpful_fn.ZRectangle.html +0 -65
  207. package/dist/classes/_zthun_helpful_query.ZDataFilterFields.html +0 -12
  208. package/dist/classes/_zthun_helpful_query.ZDataMatchOptional.html +0 -16
  209. package/dist/classes/_zthun_helpful_query.ZDataSearchFields.html +0 -11
  210. package/dist/classes/_zthun_helpful_query.ZDataSourceStatic.html +0 -58
  211. package/dist/classes/_zthun_helpful_query.ZDataSourceStaticOptionsBuilder.html +0 -23
  212. package/dist/classes/_zthun_helpful_query.ZFilterBinaryBuilder.html +0 -43
  213. package/dist/classes/_zthun_helpful_query.ZPageBuilder.html +0 -31
  214. package/dist/classes/_zthun_helpful_query.ZSortSerialize.html +0 -9
  215. package/dist/functions/_zthun_helpful_fn.commaJoinDefined.html +0 -6
  216. package/dist/functions/_zthun_helpful_fn.cssJoinDefined.html +0 -6
  217. package/dist/functions/_zthun_helpful_fn.firstDefined.html +0 -13
  218. package/dist/functions/_zthun_helpful_fn.firstTruthy.html +0 -13
  219. package/dist/functions/_zthun_helpful_fn.firstWhere.html +0 -11
  220. package/dist/functions/_zthun_helpful_fn.isEmptyObject.html +0 -9
  221. package/dist/functions/_zthun_helpful_fn.joinDefined.html +0 -10
  222. package/dist/functions/_zthun_helpful_fn.optional.html +0 -33
  223. package/dist/functions/_zthun_helpful_fn.peel.html +0 -9
  224. package/dist/functions/_zthun_helpful_fn.pickBy.html +0 -7
  225. package/dist/functions/_zthun_helpful_fn.pickDataAttributes.html +0 -5
  226. package/dist/functions/_zthun_helpful_fn.pickDefined.html +0 -5
  227. package/dist/functions/_zthun_helpful_fn.pipeJoinDefined.html +0 -6
  228. package/dist/functions/_zthun_helpful_fn.required.html +0 -10
  229. package/dist/functions/_zthun_helpful_fn.semiColonJoinDefined.html +0 -6
  230. package/dist/functions/_zthun_helpful_fn.setFirst.html +0 -17
  231. package/dist/functions/_zthun_helpful_fn.sleep.html +0 -14
  232. package/dist/functions/_zthun_helpful_fn.spaceJoinDefined.html +0 -6
  233. package/dist/functions/_zthun_helpful_fn.tryFallback.html +0 -14
  234. package/dist/functions/_zthun_helpful_fn.tryFallbackAsync.html +0 -17
  235. package/dist/functions/_zthun_helpful_query.isBinaryFilter.html +0 -5
  236. package/dist/functions/_zthun_helpful_query.isBinaryOperator.html +0 -5
  237. package/dist/functions/_zthun_helpful_query.isCollectionFilter.html +0 -5
  238. package/dist/functions/_zthun_helpful_query.isCollectionOperator.html +0 -5
  239. package/dist/functions/_zthun_helpful_query.isLogicFilter.html +0 -5
  240. package/dist/functions/_zthun_helpful_query.isLogicOperator.html +0 -5
  241. package/dist/functions/_zthun_helpful_query.isUnaryFilter.html +0 -5
  242. package/dist/functions/_zthun_helpful_query.isUnaryOperator.html +0 -5
  243. package/dist/functions/_zthun_helpful_react.ZFileSelectContext.html +0 -11
  244. package/dist/functions/_zthun_helpful_react.ZWindowServiceContext.html +0 -11
  245. package/dist/functions/_zthun_helpful_react.asStateData.html +0 -19
  246. package/dist/functions/_zthun_helpful_react.asStateError.html +0 -7
  247. package/dist/functions/_zthun_helpful_react.createKeyboardActivate.html +0 -8
  248. package/dist/functions/_zthun_helpful_react.isStateErrored.html +0 -6
  249. package/dist/functions/_zthun_helpful_react.isStateLoaded.html +0 -6
  250. package/dist/functions/_zthun_helpful_react.isStateLoading.html +0 -6
  251. package/dist/functions/_zthun_helpful_react.useAmbassadorState.html +0 -39
  252. package/dist/functions/_zthun_helpful_react.useAsyncState.html +0 -8
  253. package/dist/functions/_zthun_helpful_react.useFileSelect.html +0 -4
  254. package/dist/functions/_zthun_helpful_react.useKeyboardActivate.html +0 -13
  255. package/dist/functions/_zthun_helpful_react.useMoreViewState.html +0 -13
  256. package/dist/functions/_zthun_helpful_react.usePageViewState.html +0 -11
  257. package/dist/functions/_zthun_helpful_react.useStateAsArray.html +0 -9
  258. package/dist/functions/_zthun_helpful_react.useWindowService.html +0 -4
  259. package/dist/functions/_zthun_helpful_validation.EqualsOtherProperty.html +0 -6
  260. package/dist/functions/_zthun_helpful_validation.IsDataURILimit.html +0 -7
  261. package/dist/functions/_zthun_helpful_validation.IsNotWhiteSpace.html +0 -5
  262. package/dist/functions/_zthun_helpful_validation.RequiresOtherProperty.html +0 -6
  263. package/dist/interfaces/_zthun_helpful_fn.IZDeserialize.html +0 -12
  264. package/dist/interfaces/_zthun_helpful_fn.IZPoint2d.html +0 -7
  265. package/dist/interfaces/_zthun_helpful_fn.IZPoint3d.html +0 -9
  266. package/dist/interfaces/_zthun_helpful_fn.IZQuadrilateralCorners.html +0 -10
  267. package/dist/interfaces/_zthun_helpful_fn.IZSerialize.html +0 -10
  268. package/dist/interfaces/_zthun_helpful_internet.IZEmailEnvelope.html +0 -14
  269. package/dist/interfaces/_zthun_helpful_query.IZDataMatch.html +0 -10
  270. package/dist/interfaces/_zthun_helpful_query.IZFilterMetadata.html +0 -7
  271. package/dist/interfaces/_zthun_helpful_query.IZFilterOperator.html +0 -8
  272. package/dist/interfaces/_zthun_helpful_query.IZFilterSubject.html +0 -9
  273. package/dist/interfaces/_zthun_helpful_query.IZSorter.html +0 -28
  274. package/dist/interfaces/_zthun_helpful_react.IZFileSelect.html +0 -11
  275. package/dist/modules/_zthun_helpful_brands.html +0 -22
  276. package/dist/modules/_zthun_helpful_fn.html +0 -74
  277. package/dist/modules/_zthun_helpful_internet.html +0 -18
  278. package/dist/modules/_zthun_helpful_node.html +0 -13
  279. package/dist/modules/_zthun_helpful_proxy.html +0 -60
  280. package/dist/modules/_zthun_helpful_query.html +0 -95
  281. package/dist/modules/_zthun_helpful_react.html +0 -36
  282. package/dist/modules/_zthun_helpful_validation.html +0 -16
  283. package/dist/types/_zthun_helpful_fn.DeepPartial.html +0 -2
  284. package/dist/types/_zthun_helpful_fn.JoinListInputParameter.html +0 -7
  285. package/dist/types/_zthun_helpful_fn.PickPredicate.html +0 -2
  286. package/dist/types/_zthun_helpful_fn.PickResult.html +0 -2
  287. package/dist/types/_zthun_helpful_fn.RequiredDeep.html +0 -2
  288. package/dist/types/_zthun_helpful_fn.RequiredPick.html +0 -2
  289. package/dist/types/_zthun_helpful_fn.ZAnchor.html +0 -12
  290. package/dist/types/_zthun_helpful_fn.ZCornersHorizontal.html +0 -3
  291. package/dist/types/_zthun_helpful_fn.ZCornersVertical.html +0 -3
  292. package/dist/types/_zthun_helpful_fn.ZObligatedValue.html +0 -4
  293. package/dist/types/_zthun_helpful_fn.ZQuadrilateralCornersLike.html +0 -3
  294. package/dist/types/_zthun_helpful_fn.ZQuadrilateralLike.html +0 -6
  295. package/dist/types/_zthun_helpful_fn.ZSideAnchor.html +0 -3
  296. package/dist/types/_zthun_helpful_query.IZFilter.html +0 -3
  297. package/dist/types/_zthun_helpful_query.IZFilterUnary.html +0 -3
  298. package/dist/types/_zthun_helpful_query.ZOperatorFilter.html +0 -3
  299. package/dist/types/_zthun_helpful_react.ZAmbassadorReducer.html +0 -3
  300. package/dist/types/_zthun_helpful_react.ZAmbassadorReducerRequired.html +0 -3
  301. package/dist/types/_zthun_helpful_react.ZAmbassadorSetCurrent.html +0 -3
  302. package/dist/types/_zthun_helpful_react.ZAsyncDataState.html +0 -9
  303. package/dist/types/_zthun_helpful_react.ZAsyncDataTuple.html +0 -6
  304. package/dist/types/_zthun_helpful_react.ZAsyncUseData.html +0 -3
  305. package/dist/types/_zthun_helpful_react.ZSetStateAsArray.html +0 -2
  306. package/dist/types/_zthun_helpful_react.ZStateAsArrayReducer.html +0 -2
  307. package/dist/variables/_zthun_helpful_brands.ZBrands.html +0 -6
  308. package/dist/variables/_zthun_helpful_fn._global.html +0 -2
  309. package/dist/variables/_zthun_helpful_query.ZBinaryComparators.html +0 -3
  310. package/dist/variables/_zthun_helpful_query.ZCollectionComparators.html +0 -3
  311. package/dist/variables/_zthun_helpful_query.ZOperatorsBinary.html +0 -3
  312. package/dist/variables/_zthun_helpful_query.ZOperatorsCollection.html +0 -3
  313. package/dist/variables/_zthun_helpful_query.ZOperatorsFilter.html +0 -3
  314. package/dist/variables/_zthun_helpful_query.ZOperatorsLogic.html +0 -3
  315. package/dist/variables/_zthun_helpful_query.ZOperatorsUnary.html +0 -3
  316. package/dist/variables/_zthun_helpful_query.ZSortDirections.html +0 -3
  317. package/dist/variables/_zthun_helpful_query.ZUnaryComparators.html +0 -3
  318. package/dist/variables/_zthun_helpful_react.DefaultActivateCodes.html +0 -5
  319. package/dist/variables/_zthun_helpful_react.ZAsyncLoading.html +0 -3
  320. /package/dist/{helpful.svg → assets/favicon.svg} +0 -0
package/dist/functions/_zthun_helpful_validation.RequiresOtherProperty.html DELETED
@@ -1,6 +0,0 @@
1
- <!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>RequiresOtherProperty | Helpful</title><meta name="description" content="Documentation for Helpful"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><link rel="icon" href="../helpful.svg" />
2
- </head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">Helpful</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../modules.html">Helpful</a></li><li><a href="../modules/_zthun_helpful_validation.html">@zthun/helpful-validation</a></li><li><a href="_zthun_helpful_validation.RequiresOtherProperty.html">RequiresOtherProperty</a></li></ul><h1>Function RequiresOtherProperty</h1></div><section class="tsd-panel"><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="RequiresOtherProperty" class="tsd-anchor"></a><span class="tsd-kind-call-signature">Requires<wbr/>Other<wbr/>Property</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful_validation.RequiresOtherProperty.html#RequiresOtherProperty.T">T</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">property</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">object</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, <span class="tsd-kind-parameter">propertyName</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"> =&gt; </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><a href="#RequiresOtherProperty" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>A constraint that requires another property to be set in addition to the one this constraint belongs to.</p>
3
- </div><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a id="RequiresOtherProperty.T" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">T</span> = <span class="tsd-signature-type">any</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">property</span>: <span class="tsd-signature-keyword">keyof </span><a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful_validation.RequiresOtherProperty.html#RequiresOtherProperty.T">T</a></span><div class="tsd-comment tsd-typography"><p>The property to check.</p>
4
- </div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type">ValidationOptions</span></span><div class="tsd-comment tsd-typography"><p>The validation options.</p>
5
- </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">object</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, <span class="tsd-kind-parameter">propertyName</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"> =&gt; </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span></h4><p>A decorator that applies the constraint.</p>
6
- <ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature" id="RequiresOtherProperty.__type.__type-1"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">object</span>, <span class="tsd-kind-parameter">propertyName</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">object</span>: <span class="tsd-signature-type">any</span></span></li><li><span><span class="tsd-kind-parameter">propertyName</span>: <span class="tsd-signature-type">string</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/ce166906b78f0ba06c3593e8b6ff3e5bbb88e101/packages/helpful-validation/src/other-property/requires-other-property.mts#L46">other-property/requires-other-property.mts:46</a></li></ul></aside></li></ul></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>Helpful</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
package/dist/interfaces/_zthun_helpful_fn.IZDeserialize.html DELETED
@@ -1,12 +0,0 @@
1
- <!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>IZDeserialize | Helpful</title><meta name="description" content="Documentation for Helpful"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><link rel="icon" href="../helpful.svg" />
2
- </head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">Helpful</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../modules.html">Helpful</a></li><li><a href="../modules/_zthun_helpful_fn.html">@zthun/helpful-fn</a></li><li><a href="_zthun_helpful_fn.IZDeserialize.html">IZDeserialize</a></li></ul><h1>Interface IZDeserialize&lt;T, S&gt;</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>Represents an object that can be used to deserialize strings to objects.</p>
3
- </div><div class="tsd-comment tsd-typography"></div></section><div class="tsd-signature"><span class="tsd-signature-keyword">interface </span><span class="tsd-kind-interface">IZDeserialize</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful_fn.IZDeserialize.html#T">T</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful_fn.IZDeserialize.html#S">S</a><span class="tsd-signature-symbol">&gt;</span> <span class="tsd-signature-symbol">{ </span><br/><span>    </span><a class="tsd-kind-call-signature" href="_zthun_helpful_fn.IZDeserialize.html#deserialize.deserialize-1">deserialize</a><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">candidate</span><span class="tsd-signature-symbol">: </span><a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful_fn.IZDeserialize.html#S">S</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful_fn.IZDeserialize.html#T">T</a><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div> <section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a id="T" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">T</span></span><div class="tsd-comment tsd-typography"><p>The type of data to deserialize.</p>
4
- </div><div class="tsd-comment tsd-typography"></div></li><li><span><a id="S" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">S</span> = <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The serialization input.</p>
5
- </div><div class="tsd-comment tsd-typography"></div></li></ul></section> <section class="tsd-panel"><h4>Implemented by</h4><ul class="tsd-hierarchy"><li><a href="../classes/_zthun_helpful_fn.ZDeserializeJson.html" class="tsd-signature-type tsd-kind-class">ZDeserializeJson</a></li><li><a href="../classes/_zthun_helpful_fn.ZDeserializeTry.html" class="tsd-signature-type tsd-kind-class">ZDeserializeTry</a></li></ul></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/ce166906b78f0ba06c3593e8b6ff3e5bbb88e101/packages/helpful-fn/src/serialize/deserialize.mts#L9">packages/helpful-fn/src/serialize/deserialize.mts:9</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Methods</h3><div class="tsd-index-list"><a href="_zthun_helpful_fn.IZDeserialize.html#deserialize" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>deserialize</span></a>
6
- </div></section></div></details></section></section><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Methods"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Methods</h2></summary><section><section class="tsd-panel tsd-member"><a id="deserialize" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>deserialize</span><a href="#deserialize" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="deserialize.deserialize-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">deserialize</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">candidate</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful_fn.IZDeserialize.html#T">T</a><a href="#deserialize.deserialize-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Deserializes a candidate string to an object T.</p>
7
- </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">candidate</span>: <a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful_fn.IZDeserialize.html#S">S</a></span><div class="tsd-comment tsd-typography"><p>The candidate string to deserialize.</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.IZDeserialize.html#T">T</a></h4><p>The object that was deserialized.</p>
9
- <div class="tsd-comment tsd-typography"><div class="tsd-tag-Throws"><h4 class="tsd-anchor-link"><a id="Throws" class="tsd-anchor"></a>Throws<a href="#Throws" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>An error if the candidate contains
10
- semantic errors and cannot be deserialized
11
- to the given target type.</p>
12
- </div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/ce166906b78f0ba06c3593e8b6ff3e5bbb88e101/packages/helpful-fn/src/serialize/deserialize.mts#L24">packages/helpful-fn/src/serialize/deserialize.mts:24</a></li></ul></aside></li></ul></section></section></details></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="tsd-otp-Methods"><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Methods</summary><div><a href="#deserialize" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>deserialize</span></a></div></details></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>Helpful</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
package/dist/interfaces/_zthun_helpful_fn.IZPoint2d.html DELETED
@@ -1,7 +0,0 @@
1
- <!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>IZPoint2d | Helpful</title><meta name="description" content="Documentation for Helpful"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><link rel="icon" href="../helpful.svg" />
2
- </head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">Helpful</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../modules.html">Helpful</a></li><li><a href="../modules/_zthun_helpful_fn.html">@zthun/helpful-fn</a></li><li><a href="_zthun_helpful_fn.IZPoint2d.html">IZPoint2d</a></li></ul><h1>Interface IZPoint2d&lt;T&gt;</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>A 2d point.</p>
3
- </div><div class="tsd-comment tsd-typography"></div></section><div class="tsd-signature"><span class="tsd-signature-keyword">interface </span><span class="tsd-kind-interface">IZPoint2d</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful_fn.IZPoint2d.html#T">T</a><span class="tsd-signature-symbol">&gt;</span> <span class="tsd-signature-symbol">{ </span><br/><span>    </span><a class="tsd-kind-property" href="_zthun_helpful_fn.IZPoint2d.html#x">x</a><span class="tsd-signature-symbol">: </span><a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful_fn.IZPoint2d.html#T">T</a><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="_zthun_helpful_fn.IZPoint2d.html#y">y</a><span class="tsd-signature-symbol">: </span><a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful_fn.IZPoint2d.html#T">T</a><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div> <section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a id="T" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">T</span> = <span class="tsd-signature-type">number</span></span></li></ul></section> <section class="tsd-panel tsd-hierarchy"><h4>Hierarchy (<a href="../hierarchy.html#@zthun/helpful-fn.IZPoint2d">view full</a>)</h4><ul class="tsd-hierarchy"><li><span class="target">IZPoint2d</span><ul class="tsd-hierarchy"><li><a href="_zthun_helpful_fn.IZPoint3d.html" class="tsd-signature-type tsd-kind-interface">IZPoint3d</a></li></ul></li></ul></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/ce166906b78f0ba06c3593e8b6ff3e5bbb88e101/packages/helpful-fn/src/geometry/point.mts#L4">packages/helpful-fn/src/geometry/point.mts:4</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="_zthun_helpful_fn.IZPoint2d.html#x" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>x</span></a>
4
- <a href="_zthun_helpful_fn.IZPoint2d.html#y" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>y</span></a>
5
- </div></section></div></details></section></section><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Properties"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Properties</h2></summary><section><section class="tsd-panel tsd-member"><a id="x" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>x</span><a href="#x" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">x</span><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful_fn.IZPoint2d.html#T">T</a></div><div class="tsd-comment tsd-typography"><p>X value.</p>
6
- </div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/ce166906b78f0ba06c3593e8b6ff3e5bbb88e101/packages/helpful-fn/src/geometry/point.mts#L8">packages/helpful-fn/src/geometry/point.mts:8</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="y" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>y</span><a href="#y" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">y</span><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful_fn.IZPoint2d.html#T">T</a></div><div class="tsd-comment tsd-typography"><p>Y value.</p>
7
- </div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/ce166906b78f0ba06c3593e8b6ff3e5bbb88e101/packages/helpful-fn/src/geometry/point.mts#L12">packages/helpful-fn/src/geometry/point.mts:12</a></li></ul></aside></section></section></details></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="tsd-otp-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Properties</summary><div><a href="#x" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>x</span></a><a href="#y" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>y</span></a></div></details></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>Helpful</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
package/dist/interfaces/_zthun_helpful_fn.IZPoint3d.html DELETED
@@ -1,9 +0,0 @@
1
- <!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>IZPoint3d | Helpful</title><meta name="description" content="Documentation for Helpful"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><link rel="icon" href="../helpful.svg" />
2
- </head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">Helpful</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../modules.html">Helpful</a></li><li><a href="../modules/_zthun_helpful_fn.html">@zthun/helpful-fn</a></li><li><a href="_zthun_helpful_fn.IZPoint3d.html">IZPoint3d</a></li></ul><h1>Interface IZPoint3d&lt;T&gt;</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>A 3d point.</p>
3
- </div><div class="tsd-comment tsd-typography"></div></section><div class="tsd-signature"><span class="tsd-signature-keyword">interface </span><span class="tsd-kind-interface">IZPoint3d</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful_fn.IZPoint3d.html#T">T</a><span class="tsd-signature-symbol">&gt;</span> <span class="tsd-signature-symbol">{ </span><br/><span>    </span><a class="tsd-kind-property" href="_zthun_helpful_fn.IZPoint3d.html#x">x</a><span class="tsd-signature-symbol">: </span><a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful_fn.IZPoint3d.html#T">T</a><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="_zthun_helpful_fn.IZPoint3d.html#y">y</a><span class="tsd-signature-symbol">: </span><a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful_fn.IZPoint3d.html#T">T</a><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="_zthun_helpful_fn.IZPoint3d.html#z">z</a><span class="tsd-signature-symbol">: </span><a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful_fn.IZPoint3d.html#T">T</a><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div> <section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a id="T" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">T</span> = <span class="tsd-signature-type">number</span></span></li></ul></section> <section class="tsd-panel tsd-hierarchy"><h4>Hierarchy (<a href="../hierarchy.html#@zthun/helpful-fn.IZPoint3d">view full</a>)</h4><ul class="tsd-hierarchy"><li><a href="_zthun_helpful_fn.IZPoint2d.html" class="tsd-signature-type tsd-kind-interface">IZPoint2d</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful_fn.IZPoint3d.html#T">T</a><span class="tsd-signature-symbol">&gt;</span><ul class="tsd-hierarchy"><li><span class="target">IZPoint3d</span></li></ul></li></ul></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/ce166906b78f0ba06c3593e8b6ff3e5bbb88e101/packages/helpful-fn/src/geometry/point.mts#L18">packages/helpful-fn/src/geometry/point.mts:18</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="_zthun_helpful_fn.IZPoint3d.html#x" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>x</span></a>
4
- <a href="_zthun_helpful_fn.IZPoint3d.html#y" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>y</span></a>
5
- <a href="_zthun_helpful_fn.IZPoint3d.html#z" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>z</span></a>
6
- </div></section></div></details></section></section><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Properties"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Properties</h2></summary><section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="x" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>x</span><a href="#x" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">x</span><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful_fn.IZPoint3d.html#T">T</a></div><div class="tsd-comment tsd-typography"><p>X value.</p>
7
- </div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="_zthun_helpful_fn.IZPoint2d.html">IZPoint2d</a>.<a href="_zthun_helpful_fn.IZPoint2d.html#x">x</a></p><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/ce166906b78f0ba06c3593e8b6ff3e5bbb88e101/packages/helpful-fn/src/geometry/point.mts#L8">packages/helpful-fn/src/geometry/point.mts:8</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="y" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>y</span><a href="#y" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">y</span><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful_fn.IZPoint3d.html#T">T</a></div><div class="tsd-comment tsd-typography"><p>Y value.</p>
8
- </div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="_zthun_helpful_fn.IZPoint2d.html">IZPoint2d</a>.<a href="_zthun_helpful_fn.IZPoint2d.html#y">y</a></p><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/ce166906b78f0ba06c3593e8b6ff3e5bbb88e101/packages/helpful-fn/src/geometry/point.mts#L12">packages/helpful-fn/src/geometry/point.mts:12</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="z" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>z</span><a href="#z" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">z</span><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful_fn.IZPoint3d.html#T">T</a></div><div class="tsd-comment tsd-typography"><p>X value.</p>
9
- </div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/ce166906b78f0ba06c3593e8b6ff3e5bbb88e101/packages/helpful-fn/src/geometry/point.mts#L22">packages/helpful-fn/src/geometry/point.mts:22</a></li></ul></aside></section></section></details></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="tsd-otp-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Properties</summary><div><a href="#x" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>x</span></a><a href="#y" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>y</span></a><a href="#z" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>z</span></a></div></details></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>Helpful</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
package/dist/interfaces/_zthun_helpful_fn.IZQuadrilateralCorners.html DELETED
@@ -1,10 +0,0 @@
1
- <!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>IZQuadrilateralCorners | Helpful</title><meta name="description" content="Documentation for Helpful"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><link rel="icon" href="../helpful.svg" />
2
- </head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">Helpful</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../modules.html">Helpful</a></li><li><a href="../modules/_zthun_helpful_fn.html">@zthun/helpful-fn</a></li><li><a href="_zthun_helpful_fn.IZQuadrilateralCorners.html">IZQuadrilateralCorners</a></li></ul><h1>Interface IZQuadrilateralCorners&lt;T&gt;</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>An object that describes 4 corner values of a quadrilateral.</p>
3
- <p>This object is almost identical in functionality to a quadrilateral,
4
- but is mostly useful for semantics.</p>
5
- </div><div class="tsd-comment tsd-typography"></div></section><div class="tsd-signature"><span class="tsd-signature-keyword">interface </span><span class="tsd-kind-interface">IZQuadrilateralCorners</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful_fn.IZQuadrilateralCorners.html#T">T</a><span class="tsd-signature-symbol">&gt;</span> <span class="tsd-signature-symbol">{ </span><br/><span>    </span><a class="tsd-kind-property" href="_zthun_helpful_fn.IZQuadrilateralCorners.html#bottomLeft">bottomLeft</a><span class="tsd-signature-symbol">: </span><a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful_fn.IZQuadrilateralCorners.html#T">T</a><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="_zthun_helpful_fn.IZQuadrilateralCorners.html#bottomRight">bottomRight</a><span class="tsd-signature-symbol">: </span><a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful_fn.IZQuadrilateralCorners.html#T">T</a><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="_zthun_helpful_fn.IZQuadrilateralCorners.html#topLeft">topLeft</a><span class="tsd-signature-symbol">: </span><a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful_fn.IZQuadrilateralCorners.html#T">T</a><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="_zthun_helpful_fn.IZQuadrilateralCorners.html#topRight">topRight</a><span class="tsd-signature-symbol">: </span><a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful_fn.IZQuadrilateralCorners.html#T">T</a><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div> <section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a id="T" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">T</span> = <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>The type of data to associate to each corner.</p>
6
- </div><div class="tsd-comment tsd-typography"></div></li></ul></section> <aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/ce166906b78f0ba06c3593e8b6ff3e5bbb88e101/packages/helpful-fn/src/geometry/quadrilateral-corners.mts#L13">packages/helpful-fn/src/geometry/quadrilateral-corners.mts:13</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="_zthun_helpful_fn.IZQuadrilateralCorners.html#bottomLeft" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>bottom<wbr/>Left</span></a>
7
- <a href="_zthun_helpful_fn.IZQuadrilateralCorners.html#bottomRight" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>bottom<wbr/>Right</span></a>
8
- <a href="_zthun_helpful_fn.IZQuadrilateralCorners.html#topLeft" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>top<wbr/>Left</span></a>
9
- <a href="_zthun_helpful_fn.IZQuadrilateralCorners.html#topRight" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>top<wbr/>Right</span></a>
10
- </div></section></div></details></section></section><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Properties"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Properties</h2></summary><section><section class="tsd-panel tsd-member"><a id="bottomLeft" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>bottom<wbr/>Left</span><a href="#bottomLeft" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">bottom<wbr/>Left</span><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful_fn.IZQuadrilateralCorners.html#T">T</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/ce166906b78f0ba06c3593e8b6ff3e5bbb88e101/packages/helpful-fn/src/geometry/quadrilateral-corners.mts#L14">packages/helpful-fn/src/geometry/quadrilateral-corners.mts:14</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="bottomRight" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>bottom<wbr/>Right</span><a href="#bottomRight" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">bottom<wbr/>Right</span><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful_fn.IZQuadrilateralCorners.html#T">T</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/ce166906b78f0ba06c3593e8b6ff3e5bbb88e101/packages/helpful-fn/src/geometry/quadrilateral-corners.mts#L15">packages/helpful-fn/src/geometry/quadrilateral-corners.mts:15</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="topLeft" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>top<wbr/>Left</span><a href="#topLeft" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">top<wbr/>Left</span><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful_fn.IZQuadrilateralCorners.html#T">T</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/ce166906b78f0ba06c3593e8b6ff3e5bbb88e101/packages/helpful-fn/src/geometry/quadrilateral-corners.mts#L16">packages/helpful-fn/src/geometry/quadrilateral-corners.mts:16</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="topRight" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>top<wbr/>Right</span><a href="#topRight" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">top<wbr/>Right</span><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful_fn.IZQuadrilateralCorners.html#T">T</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/ce166906b78f0ba06c3593e8b6ff3e5bbb88e101/packages/helpful-fn/src/geometry/quadrilateral-corners.mts#L17">packages/helpful-fn/src/geometry/quadrilateral-corners.mts:17</a></li></ul></aside></section></section></details></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="tsd-otp-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Properties</summary><div><a href="#bottomLeft" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>bottom<wbr/>Left</span></a><a href="#bottomRight" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>bottom<wbr/>Right</span></a><a href="#topLeft" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>top<wbr/>Left</span></a><a href="#topRight" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>top<wbr/>Right</span></a></div></details></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>Helpful</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
package/dist/interfaces/_zthun_helpful_fn.IZSerialize.html DELETED
@@ -1,10 +0,0 @@
1
- <!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>IZSerialize | Helpful</title><meta name="description" content="Documentation for Helpful"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><link rel="icon" href="../helpful.svg" />
2
- </head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">Helpful</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../modules.html">Helpful</a></li><li><a href="../modules/_zthun_helpful_fn.html">@zthun/helpful-fn</a></li><li><a href="_zthun_helpful_fn.IZSerialize.html">IZSerialize</a></li></ul><h1>Interface IZSerialize&lt;T, S&gt;</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>Represents an object that can be used to serialize something to a output type.</p>
3
- </div><div class="tsd-comment tsd-typography"></div></section><div class="tsd-signature"><span class="tsd-signature-keyword">interface </span><span class="tsd-kind-interface">IZSerialize</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful_fn.IZSerialize.html#T">T</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful_fn.IZSerialize.html#S">S</a><span class="tsd-signature-symbol">&gt;</span> <span class="tsd-signature-symbol">{ </span><br/><span>    </span><a class="tsd-kind-call-signature" href="_zthun_helpful_fn.IZSerialize.html#serialize.serialize-1">serialize</a><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">candidate</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.IZSerialize.html#T">T</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful_fn.IZSerialize.html#S">S</a><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div> <section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a id="T" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">T</span></span><div class="tsd-comment tsd-typography"><p>The data type to serialize.</p>
4
- </div><div class="tsd-comment tsd-typography"></div></li><li><span><a id="S" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">S</span> = <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The output serialization type.</p>
5
- </div><div class="tsd-comment tsd-typography"></div></li></ul></section> <section class="tsd-panel"><h4>Implemented by</h4><ul class="tsd-hierarchy"><li><a href="../classes/_zthun_helpful_fn.ZSerializeJson.html" class="tsd-signature-type tsd-kind-class">ZSerializeJson</a></li></ul></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/ce166906b78f0ba06c3593e8b6ff3e5bbb88e101/packages/helpful-fn/src/serialize/serialize.mts#L9">packages/helpful-fn/src/serialize/serialize.mts:9</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Methods</h3><div class="tsd-index-list"><a href="_zthun_helpful_fn.IZSerialize.html#serialize" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>serialize</span></a>
6
- </div></section></div></details></section></section><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Methods"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Methods</h2></summary><section><section class="tsd-panel tsd-member"><a id="serialize" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>serialize</span><a href="#serialize" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="serialize.serialize-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">serialize</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">candidate</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful_fn.IZSerialize.html#S">S</a><a href="#serialize.serialize-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>Serializes a candidate object to a string.</p>
7
- </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">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.IZSerialize.html#T">T</a></span><div class="tsd-comment tsd-typography"><p>The candidate object.</p>
8
- </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful_fn.IZSerialize.html#S">S</a></h4><p>The string representation of the candidate or undefined
9
- if no such string representation could be serialized.</p>
10
- <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/ce166906b78f0ba06c3593e8b6ff3e5bbb88e101/packages/helpful-fn/src/serialize/serialize.mts#L20">packages/helpful-fn/src/serialize/serialize.mts:20</a></li></ul></aside></li></ul></section></section></details></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="tsd-otp-Methods"><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Methods</summary><div><a href="#serialize" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>serialize</span></a></div></details></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>Helpful</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
package/dist/interfaces/_zthun_helpful_internet.IZEmailEnvelope.html DELETED
@@ -1,14 +0,0 @@
1
- <!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>IZEmailEnvelope | Helpful</title><meta name="description" content="Documentation for Helpful"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><link rel="icon" href="../helpful.svg" />
2
- </head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">Helpful</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../modules.html">Helpful</a></li><li><a href="../modules/_zthun_helpful_internet.html">@zthun/helpful-internet</a></li><li><a href="_zthun_helpful_internet.IZEmailEnvelope.html">IZEmailEnvelope</a></li></ul><h1>Interface IZEmailEnvelope</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>Represents an email envelope of information about who the email is from and where it's going to.</p>
3
- </div><div class="tsd-comment tsd-typography"></div></section><div class="tsd-signature"><span class="tsd-signature-keyword">interface </span><span class="tsd-kind-interface">IZEmailEnvelope</span> <span class="tsd-signature-symbol">{ </span><br/><span>    </span><a class="tsd-kind-property" href="_zthun_helpful_internet.IZEmailEnvelope.html#bcc">bcc</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><a href="_zthun_helpful_internet.IZEmailContact.html" class="tsd-signature-type tsd-kind-interface">IZEmailContact</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="_zthun_helpful_internet.IZEmailEnvelope.html#cc">cc</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><a href="_zthun_helpful_internet.IZEmailContact.html" class="tsd-signature-type tsd-kind-interface">IZEmailContact</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="_zthun_helpful_internet.IZEmailEnvelope.html#from">from</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><a href="_zthun_helpful_internet.IZEmailContact.html" class="tsd-signature-type tsd-kind-interface">IZEmailContact</a><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="_zthun_helpful_internet.IZEmailEnvelope.html#to">to</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><a href="_zthun_helpful_internet.IZEmailContact.html" class="tsd-signature-type tsd-kind-interface">IZEmailContact</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/ce166906b78f0ba06c3593e8b6ff3e5bbb88e101/packages/helpful-internet/src/email/email-envelope.mts#L6">packages/helpful-internet/src/email/email-envelope.mts:6</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="_zthun_helpful_internet.IZEmailEnvelope.html#bcc" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>bcc?</span></a>
4
- <a href="_zthun_helpful_internet.IZEmailEnvelope.html#cc" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>cc?</span></a>
5
- <a href="_zthun_helpful_internet.IZEmailEnvelope.html#from" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>from</span></a>
6
- <a href="_zthun_helpful_internet.IZEmailEnvelope.html#to" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>to?</span></a>
7
- </div></section></div></details></section></section><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Properties"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Properties</h2></summary><section><section class="tsd-panel tsd-member"><a id="bcc" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>bcc</span><a href="#bcc" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">bcc</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><a href="_zthun_helpful_internet.IZEmailContact.html" class="tsd-signature-type tsd-kind-interface">IZEmailContact</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">[]</span></div><div class="tsd-comment tsd-typography"><p>Who is receiving a blind carbon copy of an email.</p>
8
- </div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/ce166906b78f0ba06c3593e8b6ff3e5bbb88e101/packages/helpful-internet/src/email/email-envelope.mts#L31">packages/helpful-internet/src/email/email-envelope.mts:31</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="cc" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>cc</span><a href="#cc" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">cc</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><a href="_zthun_helpful_internet.IZEmailContact.html" class="tsd-signature-type tsd-kind-interface">IZEmailContact</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">[]</span></div><div class="tsd-comment tsd-typography"><p>Who is receiving a carbon copy of the email.</p>
9
- <p>This can be falsy if to is filled out.</p>
10
- </div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/ce166906b78f0ba06c3593e8b6ff3e5bbb88e101/packages/helpful-internet/src/email/email-envelope.mts#L26">packages/helpful-internet/src/email/email-envelope.mts:26</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="from" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>from</span><a href="#from" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">from</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><a href="_zthun_helpful_internet.IZEmailContact.html" class="tsd-signature-type tsd-kind-interface">IZEmailContact</a></div><div class="tsd-comment tsd-typography"><p>Who the email is from.</p>
11
- <p>This can be the full contact or just the address.</p>
12
- </div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/ce166906b78f0ba06c3593e8b6ff3e5bbb88e101/packages/helpful-internet/src/email/email-envelope.mts#L12">packages/helpful-internet/src/email/email-envelope.mts:12</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="to" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>to</span><a href="#to" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">to</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><a href="_zthun_helpful_internet.IZEmailContact.html" class="tsd-signature-type tsd-kind-interface">IZEmailContact</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">[]</span></div><div class="tsd-comment tsd-typography"><p>Where the email is going.</p>
13
- <p>This can be falsy if cc is filled out.</p>
14
- </div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/ce166906b78f0ba06c3593e8b6ff3e5bbb88e101/packages/helpful-internet/src/email/email-envelope.mts#L19">packages/helpful-internet/src/email/email-envelope.mts:19</a></li></ul></aside></section></section></details></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="tsd-otp-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Properties</summary><div><a href="#bcc" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>bcc</span></a><a href="#cc" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>cc</span></a><a href="#from" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>from</span></a><a href="#to" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>to</span></a></div></details></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>Helpful</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
package/dist/interfaces/_zthun_helpful_query.IZDataMatch.html DELETED
@@ -1,10 +0,0 @@
1
- <!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>IZDataMatch | Helpful</title><meta name="description" content="Documentation for Helpful"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><link rel="icon" href="../helpful.svg" />
2
- </head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">Helpful</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../modules.html">Helpful</a></li><li><a href="../modules/_zthun_helpful_query.html">@zthun/helpful-query</a></li><li><a href="_zthun_helpful_query.IZDataMatch.html">IZDataMatch</a></li></ul><h1>Interface IZDataMatch&lt;TData, TFilter&gt;</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>Represents an object which can match data to a filter query.</p>
3
- </div><div class="tsd-comment tsd-typography"></div></section><div class="tsd-signature"><span class="tsd-signature-keyword">interface </span><span class="tsd-kind-interface">IZDataMatch</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful_query.IZDataMatch.html#TData">TData</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful_query.IZDataMatch.html#TFilter">TFilter</a><span class="tsd-signature-symbol">&gt;</span> <span class="tsd-signature-symbol">{ </span><br/><span>    </span><a class="tsd-kind-call-signature" href="_zthun_helpful_query.IZDataMatch.html#match.match-1">match</a><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">data</span><span class="tsd-signature-symbol">: </span><a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful_query.IZDataMatch.html#TData">TData</a>, <span class="tsd-kind-parameter">filter</span><span class="tsd-signature-symbol">: </span><a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful_query.IZDataMatch.html#TFilter">TFilter</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div> <section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a id="TData" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">TData</span></span><div class="tsd-comment tsd-typography"><p>The type of data being matched.</p>
4
- </div><div class="tsd-comment tsd-typography"></div></li><li><span><a id="TFilter" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">TFilter</span></span><div class="tsd-comment tsd-typography"><p>The type of filter that helps relate to the data.</p>
5
- </div><div class="tsd-comment tsd-typography"></div></li></ul></section> <section class="tsd-panel"><h4>Implemented by</h4><ul class="tsd-hierarchy"><li><a href="../classes/_zthun_helpful_query.ZDataFilterFields.html" class="tsd-signature-type tsd-kind-class">ZDataFilterFields</a></li><li><a href="../classes/_zthun_helpful_query.ZDataMatchAlways.html" class="tsd-signature-type tsd-kind-class">ZDataMatchAlways</a></li><li><a href="../classes/_zthun_helpful_query.ZDataMatchOptional.html" class="tsd-signature-type tsd-kind-class">ZDataMatchOptional</a></li><li><a href="../classes/_zthun_helpful_query.ZDataSearchFields.html" class="tsd-signature-type tsd-kind-class">ZDataSearchFields</a></li><li><a href="../classes/_zthun_helpful_query.ZDataSearchText.html" class="tsd-signature-type tsd-kind-class">ZDataSearchText</a></li></ul></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/ce166906b78f0ba06c3593e8b6ff3e5bbb88e101/packages/helpful-query/src/match/data-match.mts#L9">packages/helpful-query/src/match/data-match.mts:9</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Methods</h3><div class="tsd-index-list"><a href="_zthun_helpful_query.IZDataMatch.html#match" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>match</span></a>
6
- </div></section></div></details></section></section><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Methods"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Methods</h2></summary><section><section class="tsd-panel tsd-member"><a id="match" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>match</span><a href="#match" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="match.match-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">match</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">data</span>, <span class="tsd-kind-parameter">filter</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><a href="#match.match-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Gets whether the given data matches the given filter.</p>
7
- </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">data</span>: <a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful_query.IZDataMatch.html#TData">TData</a></span><div class="tsd-comment tsd-typography"><p>The data to check.</p>
8
- </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">filter</span>: <a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful_query.IZDataMatch.html#TFilter">TFilter</a></span><div class="tsd-comment tsd-typography"><p>The filter to match against.</p>
9
- </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><p>True if the data matches the filter.</p>
10
- <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/ce166906b78f0ba06c3593e8b6ff3e5bbb88e101/packages/helpful-query/src/match/data-match.mts#L21">packages/helpful-query/src/match/data-match.mts:21</a></li></ul></aside></li></ul></section></section></details></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="tsd-otp-Methods"><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Methods</summary><div><a href="#match" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>match</span></a></div></details></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>Helpful</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
package/dist/interfaces/_zthun_helpful_query.IZFilterMetadata.html DELETED
@@ -1,7 +0,0 @@
1
- <!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>IZFilterMetadata | Helpful</title><meta name="description" content="Documentation for Helpful"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><link rel="icon" href="../helpful.svg" />
2
- </head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">Helpful</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../modules.html">Helpful</a></li><li><a href="../modules/_zthun_helpful_query.html">@zthun/helpful-query</a></li><li><a href="_zthun_helpful_query.IZFilterMetadata.html">IZFilterMetadata</a></li></ul><h1>Interface IZFilterMetadata</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>The root filter that contains metadata information about the filter.</p>
3
- <p>The main purpose of this is to ensure that filters get the
4
- <strong>type</strong> information to correctly identify how to handle them.</p>
5
- </div><div class="tsd-comment tsd-typography"></div></section><div class="tsd-signature"><span class="tsd-signature-keyword">interface </span><span class="tsd-kind-interface">IZFilterMetadata</span> <span class="tsd-signature-symbol">{ </span><br/><span>    </span><a class="tsd-kind-property" href="_zthun_helpful_query.IZFilterMetadata.html#__type__">__type__</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div><section class="tsd-panel tsd-hierarchy"><h4>Hierarchy (<a href="../hierarchy.html#@zthun/helpful-query.IZFilterMetadata">view full</a>)</h4><ul class="tsd-hierarchy"><li><span class="target">IZFilterMetadata</span><ul class="tsd-hierarchy"><li><a href="_zthun_helpful_query.IZFilterOperator.html" class="tsd-signature-type tsd-kind-interface">IZFilterOperator</a></li></ul></li></ul></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/ce166906b78f0ba06c3593e8b6ff3e5bbb88e101/packages/helpful-query/src/filter/filter-subject.mts#L7">packages/helpful-query/src/filter/filter-subject.mts:7</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="_zthun_helpful_query.IZFilterMetadata.html#__type__" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>__type__</span></a>
6
- </div></section></div></details></section></section><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Properties"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Properties</h2></summary><section><section class="tsd-panel tsd-member"><a id="__type__" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>__type__</span><a href="#__type__" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">__type__</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>Metadata type information about this filter.</p>
7
- </div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/ce166906b78f0ba06c3593e8b6ff3e5bbb88e101/packages/helpful-query/src/filter/filter-subject.mts#L11">packages/helpful-query/src/filter/filter-subject.mts:11</a></li></ul></aside></section></section></details></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="tsd-otp-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Properties</summary><div><a href="#__type__" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>__type__</span></a></div></details></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>Helpful</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
package/dist/interfaces/_zthun_helpful_query.IZFilterOperator.html DELETED
@@ -1,8 +0,0 @@
1
- <!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>IZFilterOperator | Helpful</title><meta name="description" content="Documentation for Helpful"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><link rel="icon" href="../helpful.svg" />
2
- </head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">Helpful</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../modules.html">Helpful</a></li><li><a href="../modules/_zthun_helpful_query.html">@zthun/helpful-query</a></li><li><a href="_zthun_helpful_query.IZFilterOperator.html">IZFilterOperator</a></li></ul><h1>Interface IZFilterOperator&lt;TOperator&gt;</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>Represents a filter that contains a given operator.</p>
3
- </div><div class="tsd-comment tsd-typography"></div></section><div class="tsd-signature"><span class="tsd-signature-keyword">interface </span><span class="tsd-kind-interface">IZFilterOperator</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful_query.IZFilterOperator.html#TOperator">TOperator</a><span class="tsd-signature-symbol">&gt;</span> <span class="tsd-signature-symbol">{ </span><br/><span>    </span><a class="tsd-kind-property" href="_zthun_helpful_query.IZFilterOperator.html#__type__">__type__</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="_zthun_helpful_query.IZFilterOperator.html#operator">operator</a><span class="tsd-signature-symbol">: </span><a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful_query.IZFilterOperator.html#TOperator">TOperator</a><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div> <section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a id="TOperator" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">TOperator</span></span><div class="tsd-comment tsd-typography"><p>The type of the operator.</p>
4
- </div><div class="tsd-comment tsd-typography"></div></li></ul></section> <section class="tsd-panel tsd-hierarchy"><h4>Hierarchy (<a href="../hierarchy.html#@zthun/helpful-query.IZFilterOperator">view full</a>)</h4><ul class="tsd-hierarchy"><li><a href="_zthun_helpful_query.IZFilterMetadata.html" class="tsd-signature-type tsd-kind-interface">IZFilterMetadata</a><ul class="tsd-hierarchy"><li><span class="target">IZFilterOperator</span><ul class="tsd-hierarchy"><li><a href="_zthun_helpful_query.IZFilterLogic.html" class="tsd-signature-type tsd-kind-interface">IZFilterLogic</a></li><li><a href="_zthun_helpful_query.IZFilterSubject.html" class="tsd-signature-type tsd-kind-interface">IZFilterSubject</a></li></ul></li></ul></li></ul></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/ce166906b78f0ba06c3593e8b6ff3e5bbb88e101/packages/helpful-query/src/filter/filter-subject.mts#L20">packages/helpful-query/src/filter/filter-subject.mts:20</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="_zthun_helpful_query.IZFilterOperator.html#__type__" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>__type__</span></a>
5
- <a href="_zthun_helpful_query.IZFilterOperator.html#operator" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>operator</span></a>
6
- </div></section></div></details></section></section><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Properties"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Properties</h2></summary><section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="__type__" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>__type__</span><a href="#__type__" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">__type__</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>Metadata type information about this filter.</p>
7
- </div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="_zthun_helpful_query.IZFilterMetadata.html">IZFilterMetadata</a>.<a href="_zthun_helpful_query.IZFilterMetadata.html#__type__">__type__</a></p><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/ce166906b78f0ba06c3593e8b6ff3e5bbb88e101/packages/helpful-query/src/filter/filter-subject.mts#L11">packages/helpful-query/src/filter/filter-subject.mts:11</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="operator" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>operator</span><a href="#operator" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">operator</span><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful_query.IZFilterOperator.html#TOperator">TOperator</a></div><div class="tsd-comment tsd-typography"><p>The operator that relates the subject to something.</p>
8
- </div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/ce166906b78f0ba06c3593e8b6ff3e5bbb88e101/packages/helpful-query/src/filter/filter-subject.mts#L24">packages/helpful-query/src/filter/filter-subject.mts:24</a></li></ul></aside></section></section></details></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="tsd-otp-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Properties</summary><div><a href="#__type__" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>__type__</span></a><a href="#operator" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>operator</span></a></div></details></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>Helpful</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>