@zthun/helpful-web 7.0.0 → 7.0.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +15 -11
- package/dist/classes/_zthun_helpful-brands.ZBrandBuilder.html +42 -42
- package/dist/classes/_zthun_helpful-fn.ZAssert.html +4 -4
- package/dist/classes/_zthun_helpful-fn.ZDeserializeJson.html +3 -3
- package/dist/classes/_zthun_helpful-fn.ZDeserializeTry.html +3 -3
- package/dist/classes/_zthun_helpful-fn.ZQuadrilateralBuilder.html +11 -11
- package/dist/classes/_zthun_helpful-fn.ZQuadrilateralCornersBuilder.html +13 -13
- package/dist/classes/_zthun_helpful-fn.ZRectangle.html +18 -18
- package/dist/classes/_zthun_helpful-fn.ZSerializeJson.html +2 -2
- package/dist/classes/_zthun_helpful-internet.ZCookieBuilder.html +16 -16
- package/dist/classes/_zthun_helpful-internet.ZEmailBuilder.html +8 -8
- package/dist/classes/_zthun_helpful-internet.ZEmailContactAddressBuilder.html +5 -5
- package/dist/classes/_zthun_helpful-internet.ZEmailContactBuilder.html +8 -8
- package/dist/classes/_zthun_helpful-internet.ZEmailEnvelopeBuilder.html +12 -12
- package/dist/classes/_zthun_helpful-internet.ZServerBuilder.html +9 -9
- package/dist/classes/_zthun_helpful-query.ZDataFilterFields.html +2 -2
- package/dist/classes/_zthun_helpful-query.ZDataMatchAlways.html +2 -2
- package/dist/classes/_zthun_helpful-query.ZDataMatchOptional.html +3 -3
- package/dist/classes/_zthun_helpful-query.ZDataRequestBuilder.html +10 -10
- package/dist/classes/_zthun_helpful-query.ZDataSearchFields.html +3 -3
- package/dist/classes/_zthun_helpful-query.ZDataSearchText.html +2 -2
- package/dist/classes/_zthun_helpful-query.ZDataSourceStatic.html +9 -9
- package/dist/classes/_zthun_helpful-query.ZDataSourceStaticOptionsBuilder.html +6 -6
- package/dist/classes/_zthun_helpful-query.ZFilterBinaryBuilder.html +14 -14
- package/dist/classes/_zthun_helpful-query.ZFilterCollectionBuilder.html +10 -10
- package/dist/classes/_zthun_helpful-query.ZFilterDeserialize.html +2 -2
- package/dist/classes/_zthun_helpful-query.ZFilterLogicBuilder.html +9 -9
- package/dist/classes/_zthun_helpful-query.ZFilterSerialize.html +2 -2
- package/dist/classes/_zthun_helpful-query.ZFilterUnaryBuilder.html +8 -8
- package/dist/classes/_zthun_helpful-query.ZMetadataBuilder.html +22 -22
- package/dist/classes/_zthun_helpful-query.ZPageBuilder.html +9 -9
- package/dist/classes/_zthun_helpful-query.ZSortBuilder.html +7 -7
- package/dist/classes/_zthun_helpful-query.ZSortDeserialize.html +2 -2
- package/dist/classes/_zthun_helpful-query.ZSortSerialize.html +2 -2
- package/dist/classes/_zthun_helpful-query.ZSorterSingle.html +5 -5
- package/dist/classes/_zthun_helpful-query.ZWellKnownIconClasses.html +5 -5
- package/dist/classes/_zthun_helpful-react.ZFileSelect.html +3 -3
- package/dist/classes/_zthun_helpful-validation.EqualsOtherPropertyValidator.html +2 -2
- package/dist/classes/_zthun_helpful-validation.IsDataURILimitValidator.html +2 -2
- package/dist/classes/_zthun_helpful-validation.IsNotWhiteSpaceValidator.html +2 -2
- package/dist/classes/_zthun_helpful-validation.RequiresOtherPropertyValidator.html +2 -2
- package/dist/enums/_zthun_helpful-fn.ZHorizontalAnchor.html +4 -4
- package/dist/enums/_zthun_helpful-fn.ZOrientation.html +3 -3
- package/dist/enums/_zthun_helpful-fn.ZVerticalAnchor.html +4 -4
- package/dist/enums/_zthun_helpful-query.ZMetadataType.html +7 -7
- package/dist/enums/_zthun_helpful-query.ZOperatorBinary.html +8 -8
- package/dist/enums/_zthun_helpful-query.ZOperatorCollection.html +3 -3
- package/dist/enums/_zthun_helpful-query.ZOperatorLogic.html +3 -3
- package/dist/enums/_zthun_helpful-query.ZOperatorUnary.html +3 -3
- package/dist/enums/_zthun_helpful-query.ZSortDirection.html +3 -3
- package/dist/functions/_zthun_helpful-fn.bash.html +1 -1
- package/dist/functions/_zthun_helpful-fn.commaJoinDefined.html +1 -1
- package/dist/functions/_zthun_helpful-fn.countBuckets.html +1 -1
- package/dist/functions/_zthun_helpful-fn.createError.html +1 -1
- package/dist/functions/_zthun_helpful-fn.createGuid.html +1 -1
- package/dist/functions/_zthun_helpful-fn.css.html +1 -1
- package/dist/functions/_zthun_helpful-fn.cssJoinDefined.html +1 -1
- package/dist/functions/_zthun_helpful-fn.firstDefined.html +1 -1
- package/dist/functions/_zthun_helpful-fn.firstTruthy.html +1 -1
- package/dist/functions/_zthun_helpful-fn.firstWhere.html +1 -1
- package/dist/functions/_zthun_helpful-fn.html.html +1 -1
- package/dist/functions/_zthun_helpful-fn.isEmptyObject.html +1 -1
- package/dist/functions/_zthun_helpful-fn.javascript.html +1 -1
- package/dist/functions/_zthun_helpful-fn.joinDefined.html +1 -1
- package/dist/functions/_zthun_helpful-fn.js.html +1 -1
- package/dist/functions/_zthun_helpful-fn.markdown.html +1 -1
- package/dist/functions/_zthun_helpful-fn.md.html +1 -1
- package/dist/functions/_zthun_helpful-fn.optional.html +2 -2
- package/dist/functions/_zthun_helpful-fn.peel.html +1 -1
- package/dist/functions/_zthun_helpful-fn.peelBetween.html +1 -1
- package/dist/functions/_zthun_helpful-fn.pickBy.html +1 -1
- package/dist/functions/_zthun_helpful-fn.pickDataAttributes.html +1 -1
- package/dist/functions/_zthun_helpful-fn.pickDefined.html +1 -1
- package/dist/functions/_zthun_helpful-fn.pipeJoinDefined.html +1 -1
- package/dist/functions/_zthun_helpful-fn.required.html +1 -1
- package/dist/functions/_zthun_helpful-fn.semiColonJoinDefined.html +1 -1
- package/dist/functions/_zthun_helpful-fn.setFirst.html +1 -1
- package/dist/functions/_zthun_helpful-fn.sh.html +1 -1
- package/dist/functions/_zthun_helpful-fn.sleep.html +2 -2
- package/dist/functions/_zthun_helpful-fn.spaceJoinDefined.html +1 -1
- package/dist/functions/_zthun_helpful-fn.tag.html +1 -1
- package/dist/functions/_zthun_helpful-fn.tryFallback.html +2 -2
- package/dist/functions/_zthun_helpful-fn.tryFallbackAsync.html +2 -2
- package/dist/functions/_zthun_helpful-fn.ts.html +1 -1
- package/dist/functions/_zthun_helpful-fn.typescript.html +1 -1
- package/dist/functions/_zthun_helpful-fn.zsh.html +1 -1
- package/dist/functions/_zthun_helpful-node.walk.html +1 -1
- package/dist/functions/_zthun_helpful-query.isBinaryFilter.html +1 -1
- package/dist/functions/_zthun_helpful-query.isBinaryOperator.html +1 -1
- package/dist/functions/_zthun_helpful-query.isCollectionFilter.html +1 -1
- package/dist/functions/_zthun_helpful-query.isCollectionOperator.html +1 -1
- package/dist/functions/_zthun_helpful-query.isLogicFilter.html +1 -1
- package/dist/functions/_zthun_helpful-query.isLogicOperator.html +1 -1
- package/dist/functions/_zthun_helpful-query.isUnaryFilter.html +1 -1
- package/dist/functions/_zthun_helpful-query.isUnaryOperator.html +1 -1
- package/dist/functions/_zthun_helpful-react.ZFileSelectContext.html +1 -1
- package/dist/functions/_zthun_helpful-react.ZWindowServiceContext.html +1 -1
- package/dist/functions/_zthun_helpful-react.asStateData.html +2 -2
- package/dist/functions/_zthun_helpful-react.asStateError.html +1 -1
- package/dist/functions/_zthun_helpful-react.createKeyboardActivate.html +1 -1
- package/dist/functions/_zthun_helpful-react.isStateErrored.html +1 -1
- package/dist/functions/_zthun_helpful-react.isStateLoaded.html +1 -1
- package/dist/functions/_zthun_helpful-react.isStateLoading.html +1 -1
- package/dist/functions/_zthun_helpful-react.useAmbassadorState.html +2 -2
- package/dist/functions/_zthun_helpful-react.useAsyncState.html +1 -1
- package/dist/functions/_zthun_helpful-react.useFileSelect.html +1 -1
- package/dist/functions/_zthun_helpful-react.useKeyboardActivate.html +1 -1
- package/dist/functions/_zthun_helpful-react.useMoreViewState.html +1 -1
- package/dist/functions/_zthun_helpful-react.usePageViewState.html +1 -1
- package/dist/functions/_zthun_helpful-react.useStateAsArray.html +1 -1
- package/dist/functions/_zthun_helpful-react.useWindowService.html +1 -1
- package/dist/functions/_zthun_helpful-validation.EqualsOtherProperty.html +1 -1
- package/dist/functions/_zthun_helpful-validation.IsDataURILimit.html +1 -1
- package/dist/functions/_zthun_helpful-validation.IsNotWhiteSpace.html +1 -1
- package/dist/functions/_zthun_helpful-validation.RequiresOtherProperty.html +1 -1
- package/dist/interfaces/_zthun_helpful-brands.IZBrand.html +5 -5
- package/dist/interfaces/_zthun_helpful-fn.IZDeserialize.html +2 -2
- package/dist/interfaces/_zthun_helpful-fn.IZPoint2d.html +3 -3
- package/dist/interfaces/_zthun_helpful-fn.IZPoint3d.html +4 -4
- package/dist/interfaces/_zthun_helpful-fn.IZQuadrilateral.html +5 -5
- package/dist/interfaces/_zthun_helpful-fn.IZQuadrilateralCorners.html +2 -2
- package/dist/interfaces/_zthun_helpful-fn.IZSerialize.html +2 -2
- package/dist/interfaces/_zthun_helpful-internet.IZCookie.html +8 -8
- package/dist/interfaces/_zthun_helpful-internet.IZEmail.html +4 -4
- package/dist/interfaces/_zthun_helpful-internet.IZEmailContact.html +4 -4
- package/dist/interfaces/_zthun_helpful-internet.IZEmailEnvelope.html +5 -5
- package/dist/interfaces/_zthun_helpful-internet.IZServer.html +5 -5
- package/dist/interfaces/_zthun_helpful-node.ZWalkOptions.html +4 -4
- package/dist/interfaces/_zthun_helpful-query.IZDataMatch.html +2 -2
- package/dist/interfaces/_zthun_helpful-query.IZDataRequest.html +6 -6
- package/dist/interfaces/_zthun_helpful-query.IZDataRequestQuery.html +6 -6
- package/dist/interfaces/_zthun_helpful-query.IZDataSource.html +3 -3
- package/dist/interfaces/_zthun_helpful-query.IZDataSourceStaticOptions.html +4 -4
- package/dist/interfaces/_zthun_helpful-query.IZFilterBinary.html +5 -5
- package/dist/interfaces/_zthun_helpful-query.IZFilterCollection.html +5 -5
- package/dist/interfaces/_zthun_helpful-query.IZFilterLogic.html +4 -4
- package/dist/interfaces/_zthun_helpful-query.IZFilterMetadata.html +2 -2
- package/dist/interfaces/_zthun_helpful-query.IZFilterOperator.html +3 -3
- package/dist/interfaces/_zthun_helpful-query.IZFilterSubject.html +4 -4
- package/dist/interfaces/_zthun_helpful-query.IZMetadata.html +12 -12
- package/dist/interfaces/_zthun_helpful-query.IZPage.html +3 -3
- package/dist/interfaces/_zthun_helpful-query.IZSort.html +3 -3
- package/dist/interfaces/_zthun_helpful-query.IZSorter.html +4 -4
- package/dist/interfaces/_zthun_helpful-react.IZFileSelect.html +2 -2
- package/dist/interfaces/_zthun_helpful-react.IZKeyboardInteraction.html +3 -3
- package/dist/types/_zthun_helpful-fn.DeepPartial.html +1 -1
- package/dist/types/_zthun_helpful-fn.JoinListInputParameter.html +1 -1
- package/dist/types/_zthun_helpful-fn.PickPredicate.html +1 -1
- package/dist/types/_zthun_helpful-fn.PickResult.html +1 -1
- package/dist/types/_zthun_helpful-fn.RequiredDeep.html +1 -1
- package/dist/types/_zthun_helpful-fn.RequiredPick.html +1 -1
- package/dist/types/_zthun_helpful-fn.ZAnchor.html +1 -1
- package/dist/types/_zthun_helpful-fn.ZCornersHorizontal.html +1 -1
- package/dist/types/_zthun_helpful-fn.ZCornersVertical.html +1 -1
- package/dist/types/_zthun_helpful-fn.ZObligatedValue.html +1 -1
- package/dist/types/_zthun_helpful-fn.ZQuadrilateralCornersLike.html +1 -1
- package/dist/types/_zthun_helpful-fn.ZQuadrilateralLike.html +1 -1
- package/dist/types/_zthun_helpful-fn.ZSideAnchor.html +1 -1
- package/dist/types/_zthun_helpful-query.IZFilter.html +1 -1
- package/dist/types/_zthun_helpful-query.IZFilterUnary.html +1 -1
- package/dist/types/_zthun_helpful-query.ZOperatorFilter.html +1 -1
- package/dist/types/_zthun_helpful-react.ZAmbassadorReducer.html +1 -1
- package/dist/types/_zthun_helpful-react.ZAmbassadorReducerRequired.html +1 -1
- package/dist/types/_zthun_helpful-react.ZAmbassadorSetCurrent.html +1 -1
- package/dist/types/_zthun_helpful-react.ZAsyncDataState.html +1 -1
- package/dist/types/_zthun_helpful-react.ZAsyncDataTuple.html +1 -1
- package/dist/types/_zthun_helpful-react.ZAsyncUseData.html +1 -1
- package/dist/types/_zthun_helpful-react.ZSetStateAsArray.html +1 -1
- package/dist/types/_zthun_helpful-react.ZStateAsArrayReducer.html +1 -1
- package/dist/variables/_zthun_helpful-brands.ZBrands.html +1 -1
- package/dist/variables/_zthun_helpful-fn._global.html +1 -1
- package/dist/variables/_zthun_helpful-query.ZBinaryComparators.html +1 -1
- package/dist/variables/_zthun_helpful-query.ZCollectionComparators.html +1 -1
- package/dist/variables/_zthun_helpful-query.ZOperatorsBinary.html +1 -1
- package/dist/variables/_zthun_helpful-query.ZOperatorsCollection.html +1 -1
- package/dist/variables/_zthun_helpful-query.ZOperatorsFilter.html +1 -1
- package/dist/variables/_zthun_helpful-query.ZOperatorsLogic.html +1 -1
- package/dist/variables/_zthun_helpful-query.ZOperatorsUnary.html +1 -1
- package/dist/variables/_zthun_helpful-query.ZSortDirections.html +1 -1
- package/dist/variables/_zthun_helpful-query.ZUnaryComparators.html +1 -1
- package/dist/variables/_zthun_helpful-react.DefaultActivateCodes.html +1 -1
- package/dist/variables/_zthun_helpful-react.ZAsyncLoading.html +1 -1
- package/package.json +9 -9
|
@@ -1,15 +1,15 @@
|
|
|
1
1
|
<!DOCTYPE html><html class="default" lang="en" data-base=".."><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>IZServer | Helpful</title><link rel="icon" href="../assets/favicon.svg" type="image/svg+xml"/><meta name="description" content="Documentation for Helpful"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search"><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">Helpful</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../modules.html">Helpful</a></li><li><a href="../modules/_zthun_helpful-internet.html">@zthun/helpful-internet</a></li><li><a href="_zthun_helpful-internet.IZServer.html">IZServer</a></li></ul><h1>Interface IZServer</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>Represents an abstract server connection.</p>
|
|
2
|
-
</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">IZServer</span> <span class="tsd-signature-symbol">{</span><br/> <a class="tsd-kind-property" href="_zthun_helpful-internet.IZServer.html#address">address</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="_zthun_helpful-internet.IZServer.html#password">password</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="_zthun_helpful-internet.IZServer.html#port">port</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="_zthun_helpful-internet.IZServer.html#username">username</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><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/
|
|
2
|
+
</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">IZServer</span> <span class="tsd-signature-symbol">{</span><br/> <a class="tsd-kind-property" href="_zthun_helpful-internet.IZServer.html#address">address</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="_zthun_helpful-internet.IZServer.html#password">password</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="_zthun_helpful-internet.IZServer.html#port">port</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="_zthun_helpful-internet.IZServer.html#username">username</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><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/4242131c3dc8013a1721169b7d58b0c9201a9ea8/packages/helpful-internet/src/server/server.mts#L4">packages/helpful-internet/src/server/server.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-internet.IZServer.html#address" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>address</span></a>
|
|
3
3
|
<a href="_zthun_helpful-internet.IZServer.html#password" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>password?</span></a>
|
|
4
4
|
<a href="_zthun_helpful-internet.IZServer.html#port" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>port?</span></a>
|
|
5
5
|
<a href="_zthun_helpful-internet.IZServer.html#username" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>username?</span></a>
|
|
6
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="address" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>address</span><a href="#address" 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">address</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The host or ip address to connect to.</p>
|
|
7
7
|
<p>Does not distinguish between the protocol and hostname.</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/
|
|
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/4242131c3dc8013a1721169b7d58b0c9201a9ea8/packages/helpful-internet/src/server/server.mts#L10">packages/helpful-internet/src/server/server.mts:10</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="password" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>password</span><a href="#password" 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">password</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The user's password to connect with.</p>
|
|
9
9
|
<p>If username is not supplied, then this generally has no meaning.</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/
|
|
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/4242131c3dc8013a1721169b7d58b0c9201a9ea8/packages/helpful-internet/src/server/server.mts#L32">packages/helpful-internet/src/server/server.mts:32</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="port" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>port</span><a href="#port" 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">port</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><div class="tsd-comment tsd-typography"><p>The optional port to connect on.</p>
|
|
11
11
|
<p>If this is falsy, then it is up to the implementation
|
|
12
12
|
taking this object to properly default the value.</p>
|
|
13
|
-
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/
|
|
13
|
+
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/4242131c3dc8013a1721169b7d58b0c9201a9ea8/packages/helpful-internet/src/server/server.mts#L18">packages/helpful-internet/src/server/server.mts:18</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="username" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>username</span><a href="#username" 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">username</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The optional username.</p>
|
|
14
14
|
<p>Falsy usually implies guest access.</p>
|
|
15
|
-
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/
|
|
15
|
+
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/4242131c3dc8013a1721169b7d58b0c9201a9ea8/packages/helpful-internet/src/server/server.mts#L25">packages/helpful-internet/src/server/server.mts:25</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="section-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="#address" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>address</span></a><a href="#password" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>password</span></a><a href="#port" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>port</span></a><a href="#username" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>username</span></a></div></details></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html">Helpful</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
|
|
@@ -1,13 +1,13 @@
|
|
|
1
1
|
<!DOCTYPE html><html class="default" lang="en" data-base=".."><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>ZWalkOptions | Helpful</title><link rel="icon" href="../assets/favicon.svg" type="image/svg+xml"/><meta name="description" content="Documentation for Helpful"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search"><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">Helpful</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../modules.html">Helpful</a></li><li><a href="../modules/_zthun_helpful-node.html">@zthun/helpful-node</a></li><li><a href="_zthun_helpful-node.ZWalkOptions.html">ZWalkOptions</a></li></ul><h1>Interface ZWalkOptions</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>Options for where a directory walk starts.</p>
|
|
2
|
-
</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">ZWalkOptions</span> <span class="tsd-signature-symbol">{</span><br/> <a class="tsd-kind-property" href="_zthun_helpful-node.ZWalkOptions.html#mode">mode</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="_zthun_helpful-node.ZWalkOptions.html#start">start</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="_zthun_helpful-node.ZWalkOptions.html#stop">stop</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><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/
|
|
2
|
+
</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">ZWalkOptions</span> <span class="tsd-signature-symbol">{</span><br/> <a class="tsd-kind-property" href="_zthun_helpful-node.ZWalkOptions.html#mode">mode</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="_zthun_helpful-node.ZWalkOptions.html#start">start</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="_zthun_helpful-node.ZWalkOptions.html#stop">stop</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><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/4242131c3dc8013a1721169b7d58b0c9201a9ea8/packages/helpful-node/src/walk/walk.mts#L9">walk.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">Properties</h3><div class="tsd-index-list"><a href="_zthun_helpful-node.ZWalkOptions.html#mode" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>mode?</span></a>
|
|
3
3
|
<a href="_zthun_helpful-node.ZWalkOptions.html#start" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>start?</span></a>
|
|
4
4
|
<a href="_zthun_helpful-node.ZWalkOptions.html#stop" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>stop?</span></a>
|
|
5
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="mode" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>mode</span><a href="#mode" 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">mode</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><div class="tsd-comment tsd-typography"><p>The type of mode that the path must support in order
|
|
6
6
|
to be approved.</p>
|
|
7
7
|
<p>The default is undefined and left up to the node api.</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/
|
|
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/4242131c3dc8013a1721169b7d58b0c9201a9ea8/packages/helpful-node/src/walk/walk.mts#L32">walk.mts:32</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="start" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>start</span><a href="#start" 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">start</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The starting directory.</p>
|
|
9
9
|
<p>The default is the current working directory</p>
|
|
10
10
|
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-see"><h4 class="tsd-anchor-link"><a id="see" class="tsd-anchor"></a>See<a href="#see" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>process.cwd for more information.</p>
|
|
11
|
-
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/
|
|
11
|
+
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/4242131c3dc8013a1721169b7d58b0c9201a9ea8/packages/helpful-node/src/walk/walk.mts#L17">walk.mts:17</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="stop" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>stop</span><a href="#stop" 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">stop</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The directory to stop at.</p>
|
|
12
12
|
<p>The default is the root of the file system.</p>
|
|
13
|
-
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/
|
|
13
|
+
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/4242131c3dc8013a1721169b7d58b0c9201a9ea8/packages/helpful-node/src/walk/walk.mts#L24">walk.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="section-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="#mode" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>mode</span></a><a href="#start" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>start</span></a><a href="#stop" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>stop</span></a></div></details></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html">Helpful</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
|
|
@@ -1,9 +1,9 @@
|
|
|
1
1
|
<!DOCTYPE html><html class="default" lang="en" data-base=".."><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>IZDataMatch | Helpful</title><link rel="icon" href="../assets/favicon.svg" type="image/svg+xml"/><meta name="description" content="Documentation for Helpful"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search"><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">Helpful</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../modules.html">Helpful</a></li><li><a href="../modules/_zthun_helpful-query.html">@zthun/helpful-query</a></li><li><a href="_zthun_helpful-query.IZDataMatch.html">IZDataMatch</a></li></ul><h1>Interface IZDataMatch<TData, TFilter></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>
|
|
2
2
|
</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"><</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">></span> <span class="tsd-signature-symbol">{</span><br/> <a class="tsd-kind-call-signature" href="_zthun_helpful-query.IZDataMatch.html#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-signature-symbol">,</span> <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>
|
|
3
3
|
</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>
|
|
4
|
-
</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/
|
|
4
|
+
</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/4242131c3dc8013a1721169b7d58b0c9201a9ea8/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>
|
|
5
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-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-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-signature-symbol">:</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> <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><a href="#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>
|
|
6
6
|
</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>
|
|
7
7
|
</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>
|
|
8
8
|
</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>
|
|
9
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/
|
|
9
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/4242131c3dc8013a1721169b7d58b0c9201a9ea8/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="section-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">Helpful</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
<!DOCTYPE html><html class="default" lang="en" data-base=".."><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>IZDataRequest | Helpful</title><link rel="icon" href="../assets/favicon.svg" type="image/svg+xml"/><meta name="description" content="Documentation for Helpful"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search"><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">Helpful</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../modules.html">Helpful</a></li><li><a href="../modules/_zthun_helpful-query.html">@zthun/helpful-query</a></li><li><a href="_zthun_helpful-query.IZDataRequest.html">IZDataRequest</a></li></ul><h1>Interface IZDataRequest</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>Describes a request for a given set of data.</p>
|
|
2
|
-
</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">IZDataRequest</span> <span class="tsd-signature-symbol">{</span><br/> <a class="tsd-kind-property" href="_zthun_helpful-query.IZDataRequest.html#filter">filter</a><span class="tsd-signature-symbol">?:</span> <a href="../types/_zthun_helpful-query.IZFilter.html" class="tsd-signature-type tsd-kind-type-alias">IZFilter</a><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="_zthun_helpful-query.IZDataRequest.html#page">page</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="_zthun_helpful-query.IZDataRequest.html#search">search</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="_zthun_helpful-query.IZDataRequest.html#size">size</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="_zthun_helpful-query.IZDataRequest.html#sort">sort</a><span class="tsd-signature-symbol">?:</span> <a href="_zthun_helpful-query.IZSort.html" class="tsd-signature-type tsd-kind-interface">IZSort</a><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/
|
|
2
|
+
</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">IZDataRequest</span> <span class="tsd-signature-symbol">{</span><br/> <a class="tsd-kind-property" href="_zthun_helpful-query.IZDataRequest.html#filter">filter</a><span class="tsd-signature-symbol">?:</span> <a href="../types/_zthun_helpful-query.IZFilter.html" class="tsd-signature-type tsd-kind-type-alias">IZFilter</a><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="_zthun_helpful-query.IZDataRequest.html#page">page</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="_zthun_helpful-query.IZDataRequest.html#search">search</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="_zthun_helpful-query.IZDataRequest.html#size">size</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="_zthun_helpful-query.IZDataRequest.html#sort">sort</a><span class="tsd-signature-symbol">?:</span> <a href="_zthun_helpful-query.IZSort.html" class="tsd-signature-type tsd-kind-interface">IZSort</a><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/4242131c3dc8013a1721169b7d58b0c9201a9ea8/packages/helpful-query/src/source/data-request.mts#L36">packages/helpful-query/src/source/data-request.mts:36</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.IZDataRequest.html#filter" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>filter?</span></a>
|
|
3
3
|
<a href="_zthun_helpful-query.IZDataRequest.html#page" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>page?</span></a>
|
|
4
4
|
<a href="_zthun_helpful-query.IZDataRequest.html#search" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>search?</span></a>
|
|
5
5
|
<a href="_zthun_helpful-query.IZDataRequest.html#size" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>size?</span></a>
|
|
@@ -9,20 +9,20 @@
|
|
|
9
9
|
the consumer.</p>
|
|
10
10
|
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-see"><h4 class="tsd-anchor-link"><a id="see" class="tsd-anchor"></a>See<a href="#see" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p><a href="../classes/_zthun_helpful-query.ZDataFilterFields.html" class="tsd-kind-class">ZDataFilterFields</a> for a basic
|
|
11
11
|
implementation.</p>
|
|
12
|
-
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/
|
|
12
|
+
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/4242131c3dc8013a1721169b7d58b0c9201a9ea8/packages/helpful-query/src/source/data-request.mts#L74">packages/helpful-query/src/source/data-request.mts:74</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="page" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>page</span><a href="#page" 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">page</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><div class="tsd-comment tsd-typography"><p>The page number.</p>
|
|
13
13
|
<p>This is one based. Should always default
|
|
14
14
|
to 1.</p>
|
|
15
|
-
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/
|
|
15
|
+
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/4242131c3dc8013a1721169b7d58b0c9201a9ea8/packages/helpful-query/src/source/data-request.mts#L43">packages/helpful-query/src/source/data-request.mts:43</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="search" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>search</span><a href="#search" 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">search</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>Search query.</p>
|
|
16
16
|
<p>How the search is performed is done
|
|
17
17
|
through the consumer.</p>
|
|
18
18
|
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-see"><h4 class="tsd-anchor-link"><a id="see-1" class="tsd-anchor"></a>See<a href="#see-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p><a href="../classes/_zthun_helpful-query.ZDataSearchFields.html" class="tsd-kind-class">ZDataSearchFields</a> for a basic
|
|
19
19
|
implementation.</p>
|
|
20
|
-
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/
|
|
20
|
+
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/4242131c3dc8013a1721169b7d58b0c9201a9ea8/packages/helpful-query/src/source/data-request.mts#L62">packages/helpful-query/src/source/data-request.mts:62</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="size" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>size</span><a href="#size" 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">size</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><div class="tsd-comment tsd-typography"><p>The page size.</p>
|
|
21
21
|
<p>If not set, it will be up to the consumer
|
|
22
22
|
to decide the default.</p>
|
|
23
|
-
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/
|
|
23
|
+
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/4242131c3dc8013a1721169b7d58b0c9201a9ea8/packages/helpful-query/src/source/data-request.mts#L50">packages/helpful-query/src/source/data-request.mts:50</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="sort" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>sort</span><a href="#sort" 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">sort</span><span class="tsd-signature-symbol">?:</span> <a href="_zthun_helpful-query.IZSort.html" class="tsd-signature-type tsd-kind-interface">IZSort</a><span class="tsd-signature-symbol">[]</span></div><div class="tsd-comment tsd-typography"><p>The sort order.</p>
|
|
24
24
|
<p>How the sort is applied is done through
|
|
25
25
|
the consumer.</p>
|
|
26
26
|
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-see"><h4 class="tsd-anchor-link"><a id="see-2" class="tsd-anchor"></a>See<a href="#see-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p><a href="../classes/_zthun_helpful-query.ZSorterSingle.html" class="tsd-kind-class">ZSorterSingle</a> for a basic
|
|
27
27
|
implementation.</p>
|
|
28
|
-
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/
|
|
28
|
+
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/4242131c3dc8013a1721169b7d58b0c9201a9ea8/packages/helpful-query/src/source/data-request.mts#L86">packages/helpful-query/src/source/data-request.mts:86</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="section-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="#filter" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>filter</span></a><a href="#page" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>page</span></a><a href="#search" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>search</span></a><a href="#size" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>size</span></a><a href="#sort" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>sort</span></a></div></details></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html">Helpful</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
|
|
@@ -1,12 +1,12 @@
|
|
|
1
1
|
<!DOCTYPE html><html class="default" lang="en" data-base=".."><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>IZDataRequestQuery | Helpful</title><link rel="icon" href="../assets/favicon.svg" type="image/svg+xml"/><meta name="description" content="Documentation for Helpful"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search"><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">Helpful</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../modules.html">Helpful</a></li><li><a href="../modules/_zthun_helpful-query.html">@zthun/helpful-query</a></li><li><a href="_zthun_helpful-query.IZDataRequestQuery.html">IZDataRequestQuery</a></li></ul><h1>Interface IZDataRequestQuery</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>Describes a request as if it was placed an a url in the query params.</p>
|
|
2
|
-
</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">IZDataRequestQuery</span> <span class="tsd-signature-symbol">{</span><br/> <a class="tsd-kind-property" href="_zthun_helpful-query.IZDataRequestQuery.html#filter">filter</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="_zthun_helpful-query.IZDataRequestQuery.html#page">page</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="_zthun_helpful-query.IZDataRequestQuery.html#search">search</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="_zthun_helpful-query.IZDataRequestQuery.html#size">size</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="_zthun_helpful-query.IZDataRequestQuery.html#sort">sort</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><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/
|
|
2
|
+
</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">IZDataRequestQuery</span> <span class="tsd-signature-symbol">{</span><br/> <a class="tsd-kind-property" href="_zthun_helpful-query.IZDataRequestQuery.html#filter">filter</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="_zthun_helpful-query.IZDataRequestQuery.html#page">page</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="_zthun_helpful-query.IZDataRequestQuery.html#search">search</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="_zthun_helpful-query.IZDataRequestQuery.html#size">size</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="_zthun_helpful-query.IZDataRequestQuery.html#sort">sort</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><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/4242131c3dc8013a1721169b7d58b0c9201a9ea8/packages/helpful-query/src/source/data-request.mts#L10">packages/helpful-query/src/source/data-request.mts:10</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.IZDataRequestQuery.html#filter" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>filter?</span></a>
|
|
3
3
|
<a href="_zthun_helpful-query.IZDataRequestQuery.html#page" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>page?</span></a>
|
|
4
4
|
<a href="_zthun_helpful-query.IZDataRequestQuery.html#search" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>search?</span></a>
|
|
5
5
|
<a href="_zthun_helpful-query.IZDataRequestQuery.html#size" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>size?</span></a>
|
|
6
6
|
<a href="_zthun_helpful-query.IZDataRequestQuery.html#sort" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>sort?</span></a>
|
|
7
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="filter" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>filter</span><a href="#filter" 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">filter</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>Filter criterion.</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/
|
|
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/
|
|
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/
|
|
11
|
-
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/
|
|
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/
|
|
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/4242131c3dc8013a1721169b7d58b0c9201a9ea8/packages/helpful-query/src/source/data-request.mts#L26">packages/helpful-query/src/source/data-request.mts:26</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="page" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>page</span><a href="#page" 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">page</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>Page number.</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/4242131c3dc8013a1721169b7d58b0c9201a9ea8/packages/helpful-query/src/source/data-request.mts#L14">packages/helpful-query/src/source/data-request.mts:14</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="search" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>search</span><a href="#search" 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">search</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>Search criterion.</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/4242131c3dc8013a1721169b7d58b0c9201a9ea8/packages/helpful-query/src/source/data-request.mts#L22">packages/helpful-query/src/source/data-request.mts:22</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="size" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>size</span><a href="#size" 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">size</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>Page size.</p>
|
|
11
|
+
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/4242131c3dc8013a1721169b7d58b0c9201a9ea8/packages/helpful-query/src/source/data-request.mts#L18">packages/helpful-query/src/source/data-request.mts:18</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="sort" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>sort</span><a href="#sort" 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">sort</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>Sort criterion.</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/4242131c3dc8013a1721169b7d58b0c9201a9ea8/packages/helpful-query/src/source/data-request.mts#L30">packages/helpful-query/src/source/data-request.mts:30</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="section-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="#filter" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>filter</span></a><a href="#page" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>page</span></a><a href="#search" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>search</span></a><a href="#size" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>size</span></a><a href="#sort" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>sort</span></a></div></details></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html">Helpful</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
|