@zthun/helpful-web 7.2.0 → 8.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/assets/hierarchy.js +1 -1
- package/dist/assets/main.js +5 -5
- package/dist/assets/navigation.js +1 -1
- package/dist/assets/search.js +1 -1
- package/dist/assets/style.css +262 -232
- package/dist/classes/_zthun_helpful-brands.ZBrandBuilder.html +85 -85
- package/dist/classes/_zthun_helpful-fn.ZAssert.html +11 -11
- package/dist/classes/_zthun_helpful-fn.ZDeserializeJson.html +7 -7
- package/dist/classes/_zthun_helpful-fn.ZDeserializeTry.html +12 -12
- package/dist/classes/_zthun_helpful-fn.ZLazy.html +4 -4
- package/dist/classes/_zthun_helpful-fn.ZQuadrilateralBuilder.html +34 -34
- package/dist/classes/_zthun_helpful-fn.ZQuadrilateralCornersBuilder.html +41 -41
- package/dist/classes/_zthun_helpful-fn.ZRectangle.html +36 -36
- package/dist/classes/_zthun_helpful-fn.ZSerializeJson.html +5 -5
- package/dist/classes/_zthun_helpful-internet.ZCookieBuilder.html +35 -35
- package/dist/classes/_zthun_helpful-internet.ZEmailBuilder.html +17 -17
- package/dist/classes/_zthun_helpful-internet.ZEmailContactAddressBuilder.html +12 -12
- package/dist/classes/_zthun_helpful-internet.ZEmailContactBuilder.html +17 -17
- package/dist/classes/_zthun_helpful-internet.ZEmailEnvelopeBuilder.html +24 -24
- package/dist/classes/_zthun_helpful-internet.ZServerBuilder.html +18 -18
- package/dist/classes/_zthun_helpful-query.ZDataFilterFields.html +7 -7
- package/dist/classes/_zthun_helpful-query.ZDataMatchAlways.html +5 -5
- package/dist/classes/_zthun_helpful-query.ZDataMatchOptional.html +11 -11
- package/dist/classes/_zthun_helpful-query.ZDataRequestBuilder.html +22 -22
- package/dist/classes/_zthun_helpful-query.ZDataSearchFields.html +8 -8
- package/dist/classes/_zthun_helpful-query.ZDataSearchText.html +5 -5
- package/dist/classes/_zthun_helpful-query.ZDataSourceStatic.html +29 -29
- package/dist/classes/_zthun_helpful-query.ZDataSourceStaticOptionsBuilder.html +18 -18
- package/dist/classes/_zthun_helpful-query.ZFilterBinaryBuilder.html +36 -36
- package/dist/classes/_zthun_helpful-query.ZFilterCollectionBuilder.html +23 -23
- package/dist/classes/_zthun_helpful-query.ZFilterDeserialize.html +6 -6
- package/dist/classes/_zthun_helpful-query.ZFilterLogicBuilder.html +21 -21
- package/dist/classes/_zthun_helpful-query.ZFilterSerialize.html +5 -5
- package/dist/classes/_zthun_helpful-query.ZFilterUnaryBuilder.html +18 -18
- package/dist/classes/_zthun_helpful-query.ZMetadataBuilder.html +52 -52
- package/dist/classes/_zthun_helpful-query.ZPageBuilder.html +29 -29
- package/dist/classes/_zthun_helpful-query.ZSortBuilder.html +14 -14
- package/dist/classes/_zthun_helpful-query.ZSortDeserialize.html +6 -6
- package/dist/classes/_zthun_helpful-query.ZSortSerialize.html +5 -5
- package/dist/classes/_zthun_helpful-query.ZSorterSingle.html +10 -10
- package/dist/classes/_zthun_helpful-query.ZWellKnownIconClasses.html +15 -15
- package/dist/classes/_zthun_helpful-react.ZFileSelect.html +6 -6
- package/dist/classes/_zthun_helpful-validation.EqualsOtherPropertyValidator.html +5 -5
- package/dist/classes/_zthun_helpful-validation.IsDataURILimitValidator.html +5 -5
- package/dist/classes/_zthun_helpful-validation.IsNotWhiteSpaceValidator.html +5 -5
- package/dist/classes/_zthun_helpful-validation.RequiresOtherPropertyValidator.html +5 -5
- package/dist/enums/_zthun_helpful-fn.ZHorizontalAnchor.html +8 -8
- package/dist/enums/_zthun_helpful-fn.ZOrientation.html +6 -6
- package/dist/enums/_zthun_helpful-fn.ZVerticalAnchor.html +8 -8
- package/dist/enums/_zthun_helpful-query.ZMetadataType.html +14 -14
- package/dist/enums/_zthun_helpful-query.ZOperatorBinary.html +16 -16
- package/dist/enums/_zthun_helpful-query.ZOperatorCollection.html +6 -6
- package/dist/enums/_zthun_helpful-query.ZOperatorLogic.html +6 -6
- package/dist/enums/_zthun_helpful-query.ZOperatorUnary.html +6 -6
- package/dist/enums/_zthun_helpful-query.ZSortDirection.html +6 -6
- package/dist/functions/_zthun_helpful-fn.countBuckets.html +3 -3
- package/dist/functions/_zthun_helpful-fn.createError.html +3 -3
- package/dist/functions/_zthun_helpful-fn.firstDefined.html +8 -8
- package/dist/functions/_zthun_helpful-fn.firstTruthy.html +8 -8
- package/dist/functions/_zthun_helpful-fn.firstWhere.html +8 -8
- package/dist/functions/_zthun_helpful-fn.isEmptyObject.html +2 -2
- package/dist/functions/_zthun_helpful-fn.joinDefined.html +5 -5
- package/dist/functions/_zthun_helpful-fn.optional.html +15 -15
- package/dist/functions/_zthun_helpful-fn.peel.html +5 -5
- package/dist/functions/_zthun_helpful-fn.peelBetween.html +4 -4
- package/dist/functions/_zthun_helpful-fn.pickBy.html +4 -4
- package/dist/functions/_zthun_helpful-fn.pickDataAttributes.html +4 -4
- package/dist/functions/_zthun_helpful-fn.pickDefined.html +4 -4
- package/dist/functions/_zthun_helpful-fn.purge.html +1 -1
- package/dist/functions/_zthun_helpful-fn.required.html +6 -6
- package/dist/functions/_zthun_helpful-fn.setFirst.html +7 -7
- package/dist/functions/_zthun_helpful-fn.sleep.html +10 -10
- package/dist/functions/_zthun_helpful-fn.tag.html +3 -3
- package/dist/functions/_zthun_helpful-fn.tryFallback.html +12 -12
- package/dist/functions/_zthun_helpful-fn.tryFallbackAsync.html +12 -12
- package/dist/functions/_zthun_helpful-query.isBinaryFilter.html +2 -2
- package/dist/functions/_zthun_helpful-query.isBinaryOperator.html +2 -2
- package/dist/functions/_zthun_helpful-query.isCollectionFilter.html +2 -2
- package/dist/functions/_zthun_helpful-query.isCollectionOperator.html +2 -2
- package/dist/functions/_zthun_helpful-query.isLogicFilter.html +2 -2
- package/dist/functions/_zthun_helpful-query.isLogicOperator.html +2 -2
- package/dist/functions/_zthun_helpful-query.isUnaryFilter.html +2 -2
- package/dist/functions/_zthun_helpful-query.isUnaryOperator.html +2 -2
- package/dist/functions/_zthun_helpful-react.asStateData.html +15 -15
- package/dist/functions/_zthun_helpful-react.asStateError.html +5 -5
- package/dist/functions/_zthun_helpful-react.createKeyboardActivate.html +4 -4
- package/dist/functions/_zthun_helpful-react.isStateErrored.html +4 -4
- package/dist/functions/_zthun_helpful-react.isStateLoaded.html +5 -5
- package/dist/functions/_zthun_helpful-react.isStateLoading.html +4 -4
- package/dist/functions/_zthun_helpful-react.useAmbassadorState.html +17 -17
- package/dist/functions/_zthun_helpful-react.useAsyncState.html +5 -5
- package/dist/functions/_zthun_helpful-react.useFileSelect.html +2 -2
- package/dist/functions/_zthun_helpful-react.useKeyboardActivate.html +4 -4
- package/dist/functions/_zthun_helpful-react.useMoreViewState.html +5 -5
- package/dist/functions/_zthun_helpful-react.usePageViewState.html +5 -5
- package/dist/functions/_zthun_helpful-react.useStateAsArray.html +4 -4
- package/dist/functions/_zthun_helpful-react.useWindowService.html +2 -2
- package/dist/functions/_zthun_helpful-validation.EqualsOtherProperty.html +3 -3
- package/dist/functions/_zthun_helpful-validation.IsDataURILimit.html +2 -2
- package/dist/functions/_zthun_helpful-validation.IsNotWhiteSpace.html +2 -2
- package/dist/functions/_zthun_helpful-validation.RequiresOtherProperty.html +3 -3
- package/dist/hierarchy.html +1 -1
- package/dist/index.html +2 -2
- package/dist/interfaces/_zthun_helpful-brands.IZBrand.html +11 -11
- package/dist/interfaces/_zthun_helpful-fn.IZDeserialize.html +9 -9
- package/dist/interfaces/_zthun_helpful-fn.IZPoint2d.html +6 -6
- package/dist/interfaces/_zthun_helpful-fn.IZPoint3d.html +8 -8
- package/dist/interfaces/_zthun_helpful-fn.IZQuadrilateral.html +11 -11
- package/dist/interfaces/_zthun_helpful-fn.IZQuadrilateralCorners.html +7 -7
- package/dist/interfaces/_zthun_helpful-fn.IZSerialize.html +8 -8
- package/dist/interfaces/_zthun_helpful-internet.IZCookie.html +16 -16
- package/dist/interfaces/_zthun_helpful-internet.IZEmail.html +8 -8
- package/dist/interfaces/_zthun_helpful-internet.IZEmailContact.html +8 -8
- package/dist/interfaces/_zthun_helpful-internet.IZEmailEnvelope.html +10 -10
- package/dist/interfaces/_zthun_helpful-internet.IZServer.html +10 -10
- package/dist/interfaces/_zthun_helpful-query.IZDataMatch.html +8 -8
- package/dist/interfaces/_zthun_helpful-query.IZDataRequest.html +15 -15
- package/dist/interfaces/_zthun_helpful-query.IZDataRequestQuery.html +12 -12
- package/dist/interfaces/_zthun_helpful-query.IZDataSource.html +8 -8
- package/dist/interfaces/_zthun_helpful-query.IZDataSourceStaticOptions.html +8 -8
- package/dist/interfaces/_zthun_helpful-query.IZFilterBinary.html +10 -10
- package/dist/interfaces/_zthun_helpful-query.IZFilterCollection.html +10 -10
- package/dist/interfaces/_zthun_helpful-query.IZFilterLogic.html +8 -8
- package/dist/interfaces/_zthun_helpful-query.IZFilterMetadata.html +4 -4
- package/dist/interfaces/_zthun_helpful-query.IZFilterOperator.html +7 -7
- package/dist/interfaces/_zthun_helpful-query.IZFilterSubject.html +8 -8
- package/dist/interfaces/_zthun_helpful-query.IZMetadata.html +24 -24
- package/dist/interfaces/_zthun_helpful-query.IZPage.html +7 -7
- package/dist/interfaces/_zthun_helpful-query.IZSort.html +6 -6
- package/dist/interfaces/_zthun_helpful-query.IZSorter.html +8 -8
- package/dist/interfaces/_zthun_helpful-react.IZFileSelect.html +4 -4
- package/dist/interfaces/_zthun_helpful-react.IZKeyboardInteraction.html +8 -8
- package/dist/modules/_zthun_helpful-brands.html +4 -4
- package/dist/modules/_zthun_helpful-fn.html +3 -3
- package/dist/modules/_zthun_helpful-internet.html +3 -3
- package/dist/modules/_zthun_helpful-node.html +3 -3
- package/dist/modules/_zthun_helpful-query.html +4 -4
- package/dist/modules/_zthun_helpful-react.html +3 -3
- package/dist/modules/_zthun_helpful-validation.html +3 -3
- package/dist/modules.html +1 -1
- package/dist/types/_zthun_helpful-fn.DeepPartial.html +1 -1
- package/dist/types/_zthun_helpful-fn.JoinListInputParameter.html +3 -3
- 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 +4 -4
- package/dist/types/_zthun_helpful-fn.ZCornersHorizontal.html +4 -2
- package/dist/types/_zthun_helpful-fn.ZCornersVertical.html +4 -2
- package/dist/types/_zthun_helpful-fn.ZObligatedValue.html +3 -3
- package/dist/types/_zthun_helpful-fn.ZQuadrilateralCornersLike.html +2 -2
- package/dist/types/_zthun_helpful-fn.ZQuadrilateralLike.html +2 -2
- package/dist/types/_zthun_helpful-fn.ZSideAnchor.html +2 -2
- package/dist/types/_zthun_helpful-fn.ZSupplier.html +2 -2
- package/dist/types/_zthun_helpful-fn.ZSupplierAsync.html +2 -2
- package/dist/types/_zthun_helpful-query.IZFilter.html +2 -2
- package/dist/types/_zthun_helpful-query.IZFilterUnary.html +2 -2
- package/dist/types/_zthun_helpful-query.ZOperatorFilter.html +2 -2
- package/dist/types/_zthun_helpful-react.ZAmbassadorReducer.html +2 -2
- package/dist/types/_zthun_helpful-react.ZAmbassadorReducerRequired.html +2 -2
- package/dist/types/_zthun_helpful-react.ZAmbassadorSetCurrent.html +2 -2
- package/dist/types/_zthun_helpful-react.ZAsyncDataState.html +2 -2
- package/dist/types/_zthun_helpful-react.ZAsyncDataTuple.html +2 -2
- package/dist/types/_zthun_helpful-react.ZAsyncUseData.html +2 -2
- 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 +2 -2
- package/dist/variables/_zthun_helpful-fn._global.html +1 -1
- package/dist/variables/_zthun_helpful-fn.bash.html +14 -0
- package/dist/variables/_zthun_helpful-fn.commaJoinDefined.html +5 -0
- package/dist/variables/_zthun_helpful-fn.createGuid.html +11 -0
- package/dist/variables/_zthun_helpful-fn.css.html +16 -0
- package/dist/variables/_zthun_helpful-fn.cssJoinDefined.html +5 -0
- package/dist/variables/_zthun_helpful-fn.html.html +16 -0
- package/dist/variables/_zthun_helpful-fn.javascript.html +14 -0
- package/dist/variables/_zthun_helpful-fn.js.html +16 -0
- package/dist/variables/_zthun_helpful-fn.markdown.html +14 -0
- package/dist/variables/_zthun_helpful-fn.md.html +16 -0
- package/dist/variables/_zthun_helpful-fn.pipeJoinDefined.html +5 -0
- package/dist/variables/_zthun_helpful-fn.semiColonJoinDefined.html +5 -0
- package/dist/variables/_zthun_helpful-fn.sh.html +14 -0
- package/dist/variables/_zthun_helpful-fn.spaceJoinDefined.html +5 -0
- package/dist/variables/_zthun_helpful-fn.ts.html +16 -0
- package/dist/variables/_zthun_helpful-fn.typescript.html +14 -0
- package/dist/variables/_zthun_helpful-fn.zsh.html +14 -0
- package/dist/variables/_zthun_helpful-query.ZBinaryComparators.html +2 -2
- package/dist/variables/_zthun_helpful-query.ZCollectionComparators.html +2 -2
- package/dist/variables/_zthun_helpful-query.ZOperatorsBinary.html +2 -2
- package/dist/variables/_zthun_helpful-query.ZOperatorsCollection.html +2 -2
- package/dist/variables/_zthun_helpful-query.ZOperatorsFilter.html +2 -2
- package/dist/variables/_zthun_helpful-query.ZOperatorsLogic.html +2 -2
- package/dist/variables/_zthun_helpful-query.ZOperatorsUnary.html +2 -2
- package/dist/variables/_zthun_helpful-query.ZSortDirections.html +2 -2
- package/dist/variables/_zthun_helpful-query.ZUnaryComparators.html +2 -2
- package/dist/variables/_zthun_helpful-react.DefaultActivateCodes.html +2 -2
- package/dist/variables/_zthun_helpful-react.ZAsyncLoading.html +2 -2
- package/dist/variables/_zthun_helpful-react.ZFileSelectContext.html +2 -0
- package/dist/variables/_zthun_helpful-react.ZWindowServiceContext.html +2 -0
- package/package.json +12 -12
- package/dist/classes/_zthun_helpful-node.ZFileSystemNodeBuilder.html +0 -11
- package/dist/classes/_zthun_helpful-node.ZFileSystemService.html +0 -12
- package/dist/enums/_zthun_helpful-node.ZFileSystemNodeType.html +0 -4
- package/dist/functions/_zthun_helpful-fn.bash.html +0 -14
- package/dist/functions/_zthun_helpful-fn.commaJoinDefined.html +0 -5
- package/dist/functions/_zthun_helpful-fn.createGuid.html +0 -11
- package/dist/functions/_zthun_helpful-fn.css.html +0 -16
- package/dist/functions/_zthun_helpful-fn.cssJoinDefined.html +0 -5
- package/dist/functions/_zthun_helpful-fn.html.html +0 -16
- package/dist/functions/_zthun_helpful-fn.javascript.html +0 -14
- package/dist/functions/_zthun_helpful-fn.js.html +0 -16
- package/dist/functions/_zthun_helpful-fn.markdown.html +0 -14
- package/dist/functions/_zthun_helpful-fn.md.html +0 -16
- package/dist/functions/_zthun_helpful-fn.pipeJoinDefined.html +0 -5
- package/dist/functions/_zthun_helpful-fn.semiColonJoinDefined.html +0 -5
- package/dist/functions/_zthun_helpful-fn.sh.html +0 -14
- package/dist/functions/_zthun_helpful-fn.spaceJoinDefined.html +0 -5
- package/dist/functions/_zthun_helpful-fn.ts.html +0 -16
- package/dist/functions/_zthun_helpful-fn.typescript.html +0 -14
- package/dist/functions/_zthun_helpful-fn.zsh.html +0 -14
- package/dist/functions/_zthun_helpful-node.walk.html +0 -12
- package/dist/functions/_zthun_helpful-react.ZFileSelectContext.html +0 -10
- package/dist/functions/_zthun_helpful-react.ZWindowServiceContext.html +0 -10
- package/dist/interfaces/_zthun_helpful-node.IZFileSystemNode.html +0 -11
- package/dist/interfaces/_zthun_helpful-node.IZFileSystemSearchOptions.html +0 -5
- package/dist/interfaces/_zthun_helpful-node.IZFileSystemService.html +0 -11
- package/dist/interfaces/_zthun_helpful-node.ZWalkOptions.html +0 -13
- package/dist/variables/_zthun_helpful-node.ZFileSystemToken.html +0 -3
|
@@ -1,8 +1,8 @@
|
|
|
1
|
-
<!DOCTYPE html><html class="default" lang="en" data-base="
|
|
2
|
-
</div><div class="tsd-comment tsd-typography"></div></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/
|
|
3
|
-
</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Methods</h3><div class="tsd-index-list"><a href="
|
|
4
|
-
</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-Constructors"><
|
|
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>ZSortSerialize | Helpful</title><link rel="icon" href="../assets/favicon.svg" type="image/svg+xml"/><meta name="description" content="Documentation for Helpful"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><a href="../index.html" class="title">Helpful</a><div id="tsd-toolbar-links"></div><button id="tsd-search-trigger" class="tsd-widget" aria-label="Search"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></button><dialog id="tsd-search" aria-label="Search"><input role="combobox" id="tsd-search-input" aria-controls="tsd-search-results" aria-autocomplete="list" aria-expanded="true" autocapitalize="off" autocomplete="off" placeholder="Search the docs" maxLength="100"/><ul role="listbox" id="tsd-search-results"></ul><div id="tsd-search-status" aria-live="polite" aria-atomic="true"><div>Preparing search index...</div></div></dialog><a href="#" class="tsd-widget menu" id="tsd-toolbar-menu-trigger" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb" aria-label="Breadcrumb"><li><a href="../modules/_zthun_helpful-query.html">@zthun/helpful-query</a></li><li><a href="" aria-current="page">ZSortSerialize</a></li></ul><h1>Class ZSortSerialize</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>An object that can serialize an <a href="../interfaces/_zthun_helpful-query.IZSort.html" class="tsd-kind-interface">IZSort</a> list to a string.</p>
|
|
2
|
+
</div><div class="tsd-comment tsd-typography"></div></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/3e88f38b916d0973f2520566526efbd1519ed6af/packages/helpful-query/src/sort/sort-serialize.mts#L6">packages/helpful-query/src/sort/sort-serialize.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"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h5 class="tsd-index-heading uppercase">Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Constructors</h3><div class="tsd-index-list"><a href="#constructor" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Constructor"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a>
|
|
3
|
+
</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Methods</h3><div class="tsd-index-list"><a href="#serialize" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>serialize</span></a>
|
|
4
|
+
</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-Constructors"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h2>Constructors</h2></summary><section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="constructor"><span>constructor</span><a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="constructorzsortserialize"><span class="tsd-signature-keyword">new</span> <span class="tsd-kind-constructor-signature">ZSortSerialize</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <a href="" class="tsd-signature-type tsd-kind-class">ZSortSerialize</a><a href="#constructorzsortserialize" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><h4 class="tsd-returns-title">Returns <a href="" class="tsd-signature-type tsd-kind-class">ZSortSerialize</a></h4></div></li></ul></section></section></details><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Methods"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h2>Methods</h2></summary><section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="serialize"><span>serialize</span><a href="#serialize" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="serialize-1"><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-type">undefined</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">null</span> <span class="tsd-signature-symbol">|</span> <a href="../interfaces/_zthun_helpful-query.IZSort.html" class="tsd-signature-type tsd-kind-interface">IZSort</a><span class="tsd-signature-symbol">[]</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> <span class="tsd-signature-type">string</span><a href="#serialize-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Serializes a sort list to a string.</p>
|
|
5
5
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">candidate</span>: <span class="tsd-signature-type">undefined</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">null</span> <span class="tsd-signature-symbol">|</span> <a href="../interfaces/_zthun_helpful-query.IZSort.html" class="tsd-signature-type tsd-kind-interface">IZSort</a><span class="tsd-signature-symbol">[]</span></span><div class="tsd-comment tsd-typography"><p>The sort list to serialize.</p>
|
|
6
6
|
</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> <span class="tsd-signature-type">string</span></h4><p>The string representation of the sort. Returns undefined
|
|
7
7
|
if the list is empty, null, or undefined.</p>
|
|
8
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/
|
|
8
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/3e88f38b916d0973f2520566526efbd1519ed6af/packages/helpful-query/src/sort/sort-serialize.mts#L17">packages/helpful-query/src/sort/sort-serialize.mts:17</a></li></ul></aside></div></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"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>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-Constructors"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Constructors</summary><div><a href="#constructor"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Constructor"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a></div></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" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Methods</summary><div><a href="#serialize"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><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">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,11 +1,11 @@
|
|
|
1
|
-
<!DOCTYPE html><html class="default" lang="en" data-base="
|
|
2
|
-
</div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel"><h4>Implements</h4><ul class="tsd-hierarchy"><li><a href="../interfaces/_zthun_helpful-query.IZSorter.html" class="tsd-signature-type tsd-kind-interface">IZSorter</a></li></ul></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/
|
|
3
|
-
</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Methods</h3><div class="tsd-index-list"><a href="
|
|
4
|
-
<a href="
|
|
5
|
-
<a href="
|
|
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-Constructors"><
|
|
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>ZSorterSingle | Helpful</title><link rel="icon" href="../assets/favicon.svg" type="image/svg+xml"/><meta name="description" content="Documentation for Helpful"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><a href="../index.html" class="title">Helpful</a><div id="tsd-toolbar-links"></div><button id="tsd-search-trigger" class="tsd-widget" aria-label="Search"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></button><dialog id="tsd-search" aria-label="Search"><input role="combobox" id="tsd-search-input" aria-controls="tsd-search-results" aria-autocomplete="list" aria-expanded="true" autocapitalize="off" autocomplete="off" placeholder="Search the docs" maxLength="100"/><ul role="listbox" id="tsd-search-results"></ul><div id="tsd-search-status" aria-live="polite" aria-atomic="true"><div>Preparing search index...</div></div></dialog><a href="#" class="tsd-widget menu" id="tsd-toolbar-menu-trigger" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb" aria-label="Breadcrumb"><li><a href="../modules/_zthun_helpful-query.html">@zthun/helpful-query</a></li><li><a href="" aria-current="page">ZSorterSingle</a></li></ul><h1>Class ZSorterSingle</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>Represents a sorter that simulates a single sort at a time.</p>
|
|
2
|
+
</div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel"><h4>Implements</h4><ul class="tsd-hierarchy"><li><a href="../interfaces/_zthun_helpful-query.IZSorter.html" class="tsd-signature-type tsd-kind-interface">IZSorter</a></li></ul></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/3e88f38b916d0973f2520566526efbd1519ed6af/packages/helpful-query/src/sort/sorter-single.mts#L8">packages/helpful-query/src/sort/sorter-single.mts:8</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"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h5 class="tsd-index-heading uppercase">Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Constructors</h3><div class="tsd-index-list"><a href="#constructor" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Constructor"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a>
|
|
3
|
+
</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Methods</h3><div class="tsd-index-list"><a href="#index" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>index</span></a>
|
|
4
|
+
<a href="#sort" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>sort</span></a>
|
|
5
|
+
<a href="#sorted" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>sorted</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-Constructors"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h2>Constructors</h2></summary><section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="constructor"><span>constructor</span><a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="constructorzsortersingle"><span class="tsd-signature-keyword">new</span> <span class="tsd-kind-constructor-signature">ZSorterSingle</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">initial</span><span class="tsd-signature-symbol">?:</span> <a href="../interfaces/_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><span class="tsd-signature-symbol">:</span> <a href="" class="tsd-signature-type tsd-kind-class">ZSorterSingle</a><a href="#constructorzsortersingle" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Initializes a new instance of this object.</p>
|
|
7
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">initial</span>: <a href="../interfaces/_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></span><div class="tsd-comment tsd-typography"><p>The initial sort list.</p>
|
|
8
|
-
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="
|
|
8
|
+
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="" class="tsd-signature-type tsd-kind-class">ZSorterSingle</a></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/3e88f38b916d0973f2520566526efbd1519ed6af/packages/helpful-query/src/sort/sorter-single.mts#L17">packages/helpful-query/src/sort/sorter-single.mts:17</a></li></ul></aside></div></li></ul></section></section></details><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Methods"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h2>Methods</h2></summary><section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="index"><span>index</span><a href="#index" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="index-1"><span class="tsd-kind-call-signature">index</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">subject</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><a href="#index-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Gets the current sort index for the subject or -1 if it is not sorted.</p>
|
|
9
9
|
<p>This should be 1 based.</p>
|
|
10
10
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">subject</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The subject to sort. If this is undefined, the subject
|
|
11
11
|
should be considered the empty string (the object itself).</p>
|
|
@@ -15,7 +15,7 @@ should be considered the empty string (the object itself).</p>
|
|
|
15
15
|
</code></pre>
|
|
16
16
|
</li>
|
|
17
17
|
</ul>
|
|
18
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/_zthun_helpful-query.IZSorter.html">IZSorter</a>.<a href="../interfaces/_zthun_helpful-query.IZSorter.html#index">index</a></p><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/
|
|
18
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/_zthun_helpful-query.IZSorter.html">IZSorter</a>.<a href="../interfaces/_zthun_helpful-query.IZSorter.html#index">index</a></p><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/3e88f38b916d0973f2520566526efbd1519ed6af/packages/helpful-query/src/sort/sorter-single.mts#L21">packages/helpful-query/src/sort/sorter-single.mts:21</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="sort"><span>sort</span><a href="#sort" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="sort-1"><span class="tsd-kind-call-signature">sort</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">subject</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/_zthun_helpful-query.IZSort.html" class="tsd-signature-type tsd-kind-interface">IZSort</a><span class="tsd-signature-symbol">[]</span><a href="#sort-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Sorts a specific subject.</p>
|
|
19
19
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">subject</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The subject to sort. Undefined is considered the
|
|
20
20
|
empty string.</p>
|
|
21
21
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="../interfaces/_zthun_helpful-query.IZSort.html" class="tsd-signature-type tsd-kind-interface">IZSort</a><span class="tsd-signature-symbol">[]</span></h4><ul>
|
|
@@ -24,7 +24,7 @@ empty string.</p>
|
|
|
24
24
|
</code></pre>
|
|
25
25
|
</li>
|
|
26
26
|
</ul>
|
|
27
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/_zthun_helpful-query.IZSorter.html">IZSorter</a>.<a href="../interfaces/_zthun_helpful-query.IZSorter.html#sort">sort</a></p><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/
|
|
27
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/_zthun_helpful-query.IZSorter.html">IZSorter</a>.<a href="../interfaces/_zthun_helpful-query.IZSorter.html#sort">sort</a></p><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/3e88f38b916d0973f2520566526efbd1519ed6af/packages/helpful-query/src/sort/sorter-single.mts#L31">packages/helpful-query/src/sort/sorter-single.mts:31</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="sorted"><span>sorted</span><a href="#sorted" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="sorted-1"><span class="tsd-kind-call-signature">sorted</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">subject</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span> <span class="tsd-signature-symbol">|</span> <a href="../enums/_zthun_helpful-query.ZSortDirection.html" class="tsd-signature-type tsd-kind-enum">ZSortDirection</a><a href="#sorted-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Gets the current direction that the subject is sorted.</p>
|
|
28
28
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">subject</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The subject to check. Undefined is considered the
|
|
29
29
|
empty string (the object itself).</p>
|
|
30
|
-
</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 href="../enums/_zthun_helpful-query.ZSortDirection.html" class="tsd-signature-type tsd-kind-enum">ZSortDirection</a></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/_zthun_helpful-query.IZSorter.html">IZSorter</a>.<a href="../interfaces/_zthun_helpful-query.IZSorter.html#sorted">sorted</a></p><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/
|
|
30
|
+
</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 href="../enums/_zthun_helpful-query.ZSortDirection.html" class="tsd-signature-type tsd-kind-enum">ZSortDirection</a></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/_zthun_helpful-query.IZSorter.html">IZSorter</a>.<a href="../interfaces/_zthun_helpful-query.IZSorter.html#sorted">sorted</a></p><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/3e88f38b916d0973f2520566526efbd1519ed6af/packages/helpful-query/src/sort/sorter-single.mts#L25">packages/helpful-query/src/sort/sorter-single.mts:25</a></li></ul></aside></div></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"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>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-Constructors"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Constructors</summary><div><a href="#constructor"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Constructor"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a></div></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" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Methods</summary><div><a href="#index"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>index</span></a><a href="#sort"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>sort</span></a><a href="#sorted"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>sorted</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,15 +1,15 @@
|
|
|
1
|
-
<!DOCTYPE html><html class="default" lang="en" data-base="
|
|
2
|
-
</div><div class="tsd-comment tsd-typography"></div></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/
|
|
3
|
-
</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="
|
|
4
|
-
<a href="
|
|
5
|
-
<a href="
|
|
6
|
-
<a href="
|
|
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-Constructors"><
|
|
8
|
-
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-see"><h4 class="tsd-anchor-link"
|
|
9
|
-
</div></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 class="tsd-tag-see"><h4 class="tsd-anchor-link"
|
|
11
|
-
</div></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 class="tsd-tag-see"><h4 class="tsd-anchor-link"
|
|
13
|
-
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/
|
|
14
|
-
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-see"><h4 class="tsd-anchor-link"
|
|
15
|
-
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/
|
|
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>ZWellKnownIconClasses | Helpful</title><link rel="icon" href="../assets/favicon.svg" type="image/svg+xml"/><meta name="description" content="Documentation for Helpful"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><a href="../index.html" class="title">Helpful</a><div id="tsd-toolbar-links"></div><button id="tsd-search-trigger" class="tsd-widget" aria-label="Search"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></button><dialog id="tsd-search" aria-label="Search"><input role="combobox" id="tsd-search-input" aria-controls="tsd-search-results" aria-autocomplete="list" aria-expanded="true" autocapitalize="off" autocomplete="off" placeholder="Search the docs" maxLength="100"/><ul role="listbox" id="tsd-search-results"></ul><div id="tsd-search-status" aria-live="polite" aria-atomic="true"><div>Preparing search index...</div></div></dialog><a href="#" class="tsd-widget menu" id="tsd-toolbar-menu-trigger" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb" aria-label="Breadcrumb"><li><a href="../modules/_zthun_helpful-query.html">@zthun/helpful-query</a></li><li><a href="" aria-current="page">ZWellKnownIconClasses</a></li></ul><h1>Class ZWellKnownIconClasses<code class="tsd-tag">Abstract</code></h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>Represents well known icon font classes for reuse.</p>
|
|
2
|
+
</div><div class="tsd-comment tsd-typography"></div></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/3e88f38b916d0973f2520566526efbd1519ed6af/packages/helpful-query/src/metadata/well-known-icon-classes.mts#L4">packages/helpful-query/src/metadata/well-known-icon-classes.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"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h5 class="tsd-index-heading uppercase">Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Constructors</h3><div class="tsd-index-list"><a href="#constructor" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Constructor"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a>
|
|
3
|
+
</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="#fontawesome" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>Font<wbr/>Awesome</span></a>
|
|
4
|
+
<a href="#fontawesomebrands" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>Font<wbr/>Awesome<wbr/>Brands</span></a>
|
|
5
|
+
<a href="#fontawesomesharp" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>Font<wbr/>Awesome<wbr/>Sharp</span></a>
|
|
6
|
+
<a href="#material" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>Material</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-Constructors"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h2>Constructors</h2></summary><section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="constructor"><span>constructor</span><a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="constructorzwellknowniconclasses"><span class="tsd-signature-keyword">new</span> <span class="tsd-kind-constructor-signature">ZWellKnownIconClasses</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <a href="" class="tsd-signature-type tsd-kind-class">ZWellKnownIconClasses</a><a href="#constructorzwellknowniconclasses" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><h4 class="tsd-returns-title">Returns <a href="" class="tsd-signature-type tsd-kind-class">ZWellKnownIconClasses</a></h4></div></li></ul></section></section></details><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h2>Properties</h2></summary><section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="fontawesome"><code class="tsd-tag">Static</code> <code class="tsd-tag">Readonly</code><span>Font<wbr/>Awesome</span><a href="#fontawesome" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">FontAwesome</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"https://fontawesome.com"</span></div><div class="tsd-comment tsd-typography"><p>Font Awesome Classic.</p>
|
|
8
|
+
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-see"><h4 class="tsd-anchor-link" id="see">See<a href="#see" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p><a href="https://fontawesome.com">https://fontawesome.com</a></p>
|
|
9
|
+
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/3e88f38b916d0973f2520566526efbd1519ed6af/packages/helpful-query/src/metadata/well-known-icon-classes.mts#L10">packages/helpful-query/src/metadata/well-known-icon-classes.mts:10</a></li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="fontawesomebrands"><code class="tsd-tag">Static</code> <code class="tsd-tag">Readonly</code><span>Font<wbr/>Awesome<wbr/>Brands</span><a href="#fontawesomebrands" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">FontAwesomeBrands</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"https://fontawesome.com/search?o=r&f=brands"</span></div><div class="tsd-comment tsd-typography"><p>Font Awesome Brands.</p>
|
|
10
|
+
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-see"><h4 class="tsd-anchor-link" id="see-1">See<a href="#see-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p><a href="https://fontawesome.com/search?o=r&f=brands">https://fontawesome.com/search?o=r&f=brands</a></p>
|
|
11
|
+
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/3e88f38b916d0973f2520566526efbd1519ed6af/packages/helpful-query/src/metadata/well-known-icon-classes.mts#L17">packages/helpful-query/src/metadata/well-known-icon-classes.mts:17</a></li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="fontawesomesharp"><code class="tsd-tag">Static</code> <code class="tsd-tag">Readonly</code><span>Font<wbr/>Awesome<wbr/>Sharp</span><a href="#fontawesomesharp" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">FontAwesomeSharp</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"https://fontawesome.com/search?o=r&f=sharp"</span></div><div class="tsd-comment tsd-typography"><p>Font Awesome Sharp.</p>
|
|
12
|
+
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-see"><h4 class="tsd-anchor-link" id="see-2">See<a href="#see-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p><a href="https://fontawesome.com/search?o=r&f=sharp">https://fontawesome.com/search?o=r&f=sharp</a></p>
|
|
13
|
+
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/3e88f38b916d0973f2520566526efbd1519ed6af/packages/helpful-query/src/metadata/well-known-icon-classes.mts#L25">packages/helpful-query/src/metadata/well-known-icon-classes.mts:25</a></li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="material"><code class="tsd-tag">Static</code> <code class="tsd-tag">Readonly</code><span>Material</span><a href="#material" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">Material</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"https://mui.com/material-ui/material-icons"</span></div><div class="tsd-comment tsd-typography"><p>Material design.</p>
|
|
14
|
+
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-see"><h4 class="tsd-anchor-link" id="see-3">See<a href="#see-3" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p><a href="https://mui.com/material-ui/material-icons">https://mui.com/material-ui/material-icons</a></p>
|
|
15
|
+
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/3e88f38b916d0973f2520566526efbd1519ed6af/packages/helpful-query/src/metadata/well-known-icon-classes.mts#L33">packages/helpful-query/src/metadata/well-known-icon-classes.mts:33</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"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>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-Constructors"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Constructors</summary><div><a href="#constructor"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Constructor"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a></div></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" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Properties</summary><div><a href="#fontawesome"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>Font<wbr/>Awesome</span></a><a href="#fontawesomebrands"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>Font<wbr/>Awesome<wbr/>Brands</span></a><a href="#fontawesomesharp"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>Font<wbr/>Awesome<wbr/>Sharp</span></a><a href="#material"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>Material</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,10 +1,10 @@
|
|
|
1
|
-
<!DOCTYPE html><html class="default" lang="en" data-base="
|
|
2
|
-
</div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel"><h4>Implements</h4><ul class="tsd-hierarchy"><li><a href="../interfaces/_zthun_helpful-react.IZFileSelect.html" class="tsd-signature-type tsd-kind-interface">IZFileSelect</a></li></ul></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/
|
|
3
|
-
</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Methods</h3><div class="tsd-index-list"><a href="
|
|
4
|
-
</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-Constructors"><
|
|
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>ZFileSelect | Helpful</title><link rel="icon" href="../assets/favicon.svg" type="image/svg+xml"/><meta name="description" content="Documentation for Helpful"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><a href="../index.html" class="title">Helpful</a><div id="tsd-toolbar-links"></div><button id="tsd-search-trigger" class="tsd-widget" aria-label="Search"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></button><dialog id="tsd-search" aria-label="Search"><input role="combobox" id="tsd-search-input" aria-controls="tsd-search-results" aria-autocomplete="list" aria-expanded="true" autocapitalize="off" autocomplete="off" placeholder="Search the docs" maxLength="100"/><ul role="listbox" id="tsd-search-results"></ul><div id="tsd-search-status" aria-live="polite" aria-atomic="true"><div>Preparing search index...</div></div></dialog><a href="#" class="tsd-widget menu" id="tsd-toolbar-menu-trigger" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb" aria-label="Breadcrumb"><li><a href="../modules/_zthun_helpful-react.html">@zthun/helpful-react</a></li><li><a href="" aria-current="page">ZFileSelect</a></li></ul><h1>Class ZFileSelect</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>Represents a file select that is opened from an input.</p>
|
|
2
|
+
</div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel"><h4>Implements</h4><ul class="tsd-hierarchy"><li><a href="../interfaces/_zthun_helpful-react.IZFileSelect.html" class="tsd-signature-type tsd-kind-interface">IZFileSelect</a></li></ul></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/3e88f38b916d0973f2520566526efbd1519ed6af/packages/helpful-react/src/file-select/file-select.mts#L36">file-select/file-select.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"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h5 class="tsd-index-heading uppercase">Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Constructors</h3><div class="tsd-index-list"><a href="#constructor" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Constructor"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a>
|
|
3
|
+
</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Methods</h3><div class="tsd-index-list"><a href="#open" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>open</span></a>
|
|
4
|
+
</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-Constructors"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h2>Constructors</h2></summary><section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="constructor"><span>constructor</span><a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="constructorzfileselect"><span class="tsd-signature-keyword">new</span> <span class="tsd-kind-constructor-signature">ZFileSelect</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">_doc</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">Document</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">_container</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">HTMLElement</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="" class="tsd-signature-type tsd-kind-class">ZFileSelect</a><a href="#constructorzfileselect" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Initializes a new instance of this object.</p>
|
|
5
5
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">_doc</span>: <span class="tsd-signature-type">Document</span><span class="tsd-signature-symbol"> = $global.document</span></span><div class="tsd-comment tsd-typography"><p>The root document that can be used to create the file dialog.</p>
|
|
6
6
|
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">_container</span>: <span class="tsd-signature-type">HTMLElement</span><span class="tsd-signature-symbol"> = _doc.body</span></span><div class="tsd-comment tsd-typography"><p>The container to house the input element.</p>
|
|
7
|
-
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="
|
|
7
|
+
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="" class="tsd-signature-type tsd-kind-class">ZFileSelect</a></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/3e88f38b916d0973f2520566526efbd1519ed6af/packages/helpful-react/src/file-select/file-select.mts#L75">file-select/file-select.mts:75</a></li></ul></aside></div></li></ul></section></section></details><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Methods"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h2>Methods</h2></summary><section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="open"><span>open</span><a href="#open" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="open-1"><span class="tsd-kind-call-signature">open</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">accept</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">cb</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">file</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">File</span><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=></span> <span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#open-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Opens the file dialog.</p>
|
|
8
8
|
<p>Note that this uses the older node callback style rather than returning a promise.
|
|
9
9
|
This is intentional due to how this object opens a file select. Since there is no
|
|
10
10
|
way to determine if the user canceled the dialog, returning a promise would actually
|
|
@@ -12,4 +12,4 @@ potentially result in a memory leak since it would never get resolved. Therefor
|
|
|
12
12
|
the class callback style has to be used here.</p>
|
|
13
13
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">accept</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The file mime types to accept.</p>
|
|
14
14
|
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">cb</span>: <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">file</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">File</span><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=></span> <span class="tsd-signature-type">void</span></span><div class="tsd-comment tsd-typography"><p>The callback for when the user selects a file.</p>
|
|
15
|
-
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/_zthun_helpful-react.IZFileSelect.html">IZFileSelect</a>.<a href="../interfaces/_zthun_helpful-react.IZFileSelect.html#open">open</a></p><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/
|
|
15
|
+
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/_zthun_helpful-react.IZFileSelect.html">IZFileSelect</a>.<a href="../interfaces/_zthun_helpful-react.IZFileSelect.html#open">open</a></p><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/3e88f38b916d0973f2520566526efbd1519ed6af/packages/helpful-react/src/file-select/file-select.mts#L94">file-select/file-select.mts:94</a></li></ul></aside></div></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"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>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-Constructors"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Constructors</summary><div><a href="#constructor"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Constructor"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a></div></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" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Methods</summary><div><a href="#open"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>open</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>
|