@zthun/helpful-web 6.3.0 → 6.4.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/assets/icons.js +1 -1
- package/dist/assets/icons.svg +1 -1
- package/dist/assets/main.js +1 -1
- package/dist/assets/search.js +1 -1
- package/dist/assets/style.css +66 -21
- package/dist/classes/_zthun_helpful_brands.ZBrandBuilder.html +44 -44
- package/dist/classes/_zthun_helpful_fn.ZAssert.html +6 -6
- package/dist/classes/_zthun_helpful_fn.ZDeserializeJson.html +5 -5
- package/dist/classes/_zthun_helpful_fn.ZDeserializeTry.html +5 -5
- package/dist/classes/_zthun_helpful_fn.ZQuadrilateralBuilder.html +12 -12
- package/dist/classes/_zthun_helpful_fn.ZQuadrilateralCornersBuilder.html +14 -14
- package/dist/classes/_zthun_helpful_fn.ZRectangle.html +26 -17
- package/dist/classes/_zthun_helpful_fn.ZSerializeJson.html +3 -3
- package/dist/classes/_zthun_helpful_internet.ZCookieBuilder.html +17 -17
- package/dist/classes/_zthun_helpful_internet.ZEmailBuilder.html +9 -9
- package/dist/classes/_zthun_helpful_internet.ZEmailContactAddressBuilder.html +6 -6
- package/dist/classes/_zthun_helpful_internet.ZEmailContactBuilder.html +9 -9
- package/dist/classes/_zthun_helpful_internet.ZEmailEnvelopeBuilder.html +13 -13
- package/dist/classes/_zthun_helpful_internet.ZServerBuilder.html +10 -10
- package/dist/classes/_zthun_helpful_query.ZDataFilterFields.html +3 -3
- package/dist/classes/_zthun_helpful_query.ZDataMatchAlways.html +3 -3
- package/dist/classes/_zthun_helpful_query.ZDataMatchOptional.html +4 -4
- package/dist/classes/_zthun_helpful_query.ZDataRequestBuilder.html +11 -11
- package/dist/classes/_zthun_helpful_query.ZDataSearchFields.html +4 -4
- package/dist/classes/_zthun_helpful_query.ZDataSearchText.html +3 -3
- package/dist/classes/_zthun_helpful_query.ZDataSourceStatic.html +10 -10
- package/dist/classes/_zthun_helpful_query.ZDataSourceStaticOptionsBuilder.html +10 -10
- package/dist/classes/_zthun_helpful_query.ZFilterBinaryBuilder.html +15 -15
- package/dist/classes/_zthun_helpful_query.ZFilterCollectionBuilder.html +11 -11
- package/dist/classes/_zthun_helpful_query.ZFilterDeserialize.html +4 -4
- package/dist/classes/_zthun_helpful_query.ZFilterLogicBuilder.html +10 -10
- package/dist/classes/_zthun_helpful_query.ZFilterSerialize.html +3 -3
- package/dist/classes/_zthun_helpful_query.ZFilterUnaryBuilder.html +9 -9
- package/dist/classes/_zthun_helpful_query.ZMetadataBuilder.html +23 -23
- package/dist/classes/_zthun_helpful_query.ZPageBuilder.html +10 -10
- package/dist/classes/_zthun_helpful_query.ZSortBuilder.html +8 -8
- package/dist/classes/_zthun_helpful_query.ZSortDeserialize.html +4 -4
- package/dist/classes/_zthun_helpful_query.ZSortSerialize.html +3 -3
- package/dist/classes/_zthun_helpful_query.ZSorterSingle.html +6 -6
- package/dist/classes/_zthun_helpful_query.ZWellKnownIconClasses.html +11 -11
- package/dist/classes/_zthun_helpful_react.ZFileSelect.html +4 -4
- package/dist/classes/_zthun_helpful_validation.EqualsOtherPropertyValidator.html +3 -3
- package/dist/classes/_zthun_helpful_validation.IsDataURILimitValidator.html +3 -3
- package/dist/classes/_zthun_helpful_validation.IsNotWhiteSpaceValidator.html +3 -3
- package/dist/classes/_zthun_helpful_validation.RequiresOtherPropertyValidator.html +3 -3
- package/dist/enums/_zthun_helpful_fn.ZHorizontalAnchor.html +6 -6
- package/dist/enums/_zthun_helpful_fn.ZOrientation.html +5 -5
- package/dist/enums/_zthun_helpful_fn.ZVerticalAnchor.html +6 -6
- 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 +5 -5
- package/dist/enums/_zthun_helpful_query.ZOperatorLogic.html +5 -5
- package/dist/enums/_zthun_helpful_query.ZOperatorUnary.html +5 -5
- package/dist/enums/_zthun_helpful_query.ZSortDirection.html +5 -5
- package/dist/functions/_zthun_helpful_fn.bash.html +3 -3
- package/dist/functions/_zthun_helpful_fn.commaJoinDefined.html +4 -4
- package/dist/functions/_zthun_helpful_fn.countBuckets.html +3 -3
- package/dist/functions/_zthun_helpful_fn.createError.html +3 -3
- package/dist/functions/_zthun_helpful_fn.createGuid.html +4 -4
- package/dist/functions/_zthun_helpful_fn.css.html +3 -3
- package/dist/functions/_zthun_helpful_fn.cssJoinDefined.html +4 -4
- package/dist/functions/_zthun_helpful_fn.firstDefined.html +3 -3
- package/dist/functions/_zthun_helpful_fn.firstTruthy.html +3 -3
- package/dist/functions/_zthun_helpful_fn.firstWhere.html +2 -2
- package/dist/functions/_zthun_helpful_fn.html.html +3 -3
- package/dist/functions/_zthun_helpful_fn.isEmptyObject.html +2 -2
- package/dist/functions/_zthun_helpful_fn.javascript.html +3 -3
- package/dist/functions/_zthun_helpful_fn.joinDefined.html +3 -3
- package/dist/functions/_zthun_helpful_fn.js.html +3 -3
- package/dist/functions/_zthun_helpful_fn.markdown.html +3 -3
- package/dist/functions/_zthun_helpful_fn.md.html +3 -3
- package/dist/functions/_zthun_helpful_fn.optional.html +8 -8
- package/dist/functions/_zthun_helpful_fn.peel.html +2 -2
- package/dist/functions/_zthun_helpful_fn.peelBetween.html +3 -3
- package/dist/functions/_zthun_helpful_fn.pickBy.html +2 -2
- package/dist/functions/_zthun_helpful_fn.pickDataAttributes.html +2 -2
- package/dist/functions/_zthun_helpful_fn.pickDefined.html +2 -2
- package/dist/functions/_zthun_helpful_fn.pipeJoinDefined.html +4 -4
- package/dist/functions/_zthun_helpful_fn.required.html +3 -3
- package/dist/functions/_zthun_helpful_fn.semiColonJoinDefined.html +4 -4
- package/dist/functions/_zthun_helpful_fn.setFirst.html +3 -3
- package/dist/functions/_zthun_helpful_fn.sh.html +3 -3
- package/dist/functions/_zthun_helpful_fn.sleep.html +7 -7
- package/dist/functions/_zthun_helpful_fn.spaceJoinDefined.html +4 -4
- package/dist/functions/_zthun_helpful_fn.tag.html +3 -3
- package/dist/functions/_zthun_helpful_fn.tryFallback.html +7 -7
- package/dist/functions/_zthun_helpful_fn.tryFallbackAsync.html +7 -7
- package/dist/functions/_zthun_helpful_fn.ts.html +3 -3
- package/dist/functions/_zthun_helpful_fn.typescript.html +3 -3
- package/dist/functions/_zthun_helpful_fn.zsh.html +3 -3
- package/dist/functions/_zthun_helpful_node.walk.html +3 -3
- package/dist/functions/_zthun_helpful_query.isBinaryFilter.html +2 -2
- package/dist/functions/_zthun_helpful_query.isBinaryOperator.html +2 -2
- package/dist/functions/_zthun_helpful_query.isCollectionFilter.html +2 -2
- package/dist/functions/_zthun_helpful_query.isCollectionOperator.html +2 -2
- package/dist/functions/_zthun_helpful_query.isLogicFilter.html +2 -2
- package/dist/functions/_zthun_helpful_query.isLogicOperator.html +2 -2
- package/dist/functions/_zthun_helpful_query.isUnaryFilter.html +2 -2
- package/dist/functions/_zthun_helpful_query.isUnaryOperator.html +2 -2
- package/dist/functions/_zthun_helpful_react.asStateData.html +8 -8
- package/dist/functions/_zthun_helpful_react.asStateError.html +2 -2
- package/dist/functions/_zthun_helpful_react.isStateErrored.html +2 -2
- package/dist/functions/_zthun_helpful_react.isStateLoaded.html +2 -2
- package/dist/functions/_zthun_helpful_react.isStateLoading.html +2 -2
- package/dist/functions/_zthun_helpful_react.useAmbassadorState.html +9 -9
- package/dist/functions/_zthun_helpful_react.useAsyncState.html +2 -2
- package/dist/functions/_zthun_helpful_react.useFileSelect.html +2 -2
- package/dist/functions/_zthun_helpful_react.useKeyboardActivate.html +2 -2
- package/dist/functions/_zthun_helpful_react.useMoreViewState.html +2 -2
- package/dist/functions/_zthun_helpful_react.usePageViewState.html +2 -2
- package/dist/functions/_zthun_helpful_react.useStateAsArray.html +2 -2
- package/dist/functions/_zthun_helpful_react.useWindowService.html +2 -2
- package/dist/functions/_zthun_helpful_validation.EqualsOtherProperty.html +2 -2
- package/dist/functions/_zthun_helpful_validation.IsDataURILimit.html +2 -2
- package/dist/functions/_zthun_helpful_validation.IsNotWhiteSpace.html +2 -2
- package/dist/functions/_zthun_helpful_validation.RequiresOtherProperty.html +2 -2
- package/dist/hierarchy.html +1 -1
- package/dist/index.html +2 -2
- package/dist/interfaces/_zthun_helpful_brands.IZBrand.html +7 -7
- package/dist/interfaces/_zthun_helpful_fn.IZDeserialize.html +4 -4
- package/dist/interfaces/_zthun_helpful_fn.IZPoint2d.html +4 -4
- package/dist/interfaces/_zthun_helpful_fn.IZPoint3d.html +5 -5
- package/dist/interfaces/_zthun_helpful_fn.IZQuadrilateral.html +6 -6
- package/dist/interfaces/_zthun_helpful_fn.IZQuadrilateralCorners.html +3 -3
- package/dist/interfaces/_zthun_helpful_fn.IZSerialize.html +3 -3
- package/dist/interfaces/_zthun_helpful_internet.IZCookie.html +9 -9
- package/dist/interfaces/_zthun_helpful_internet.IZEmail.html +5 -5
- package/dist/interfaces/_zthun_helpful_internet.IZEmailContact.html +5 -5
- package/dist/interfaces/_zthun_helpful_internet.IZEmailEnvelope.html +6 -6
- package/dist/interfaces/_zthun_helpful_internet.IZServer.html +6 -6
- package/dist/interfaces/_zthun_helpful_node.ZWalkOptions.html +6 -6
- package/dist/interfaces/_zthun_helpful_query.IZDataMatch.html +3 -3
- package/dist/interfaces/_zthun_helpful_query.IZDataRequest.html +10 -10
- package/dist/interfaces/_zthun_helpful_query.IZDataRequestQuery.html +7 -7
- package/dist/interfaces/_zthun_helpful_query.IZDataSource.html +4 -4
- package/dist/interfaces/_zthun_helpful_query.IZDataSourceStaticOptions.html +5 -5
- package/dist/interfaces/_zthun_helpful_query.IZFilterBinary.html +6 -6
- package/dist/interfaces/_zthun_helpful_query.IZFilterCollection.html +6 -6
- package/dist/interfaces/_zthun_helpful_query.IZFilterLogic.html +5 -5
- package/dist/interfaces/_zthun_helpful_query.IZFilterMetadata.html +3 -3
- package/dist/interfaces/_zthun_helpful_query.IZFilterOperator.html +4 -4
- package/dist/interfaces/_zthun_helpful_query.IZFilterSubject.html +5 -5
- package/dist/interfaces/_zthun_helpful_query.IZMetadata.html +13 -13
- package/dist/interfaces/_zthun_helpful_query.IZPage.html +4 -4
- package/dist/interfaces/_zthun_helpful_query.IZSort.html +4 -4
- package/dist/interfaces/_zthun_helpful_query.IZSorter.html +5 -5
- package/dist/interfaces/_zthun_helpful_react.IZFileSelect.html +3 -3
- package/dist/interfaces/_zthun_helpful_react.IZKeyboardInteraction.html +4 -4
- package/dist/modules/_zthun_helpful_brands.html +2 -2
- package/dist/modules/_zthun_helpful_fn.html +2 -2
- package/dist/modules/_zthun_helpful_internet.html +2 -2
- package/dist/modules/_zthun_helpful_node.html +2 -2
- package/dist/modules/_zthun_helpful_proxy.html +2 -2
- package/dist/modules/_zthun_helpful_query.html +2 -2
- package/dist/modules/_zthun_helpful_react.html +2 -2
- package/dist/modules/_zthun_helpful_validation.html +2 -2
- package/dist/modules.html +2 -0
- package/dist/types/_zthun_helpful_fn.JoinListInputParameter.html +2 -2
- package/dist/types/_zthun_helpful_fn.PickPredicate.html +1 -1
- package/dist/types/_zthun_helpful_fn.PickResult.html +1 -1
- package/dist/types/_zthun_helpful_fn.RequiredDeep.html +1 -1
- package/dist/types/_zthun_helpful_fn.RequiredPick.html +1 -1
- package/dist/types/_zthun_helpful_fn.ZAnchor.html +4 -4
- package/dist/types/_zthun_helpful_fn.ZObligatedValue.html +2 -2
- package/dist/types/_zthun_helpful_fn.ZQuadrilateralCornersLike.html +2 -2
- package/dist/types/_zthun_helpful_fn.ZQuadrilateralLike.html +2 -2
- package/dist/types/_zthun_helpful_fn.ZSideAnchor.html +2 -2
- package/dist/types/_zthun_helpful_query.IZFilter.html +2 -2
- package/dist/types/_zthun_helpful_query.IZFilterUnary.html +2 -2
- package/dist/types/_zthun_helpful_query.ZOperatorFilter.html +2 -2
- package/dist/types/_zthun_helpful_react.ZAmbassadorReducer.html +2 -2
- package/dist/types/_zthun_helpful_react.ZAmbassadorReducerRequired.html +2 -2
- package/dist/types/_zthun_helpful_react.ZAmbassadorSetCurrent.html +2 -2
- package/dist/types/_zthun_helpful_react.ZAsyncDataState.html +2 -2
- package/dist/types/_zthun_helpful_react.ZAsyncDataTuple.html +2 -2
- package/dist/types/_zthun_helpful_react.ZAsyncUseData.html +2 -2
- package/dist/types/_zthun_helpful_react.ZSetStateAsArray.html +1 -1
- package/dist/types/_zthun_helpful_react.ZStateAsArrayReducer.html +1 -1
- package/dist/variables/_zthun_helpful_brands.ZBrands.html +2 -2
- package/dist/variables/_zthun_helpful_fn._global.html +1 -1
- package/dist/variables/_zthun_helpful_query.ZBinaryComparators.html +2 -2
- package/dist/variables/_zthun_helpful_query.ZCollectionComparators.html +2 -2
- package/dist/variables/_zthun_helpful_query.ZOperatorsBinary.html +2 -2
- package/dist/variables/_zthun_helpful_query.ZOperatorsCollection.html +2 -2
- package/dist/variables/_zthun_helpful_query.ZOperatorsFilter.html +2 -2
- package/dist/variables/_zthun_helpful_query.ZOperatorsLogic.html +2 -2
- package/dist/variables/_zthun_helpful_query.ZOperatorsUnary.html +2 -2
- package/dist/variables/_zthun_helpful_query.ZSortDirections.html +2 -2
- package/dist/variables/_zthun_helpful_query.ZUnaryComparators.html +2 -2
- package/dist/variables/_zthun_helpful_react.DefaultActivateCodes.html +2 -2
- package/dist/variables/_zthun_helpful_react.ZAsyncLoading.html +2 -2
- package/dist/variables/_zthun_helpful_react.ZFileSelectContext.html +2 -2
- package/dist/variables/_zthun_helpful_react.ZWindowServiceContext.html +2 -2
- package/package.json +12 -12
|
@@ -1,17 +1,17 @@
|
|
|
1
1
|
<!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>tryFallbackAsync | Helpful</title><meta name="description" content="Documentation for Helpful"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><link rel="icon" href="../helpful.svg" />
|
|
2
|
-
</head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">Helpful</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../
|
|
3
|
-
</div><div class="tsd-comment tsd-typography"><h4 class="tsd-anchor-link"><a id="Param: candidate" class="tsd-anchor"></a>Param: candidate<a href="#Param: candidate" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>The candidate function to run.</p>
|
|
4
|
-
|
|
5
|
-
|
|
2
|
+
</head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">Helpful</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../modules.html">Helpful</a></li><li><a href="../modules/_zthun_helpful_fn.html">@zthun/helpful-fn</a></li><li><a href="_zthun_helpful_fn.tryFallbackAsync.html">tryFallbackAsync</a></li></ul><h1>Function tryFallbackAsync</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>Invokes the candidate function and returns undefined if an rejected promise is returned from it.</p>
|
|
3
|
+
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-Param: candidate"><h4 class="tsd-anchor-link"><a id="Param: candidate" class="tsd-anchor"></a>Param: candidate<a href="#Param: candidate" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>The candidate function to run.</p>
|
|
4
|
+
</div><div class="tsd-tag-Param: fallback"><h4 class="tsd-anchor-link"><a id="Param: fallback" class="tsd-anchor"></a>Param: fallback<a href="#Param: fallback" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>The optional fallback value to return if the candidate throws an Error.</p>
|
|
5
|
+
</div><div class="tsd-tag-Returns"><h4 class="tsd-anchor-link"><a id="Returns" class="tsd-anchor"></a>Returns<a href="#Returns" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>A promise that resolves with the result from candidate or fallback
|
|
6
6
|
if candidate returns a rejected promise. Resolves with undefined
|
|
7
7
|
if no fallback is provided.</p>
|
|
8
|
-
</div></section><section class="tsd-panel"><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="tryFallbackAsync" class="tsd-anchor"></a><span class="tsd-kind-call-signature">try<wbr/>Fallback<wbr/>Async</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful_fn.tryFallbackAsync.html#tryFallbackAsync.T">T</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">candidate</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful_fn.tryFallbackAsync.html#tryFallbackAsync.T">T</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">></span><a href="#tryFallbackAsync" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Invokes the candidate function and returns undefined if an rejected promise is returned from it.</p>
|
|
8
|
+
</div></div></section><section class="tsd-panel"><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="tryFallbackAsync" class="tsd-anchor"></a><span class="tsd-kind-call-signature">try<wbr/>Fallback<wbr/>Async</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful_fn.tryFallbackAsync.html#tryFallbackAsync.T">T</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">candidate</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful_fn.tryFallbackAsync.html#tryFallbackAsync.T">T</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">></span><a href="#tryFallbackAsync" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Invokes the candidate function and returns undefined if an rejected promise is returned from it.</p>
|
|
9
9
|
</div><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a id="tryFallbackAsync.T" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">T</span></span></li></ul></section><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">candidate</span>: <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful_fn.tryFallbackAsync.html#tryFallbackAsync.T">T</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span></span><div class="tsd-comment tsd-typography"><p>The candidate function to run.</p>
|
|
10
10
|
</div><div class="tsd-comment tsd-typography"></div><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful_fn.tryFallbackAsync.html#tryFallbackAsync.T">T</a><span class="tsd-signature-symbol">></span></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful_fn.tryFallbackAsync.html#tryFallbackAsync.T">T</a><span class="tsd-signature-symbol">></span></h4></li></ul></li></ul></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful_fn.tryFallbackAsync.html#tryFallbackAsync.T">T</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">></span></h4><p>A promise that resolves with the result from candidate. Returns undefined
|
|
11
11
|
if candidate returns a rejected promise.</p>
|
|
12
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/
|
|
12
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/cffdc645947069d32dcd73c87f0b40e230a5f2fb/packages/helpful-fn/src/try-fallback/try-fallback.mts#L58">packages/helpful-fn/src/try-fallback/try-fallback.mts:58</a></li></ul></aside></li><li class="tsd-signature tsd-anchor-link"><a id="tryFallbackAsync-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">try<wbr/>Fallback<wbr/>Async</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful_fn.tryFallbackAsync.html#tryFallbackAsync-1.T-1">T</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">candidate</span>, <span class="tsd-kind-parameter">fallback</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful_fn.tryFallbackAsync.html#tryFallbackAsync-1.T-1">T</a><span class="tsd-signature-symbol">></span><a href="#tryFallbackAsync-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Invokes the candidate function and returns undefined if an rejected promise is returned from it.</p>
|
|
13
13
|
</div><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a id="tryFallbackAsync-1.T-1" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">T</span></span></li></ul></section><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">candidate</span>: <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful_fn.tryFallbackAsync.html#tryFallbackAsync-1.T-1">T</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span></span><div class="tsd-comment tsd-typography"><p>The candidate function to run.</p>
|
|
14
14
|
</div><div class="tsd-comment tsd-typography"></div><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful_fn.tryFallbackAsync.html#tryFallbackAsync-1.T-1">T</a><span class="tsd-signature-symbol">></span></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful_fn.tryFallbackAsync.html#tryFallbackAsync-1.T-1">T</a><span class="tsd-signature-symbol">></span></h4></li></ul></li></ul></li><li><span><span class="tsd-kind-parameter">fallback</span>: <a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful_fn.tryFallbackAsync.html#tryFallbackAsync-1.T-1">T</a></span><div class="tsd-comment tsd-typography"><p>The fallback value that will be returned if candidate returns a rejected promise.</p>
|
|
15
15
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful_fn.tryFallbackAsync.html#tryFallbackAsync-1.T-1">T</a><span class="tsd-signature-symbol">></span></h4><p>A promise that resolves with the result from candidate. Returns fallback
|
|
16
16
|
if candidate returns a rejected promise.</p>
|
|
17
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/
|
|
17
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/cffdc645947069d32dcd73c87f0b40e230a5f2fb/packages/helpful-fn/src/try-fallback/try-fallback.mts#L74">packages/helpful-fn/src/try-fallback/try-fallback.mts:74</a></li></ul></aside></li></ul></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>Helpful</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
<!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>ts | Helpful</title><meta name="description" content="Documentation for Helpful"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><link rel="icon" href="../helpful.svg" />
|
|
2
|
-
</head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">Helpful</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../
|
|
2
|
+
</head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">Helpful</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../modules.html">Helpful</a></li><li><a href="../modules/_zthun_helpful_fn.html">@zthun/helpful-fn</a></li><li><a href="_zthun_helpful_fn.ts.html">ts</a></li></ul><h1>Function ts</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>An alias for <a href="_zthun_helpful_fn.tag.html" class="tsd-kind-function">tag</a>.</p>
|
|
3
3
|
<p>Some <a href="https://marketplace.visualstudio.com/items?itemName=HoodieCollin.es6-string-typescript">IDE extensions will detect the string</a>
|
|
4
4
|
interpolation as typescript when using this tag.</p>
|
|
5
5
|
</div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel"><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="ts" class="tsd-anchor"></a><span class="tsd-kind-call-signature">ts</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">strings</span>, <span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">expressions</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#ts" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>This is just a method that allows you to tag an interpolation
|
|
@@ -11,7 +11,7 @@ and do the syntax highlighting for you.</p>
|
|
|
11
11
|
the single string literal.</p>
|
|
12
12
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><p>The compiled string literal. This is no different
|
|
13
13
|
than letting native JavaScript do it for you.</p>
|
|
14
|
-
<div class="tsd-comment tsd-typography"><h4 class="tsd-anchor-link"><a id="Example" class="tsd-anchor"></a>Example<a href="#Example" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-4">const</span><span class="hl-2"> </span><span class="hl-7">html</span><span class="hl-2"> = </span><span class="hl-6">tag</span><span class="hl-2">;</span><br/><span class="hl-4">const</span><span class="hl-2"> </span><span class="hl-7">css</span><span class="hl-2"> = </span><span class="hl-6">tag</span><span class="hl-2">;</span><br/><br/><span class="hl-4">const</span><span class="hl-2"> </span><span class="hl-7">$html</span><span class="hl-2"> = </span><span class="hl-1">html</span><span class="hl-3">`</span><br/><span class="hl-3"> <div>Some IDE extensions will highlight this as html</div></span><br/><span class="hl-3">`</span><br/><br/><span class="hl-4">const</span><span class="hl-2"> </span><span class="hl-7">$css</span><span class="hl-2"> = </span><span class="hl-1">css</span><span class="hl-3">`</span><br/><span class="hl-3"> button {</span><br/><span class="hl-3"> display: grid;</span><br/><span class="hl-3"> }</span><br/><span class="hl-3">`</span>
|
|
14
|
+
<div class="tsd-comment tsd-typography"><div class="tsd-tag-Example"><h4 class="tsd-anchor-link"><a id="Example" class="tsd-anchor"></a>Example<a href="#Example" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-4">const</span><span class="hl-2"> </span><span class="hl-7">html</span><span class="hl-2"> = </span><span class="hl-6">tag</span><span class="hl-2">;</span><br/><span class="hl-4">const</span><span class="hl-2"> </span><span class="hl-7">css</span><span class="hl-2"> = </span><span class="hl-6">tag</span><span class="hl-2">;</span><br/><br/><span class="hl-4">const</span><span class="hl-2"> </span><span class="hl-7">$html</span><span class="hl-2"> = </span><span class="hl-1">html</span><span class="hl-3">`</span><br/><span class="hl-3"> <div>Some IDE extensions will highlight this as html</div></span><br/><span class="hl-3">`</span><br/><br/><span class="hl-4">const</span><span class="hl-2"> </span><span class="hl-7">$css</span><span class="hl-2"> = </span><span class="hl-1">css</span><span class="hl-3">`</span><br/><span class="hl-3"> button {</span><br/><span class="hl-3"> display: grid;</span><br/><span class="hl-3"> }</span><br/><span class="hl-3">`</span>
|
|
15
15
|
</code><button type="button">Copy</button></pre>
|
|
16
16
|
|
|
17
|
-
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/
|
|
17
|
+
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/cffdc645947069d32dcd73c87f0b40e230a5f2fb/packages/helpful-fn/src/tag/tag.mts#L97">packages/helpful-fn/src/tag/tag.mts:97</a></li></ul></aside></li></ul></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>Helpful</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
<!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>typescript | Helpful</title><meta name="description" content="Documentation for Helpful"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><link rel="icon" href="../helpful.svg" />
|
|
2
|
-
</head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">Helpful</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../
|
|
2
|
+
</head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">Helpful</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../modules.html">Helpful</a></li><li><a href="../modules/_zthun_helpful_fn.html">@zthun/helpful-fn</a></li><li><a href="_zthun_helpful_fn.typescript.html">typescript</a></li></ul><h1>Function typescript</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>See <a href="_zthun_helpful_fn.ts.html" class="tsd-kind-function">ts</a></p>
|
|
3
3
|
</div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel"><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="typescript" class="tsd-anchor"></a><span class="tsd-kind-call-signature">typescript</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">strings</span>, <span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">expressions</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#typescript" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>This is just a method that allows you to tag an interpolation
|
|
4
4
|
string as a syntax language.</p>
|
|
5
5
|
<p>This is useful with IDE extensions that can detect the language
|
|
@@ -9,7 +9,7 @@ and do the syntax highlighting for you.</p>
|
|
|
9
9
|
the single string literal.</p>
|
|
10
10
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><p>The compiled string literal. This is no different
|
|
11
11
|
than letting native JavaScript do it for you.</p>
|
|
12
|
-
<div class="tsd-comment tsd-typography"><h4 class="tsd-anchor-link"><a id="Example" class="tsd-anchor"></a>Example<a href="#Example" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-4">const</span><span class="hl-2"> </span><span class="hl-7">html</span><span class="hl-2"> = </span><span class="hl-6">tag</span><span class="hl-2">;</span><br/><span class="hl-4">const</span><span class="hl-2"> </span><span class="hl-7">css</span><span class="hl-2"> = </span><span class="hl-6">tag</span><span class="hl-2">;</span><br/><br/><span class="hl-4">const</span><span class="hl-2"> </span><span class="hl-7">$html</span><span class="hl-2"> = </span><span class="hl-1">html</span><span class="hl-3">`</span><br/><span class="hl-3"> <div>Some IDE extensions will highlight this as html</div></span><br/><span class="hl-3">`</span><br/><br/><span class="hl-4">const</span><span class="hl-2"> </span><span class="hl-7">$css</span><span class="hl-2"> = </span><span class="hl-1">css</span><span class="hl-3">`</span><br/><span class="hl-3"> button {</span><br/><span class="hl-3"> display: grid;</span><br/><span class="hl-3"> }</span><br/><span class="hl-3">`</span>
|
|
12
|
+
<div class="tsd-comment tsd-typography"><div class="tsd-tag-Example"><h4 class="tsd-anchor-link"><a id="Example" class="tsd-anchor"></a>Example<a href="#Example" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-4">const</span><span class="hl-2"> </span><span class="hl-7">html</span><span class="hl-2"> = </span><span class="hl-6">tag</span><span class="hl-2">;</span><br/><span class="hl-4">const</span><span class="hl-2"> </span><span class="hl-7">css</span><span class="hl-2"> = </span><span class="hl-6">tag</span><span class="hl-2">;</span><br/><br/><span class="hl-4">const</span><span class="hl-2"> </span><span class="hl-7">$html</span><span class="hl-2"> = </span><span class="hl-1">html</span><span class="hl-3">`</span><br/><span class="hl-3"> <div>Some IDE extensions will highlight this as html</div></span><br/><span class="hl-3">`</span><br/><br/><span class="hl-4">const</span><span class="hl-2"> </span><span class="hl-7">$css</span><span class="hl-2"> = </span><span class="hl-1">css</span><span class="hl-3">`</span><br/><span class="hl-3"> button {</span><br/><span class="hl-3"> display: grid;</span><br/><span class="hl-3"> }</span><br/><span class="hl-3">`</span>
|
|
13
13
|
</code><button type="button">Copy</button></pre>
|
|
14
14
|
|
|
15
|
-
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/
|
|
15
|
+
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/cffdc645947069d32dcd73c87f0b40e230a5f2fb/packages/helpful-fn/src/tag/tag.mts#L102">packages/helpful-fn/src/tag/tag.mts:102</a></li></ul></aside></li></ul></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>Helpful</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
<!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>zsh | Helpful</title><meta name="description" content="Documentation for Helpful"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><link rel="icon" href="../helpful.svg" />
|
|
2
|
-
</head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">Helpful</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../
|
|
2
|
+
</head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">Helpful</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../modules.html">Helpful</a></li><li><a href="../modules/_zthun_helpful_fn.html">@zthun/helpful-fn</a></li><li><a href="_zthun_helpful_fn.zsh.html">zsh</a></li></ul><h1>Function zsh</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>An alias for <a href="_zthun_helpful_fn.tag.html" class="tsd-kind-function">tag</a>.</p>
|
|
3
3
|
</div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel"><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="zsh" class="tsd-anchor"></a><span class="tsd-kind-call-signature">zsh</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">strings</span>, <span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">expressions</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#zsh" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>This is just a method that allows you to tag an interpolation
|
|
4
4
|
string as a syntax language.</p>
|
|
5
5
|
<p>This is useful with IDE extensions that can detect the language
|
|
@@ -9,7 +9,7 @@ and do the syntax highlighting for you.</p>
|
|
|
9
9
|
the single string literal.</p>
|
|
10
10
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><p>The compiled string literal. This is no different
|
|
11
11
|
than letting native JavaScript do it for you.</p>
|
|
12
|
-
<div class="tsd-comment tsd-typography"><h4 class="tsd-anchor-link"><a id="Example" class="tsd-anchor"></a>Example<a href="#Example" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-4">const</span><span class="hl-2"> </span><span class="hl-7">html</span><span class="hl-2"> = </span><span class="hl-6">tag</span><span class="hl-2">;</span><br/><span class="hl-4">const</span><span class="hl-2"> </span><span class="hl-7">css</span><span class="hl-2"> = </span><span class="hl-6">tag</span><span class="hl-2">;</span><br/><br/><span class="hl-4">const</span><span class="hl-2"> </span><span class="hl-7">$html</span><span class="hl-2"> = </span><span class="hl-1">html</span><span class="hl-3">`</span><br/><span class="hl-3"> <div>Some IDE extensions will highlight this as html</div></span><br/><span class="hl-3">`</span><br/><br/><span class="hl-4">const</span><span class="hl-2"> </span><span class="hl-7">$css</span><span class="hl-2"> = </span><span class="hl-1">css</span><span class="hl-3">`</span><br/><span class="hl-3"> button {</span><br/><span class="hl-3"> display: grid;</span><br/><span class="hl-3"> }</span><br/><span class="hl-3">`</span>
|
|
12
|
+
<div class="tsd-comment tsd-typography"><div class="tsd-tag-Example"><h4 class="tsd-anchor-link"><a id="Example" class="tsd-anchor"></a>Example<a href="#Example" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-4">const</span><span class="hl-2"> </span><span class="hl-7">html</span><span class="hl-2"> = </span><span class="hl-6">tag</span><span class="hl-2">;</span><br/><span class="hl-4">const</span><span class="hl-2"> </span><span class="hl-7">css</span><span class="hl-2"> = </span><span class="hl-6">tag</span><span class="hl-2">;</span><br/><br/><span class="hl-4">const</span><span class="hl-2"> </span><span class="hl-7">$html</span><span class="hl-2"> = </span><span class="hl-1">html</span><span class="hl-3">`</span><br/><span class="hl-3"> <div>Some IDE extensions will highlight this as html</div></span><br/><span class="hl-3">`</span><br/><br/><span class="hl-4">const</span><span class="hl-2"> </span><span class="hl-7">$css</span><span class="hl-2"> = </span><span class="hl-1">css</span><span class="hl-3">`</span><br/><span class="hl-3"> button {</span><br/><span class="hl-3"> display: grid;</span><br/><span class="hl-3"> }</span><br/><span class="hl-3">`</span>
|
|
13
13
|
</code><button type="button">Copy</button></pre>
|
|
14
14
|
|
|
15
|
-
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/
|
|
15
|
+
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/cffdc645947069d32dcd73c87f0b40e230a5f2fb/packages/helpful-fn/src/tag/tag.mts#L117">packages/helpful-fn/src/tag/tag.mts:117</a></li></ul></aside></li></ul></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>Helpful</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
<!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>walk | Helpful</title><meta name="description" content="Documentation for Helpful"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><link rel="icon" href="../helpful.svg" />
|
|
2
|
-
</head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">Helpful</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../
|
|
2
|
+
</head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">Helpful</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../modules.html">Helpful</a></li><li><a href="../modules/_zthun_helpful_node.html">@zthun/helpful-node</a></li><li><a href="_zthun_helpful_node.walk.html">walk</a></li></ul><h1>Function walk</h1></div><section class="tsd-panel"><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="walk" class="tsd-anchor"></a><span class="tsd-kind-call-signature">walk</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">search</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol">></span><a href="#walk" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Walks up a directory tree to search for existence of a given path.</p>
|
|
3
3
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">search</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The path to search for. This is the candidate folder path that
|
|
4
4
|
may or may not exist somewhere from the start directory all the
|
|
5
5
|
way up the directory tree.</p>
|
|
@@ -7,7 +7,7 @@ way up the directory tree.</p>
|
|
|
7
7
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol">></span></h4><p>The fully qualified path to the first path that matches the search
|
|
8
8
|
starting at the options start or the current working directory if not
|
|
9
9
|
specified. Returns null if no such directory exists.</p>
|
|
10
|
-
<div class="tsd-comment tsd-typography"><h4 class="tsd-anchor-link"><a id="Example" class="tsd-anchor"></a>Example<a href="#Example" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-5">import</span><span class="hl-2"> { </span><span class="hl-6">resolve</span><span class="hl-2"> } </span><span class="hl-5">from</span><span class="hl-2"> </span><span class="hl-3">'path'</span><br/><br/><span class="hl-0">// Find any folder named .vscode from the current working directory all the way</span><br/><span class="hl-0">// up the directory tree. Returns null if no vscode directory can be found.</span><br/><span class="hl-4">const</span><span class="hl-2"> </span><span class="hl-7">vscode</span><span class="hl-2"> = </span><span class="hl-1">walk</span><span class="hl-2">(</span><span class="hl-3">'.vscode'</span><span class="hl-2">);</span><br/><br/><span class="hl-0">// Walk the directory tree from the current script and find the .config folder.</span><br/><span class="hl-4">const</span><span class="hl-2"> </span><span class="hl-7">config</span><span class="hl-2"> = </span><span class="hl-1">walk</span><span class="hl-2">(</span><span class="hl-3">'.config'</span><span class="hl-2">, { </span><span class="hl-6">start:</span><span class="hl-2"> </span><span class="hl-6">__dirname</span><span class="hl-2"> });</span><br/><br/><span class="hl-0">// Walk the directory tree from the current script and stop when we reach</span><br/><span class="hl-0">// at most 2 directories up.</span><br/><span class="hl-4">const</span><span class="hl-2"> </span><span class="hl-7">start</span><span class="hl-2"> = </span><span class="hl-6">__dirname</span><span class="hl-2">;</span><br/><span class="hl-4">const</span><span class="hl-2"> </span><span class="hl-7">stop</span><span class="hl-2"> = </span><span class="hl-1">resolve</span><span class="hl-2">(</span><span class="hl-6">__dirname</span><span class="hl-2">, </span><span class="hl-3">'../..'</span><span class="hl-2">);</span><br/><span class="hl-4">const</span><span class="hl-2"> </span><span class="hl-7">file</span><span class="hl-2"> = </span><span class="hl-1">walk</span><span class="hl-2">(</span><span class="hl-3">'path/to/file.json'</span><span class="hl-2">, { </span><span class="hl-6">start</span><span class="hl-2">, </span><span class="hl-6">stop</span><span class="hl-2"> });</span>
|
|
10
|
+
<div class="tsd-comment tsd-typography"><div class="tsd-tag-Example"><h4 class="tsd-anchor-link"><a id="Example" class="tsd-anchor"></a>Example<a href="#Example" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-5">import</span><span class="hl-2"> { </span><span class="hl-6">resolve</span><span class="hl-2"> } </span><span class="hl-5">from</span><span class="hl-2"> </span><span class="hl-3">'path'</span><br/><br/><span class="hl-0">// Find any folder named .vscode from the current working directory all the way</span><br/><span class="hl-0">// up the directory tree. Returns null if no vscode directory can be found.</span><br/><span class="hl-4">const</span><span class="hl-2"> </span><span class="hl-7">vscode</span><span class="hl-2"> = </span><span class="hl-1">walk</span><span class="hl-2">(</span><span class="hl-3">'.vscode'</span><span class="hl-2">);</span><br/><br/><span class="hl-0">// Walk the directory tree from the current script and find the .config folder.</span><br/><span class="hl-4">const</span><span class="hl-2"> </span><span class="hl-7">config</span><span class="hl-2"> = </span><span class="hl-1">walk</span><span class="hl-2">(</span><span class="hl-3">'.config'</span><span class="hl-2">, { </span><span class="hl-6">start:</span><span class="hl-2"> </span><span class="hl-6">__dirname</span><span class="hl-2"> });</span><br/><br/><span class="hl-0">// Walk the directory tree from the current script and stop when we reach</span><br/><span class="hl-0">// at most 2 directories up.</span><br/><span class="hl-4">const</span><span class="hl-2"> </span><span class="hl-7">start</span><span class="hl-2"> = </span><span class="hl-6">__dirname</span><span class="hl-2">;</span><br/><span class="hl-4">const</span><span class="hl-2"> </span><span class="hl-7">stop</span><span class="hl-2"> = </span><span class="hl-1">resolve</span><span class="hl-2">(</span><span class="hl-6">__dirname</span><span class="hl-2">, </span><span class="hl-3">'../..'</span><span class="hl-2">);</span><br/><span class="hl-4">const</span><span class="hl-2"> </span><span class="hl-7">file</span><span class="hl-2"> = </span><span class="hl-1">walk</span><span class="hl-2">(</span><span class="hl-3">'path/to/file.json'</span><span class="hl-2">, { </span><span class="hl-6">start</span><span class="hl-2">, </span><span class="hl-6">stop</span><span class="hl-2"> });</span>
|
|
11
11
|
</code><button type="button">Copy</button></pre>
|
|
12
12
|
|
|
13
|
-
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/
|
|
13
|
+
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/cffdc645947069d32dcd73c87f0b40e230a5f2fb/packages/helpful-node/src/walk/walk.mts#L69">walk.mts:69</a></li></ul></aside></li></ul></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>Helpful</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
<!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>isBinaryFilter | Helpful</title><meta name="description" content="Documentation for Helpful"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><link rel="icon" href="../helpful.svg" />
|
|
2
|
-
</head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">Helpful</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../
|
|
2
|
+
</head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">Helpful</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../modules.html">Helpful</a></li><li><a href="../modules/_zthun_helpful_query.html">@zthun/helpful-query</a></li><li><a href="_zthun_helpful_query.isBinaryFilter.html">isBinaryFilter</a></li></ul><h1>Function isBinaryFilter</h1></div><section class="tsd-panel"><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="isBinaryFilter" class="tsd-anchor"></a><span class="tsd-kind-call-signature">is<wbr/>Binary<wbr/>Filter</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">filter</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-kind-parameter">filter</span><span class="tsd-signature-keyword"> is </span><a href="../interfaces/_zthun_helpful_query.IZFilterBinary.html" class="tsd-signature-type tsd-kind-interface">IZFilterBinary</a><a href="#isBinaryFilter" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Type guard for determining if a target filter is a binary filter.</p>
|
|
3
3
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">filter</span>: <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="../interfaces/_zthun_helpful_query.IZFilterMetadata.html" class="tsd-signature-type tsd-kind-interface">IZFilterMetadata</a></span><div class="tsd-comment tsd-typography"><p>The filter to test.</p>
|
|
4
4
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-kind-parameter">filter</span><span class="tsd-signature-keyword"> is </span><a href="../interfaces/_zthun_helpful_query.IZFilterBinary.html" class="tsd-signature-type tsd-kind-interface">IZFilterBinary</a></h4><p>True if filters type is a binary filter. False otherwise.</p>
|
|
5
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/
|
|
5
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/cffdc645947069d32dcd73c87f0b40e230a5f2fb/packages/helpful-query/src/filter/filter-binary.mts#L194">packages/helpful-query/src/filter/filter-binary.mts:194</a></li></ul></aside></li></ul></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>Helpful</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
<!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>isBinaryOperator | Helpful</title><meta name="description" content="Documentation for Helpful"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><link rel="icon" href="../helpful.svg" />
|
|
2
|
-
</head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">Helpful</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../
|
|
2
|
+
</head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">Helpful</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../modules.html">Helpful</a></li><li><a href="../modules/_zthun_helpful_query.html">@zthun/helpful-query</a></li><li><a href="_zthun_helpful_query.isBinaryOperator.html">isBinaryOperator</a></li></ul><h1>Function isBinaryOperator</h1></div><section class="tsd-panel"><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="isBinaryOperator" class="tsd-anchor"></a><span class="tsd-kind-call-signature">is<wbr/>Binary<wbr/>Operator</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">candidate</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-kind-parameter">candidate</span><span class="tsd-signature-keyword"> is </span><a href="../enums/_zthun_helpful_query.ZOperatorBinary.html" class="tsd-signature-type tsd-kind-enum">ZOperatorBinary</a><a href="#isBinaryOperator" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Gets whether a candidate string represents a binary operator.</p>
|
|
3
3
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">candidate</span>: <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-kind-parameter">candidate</span><span class="tsd-signature-keyword"> is </span><a href="../enums/_zthun_helpful_query.ZOperatorBinary.html" class="tsd-signature-type tsd-kind-enum">ZOperatorBinary</a></h4><p>Type guard true if candidate is a binary operator, false
|
|
4
4
|
otherwise.</p>
|
|
5
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/
|
|
5
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/cffdc645947069d32dcd73c87f0b40e230a5f2fb/packages/helpful-query/src/filter/filter-binary.mts#L214">packages/helpful-query/src/filter/filter-binary.mts:214</a></li></ul></aside></li></ul></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>Helpful</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
<!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>isCollectionFilter | Helpful</title><meta name="description" content="Documentation for Helpful"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><link rel="icon" href="../helpful.svg" />
|
|
2
|
-
</head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">Helpful</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../
|
|
2
|
+
</head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">Helpful</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../modules.html">Helpful</a></li><li><a href="../modules/_zthun_helpful_query.html">@zthun/helpful-query</a></li><li><a href="_zthun_helpful_query.isCollectionFilter.html">isCollectionFilter</a></li></ul><h1>Function isCollectionFilter</h1></div><section class="tsd-panel"><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="isCollectionFilter" class="tsd-anchor"></a><span class="tsd-kind-call-signature">is<wbr/>Collection<wbr/>Filter</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">filter</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-kind-parameter">filter</span><span class="tsd-signature-keyword"> is </span><a href="../interfaces/_zthun_helpful_query.IZFilterCollection.html" class="tsd-signature-type tsd-kind-interface">IZFilterCollection</a><a href="#isCollectionFilter" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Type guard for determining if a target filter is a collection filter.</p>
|
|
3
3
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">filter</span>: <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="../interfaces/_zthun_helpful_query.IZFilterMetadata.html" class="tsd-signature-type tsd-kind-interface">IZFilterMetadata</a></span><div class="tsd-comment tsd-typography"><p>The filter to test.</p>
|
|
4
4
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-kind-parameter">filter</span><span class="tsd-signature-keyword"> is </span><a href="../interfaces/_zthun_helpful_query.IZFilterCollection.html" class="tsd-signature-type tsd-kind-interface">IZFilterCollection</a></h4><p>True if filters type is a collection filter. False otherwise.</p>
|
|
5
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/
|
|
5
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/cffdc645947069d32dcd73c87f0b40e230a5f2fb/packages/helpful-query/src/filter/filter-collection.mts#L144">packages/helpful-query/src/filter/filter-collection.mts:144</a></li></ul></aside></li></ul></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>Helpful</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
|