@zthun/helpful-web 9.11.6 → 9.11.8
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/assets/hierarchy.js +1 -1
- package/dist/assets/navigation.js +1 -1
- package/dist/assets/search.js +1 -1
- package/dist/classes/_zthun_helpful-brands.ZBrandBuilder.html +9 -9
- package/dist/classes/_zthun_helpful-brands.ZBrandDataSourceFactory.html +2 -2
- package/dist/classes/_zthun_helpful-brands.ZBrandKnown.html +37 -37
- package/dist/classes/_zthun_helpful-brands.ZBrandMetadata.html +2 -2
- package/dist/classes/_zthun_helpful-fn.ZAssert.html +4 -4
- package/dist/classes/_zthun_helpful-fn.ZDeserializeJson.html +3 -3
- package/dist/classes/_zthun_helpful-fn.ZDeserializeTry.html +3 -3
- package/dist/classes/_zthun_helpful-fn.ZEnumInfoBuilder.html +22 -0
- package/dist/classes/_zthun_helpful-fn.ZLazy.html +2 -2
- package/dist/classes/_zthun_helpful-fn.ZQuadrilateralBuilder.html +11 -11
- package/dist/classes/_zthun_helpful-fn.ZQuadrilateralCornersBuilder.html +13 -13
- package/dist/classes/_zthun_helpful-fn.ZRectangle.html +18 -18
- package/dist/classes/_zthun_helpful-fn.ZSerializeJson.html +2 -2
- package/dist/classes/_zthun_helpful-internet.ZCookieBuilder.html +16 -16
- package/dist/classes/_zthun_helpful-internet.ZEmailBuilder.html +8 -8
- package/dist/classes/_zthun_helpful-internet.ZEmailContactAddressBuilder.html +5 -5
- package/dist/classes/_zthun_helpful-internet.ZEmailContactBuilder.html +8 -8
- package/dist/classes/_zthun_helpful-internet.ZEmailEnvelopeBuilder.html +12 -12
- package/dist/classes/_zthun_helpful-internet.ZServerBuilder.html +9 -9
- package/dist/classes/_zthun_helpful-query.ZAggregateBuilder.html +5 -5
- package/dist/classes/_zthun_helpful-query.ZDataFilterFields.html +2 -2
- package/dist/classes/_zthun_helpful-query.ZDataMatchAlways.html +2 -2
- package/dist/classes/_zthun_helpful-query.ZDataMatchOptional.html +3 -3
- package/dist/classes/_zthun_helpful-query.ZDataRequestBuilder.html +10 -10
- package/dist/classes/_zthun_helpful-query.ZDataSearchFields.html +3 -3
- package/dist/classes/_zthun_helpful-query.ZDataSearchText.html +2 -2
- package/dist/classes/_zthun_helpful-query.ZDataSourceStatic.html +9 -9
- package/dist/classes/_zthun_helpful-query.ZDataSourceStaticOptionsBuilder.html +6 -6
- package/dist/classes/_zthun_helpful-query.ZFilterBinaryBuilder.html +16 -16
- package/dist/classes/_zthun_helpful-query.ZFilterCollectionBuilder.html +10 -10
- package/dist/classes/_zthun_helpful-query.ZFilterDeserialize.html +2 -2
- package/dist/classes/_zthun_helpful-query.ZFilterLogicBuilder.html +9 -9
- package/dist/classes/_zthun_helpful-query.ZFilterSerialize.html +2 -2
- package/dist/classes/_zthun_helpful-query.ZFilterUnaryBuilder.html +8 -8
- package/dist/classes/_zthun_helpful-query.ZMetadataBuilder.html +26 -26
- package/dist/classes/_zthun_helpful-query.ZPageBuilder.html +9 -9
- package/dist/classes/_zthun_helpful-query.ZSortBuilder.html +7 -7
- package/dist/classes/_zthun_helpful-query.ZSortDeserialize.html +2 -2
- package/dist/classes/_zthun_helpful-query.ZSortSerialize.html +2 -2
- package/dist/classes/_zthun_helpful-query.ZSorterSingle.html +5 -5
- package/dist/classes/_zthun_helpful-react.ZFileSelect.html +3 -3
- package/dist/classes/_zthun_helpful-validation.EqualsOtherPropertyValidator.html +2 -2
- package/dist/classes/_zthun_helpful-validation.IsDataURILimitValidator.html +2 -2
- package/dist/classes/_zthun_helpful-validation.IsNotWhiteSpaceValidator.html +2 -2
- package/dist/classes/_zthun_helpful-validation.RequiresOtherPropertyValidator.html +2 -2
- package/dist/enums/_zthun_helpful-fn.ZDateFormats.html +8 -8
- package/dist/enums/_zthun_helpful-fn.ZHorizontalAnchor.html +4 -4
- package/dist/enums/_zthun_helpful-fn.ZOrientation.html +3 -3
- package/dist/enums/_zthun_helpful-fn.ZVerticalAnchor.html +4 -4
- package/dist/enums/_zthun_helpful-query.ZMetadataType.html +9 -9
- package/dist/enums/_zthun_helpful-query.ZOperatorBinary.html +10 -10
- package/dist/enums/_zthun_helpful-query.ZOperatorCollection.html +3 -3
- package/dist/enums/_zthun_helpful-query.ZOperatorLogic.html +3 -3
- package/dist/enums/_zthun_helpful-query.ZOperatorUnary.html +3 -3
- package/dist/enums/_zthun_helpful-query.ZSortDirection.html +3 -3
- package/dist/enums/_zthun_helpful-query.ZWellKnownIconClasses.html +5 -5
- package/dist/functions/_zthun_helpful-fn.castEnum.html +20 -0
- package/dist/functions/_zthun_helpful-fn.castExtension.html +1 -1
- package/dist/functions/_zthun_helpful-fn.castNumber.html +26 -0
- package/dist/functions/_zthun_helpful-fn.countBuckets.html +1 -1
- package/dist/functions/_zthun_helpful-fn.createError.html +1 -1
- package/dist/functions/_zthun_helpful-fn.culture.html +1 -1
- package/dist/functions/_zthun_helpful-fn.cultures.html +1 -1
- package/dist/functions/_zthun_helpful-fn.detokenize.html +1 -1
- package/dist/functions/_zthun_helpful-fn.firstDefined.html +1 -1
- package/dist/functions/_zthun_helpful-fn.firstTruthy.html +1 -1
- package/dist/functions/_zthun_helpful-fn.firstWhere.html +1 -1
- package/dist/functions/_zthun_helpful-fn.formatDateTime.html +1 -1
- package/dist/functions/_zthun_helpful-fn.guessDateTime.html +1 -1
- package/dist/functions/_zthun_helpful-fn.isEmptyObject.html +1 -1
- package/dist/functions/_zthun_helpful-fn.isEnum.html +7 -0
- package/dist/functions/_zthun_helpful-fn.joinDefined.html +1 -1
- package/dist/functions/_zthun_helpful-fn.optional.html +2 -2
- package/dist/functions/_zthun_helpful-fn.parseDateTime.html +1 -1
- package/dist/functions/_zthun_helpful-fn.peel.html +1 -1
- package/dist/functions/_zthun_helpful-fn.peelBetween.html +1 -1
- package/dist/functions/_zthun_helpful-fn.pickBy.html +1 -1
- package/dist/functions/_zthun_helpful-fn.pickDataAttributes.html +1 -1
- package/dist/functions/_zthun_helpful-fn.pickDefined.html +1 -1
- package/dist/functions/_zthun_helpful-fn.pickEvents.html +1 -1
- package/dist/functions/_zthun_helpful-fn.purge.html +1 -1
- package/dist/functions/_zthun_helpful-fn.required.html +1 -1
- package/dist/functions/_zthun_helpful-fn.setFirst.html +1 -1
- package/dist/functions/_zthun_helpful-fn.sleep.html +2 -2
- package/dist/functions/_zthun_helpful-fn.tag.html +1 -1
- package/dist/functions/_zthun_helpful-fn.timeZones.html +1 -1
- package/dist/functions/_zthun_helpful-fn.tryFallback.html +2 -2
- package/dist/functions/_zthun_helpful-fn.tryFallbackAsync.html +2 -2
- package/dist/functions/_zthun_helpful-fn.tryJsonParse.html +2 -2
- package/dist/functions/_zthun_helpful-fn.userTimeZone.html +1 -1
- package/dist/functions/_zthun_helpful-query.isBinaryFilter.html +1 -1
- package/dist/functions/_zthun_helpful-query.isBinaryOperator.html +1 -1
- package/dist/functions/_zthun_helpful-query.isCollectionFilter.html +1 -1
- package/dist/functions/_zthun_helpful-query.isCollectionOperator.html +1 -1
- package/dist/functions/_zthun_helpful-query.isLogicFilter.html +1 -1
- package/dist/functions/_zthun_helpful-query.isLogicOperator.html +1 -1
- package/dist/functions/_zthun_helpful-query.isUnaryFilter.html +1 -1
- package/dist/functions/_zthun_helpful-query.isUnaryOperator.html +1 -1
- package/dist/functions/_zthun_helpful-react.asStateData.html +2 -2
- package/dist/functions/_zthun_helpful-react.asStateError.html +1 -1
- package/dist/functions/_zthun_helpful-react.createKeyboardActivate.html +1 -1
- package/dist/functions/_zthun_helpful-react.isStateErrored.html +1 -1
- package/dist/functions/_zthun_helpful-react.isStateLoaded.html +1 -1
- package/dist/functions/_zthun_helpful-react.isStateLoading.html +1 -1
- package/dist/functions/_zthun_helpful-react.useAmbassadorState.html +2 -2
- package/dist/functions/_zthun_helpful-react.useAsyncState.html +1 -1
- package/dist/functions/_zthun_helpful-react.useFileSelect.html +1 -1
- package/dist/functions/_zthun_helpful-react.useKeyboardActivate.html +1 -1
- package/dist/functions/_zthun_helpful-react.useMoreViewState.html +1 -1
- package/dist/functions/_zthun_helpful-react.usePageViewState.html +1 -1
- package/dist/functions/_zthun_helpful-react.useStateAsArray.html +1 -1
- package/dist/functions/_zthun_helpful-react.useSyncState.html +1 -1
- package/dist/functions/_zthun_helpful-react.useWindowService.html +1 -1
- package/dist/functions/_zthun_helpful-reflection.ZTag.html +1 -1
- package/dist/functions/_zthun_helpful-reflection.isTagged.html +1 -1
- package/dist/functions/_zthun_helpful-validation.EqualsOtherProperty.html +1 -1
- package/dist/functions/_zthun_helpful-validation.IsDataURILimit.html +1 -1
- package/dist/functions/_zthun_helpful-validation.IsNotWhiteSpace.html +1 -1
- package/dist/functions/_zthun_helpful-validation.RequiresOtherProperty.html +1 -1
- package/dist/hierarchy.html +1 -1
- package/dist/interfaces/_zthun_helpful-brands.IZBrand.html +6 -6
- package/dist/interfaces/_zthun_helpful-fn.IZDeserialize.html +2 -2
- package/dist/interfaces/_zthun_helpful-fn.IZEnumInformation.html +21 -0
- package/dist/interfaces/_zthun_helpful-fn.IZPoint2d.html +3 -3
- package/dist/interfaces/_zthun_helpful-fn.IZPoint3d.html +4 -4
- package/dist/interfaces/_zthun_helpful-fn.IZQuadrilateral.html +5 -5
- package/dist/interfaces/_zthun_helpful-fn.IZQuadrilateralCorners.html +2 -2
- package/dist/interfaces/_zthun_helpful-fn.IZSerialize.html +2 -2
- package/dist/interfaces/_zthun_helpful-internet.IZCookie.html +8 -8
- package/dist/interfaces/_zthun_helpful-internet.IZEmail.html +4 -4
- package/dist/interfaces/_zthun_helpful-internet.IZEmailContact.html +4 -4
- package/dist/interfaces/_zthun_helpful-internet.IZEmailEnvelope.html +5 -5
- package/dist/interfaces/_zthun_helpful-internet.IZServer.html +5 -5
- package/dist/interfaces/_zthun_helpful-query.IZAggregate.html +3 -3
- package/dist/interfaces/_zthun_helpful-query.IZDataMatch.html +2 -2
- package/dist/interfaces/_zthun_helpful-query.IZDataRequest.html +6 -6
- package/dist/interfaces/_zthun_helpful-query.IZDataRequestQuery.html +6 -6
- package/dist/interfaces/_zthun_helpful-query.IZDataSource.html +3 -3
- package/dist/interfaces/_zthun_helpful-query.IZDataSourceStaticOptions.html +4 -4
- package/dist/interfaces/_zthun_helpful-query.IZFilterBinary.html +5 -5
- package/dist/interfaces/_zthun_helpful-query.IZFilterCollection.html +5 -5
- package/dist/interfaces/_zthun_helpful-query.IZFilterLogic.html +4 -4
- package/dist/interfaces/_zthun_helpful-query.IZFilterMetadata.html +2 -2
- package/dist/interfaces/_zthun_helpful-query.IZFilterOperator.html +3 -3
- package/dist/interfaces/_zthun_helpful-query.IZFilterSubject.html +4 -4
- package/dist/interfaces/_zthun_helpful-query.IZMetadata.html +14 -14
- package/dist/interfaces/_zthun_helpful-query.IZPage.html +3 -3
- package/dist/interfaces/_zthun_helpful-query.IZSort.html +3 -3
- package/dist/interfaces/_zthun_helpful-query.IZSorter.html +4 -4
- package/dist/interfaces/_zthun_helpful-react.IZFileSelect.html +2 -2
- package/dist/interfaces/_zthun_helpful-react.IZKeyboardInteraction.html +3 -3
- package/dist/modules/_zthun_helpful-fn.html +1 -1
- package/dist/types/_zthun_helpful-fn.DeepPartial.html +1 -1
- package/dist/types/_zthun_helpful-fn.JoinListInputParameter.html +1 -1
- package/dist/types/_zthun_helpful-fn.PickPredicate.html +1 -1
- package/dist/types/_zthun_helpful-fn.PickResult.html +1 -1
- package/dist/types/_zthun_helpful-fn.RequiredDeep.html +1 -1
- package/dist/types/_zthun_helpful-fn.RequiredPick.html +1 -1
- package/dist/types/_zthun_helpful-fn.ZAnchor.html +1 -1
- package/dist/types/_zthun_helpful-fn.ZCornersHorizontal.html +2 -2
- package/dist/types/_zthun_helpful-fn.ZCornersVertical.html +2 -2
- package/dist/types/_zthun_helpful-fn.ZDateTime.html +1 -1
- package/dist/types/_zthun_helpful-fn.ZDateTimeOptions.html +6 -6
- package/dist/types/_zthun_helpful-fn.ZDeepPartial.html +1 -1
- package/dist/types/_zthun_helpful-fn.ZMutable.html +1 -1
- package/dist/types/_zthun_helpful-fn.ZMutableKeys.html +1 -1
- package/dist/types/_zthun_helpful-fn.ZNullable.html +1 -1
- package/dist/types/_zthun_helpful-fn.ZNumberLike.html +1 -1
- package/dist/types/_zthun_helpful-fn.ZObligatedValue.html +1 -1
- package/dist/types/_zthun_helpful-fn.ZOptional.html +1 -1
- package/dist/types/_zthun_helpful-fn.ZQuadrilateralCornersLike.html +1 -1
- package/dist/types/_zthun_helpful-fn.ZQuadrilateralLike.html +1 -1
- package/dist/types/_zthun_helpful-fn.ZRequiredDeep.html +1 -1
- package/dist/types/_zthun_helpful-fn.ZRequiredPick.html +1 -1
- package/dist/types/_zthun_helpful-fn.ZSideAnchor.html +1 -1
- package/dist/types/_zthun_helpful-fn.ZSupplier.html +1 -1
- package/dist/types/_zthun_helpful-fn.ZSupplierAsync.html +1 -1
- package/dist/types/_zthun_helpful-query.IZFilter.html +1 -1
- package/dist/types/_zthun_helpful-query.IZFilterUnary.html +1 -1
- package/dist/types/_zthun_helpful-query.ZOperatorFilter.html +1 -1
- package/dist/types/_zthun_helpful-react.ZAmbassadorReducer.html +1 -1
- package/dist/types/_zthun_helpful-react.ZAmbassadorReducerRequired.html +1 -1
- package/dist/types/_zthun_helpful-react.ZAmbassadorSetCurrent.html +1 -1
- package/dist/types/_zthun_helpful-react.ZAsyncDataState.html +1 -1
- package/dist/types/_zthun_helpful-react.ZAsyncDataTuple.html +1 -1
- package/dist/types/_zthun_helpful-react.ZAsyncUseData.html +1 -1
- package/dist/types/_zthun_helpful-react.ZSetStateAsArray.html +1 -1
- package/dist/types/_zthun_helpful-react.ZStateAsArrayReducer.html +1 -1
- package/dist/variables/_zthun_helpful-fn._global.html +1 -1
- package/dist/variables/_zthun_helpful-fn.bash.html +1 -1
- package/dist/variables/_zthun_helpful-fn.commaJoinDefined.html +1 -1
- package/dist/variables/_zthun_helpful-fn.createGuid.html +1 -1
- package/dist/variables/_zthun_helpful-fn.css.html +1 -1
- package/dist/variables/_zthun_helpful-fn.cssJoinDefined.html +1 -1
- package/dist/variables/_zthun_helpful-fn.gib.html +1 -1
- package/dist/variables/_zthun_helpful-fn.gibibytes.html +1 -1
- package/dist/variables/_zthun_helpful-fn.html.html +1 -1
- package/dist/variables/_zthun_helpful-fn.javascript.html +1 -1
- package/dist/variables/_zthun_helpful-fn.js.html +1 -1
- package/dist/variables/_zthun_helpful-fn.kib.html +1 -1
- package/dist/variables/_zthun_helpful-fn.kibibytes.html +1 -1
- package/dist/variables/_zthun_helpful-fn.markdown.html +1 -1
- package/dist/variables/_zthun_helpful-fn.md.html +1 -1
- package/dist/variables/_zthun_helpful-fn.mebibytes.html +1 -1
- package/dist/variables/_zthun_helpful-fn.mib.html +1 -1
- package/dist/variables/_zthun_helpful-fn.pebibytes.html +1 -1
- package/dist/variables/_zthun_helpful-fn.pib.html +1 -1
- package/dist/variables/_zthun_helpful-fn.pipeJoinDefined.html +1 -1
- package/dist/variables/_zthun_helpful-fn.semiColonJoinDefined.html +1 -1
- package/dist/variables/_zthun_helpful-fn.sh.html +1 -1
- package/dist/variables/_zthun_helpful-fn.spaceJoinDefined.html +1 -1
- package/dist/variables/_zthun_helpful-fn.tebibytes.html +1 -1
- package/dist/variables/_zthun_helpful-fn.tib.html +1 -1
- package/dist/variables/_zthun_helpful-fn.ts.html +1 -1
- package/dist/variables/_zthun_helpful-fn.typescript.html +1 -1
- package/dist/variables/_zthun_helpful-fn.zsh.html +1 -1
- package/dist/variables/_zthun_helpful-query.ZBinaryComparators.html +1 -1
- package/dist/variables/_zthun_helpful-query.ZCollectionComparators.html +1 -1
- package/dist/variables/_zthun_helpful-query.ZOperatorsBinary.html +1 -1
- package/dist/variables/_zthun_helpful-query.ZOperatorsCollection.html +1 -1
- package/dist/variables/_zthun_helpful-query.ZOperatorsFilter.html +1 -1
- package/dist/variables/_zthun_helpful-query.ZOperatorsLogic.html +1 -1
- package/dist/variables/_zthun_helpful-query.ZOperatorsUnary.html +1 -1
- package/dist/variables/_zthun_helpful-query.ZSortDirections.html +1 -1
- package/dist/variables/_zthun_helpful-query.ZUnaryComparators.html +1 -1
- package/dist/variables/_zthun_helpful-react.DefaultActivateCodes.html +1 -1
- package/dist/variables/_zthun_helpful-react.ZAsyncLoading.html +1 -1
- package/dist/variables/_zthun_helpful-react.ZFileSelectContext.html +1 -1
- package/dist/variables/_zthun_helpful-react.ZWindowServiceContext.html +1 -1
- package/package.json +7 -7
|
@@ -6,8 +6,8 @@ If no fallback value is provided, then undefined is returned.</p>
|
|
|
6
6
|
</div></div></section><section class="tsd-panel"><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="tryfallback"><span class="tsd-kind-call-signature">tryFallback</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#tryfallbackt">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-symbol">=></span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#tryfallbackt">T</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#tryfallbackt">T</a> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">undefined</span><a href="#tryfallback" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Invokes the candidate function and returns undefined if an error is thrown from it.</p>
|
|
7
7
|
</div><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span id="tryfallbackt"><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> <a class="tsd-signature-type tsd-kind-type-parameter" href="#tryfallbackt">T</a></span><div class="tsd-comment tsd-typography"><p>The candidate function to run.</p>
|
|
8
8
|
</div></li></ul></div><h4 class="tsd-returns-title">Returns <a class="tsd-signature-type tsd-kind-type-parameter" href="#tryfallbackt">T</a> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">undefined</span></h4><p>The result from candidate. Returns undefined if candidate throws an Error.</p>
|
|
9
|
-
<aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/
|
|
9
|
+
<aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/3e3413f11e509602b2fbae04cbf7d6f6873a3240/packages/helpful-fn/src/try/try-fallback.mts#L10">try/try-fallback.mts:10</a></li></ul></aside></div></li><li class=""><div class="tsd-signature tsd-anchor-link" id="tryfallback-1"><span class="tsd-kind-call-signature">tryFallback</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#tryfallbackt-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-signature-symbol">:</span> <span class="tsd-signature-symbol">()</span> <span class="tsd-signature-symbol">=></span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#tryfallbackt-1">T</a><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">fallback</span><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#tryfallbackt-1">T</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#tryfallbackt-1">T</a><a href="#tryfallback-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Invokes the candidate function and returns fallback if an error is thrown from it.</p>
|
|
10
10
|
</div><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span id="tryfallbackt-1"><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> <a class="tsd-signature-type tsd-kind-type-parameter" href="#tryfallbackt-1">T</a></span><div class="tsd-comment tsd-typography"><p>The candidate function to run.</p>
|
|
11
11
|
</div></li><li><span><span class="tsd-kind-parameter">fallback</span>: <a class="tsd-signature-type tsd-kind-type-parameter" href="#tryfallbackt-1">T</a></span><div class="tsd-comment tsd-typography"><p>The fallback value to return if candidate throws an error.</p>
|
|
12
12
|
</div></li></ul></div><h4 class="tsd-returns-title">Returns <a class="tsd-signature-type tsd-kind-type-parameter" href="#tryfallbackt-1">T</a></h4><p>The result from candidate. Returns fallback if candidate throws an Error.</p>
|
|
13
|
-
<aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/
|
|
13
|
+
<aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/3e3413f11e509602b2fbae04cbf7d6f6873a3240/packages/helpful-fn/src/try/try-fallback.mts#L23">try/try-fallback.mts:23</a></li></ul></aside></div></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"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html">Helpful</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
|
|
@@ -8,9 +8,9 @@ if no fallback is provided.</p>
|
|
|
8
8
|
</div><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span id="tryfallbackasynct"><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-type">Promise</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#tryfallbackasynct">T</a><span class="tsd-signature-symbol">></span></span><div class="tsd-comment tsd-typography"><p>The candidate function to run.</p>
|
|
9
9
|
</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="#tryfallbackasynct">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
|
|
10
10
|
if candidate returns a rejected promise.</p>
|
|
11
|
-
<aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/
|
|
11
|
+
<aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/3e3413f11e509602b2fbae04cbf7d6f6873a3240/packages/helpful-fn/src/try/try-fallback.mts#L58">try/try-fallback.mts:58</a></li></ul></aside></div></li><li class=""><div class="tsd-signature tsd-anchor-link" id="tryfallbackasync-1"><span class="tsd-kind-call-signature">tryFallbackAsync</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#tryfallbackasynct-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-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="#tryfallbackasynct-1">T</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">fallback</span><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#tryfallbackasynct-1">T</a><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="#tryfallbackasynct-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" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Invokes the candidate function and returns undefined if an rejected promise is returned from it.</p>
|
|
12
12
|
</div><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span id="tryfallbackasynct-1"><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-type">Promise</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#tryfallbackasynct-1">T</a><span class="tsd-signature-symbol">></span></span><div class="tsd-comment tsd-typography"><p>The candidate function to run.</p>
|
|
13
13
|
</div></li><li><span><span class="tsd-kind-parameter">fallback</span>: <a class="tsd-signature-type tsd-kind-type-parameter" href="#tryfallbackasynct-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>
|
|
14
14
|
</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="#tryfallbackasynct-1">T</a><span class="tsd-signature-symbol">></span></h4><p>A promise that resolves with the result from candidate. Returns fallback
|
|
15
15
|
if candidate returns a rejected promise.</p>
|
|
16
|
-
<aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/
|
|
16
|
+
<aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/3e3413f11e509602b2fbae04cbf7d6f6873a3240/packages/helpful-fn/src/try/try-fallback.mts#L74">try/try-fallback.mts:74</a></li></ul></aside></div></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"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html">Helpful</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
|
|
@@ -16,7 +16,7 @@ an error, it returns null.</p>
|
|
|
16
16
|
</div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="../types/_zthun_helpful-fn.ZNullable.html" class="tsd-signature-type tsd-kind-type-alias">ZNullable</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#tryjsonparset">T</a><span class="tsd-signature-symbol">></span></h4><p>The parsed value of the buffer when parsed as JSON. If
|
|
17
17
|
buffer is null, undefined, or does not represent valid
|
|
18
18
|
JSON, then null is returned.</p>
|
|
19
|
-
<aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/
|
|
19
|
+
<aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/3e3413f11e509602b2fbae04cbf7d6f6873a3240/packages/helpful-fn/src/try/try-json-parse.mts#L18">try/try-json-parse.mts:18</a></li></ul></aside></div></li><li class=""><div class="tsd-signature tsd-anchor-link" id="tryjsonparse-1"><span class="tsd-kind-call-signature">tryJsonParse</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#tryjsonparset-1">T</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">buffer</span><span class="tsd-signature-symbol">:</span> <a href="../types/_zthun_helpful-fn.ZOptional.html" class="tsd-signature-type tsd-kind-type-alias">ZOptional</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">fallback</span><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#tryjsonparset-1">T</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#tryjsonparset-1">T</a><a href="#tryjsonparse-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Attempts to parse the string buffer as json.</p>
|
|
20
20
|
<p>This is similar to JSON.parse, but instead of throwing
|
|
21
21
|
an error, it returns a fallback value.</p>
|
|
22
22
|
</div><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span id="tryjsonparset-1"><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">buffer</span>: <a href="../types/_zthun_helpful-fn.ZOptional.html" class="tsd-signature-type tsd-kind-type-alias">ZOptional</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span></span><div class="tsd-comment tsd-typography"><p>The string buffer that may be json.</p>
|
|
@@ -26,4 +26,4 @@ cannot be parsed. Note that parsing the text
|
|
|
26
26
|
</div></li></ul></div><h4 class="tsd-returns-title">Returns <a class="tsd-signature-type tsd-kind-type-parameter" href="#tryjsonparset-1">T</a></h4><p>The parsed value of the buffer when parsed as JSON. If
|
|
27
27
|
buffer is null, undefined, or does not represent valid
|
|
28
28
|
JSON, then fallback is returned.</p>
|
|
29
|
-
<aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/
|
|
29
|
+
<aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/3e3413f11e509602b2fbae04cbf7d6f6873a3240/packages/helpful-fn/src/try/try-json-parse.mts#L40">try/try-json-parse.mts:40</a></li></ul></aside></div></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"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html">Helpful</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
|
|
@@ -1,3 +1,3 @@
|
|
|
1
1
|
<!DOCTYPE html><html class="default" lang="en" data-base="../"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>userTimeZone | Helpful</title><link rel="icon" href="../assets/favicon.svg" type="image/svg+xml"/><meta name="description" content="Documentation for Helpful"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><a href="../index.html" class="title">Helpful</a><div id="tsd-toolbar-links"></div><button id="tsd-search-trigger" class="tsd-widget" aria-label="Search"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></button><dialog id="tsd-search" aria-label="Search"><input role="combobox" id="tsd-search-input" aria-controls="tsd-search-results" aria-autocomplete="list" aria-expanded="true" autocapitalize="off" autocomplete="off" placeholder="Search the docs" maxLength="100"/><ul role="listbox" id="tsd-search-results"></ul><div id="tsd-search-status" aria-live="polite" aria-atomic="true"><div>Preparing search index...</div></div></dialog><a href="#" class="tsd-widget menu" id="tsd-toolbar-menu-trigger" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb" aria-label="Breadcrumb"><li><a href="../modules/_zthun_helpful-fn.html">@zthun/helpful-fn</a></li><li><a href="" aria-current="page">userTimeZone</a></li></ul><h1>Function userTimeZone</h1></div><section class="tsd-panel"><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="usertimezone"><span class="tsd-kind-call-signature">userTimeZone</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><a href="#usertimezone" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns the user's current timezone.</p>
|
|
2
2
|
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><p>The users current timezone.</p>
|
|
3
|
-
<aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/
|
|
3
|
+
<aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/3e3413f11e509602b2fbae04cbf7d6f6873a3240/packages/helpful-fn/src/date/timezone.mts#L7">date/timezone.mts:7</a></li></ul></aside></div></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"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html">Helpful</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
|
|
@@ -1,4 +1,4 @@
|
|
|
1
1
|
<!DOCTYPE html><html class="default" lang="en" data-base="../"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>isBinaryFilter | Helpful</title><link rel="icon" href="../assets/favicon.svg" type="image/svg+xml"/><meta name="description" content="Documentation for Helpful"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><a href="../index.html" class="title">Helpful</a><div id="tsd-toolbar-links"></div><button id="tsd-search-trigger" class="tsd-widget" aria-label="Search"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></button><dialog id="tsd-search" aria-label="Search"><input role="combobox" id="tsd-search-input" aria-controls="tsd-search-results" aria-autocomplete="list" aria-expanded="true" autocapitalize="off" autocomplete="off" placeholder="Search the docs" maxLength="100"/><ul role="listbox" id="tsd-search-results"></ul><div id="tsd-search-status" aria-live="polite" aria-atomic="true"><div>Preparing search index...</div></div></dialog><a href="#" class="tsd-widget menu" id="tsd-toolbar-menu-trigger" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb" aria-label="Breadcrumb"><li><a href="../modules/_zthun_helpful-query.html">@zthun/helpful-query</a></li><li><a href="" aria-current="page">isBinaryFilter</a></li></ul><h1>Function isBinaryFilter</h1></div><section class="tsd-panel"><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="isbinaryfilter"><span class="tsd-kind-call-signature">isBinaryFilter</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">filter</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 class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">null</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><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" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Type guard for determining if a target filter is a binary filter.</p>
|
|
2
2
|
</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>: <a href="../interfaces/_zthun_helpful-query.IZFilterMetadata.html" class="tsd-signature-type tsd-kind-interface">IZFilterMetadata</a> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">null</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">undefined</span></span><div class="tsd-comment tsd-typography"><p>The filter to test.</p>
|
|
3
3
|
</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>
|
|
4
|
-
<aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/
|
|
4
|
+
<aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/3e3413f11e509602b2fbae04cbf7d6f6873a3240/packages/helpful-query/src/filter/filter-binary.mts#L219">filter/filter-binary.mts:219</a></li></ul></aside></div></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"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html">Helpful</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
|
|
@@ -1,4 +1,4 @@
|
|
|
1
1
|
<!DOCTYPE html><html class="default" lang="en" data-base="../"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>isBinaryOperator | Helpful</title><link rel="icon" href="../assets/favicon.svg" type="image/svg+xml"/><meta name="description" content="Documentation for Helpful"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><a href="../index.html" class="title">Helpful</a><div id="tsd-toolbar-links"></div><button id="tsd-search-trigger" class="tsd-widget" aria-label="Search"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></button><dialog id="tsd-search" aria-label="Search"><input role="combobox" id="tsd-search-input" aria-controls="tsd-search-results" aria-autocomplete="list" aria-expanded="true" autocapitalize="off" autocomplete="off" placeholder="Search the docs" maxLength="100"/><ul role="listbox" id="tsd-search-results"></ul><div id="tsd-search-status" aria-live="polite" aria-atomic="true"><div>Preparing search index...</div></div></dialog><a href="#" class="tsd-widget menu" id="tsd-toolbar-menu-trigger" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb" aria-label="Breadcrumb"><li><a href="../modules/_zthun_helpful-query.html">@zthun/helpful-query</a></li><li><a href="" aria-current="page">isBinaryOperator</a></li></ul><h1>Function isBinaryOperator</h1></div><section class="tsd-panel"><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="isbinaryoperator"><span class="tsd-kind-call-signature">isBinaryOperator</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">candidate</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> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">,</span><br/><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" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Gets whether a candidate string represents a binary operator.</p>
|
|
2
2
|
</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">string</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">undefined</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
|
|
3
3
|
otherwise.</p>
|
|
4
|
-
<aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/
|
|
4
|
+
<aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/3e3413f11e509602b2fbae04cbf7d6f6873a3240/packages/helpful-query/src/filter/filter-binary.mts#L239">filter/filter-binary.mts:239</a></li></ul></aside></div></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"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html">Helpful</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
|
|
@@ -1,4 +1,4 @@
|
|
|
1
1
|
<!DOCTYPE html><html class="default" lang="en" data-base="../"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>isCollectionFilter | Helpful</title><link rel="icon" href="../assets/favicon.svg" type="image/svg+xml"/><meta name="description" content="Documentation for Helpful"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><a href="../index.html" class="title">Helpful</a><div id="tsd-toolbar-links"></div><button id="tsd-search-trigger" class="tsd-widget" aria-label="Search"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></button><dialog id="tsd-search" aria-label="Search"><input role="combobox" id="tsd-search-input" aria-controls="tsd-search-results" aria-autocomplete="list" aria-expanded="true" autocapitalize="off" autocomplete="off" placeholder="Search the docs" maxLength="100"/><ul role="listbox" id="tsd-search-results"></ul><div id="tsd-search-status" aria-live="polite" aria-atomic="true"><div>Preparing search index...</div></div></dialog><a href="#" class="tsd-widget menu" id="tsd-toolbar-menu-trigger" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb" aria-label="Breadcrumb"><li><a href="../modules/_zthun_helpful-query.html">@zthun/helpful-query</a></li><li><a href="" aria-current="page">isCollectionFilter</a></li></ul><h1>Function isCollectionFilter</h1></div><section class="tsd-panel"><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="iscollectionfilter"><span class="tsd-kind-call-signature">isCollectionFilter</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">filter</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 class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">null</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><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" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Type guard for determining if a target filter is a collection filter.</p>
|
|
2
2
|
</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>: <a href="../interfaces/_zthun_helpful-query.IZFilterMetadata.html" class="tsd-signature-type tsd-kind-interface">IZFilterMetadata</a> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">null</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">undefined</span></span><div class="tsd-comment tsd-typography"><p>The filter to test.</p>
|
|
3
3
|
</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>
|
|
4
|
-
<aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/
|
|
4
|
+
<aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/3e3413f11e509602b2fbae04cbf7d6f6873a3240/packages/helpful-query/src/filter/filter-collection.mts#L143">filter/filter-collection.mts:143</a></li></ul></aside></div></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"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html">Helpful</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
|
|
@@ -1,4 +1,4 @@
|
|
|
1
1
|
<!DOCTYPE html><html class="default" lang="en" data-base="../"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>isCollectionOperator | Helpful</title><link rel="icon" href="../assets/favicon.svg" type="image/svg+xml"/><meta name="description" content="Documentation for Helpful"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><a href="../index.html" class="title">Helpful</a><div id="tsd-toolbar-links"></div><button id="tsd-search-trigger" class="tsd-widget" aria-label="Search"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></button><dialog id="tsd-search" aria-label="Search"><input role="combobox" id="tsd-search-input" aria-controls="tsd-search-results" aria-autocomplete="list" aria-expanded="true" autocapitalize="off" autocomplete="off" placeholder="Search the docs" maxLength="100"/><ul role="listbox" id="tsd-search-results"></ul><div id="tsd-search-status" aria-live="polite" aria-atomic="true"><div>Preparing search index...</div></div></dialog><a href="#" class="tsd-widget menu" id="tsd-toolbar-menu-trigger" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb" aria-label="Breadcrumb"><li><a href="../modules/_zthun_helpful-query.html">@zthun/helpful-query</a></li><li><a href="" aria-current="page">isCollectionOperator</a></li></ul><h1>Function isCollectionOperator</h1></div><section class="tsd-panel"><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="iscollectionoperator"><span class="tsd-kind-call-signature">isCollectionOperator</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">candidate</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> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">,</span><br/><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.ZOperatorCollection.html" class="tsd-signature-type tsd-kind-enum">ZOperatorCollection</a><a href="#iscollectionoperator" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Gets whether a candidate string represents a collection operator.</p>
|
|
2
2
|
</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">string</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">undefined</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.ZOperatorCollection.html" class="tsd-signature-type tsd-kind-enum">ZOperatorCollection</a></h4><p>Type guard true if candidate is a collection operator, false
|
|
3
3
|
otherwise.</p>
|
|
4
|
-
<aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/
|
|
4
|
+
<aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/3e3413f11e509602b2fbae04cbf7d6f6873a3240/packages/helpful-query/src/filter/filter-collection.mts#L173">filter/filter-collection.mts:173</a></li></ul></aside></div></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"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html">Helpful</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
|
|
@@ -1,4 +1,4 @@
|
|
|
1
1
|
<!DOCTYPE html><html class="default" lang="en" data-base="../"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>isLogicFilter | Helpful</title><link rel="icon" href="../assets/favicon.svg" type="image/svg+xml"/><meta name="description" content="Documentation for Helpful"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><a href="../index.html" class="title">Helpful</a><div id="tsd-toolbar-links"></div><button id="tsd-search-trigger" class="tsd-widget" aria-label="Search"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></button><dialog id="tsd-search" aria-label="Search"><input role="combobox" id="tsd-search-input" aria-controls="tsd-search-results" aria-autocomplete="list" aria-expanded="true" autocapitalize="off" autocomplete="off" placeholder="Search the docs" maxLength="100"/><ul role="listbox" id="tsd-search-results"></ul><div id="tsd-search-status" aria-live="polite" aria-atomic="true"><div>Preparing search index...</div></div></dialog><a href="#" class="tsd-widget menu" id="tsd-toolbar-menu-trigger" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb" aria-label="Breadcrumb"><li><a href="../modules/_zthun_helpful-query.html">@zthun/helpful-query</a></li><li><a href="" aria-current="page">isLogicFilter</a></li></ul><h1>Function isLogicFilter</h1></div><section class="tsd-panel"><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="islogicfilter"><span class="tsd-kind-call-signature">isLogicFilter</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">filter</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 class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">null</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><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.IZFilterLogic.html" class="tsd-signature-type tsd-kind-interface">IZFilterLogic</a><a href="#islogicfilter" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Type guard for determining if a target filter is a logic filter.</p>
|
|
2
2
|
</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>: <a href="../interfaces/_zthun_helpful-query.IZFilterMetadata.html" class="tsd-signature-type tsd-kind-interface">IZFilterMetadata</a> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">null</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">undefined</span></span><div class="tsd-comment tsd-typography"><p>The filter to test.</p>
|
|
3
3
|
</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.IZFilterLogic.html" class="tsd-signature-type tsd-kind-interface">IZFilterLogic</a></h4><p>True if filters type is a logic filter. False otherwise.</p>
|
|
4
|
-
<aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/
|
|
4
|
+
<aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/3e3413f11e509602b2fbae04cbf7d6f6873a3240/packages/helpful-query/src/filter/filter-logic.mts#L133">filter/filter-logic.mts:133</a></li></ul></aside></div></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"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html">Helpful</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
|
|
@@ -1,4 +1,4 @@
|
|
|
1
1
|
<!DOCTYPE html><html class="default" lang="en" data-base="../"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>isLogicOperator | Helpful</title><link rel="icon" href="../assets/favicon.svg" type="image/svg+xml"/><meta name="description" content="Documentation for Helpful"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><a href="../index.html" class="title">Helpful</a><div id="tsd-toolbar-links"></div><button id="tsd-search-trigger" class="tsd-widget" aria-label="Search"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></button><dialog id="tsd-search" aria-label="Search"><input role="combobox" id="tsd-search-input" aria-controls="tsd-search-results" aria-autocomplete="list" aria-expanded="true" autocapitalize="off" autocomplete="off" placeholder="Search the docs" maxLength="100"/><ul role="listbox" id="tsd-search-results"></ul><div id="tsd-search-status" aria-live="polite" aria-atomic="true"><div>Preparing search index...</div></div></dialog><a href="#" class="tsd-widget menu" id="tsd-toolbar-menu-trigger" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb" aria-label="Breadcrumb"><li><a href="../modules/_zthun_helpful-query.html">@zthun/helpful-query</a></li><li><a href="" aria-current="page">isLogicOperator</a></li></ul><h1>Function isLogicOperator</h1></div><section class="tsd-panel"><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="islogicoperator"><span class="tsd-kind-call-signature">isLogicOperator</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">candidate</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> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">,</span><br/><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.ZOperatorLogic.html" class="tsd-signature-type tsd-kind-enum">ZOperatorLogic</a><a href="#islogicoperator" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Gets whether a candidate string represents a logic operator.</p>
|
|
2
2
|
</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">string</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">undefined</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.ZOperatorLogic.html" class="tsd-signature-type tsd-kind-enum">ZOperatorLogic</a></h4><p>Type guard true if candidate is a logic operator, false
|
|
3
3
|
otherwise.</p>
|
|
4
|
-
<aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/
|
|
4
|
+
<aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/3e3413f11e509602b2fbae04cbf7d6f6873a3240/packages/helpful-query/src/filter/filter-logic.mts#L152">filter/filter-logic.mts:152</a></li></ul></aside></div></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"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html">Helpful</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
|
|
@@ -1,4 +1,4 @@
|
|
|
1
1
|
<!DOCTYPE html><html class="default" lang="en" data-base="../"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>isUnaryFilter | Helpful</title><link rel="icon" href="../assets/favicon.svg" type="image/svg+xml"/><meta name="description" content="Documentation for Helpful"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><a href="../index.html" class="title">Helpful</a><div id="tsd-toolbar-links"></div><button id="tsd-search-trigger" class="tsd-widget" aria-label="Search"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></button><dialog id="tsd-search" aria-label="Search"><input role="combobox" id="tsd-search-input" aria-controls="tsd-search-results" aria-autocomplete="list" aria-expanded="true" autocapitalize="off" autocomplete="off" placeholder="Search the docs" maxLength="100"/><ul role="listbox" id="tsd-search-results"></ul><div id="tsd-search-status" aria-live="polite" aria-atomic="true"><div>Preparing search index...</div></div></dialog><a href="#" class="tsd-widget menu" id="tsd-toolbar-menu-trigger" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb" aria-label="Breadcrumb"><li><a href="../modules/_zthun_helpful-query.html">@zthun/helpful-query</a></li><li><a href="" aria-current="page">isUnaryFilter</a></li></ul><h1>Function isUnaryFilter</h1></div><section class="tsd-panel"><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="isunaryfilter"><span class="tsd-kind-call-signature">isUnaryFilter</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">filter</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 class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">null</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-kind-parameter">filter</span> <span class="tsd-signature-keyword">is</span> <a href="../types/_zthun_helpful-query.IZFilterUnary.html" class="tsd-signature-type tsd-kind-type-alias">IZFilterUnary</a><a href="#isunaryfilter" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Type guard for determining if a target filter is a unary filter.</p>
|
|
2
2
|
</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>: <a href="../interfaces/_zthun_helpful-query.IZFilterMetadata.html" class="tsd-signature-type tsd-kind-interface">IZFilterMetadata</a> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">null</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">undefined</span></span><div class="tsd-comment tsd-typography"><p>The filter to test.</p>
|
|
3
3
|
</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="../types/_zthun_helpful-query.IZFilterUnary.html" class="tsd-signature-type tsd-kind-type-alias">IZFilterUnary</a></h4><p>True if filters type is a unary filter. False otherwise.</p>
|
|
4
|
-
<aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/
|
|
4
|
+
<aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/3e3413f11e509602b2fbae04cbf7d6f6873a3240/packages/helpful-query/src/filter/filter-unary.mts#L109">filter/filter-unary.mts:109</a></li></ul></aside></div></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"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html">Helpful</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
|
|
@@ -1,4 +1,4 @@
|
|
|
1
1
|
<!DOCTYPE html><html class="default" lang="en" data-base="../"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>isUnaryOperator | Helpful</title><link rel="icon" href="../assets/favicon.svg" type="image/svg+xml"/><meta name="description" content="Documentation for Helpful"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><a href="../index.html" class="title">Helpful</a><div id="tsd-toolbar-links"></div><button id="tsd-search-trigger" class="tsd-widget" aria-label="Search"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></button><dialog id="tsd-search" aria-label="Search"><input role="combobox" id="tsd-search-input" aria-controls="tsd-search-results" aria-autocomplete="list" aria-expanded="true" autocapitalize="off" autocomplete="off" placeholder="Search the docs" maxLength="100"/><ul role="listbox" id="tsd-search-results"></ul><div id="tsd-search-status" aria-live="polite" aria-atomic="true"><div>Preparing search index...</div></div></dialog><a href="#" class="tsd-widget menu" id="tsd-toolbar-menu-trigger" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb" aria-label="Breadcrumb"><li><a href="../modules/_zthun_helpful-query.html">@zthun/helpful-query</a></li><li><a href="" aria-current="page">isUnaryOperator</a></li></ul><h1>Function isUnaryOperator</h1></div><section class="tsd-panel"><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="isunaryoperator"><span class="tsd-kind-call-signature">isUnaryOperator</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">candidate</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> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">,</span><br/><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.ZOperatorUnary.html" class="tsd-signature-type tsd-kind-enum">ZOperatorUnary</a><a href="#isunaryoperator" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Gets whether a candidate string represents a unary operator.</p>
|
|
2
2
|
</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">string</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">undefined</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.ZOperatorUnary.html" class="tsd-signature-type tsd-kind-enum">ZOperatorUnary</a></h4><p>Type guard true if candidate is a unary operator, false
|
|
3
3
|
otherwise.</p>
|
|
4
|
-
<aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/
|
|
4
|
+
<aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/3e3413f11e509602b2fbae04cbf7d6f6873a3240/packages/helpful-query/src/filter/filter-unary.mts#L128">filter/filter-unary.mts:128</a></li></ul></aside></div></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"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html">Helpful</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
|