@zthun/helpful-web 9.11.6 → 9.11.8
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/navigation.js +1 -1
- package/dist/assets/search.js +1 -1
- package/dist/classes/_zthun_helpful-brands.ZBrandBuilder.html +9 -9
- package/dist/classes/_zthun_helpful-brands.ZBrandDataSourceFactory.html +2 -2
- package/dist/classes/_zthun_helpful-brands.ZBrandKnown.html +37 -37
- package/dist/classes/_zthun_helpful-brands.ZBrandMetadata.html +2 -2
- 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.ZEnumInfoBuilder.html +22 -0
- package/dist/classes/_zthun_helpful-fn.ZLazy.html +2 -2
- 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.ZAggregateBuilder.html +5 -5
- 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 +16 -16
- 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 +26 -26
- 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-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.ZDateFormats.html +8 -8
- 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 +9 -9
- package/dist/enums/_zthun_helpful-query.ZOperatorBinary.html +10 -10
- 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/enums/_zthun_helpful-query.ZWellKnownIconClasses.html +5 -5
- package/dist/functions/_zthun_helpful-fn.castEnum.html +20 -0
- package/dist/functions/_zthun_helpful-fn.castExtension.html +1 -1
- package/dist/functions/_zthun_helpful-fn.castNumber.html +26 -0
- 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.culture.html +1 -1
- package/dist/functions/_zthun_helpful-fn.cultures.html +1 -1
- package/dist/functions/_zthun_helpful-fn.detokenize.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.formatDateTime.html +1 -1
- package/dist/functions/_zthun_helpful-fn.guessDateTime.html +1 -1
- package/dist/functions/_zthun_helpful-fn.isEmptyObject.html +1 -1
- package/dist/functions/_zthun_helpful-fn.isEnum.html +7 -0
- package/dist/functions/_zthun_helpful-fn.joinDefined.html +1 -1
- package/dist/functions/_zthun_helpful-fn.optional.html +2 -2
- package/dist/functions/_zthun_helpful-fn.parseDateTime.html +1 -1
- 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.pickEvents.html +1 -1
- package/dist/functions/_zthun_helpful-fn.purge.html +1 -1
- package/dist/functions/_zthun_helpful-fn.required.html +1 -1
- package/dist/functions/_zthun_helpful-fn.setFirst.html +1 -1
- package/dist/functions/_zthun_helpful-fn.sleep.html +2 -2
- package/dist/functions/_zthun_helpful-fn.tag.html +1 -1
- package/dist/functions/_zthun_helpful-fn.timeZones.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.tryJsonParse.html +2 -2
- package/dist/functions/_zthun_helpful-fn.userTimeZone.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.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.useSyncState.html +1 -1
- package/dist/functions/_zthun_helpful-react.useWindowService.html +1 -1
- package/dist/functions/_zthun_helpful-reflection.ZTag.html +1 -1
- package/dist/functions/_zthun_helpful-reflection.isTagged.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/hierarchy.html +1 -1
- package/dist/interfaces/_zthun_helpful-brands.IZBrand.html +6 -6
- package/dist/interfaces/_zthun_helpful-fn.IZDeserialize.html +2 -2
- package/dist/interfaces/_zthun_helpful-fn.IZEnumInformation.html +21 -0
- 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-query.IZAggregate.html +3 -3
- 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 +14 -14
- 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/modules/_zthun_helpful-fn.html +1 -1
- 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 +2 -2
- package/dist/types/_zthun_helpful-fn.ZCornersVertical.html +2 -2
- package/dist/types/_zthun_helpful-fn.ZDateTime.html +1 -1
- package/dist/types/_zthun_helpful-fn.ZDateTimeOptions.html +6 -6
- package/dist/types/_zthun_helpful-fn.ZDeepPartial.html +1 -1
- package/dist/types/_zthun_helpful-fn.ZMutable.html +1 -1
- package/dist/types/_zthun_helpful-fn.ZMutableKeys.html +1 -1
- package/dist/types/_zthun_helpful-fn.ZNullable.html +1 -1
- package/dist/types/_zthun_helpful-fn.ZNumberLike.html +1 -1
- package/dist/types/_zthun_helpful-fn.ZObligatedValue.html +1 -1
- package/dist/types/_zthun_helpful-fn.ZOptional.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.ZRequiredDeep.html +1 -1
- package/dist/types/_zthun_helpful-fn.ZRequiredPick.html +1 -1
- package/dist/types/_zthun_helpful-fn.ZSideAnchor.html +1 -1
- package/dist/types/_zthun_helpful-fn.ZSupplier.html +1 -1
- package/dist/types/_zthun_helpful-fn.ZSupplierAsync.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-fn._global.html +1 -1
- package/dist/variables/_zthun_helpful-fn.bash.html +1 -1
- package/dist/variables/_zthun_helpful-fn.commaJoinDefined.html +1 -1
- package/dist/variables/_zthun_helpful-fn.createGuid.html +1 -1
- package/dist/variables/_zthun_helpful-fn.css.html +1 -1
- package/dist/variables/_zthun_helpful-fn.cssJoinDefined.html +1 -1
- package/dist/variables/_zthun_helpful-fn.gib.html +1 -1
- package/dist/variables/_zthun_helpful-fn.gibibytes.html +1 -1
- package/dist/variables/_zthun_helpful-fn.html.html +1 -1
- package/dist/variables/_zthun_helpful-fn.javascript.html +1 -1
- package/dist/variables/_zthun_helpful-fn.js.html +1 -1
- package/dist/variables/_zthun_helpful-fn.kib.html +1 -1
- package/dist/variables/_zthun_helpful-fn.kibibytes.html +1 -1
- package/dist/variables/_zthun_helpful-fn.markdown.html +1 -1
- package/dist/variables/_zthun_helpful-fn.md.html +1 -1
- package/dist/variables/_zthun_helpful-fn.mebibytes.html +1 -1
- package/dist/variables/_zthun_helpful-fn.mib.html +1 -1
- package/dist/variables/_zthun_helpful-fn.pebibytes.html +1 -1
- package/dist/variables/_zthun_helpful-fn.pib.html +1 -1
- package/dist/variables/_zthun_helpful-fn.pipeJoinDefined.html +1 -1
- package/dist/variables/_zthun_helpful-fn.semiColonJoinDefined.html +1 -1
- package/dist/variables/_zthun_helpful-fn.sh.html +1 -1
- package/dist/variables/_zthun_helpful-fn.spaceJoinDefined.html +1 -1
- package/dist/variables/_zthun_helpful-fn.tebibytes.html +1 -1
- package/dist/variables/_zthun_helpful-fn.tib.html +1 -1
- package/dist/variables/_zthun_helpful-fn.ts.html +1 -1
- package/dist/variables/_zthun_helpful-fn.typescript.html +1 -1
- package/dist/variables/_zthun_helpful-fn.zsh.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/dist/variables/_zthun_helpful-react.ZFileSelectContext.html +1 -1
- package/dist/variables/_zthun_helpful-react.ZWindowServiceContext.html +1 -1
- package/package.json +7 -7
|
@@ -1,6 +1,6 @@
|
|
|
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>IZMetadata | 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">IZMetadata</a></li></ul><h1>Interface IZMetadata</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>Represents metadata about a object field.</p>
|
|
2
2
|
<p>This of this as data about the data.</p>
|
|
3
|
-
</div></section><div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">IZMetadata</span> <span class="tsd-signature-symbol">{</span><br/> <a class="tsd-kind-property" href="#cls">cls</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="#description">description</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="#editable">editable</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#fallback">fallback</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#format">format</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="#height">height</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="#id">id</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="#name">name</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="#path">path</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="#precision">precision</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="#sortable">sortable</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#type">type</a><span class="tsd-signature-symbol">:</span> <a href="../enums/_zthun_helpful-query.ZMetadataType.html" class="tsd-signature-type tsd-kind-enum">ZMetadataType</a><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#width">width</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/
|
|
3
|
+
</div></section><div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">IZMetadata</span> <span class="tsd-signature-symbol">{</span><br/> <a class="tsd-kind-property" href="#cls">cls</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="#description">description</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="#editable">editable</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#fallback">fallback</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#format">format</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="#height">height</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="#id">id</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="#name">name</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="#path">path</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="#precision">precision</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="#sortable">sortable</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#type">type</a><span class="tsd-signature-symbol">:</span> <a href="../enums/_zthun_helpful-query.ZMetadataType.html" class="tsd-signature-type tsd-kind-enum">ZMetadataType</a><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#width">width</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/3e3413f11e509602b2fbae04cbf7d6f6873a3240/packages/helpful-query/src/metadata/metadata.mts#L61">metadata/metadata.mts:61</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">Properties</h3><div class="tsd-index-list"><a href="#cls" 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>cls?</span></a>
|
|
4
4
|
<a href="#description" 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>description?</span></a>
|
|
5
5
|
<a href="#editable" 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>editable?</span></a>
|
|
6
6
|
<a href="#fallback" 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>fallback?</span></a>
|
|
@@ -21,40 +21,40 @@ value can be font-awesome to specify usage of
|
|
|
21
21
|
the refresh icon from the font-awesome set.</p>
|
|
22
22
|
<p>The actual class usage is determined by the one
|
|
23
23
|
using the metadata.</p>
|
|
24
|
-
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/
|
|
24
|
+
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/3e3413f11e509602b2fbae04cbf7d6f6873a3240/packages/helpful-query/src/metadata/metadata.mts#L136">metadata/metadata.mts:136</a></li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="description"><code class="tsd-tag">Optional</code><span>description</span><a href="#description" 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">description</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>An explanation of what the field is for.</p>
|
|
25
25
|
<p>This can act like a comment. Those looking
|
|
26
26
|
at the metadata can use this to get a better
|
|
27
27
|
idea of what the value represents.</p>
|
|
28
|
-
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/
|
|
29
|
-
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/
|
|
28
|
+
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/3e3413f11e509602b2fbae04cbf7d6f6873a3240/packages/helpful-query/src/metadata/metadata.mts#L95">metadata/metadata.mts:95</a></li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="editable"><code class="tsd-tag">Optional</code><span>editable</span><a href="#editable" 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">editable</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>Whether or not this metadata can be edited.</p>
|
|
29
|
+
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/3e3413f11e509602b2fbae04cbf7d6f6873a3240/packages/helpful-query/src/metadata/metadata.mts#L121">metadata/metadata.mts:121</a></li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="fallback"><code class="tsd-tag">Optional</code><span>fallback</span><a href="#fallback" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">fallback</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">any</span></div><div class="tsd-comment tsd-typography"><p>The default value that should be used for null or undefined
|
|
30
30
|
representations of this value.</p>
|
|
31
|
-
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/
|
|
31
|
+
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/3e3413f11e509602b2fbae04cbf7d6f6873a3240/packages/helpful-query/src/metadata/metadata.mts#L101">metadata/metadata.mts:101</a></li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="format"><code class="tsd-tag">Optional</code><span>format</span><a href="#format" 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">format</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The expected format.</p>
|
|
32
32
|
<p>The usage of this depends on the type.
|
|
33
33
|
For example, for date fields, this can be something
|
|
34
34
|
such as 'L LT' and for numbers this can be something
|
|
35
35
|
such as 'currency' or 'percentage'.</p>
|
|
36
|
-
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/
|
|
36
|
+
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/3e3413f11e509602b2fbae04cbf7d6f6873a3240/packages/helpful-query/src/metadata/metadata.mts#L111">metadata/metadata.mts:111</a></li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="height"><code class="tsd-tag">Optional</code><span>height</span><a href="#height" 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">height</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The height represented as a string.</p>
|
|
37
37
|
<p>Useful for things like icons and images.</p>
|
|
38
38
|
<p>This allows for pseudo sizes such as xs,
|
|
39
39
|
sm, lg, etc, as well as css values such as
|
|
40
40
|
24px, 2rem, etc.</p>
|
|
41
41
|
<p>The usage of this depends on the developer using it.</p>
|
|
42
|
-
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/
|
|
42
|
+
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/3e3413f11e509602b2fbae04cbf7d6f6873a3240/packages/helpful-query/src/metadata/metadata.mts#L169">metadata/metadata.mts:169</a></li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="id"><span>id</span><a href="#id" 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">id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The id.</p>
|
|
43
43
|
<p>This can be a guid or a human readable
|
|
44
44
|
value. The most important feature is that
|
|
45
45
|
this must be unique across a collection of
|
|
46
46
|
metadata.</p>
|
|
47
|
-
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/
|
|
48
|
-
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/
|
|
47
|
+
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/3e3413f11e509602b2fbae04cbf7d6f6873a3240/packages/helpful-query/src/metadata/metadata.mts#L70">metadata/metadata.mts:70</a></li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="name"><span>name</span><a href="#name" 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">name</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>Human readable name of the field data.</p>
|
|
48
|
+
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/3e3413f11e509602b2fbae04cbf7d6f6873a3240/packages/helpful-query/src/metadata/metadata.mts#L75">metadata/metadata.mts:75</a></li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="path"><code class="tsd-tag">Optional</code><span>path</span><a href="#path" 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">path</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The field path into the entity that targets
|
|
49
49
|
the value.</p>
|
|
50
|
-
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/
|
|
50
|
+
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/3e3413f11e509602b2fbae04cbf7d6f6873a3240/packages/helpful-query/src/metadata/metadata.mts#L86">metadata/metadata.mts:86</a></li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="precision"><code class="tsd-tag">Optional</code><span>precision</span><a href="#precision" 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">precision</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><div class="tsd-comment tsd-typography"><p>Decimal precision.</p>
|
|
51
51
|
<p>Useful for numbers.</p>
|
|
52
|
-
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/
|
|
53
|
-
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/
|
|
54
|
-
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/
|
|
52
|
+
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/3e3413f11e509602b2fbae04cbf7d6f6873a3240/packages/helpful-query/src/metadata/metadata.mts#L143">metadata/metadata.mts:143</a></li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="sortable"><code class="tsd-tag">Optional</code><span>sortable</span><a href="#sortable" 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">sortable</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>Whether or not this metadata can be sorted.</p>
|
|
53
|
+
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/3e3413f11e509602b2fbae04cbf7d6f6873a3240/packages/helpful-query/src/metadata/metadata.mts#L116">metadata/metadata.mts:116</a></li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="type"><span>type</span><a href="#type" 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">type</span><span class="tsd-signature-symbol">:</span> <a href="../enums/_zthun_helpful-query.ZMetadataType.html" class="tsd-signature-type tsd-kind-enum">ZMetadataType</a></div><div class="tsd-comment tsd-typography"><p>The metadata type.</p>
|
|
54
|
+
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/3e3413f11e509602b2fbae04cbf7d6f6873a3240/packages/helpful-query/src/metadata/metadata.mts#L80">metadata/metadata.mts:80</a></li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="width"><code class="tsd-tag">Optional</code><span>width</span><a href="#width" 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">width</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The width represented as a string.</p>
|
|
55
55
|
<p>Useful for things like icons and images.</p>
|
|
56
56
|
<p>This allows for pseudo sizes such as xs,
|
|
57
57
|
sm, lg, etc, as well as css values such as
|
|
58
58
|
24px, 2rem, etc.</p>
|
|
59
59
|
<p>The usage of this depends on the developer using it.</p>
|
|
60
|
-
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/
|
|
60
|
+
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/3e3413f11e509602b2fbae04cbf7d6f6873a3240/packages/helpful-query/src/metadata/metadata.mts#L156">metadata/metadata.mts:156</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-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="#cls"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>cls</span></a><a href="#description"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>description</span></a><a href="#editable"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>editable</span></a><a href="#fallback"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>fallback</span></a><a href="#format"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>format</span></a><a href="#height"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>height</span></a><a href="#id"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>id</span></a><a href="#name"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>name</span></a><a href="#path"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>path</span></a><a href="#precision"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>precision</span></a><a href="#sortable"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>sortable</span></a><a href="#type"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>type</span></a><a href="#width"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>width</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,7 +1,7 @@
|
|
|
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>IZPage | 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">IZPage</a></li></ul><h1>Interface IZPage<T></h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>Represents a page of data.</p>
|
|
2
2
|
</div></section><div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">IZPage</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#t">T</a><span class="tsd-signature-symbol">></span> <span class="tsd-signature-symbol">{</span><br/> <a class="tsd-kind-property" href="#count">count</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="#data">data</a><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#t">T</a><span class="tsd-signature-symbol">[]</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 id="t"><span class="tsd-kind-type-parameter">T</span></span><div class="tsd-comment tsd-typography"><p>The type of data on the page.</p>
|
|
3
|
-
</div></li></ul></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/
|
|
3
|
+
</div></li></ul></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/3e3413f11e509602b2fbae04cbf7d6f6873a3240/packages/helpful-query/src/page/page.mts#L7">page/page.mts:7</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><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">Properties</h3><div class="tsd-index-list"><a href="#count" 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>count</span></a>
|
|
4
4
|
<a href="#data" 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>data</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"><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="count"><span>count</span><a href="#count" 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">count</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><div class="tsd-comment tsd-typography"><p>The total number of items across all pages.</p>
|
|
6
|
-
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/
|
|
7
|
-
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/
|
|
6
|
+
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/3e3413f11e509602b2fbae04cbf7d6f6873a3240/packages/helpful-query/src/page/page.mts#L11">page/page.mts:11</a></li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="data"><span>data</span><a href="#data" 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">data</span><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#t">T</a><span class="tsd-signature-symbol">[]</span></div><div class="tsd-comment tsd-typography"><p>The current data view on the page.</p>
|
|
7
|
+
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/3e3413f11e509602b2fbae04cbf7d6f6873a3240/packages/helpful-query/src/page/page.mts#L15">page/page.mts:15</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-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="#count"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>count</span></a><a href="#data"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>data</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,6 +1,6 @@
|
|
|
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>IZSort | 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">IZSort</a></li></ul><h1>Interface IZSort</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>Represents an option for sorting.</p>
|
|
2
|
-
</div></section><div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">IZSort</span> <span class="tsd-signature-symbol">{</span><br/> <a class="tsd-kind-property" href="#direction">direction</a><span class="tsd-signature-symbol">:</span> <a href="../enums/_zthun_helpful-query.ZSortDirection.html" class="tsd-signature-type tsd-kind-enum">ZSortDirection</a><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#subject">subject</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></section><div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">IZSort</span> <span class="tsd-signature-symbol">{</span><br/> <a class="tsd-kind-property" href="#direction">direction</a><span class="tsd-signature-symbol">:</span> <a href="../enums/_zthun_helpful-query.ZSortDirection.html" class="tsd-signature-type tsd-kind-enum">ZSortDirection</a><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#subject">subject</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/3e3413f11e509602b2fbae04cbf7d6f6873a3240/packages/helpful-query/src/sort/sort.mts#L20">sort/sort.mts:20</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><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">Properties</h3><div class="tsd-index-list"><a href="#direction" 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>direction</span></a>
|
|
3
3
|
<a href="#subject" 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>subject?</span></a>
|
|
4
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-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="direction"><span>direction</span><a href="#direction" 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">direction</span><span class="tsd-signature-symbol">:</span> <a href="../enums/_zthun_helpful-query.ZSortDirection.html" class="tsd-signature-type tsd-kind-enum">ZSortDirection</a></div><div class="tsd-comment tsd-typography"><p>The direction to sort.</p>
|
|
5
|
-
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/
|
|
6
|
-
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/
|
|
5
|
+
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/3e3413f11e509602b2fbae04cbf7d6f6873a3240/packages/helpful-query/src/sort/sort.mts#L29">sort/sort.mts:29</a></li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="subject"><code class="tsd-tag">Optional</code><span>subject</span><a href="#subject" 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">subject</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The subject to sort by.</p>
|
|
6
|
+
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/3e3413f11e509602b2fbae04cbf7d6f6873a3240/packages/helpful-query/src/sort/sort.mts#L24">sort/sort.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"><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-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="#direction"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>direction</span></a><a href="#subject"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>subject</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>IZSorter | 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">IZSorter</a></li></ul><h1>Interface IZSorter</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>Represents a sorter algorithm that can help with building sorts based on common techniques.</p>
|
|
2
|
-
</div></section><div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">IZSorter</span> <span class="tsd-signature-symbol">{</span><br/> <a class="tsd-kind-call-signature" href="#index-1">index</a><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><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-call-signature" href="#sort-1">sort</a><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="_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/> <a class="tsd-kind-call-signature" href="#sorted-1">sorted</a><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="../enums/_zthun_helpful-query.ZSortDirection.html" class="tsd-signature-type tsd-kind-enum">ZSortDirection</a> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></div><section class="tsd-panel"><h4>Implemented by</h4><ul class="tsd-hierarchy"><li><a href="../classes/_zthun_helpful-query.ZSorterSingle.html" class="tsd-signature-type tsd-kind-class">ZSorterSingle</a></li></ul></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/
|
|
2
|
+
</div></section><div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">IZSorter</span> <span class="tsd-signature-symbol">{</span><br/> <a class="tsd-kind-call-signature" href="#index-1">index</a><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><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-call-signature" href="#sort-1">sort</a><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="_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/> <a class="tsd-kind-call-signature" href="#sorted-1">sorted</a><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="../enums/_zthun_helpful-query.ZSortDirection.html" class="tsd-signature-type tsd-kind-enum">ZSortDirection</a> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></div><section class="tsd-panel"><h4>Implemented by</h4><ul class="tsd-hierarchy"><li><a href="../classes/_zthun_helpful-query.ZSorterSingle.html" class="tsd-signature-type tsd-kind-class">ZSorterSingle</a></li></ul></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/3e3413f11e509602b2fbae04cbf7d6f6873a3240/packages/helpful-query/src/sort/sorter.mts#L6">sort/sorter.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">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>
|
|
3
3
|
<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>
|
|
4
4
|
<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>
|
|
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"><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>
|
|
@@ -7,11 +7,11 @@
|
|
|
7
7
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">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
|
|
8
8
|
should be considered the empty string (the object itself).</p>
|
|
9
9
|
</div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4><p>The current sort index.</p>
|
|
10
|
-
<aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/
|
|
10
|
+
<aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/3e3413f11e509602b2fbae04cbf7d6f6873a3240/packages/helpful-query/src/sort/sorter.mts#L19">sort/sorter.mts:19</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="_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>
|
|
11
11
|
</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
|
|
12
12
|
empty string.</p>
|
|
13
13
|
</div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="_zthun_helpful-query.IZSort.html" class="tsd-signature-type tsd-kind-interface">IZSort</a><span class="tsd-signature-symbol">[]</span></h4><p>The updated sort list.</p>
|
|
14
|
-
<aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/
|
|
14
|
+
<aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/3e3413f11e509602b2fbae04cbf7d6f6873a3240/packages/helpful-query/src/sort/sorter.mts#L40">sort/sorter.mts:40</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> <a href="../enums/_zthun_helpful-query.ZSortDirection.html" class="tsd-signature-type tsd-kind-enum">ZSortDirection</a> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">undefined</span><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>
|
|
15
15
|
</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
|
|
16
16
|
empty string (the object itself).</p>
|
|
17
|
-
</div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="../enums/_zthun_helpful-query.ZSortDirection.html" class="tsd-signature-type tsd-kind-enum">ZSortDirection</a> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">undefined</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/
|
|
17
|
+
</div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="../enums/_zthun_helpful-query.ZSortDirection.html" class="tsd-signature-type tsd-kind-enum">ZSortDirection</a> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">undefined</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/3e3413f11e509602b2fbae04cbf7d6f6873a3240/packages/helpful-query/src/sort/sorter.mts#L28">sort/sorter.mts:28</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-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>
|
|
@@ -3,8 +3,8 @@
|
|
|
3
3
|
we have to use callbacks instead of promises in the case that the
|
|
4
4
|
user cancels. If the user cancels, then we don't want to wind up
|
|
5
5
|
with a memory leak with the promise.</p>
|
|
6
|
-
</div></section><div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">IZFileSelect</span> <span class="tsd-signature-symbol">{</span><br/> <a class="tsd-kind-call-signature" href="#open-1">open</a><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><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></div><section class="tsd-panel"><h4>Implemented by</h4><ul class="tsd-hierarchy"><li><a href="../classes/_zthun_helpful-react.ZFileSelect.html" class="tsd-signature-type tsd-kind-class">ZFileSelect</a></li></ul></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/
|
|
6
|
+
</div></section><div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">IZFileSelect</span> <span class="tsd-signature-symbol">{</span><br/> <a class="tsd-kind-call-signature" href="#open-1">open</a><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><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></div><section class="tsd-panel"><h4>Implemented by</h4><ul class="tsd-hierarchy"><li><a href="../classes/_zthun_helpful-react.ZFileSelect.html" class="tsd-signature-type tsd-kind-class">ZFileSelect</a></li></ul></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/3e3413f11e509602b2fbae04cbf7d6f6873a3240/packages/helpful-react/src/file-select/file-select.mts#L21">file-select/file-select.mts:21</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">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>
|
|
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-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 select dialog.</p>
|
|
8
8
|
</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 filter.</p>
|
|
9
9
|
</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 if the user accepts the file.</p>
|
|
10
|
-
</div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/
|
|
10
|
+
</div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/3e3413f11e509602b2fbae04cbf7d6f6873a3240/packages/helpful-react/src/file-select/file-select.mts#L30">file-select/file-select.mts:30</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-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>
|