@zthun/helpful-web 7.2.0 → 8.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/assets/hierarchy.js +1 -1
- package/dist/assets/main.js +5 -5
- package/dist/assets/navigation.js +1 -1
- package/dist/assets/search.js +1 -1
- package/dist/assets/style.css +262 -232
- package/dist/classes/_zthun_helpful-brands.ZBrandBuilder.html +85 -85
- package/dist/classes/_zthun_helpful-fn.ZAssert.html +11 -11
- package/dist/classes/_zthun_helpful-fn.ZDeserializeJson.html +7 -7
- package/dist/classes/_zthun_helpful-fn.ZDeserializeTry.html +12 -12
- package/dist/classes/_zthun_helpful-fn.ZLazy.html +4 -4
- package/dist/classes/_zthun_helpful-fn.ZQuadrilateralBuilder.html +34 -34
- package/dist/classes/_zthun_helpful-fn.ZQuadrilateralCornersBuilder.html +41 -41
- package/dist/classes/_zthun_helpful-fn.ZRectangle.html +36 -36
- package/dist/classes/_zthun_helpful-fn.ZSerializeJson.html +5 -5
- package/dist/classes/_zthun_helpful-internet.ZCookieBuilder.html +35 -35
- package/dist/classes/_zthun_helpful-internet.ZEmailBuilder.html +17 -17
- package/dist/classes/_zthun_helpful-internet.ZEmailContactAddressBuilder.html +12 -12
- package/dist/classes/_zthun_helpful-internet.ZEmailContactBuilder.html +17 -17
- package/dist/classes/_zthun_helpful-internet.ZEmailEnvelopeBuilder.html +24 -24
- package/dist/classes/_zthun_helpful-internet.ZServerBuilder.html +18 -18
- package/dist/classes/_zthun_helpful-query.ZDataFilterFields.html +7 -7
- package/dist/classes/_zthun_helpful-query.ZDataMatchAlways.html +5 -5
- package/dist/classes/_zthun_helpful-query.ZDataMatchOptional.html +11 -11
- package/dist/classes/_zthun_helpful-query.ZDataRequestBuilder.html +22 -22
- package/dist/classes/_zthun_helpful-query.ZDataSearchFields.html +8 -8
- package/dist/classes/_zthun_helpful-query.ZDataSearchText.html +5 -5
- package/dist/classes/_zthun_helpful-query.ZDataSourceStatic.html +29 -29
- package/dist/classes/_zthun_helpful-query.ZDataSourceStaticOptionsBuilder.html +18 -18
- package/dist/classes/_zthun_helpful-query.ZFilterBinaryBuilder.html +36 -36
- package/dist/classes/_zthun_helpful-query.ZFilterCollectionBuilder.html +23 -23
- package/dist/classes/_zthun_helpful-query.ZFilterDeserialize.html +6 -6
- package/dist/classes/_zthun_helpful-query.ZFilterLogicBuilder.html +21 -21
- package/dist/classes/_zthun_helpful-query.ZFilterSerialize.html +5 -5
- package/dist/classes/_zthun_helpful-query.ZFilterUnaryBuilder.html +18 -18
- package/dist/classes/_zthun_helpful-query.ZMetadataBuilder.html +52 -52
- package/dist/classes/_zthun_helpful-query.ZPageBuilder.html +29 -29
- package/dist/classes/_zthun_helpful-query.ZSortBuilder.html +14 -14
- package/dist/classes/_zthun_helpful-query.ZSortDeserialize.html +6 -6
- package/dist/classes/_zthun_helpful-query.ZSortSerialize.html +5 -5
- package/dist/classes/_zthun_helpful-query.ZSorterSingle.html +10 -10
- package/dist/classes/_zthun_helpful-query.ZWellKnownIconClasses.html +15 -15
- package/dist/classes/_zthun_helpful-react.ZFileSelect.html +6 -6
- package/dist/classes/_zthun_helpful-validation.EqualsOtherPropertyValidator.html +5 -5
- package/dist/classes/_zthun_helpful-validation.IsDataURILimitValidator.html +5 -5
- package/dist/classes/_zthun_helpful-validation.IsNotWhiteSpaceValidator.html +5 -5
- package/dist/classes/_zthun_helpful-validation.RequiresOtherPropertyValidator.html +5 -5
- package/dist/enums/_zthun_helpful-fn.ZHorizontalAnchor.html +8 -8
- package/dist/enums/_zthun_helpful-fn.ZOrientation.html +6 -6
- package/dist/enums/_zthun_helpful-fn.ZVerticalAnchor.html +8 -8
- package/dist/enums/_zthun_helpful-query.ZMetadataType.html +14 -14
- package/dist/enums/_zthun_helpful-query.ZOperatorBinary.html +16 -16
- package/dist/enums/_zthun_helpful-query.ZOperatorCollection.html +6 -6
- package/dist/enums/_zthun_helpful-query.ZOperatorLogic.html +6 -6
- package/dist/enums/_zthun_helpful-query.ZOperatorUnary.html +6 -6
- package/dist/enums/_zthun_helpful-query.ZSortDirection.html +6 -6
- package/dist/functions/_zthun_helpful-fn.countBuckets.html +3 -3
- package/dist/functions/_zthun_helpful-fn.createError.html +3 -3
- package/dist/functions/_zthun_helpful-fn.firstDefined.html +8 -8
- package/dist/functions/_zthun_helpful-fn.firstTruthy.html +8 -8
- package/dist/functions/_zthun_helpful-fn.firstWhere.html +8 -8
- package/dist/functions/_zthun_helpful-fn.isEmptyObject.html +2 -2
- package/dist/functions/_zthun_helpful-fn.joinDefined.html +5 -5
- package/dist/functions/_zthun_helpful-fn.optional.html +15 -15
- package/dist/functions/_zthun_helpful-fn.peel.html +5 -5
- package/dist/functions/_zthun_helpful-fn.peelBetween.html +4 -4
- package/dist/functions/_zthun_helpful-fn.pickBy.html +4 -4
- package/dist/functions/_zthun_helpful-fn.pickDataAttributes.html +4 -4
- package/dist/functions/_zthun_helpful-fn.pickDefined.html +4 -4
- package/dist/functions/_zthun_helpful-fn.purge.html +1 -1
- package/dist/functions/_zthun_helpful-fn.required.html +6 -6
- package/dist/functions/_zthun_helpful-fn.setFirst.html +7 -7
- package/dist/functions/_zthun_helpful-fn.sleep.html +10 -10
- package/dist/functions/_zthun_helpful-fn.tag.html +3 -3
- package/dist/functions/_zthun_helpful-fn.tryFallback.html +12 -12
- package/dist/functions/_zthun_helpful-fn.tryFallbackAsync.html +12 -12
- package/dist/functions/_zthun_helpful-query.isBinaryFilter.html +2 -2
- package/dist/functions/_zthun_helpful-query.isBinaryOperator.html +2 -2
- package/dist/functions/_zthun_helpful-query.isCollectionFilter.html +2 -2
- package/dist/functions/_zthun_helpful-query.isCollectionOperator.html +2 -2
- package/dist/functions/_zthun_helpful-query.isLogicFilter.html +2 -2
- package/dist/functions/_zthun_helpful-query.isLogicOperator.html +2 -2
- package/dist/functions/_zthun_helpful-query.isUnaryFilter.html +2 -2
- package/dist/functions/_zthun_helpful-query.isUnaryOperator.html +2 -2
- package/dist/functions/_zthun_helpful-react.asStateData.html +15 -15
- package/dist/functions/_zthun_helpful-react.asStateError.html +5 -5
- package/dist/functions/_zthun_helpful-react.createKeyboardActivate.html +4 -4
- package/dist/functions/_zthun_helpful-react.isStateErrored.html +4 -4
- package/dist/functions/_zthun_helpful-react.isStateLoaded.html +5 -5
- package/dist/functions/_zthun_helpful-react.isStateLoading.html +4 -4
- package/dist/functions/_zthun_helpful-react.useAmbassadorState.html +17 -17
- package/dist/functions/_zthun_helpful-react.useAsyncState.html +5 -5
- package/dist/functions/_zthun_helpful-react.useFileSelect.html +2 -2
- package/dist/functions/_zthun_helpful-react.useKeyboardActivate.html +4 -4
- package/dist/functions/_zthun_helpful-react.useMoreViewState.html +5 -5
- package/dist/functions/_zthun_helpful-react.usePageViewState.html +5 -5
- package/dist/functions/_zthun_helpful-react.useStateAsArray.html +4 -4
- package/dist/functions/_zthun_helpful-react.useWindowService.html +2 -2
- package/dist/functions/_zthun_helpful-validation.EqualsOtherProperty.html +3 -3
- package/dist/functions/_zthun_helpful-validation.IsDataURILimit.html +2 -2
- package/dist/functions/_zthun_helpful-validation.IsNotWhiteSpace.html +2 -2
- package/dist/functions/_zthun_helpful-validation.RequiresOtherProperty.html +3 -3
- package/dist/hierarchy.html +1 -1
- package/dist/index.html +2 -2
- package/dist/interfaces/_zthun_helpful-brands.IZBrand.html +11 -11
- package/dist/interfaces/_zthun_helpful-fn.IZDeserialize.html +9 -9
- package/dist/interfaces/_zthun_helpful-fn.IZPoint2d.html +6 -6
- package/dist/interfaces/_zthun_helpful-fn.IZPoint3d.html +8 -8
- package/dist/interfaces/_zthun_helpful-fn.IZQuadrilateral.html +11 -11
- package/dist/interfaces/_zthun_helpful-fn.IZQuadrilateralCorners.html +7 -7
- package/dist/interfaces/_zthun_helpful-fn.IZSerialize.html +8 -8
- package/dist/interfaces/_zthun_helpful-internet.IZCookie.html +16 -16
- package/dist/interfaces/_zthun_helpful-internet.IZEmail.html +8 -8
- package/dist/interfaces/_zthun_helpful-internet.IZEmailContact.html +8 -8
- package/dist/interfaces/_zthun_helpful-internet.IZEmailEnvelope.html +10 -10
- package/dist/interfaces/_zthun_helpful-internet.IZServer.html +10 -10
- package/dist/interfaces/_zthun_helpful-query.IZDataMatch.html +8 -8
- package/dist/interfaces/_zthun_helpful-query.IZDataRequest.html +15 -15
- package/dist/interfaces/_zthun_helpful-query.IZDataRequestQuery.html +12 -12
- package/dist/interfaces/_zthun_helpful-query.IZDataSource.html +8 -8
- package/dist/interfaces/_zthun_helpful-query.IZDataSourceStaticOptions.html +8 -8
- package/dist/interfaces/_zthun_helpful-query.IZFilterBinary.html +10 -10
- package/dist/interfaces/_zthun_helpful-query.IZFilterCollection.html +10 -10
- package/dist/interfaces/_zthun_helpful-query.IZFilterLogic.html +8 -8
- package/dist/interfaces/_zthun_helpful-query.IZFilterMetadata.html +4 -4
- package/dist/interfaces/_zthun_helpful-query.IZFilterOperator.html +7 -7
- package/dist/interfaces/_zthun_helpful-query.IZFilterSubject.html +8 -8
- package/dist/interfaces/_zthun_helpful-query.IZMetadata.html +24 -24
- package/dist/interfaces/_zthun_helpful-query.IZPage.html +7 -7
- package/dist/interfaces/_zthun_helpful-query.IZSort.html +6 -6
- package/dist/interfaces/_zthun_helpful-query.IZSorter.html +8 -8
- package/dist/interfaces/_zthun_helpful-react.IZFileSelect.html +4 -4
- package/dist/interfaces/_zthun_helpful-react.IZKeyboardInteraction.html +8 -8
- package/dist/modules/_zthun_helpful-brands.html +4 -4
- package/dist/modules/_zthun_helpful-fn.html +3 -3
- package/dist/modules/_zthun_helpful-internet.html +3 -3
- package/dist/modules/_zthun_helpful-node.html +3 -3
- package/dist/modules/_zthun_helpful-query.html +4 -4
- package/dist/modules/_zthun_helpful-react.html +3 -3
- package/dist/modules/_zthun_helpful-validation.html +3 -3
- package/dist/modules.html +1 -1
- package/dist/types/_zthun_helpful-fn.DeepPartial.html +1 -1
- package/dist/types/_zthun_helpful-fn.JoinListInputParameter.html +3 -3
- package/dist/types/_zthun_helpful-fn.PickPredicate.html +1 -1
- package/dist/types/_zthun_helpful-fn.PickResult.html +1 -1
- package/dist/types/_zthun_helpful-fn.RequiredDeep.html +1 -1
- package/dist/types/_zthun_helpful-fn.RequiredPick.html +1 -1
- package/dist/types/_zthun_helpful-fn.ZAnchor.html +4 -4
- package/dist/types/_zthun_helpful-fn.ZCornersHorizontal.html +4 -2
- package/dist/types/_zthun_helpful-fn.ZCornersVertical.html +4 -2
- package/dist/types/_zthun_helpful-fn.ZObligatedValue.html +3 -3
- package/dist/types/_zthun_helpful-fn.ZQuadrilateralCornersLike.html +2 -2
- package/dist/types/_zthun_helpful-fn.ZQuadrilateralLike.html +2 -2
- package/dist/types/_zthun_helpful-fn.ZSideAnchor.html +2 -2
- package/dist/types/_zthun_helpful-fn.ZSupplier.html +2 -2
- package/dist/types/_zthun_helpful-fn.ZSupplierAsync.html +2 -2
- package/dist/types/_zthun_helpful-query.IZFilter.html +2 -2
- package/dist/types/_zthun_helpful-query.IZFilterUnary.html +2 -2
- package/dist/types/_zthun_helpful-query.ZOperatorFilter.html +2 -2
- package/dist/types/_zthun_helpful-react.ZAmbassadorReducer.html +2 -2
- package/dist/types/_zthun_helpful-react.ZAmbassadorReducerRequired.html +2 -2
- package/dist/types/_zthun_helpful-react.ZAmbassadorSetCurrent.html +2 -2
- package/dist/types/_zthun_helpful-react.ZAsyncDataState.html +2 -2
- package/dist/types/_zthun_helpful-react.ZAsyncDataTuple.html +2 -2
- package/dist/types/_zthun_helpful-react.ZAsyncUseData.html +2 -2
- package/dist/types/_zthun_helpful-react.ZSetStateAsArray.html +1 -1
- package/dist/types/_zthun_helpful-react.ZStateAsArrayReducer.html +1 -1
- package/dist/variables/_zthun_helpful-brands.ZBrands.html +2 -2
- package/dist/variables/_zthun_helpful-fn._global.html +1 -1
- package/dist/variables/_zthun_helpful-fn.bash.html +14 -0
- package/dist/variables/_zthun_helpful-fn.commaJoinDefined.html +5 -0
- package/dist/variables/_zthun_helpful-fn.createGuid.html +11 -0
- package/dist/variables/_zthun_helpful-fn.css.html +16 -0
- package/dist/variables/_zthun_helpful-fn.cssJoinDefined.html +5 -0
- package/dist/variables/_zthun_helpful-fn.html.html +16 -0
- package/dist/variables/_zthun_helpful-fn.javascript.html +14 -0
- package/dist/variables/_zthun_helpful-fn.js.html +16 -0
- package/dist/variables/_zthun_helpful-fn.markdown.html +14 -0
- package/dist/variables/_zthun_helpful-fn.md.html +16 -0
- package/dist/variables/_zthun_helpful-fn.pipeJoinDefined.html +5 -0
- package/dist/variables/_zthun_helpful-fn.semiColonJoinDefined.html +5 -0
- package/dist/variables/_zthun_helpful-fn.sh.html +14 -0
- package/dist/variables/_zthun_helpful-fn.spaceJoinDefined.html +5 -0
- package/dist/variables/_zthun_helpful-fn.ts.html +16 -0
- package/dist/variables/_zthun_helpful-fn.typescript.html +14 -0
- package/dist/variables/_zthun_helpful-fn.zsh.html +14 -0
- package/dist/variables/_zthun_helpful-query.ZBinaryComparators.html +2 -2
- package/dist/variables/_zthun_helpful-query.ZCollectionComparators.html +2 -2
- package/dist/variables/_zthun_helpful-query.ZOperatorsBinary.html +2 -2
- package/dist/variables/_zthun_helpful-query.ZOperatorsCollection.html +2 -2
- package/dist/variables/_zthun_helpful-query.ZOperatorsFilter.html +2 -2
- package/dist/variables/_zthun_helpful-query.ZOperatorsLogic.html +2 -2
- package/dist/variables/_zthun_helpful-query.ZOperatorsUnary.html +2 -2
- package/dist/variables/_zthun_helpful-query.ZSortDirections.html +2 -2
- package/dist/variables/_zthun_helpful-query.ZUnaryComparators.html +2 -2
- package/dist/variables/_zthun_helpful-react.DefaultActivateCodes.html +2 -2
- package/dist/variables/_zthun_helpful-react.ZAsyncLoading.html +2 -2
- package/dist/variables/_zthun_helpful-react.ZFileSelectContext.html +2 -0
- package/dist/variables/_zthun_helpful-react.ZWindowServiceContext.html +2 -0
- package/package.json +12 -12
- package/dist/classes/_zthun_helpful-node.ZFileSystemNodeBuilder.html +0 -11
- package/dist/classes/_zthun_helpful-node.ZFileSystemService.html +0 -12
- package/dist/enums/_zthun_helpful-node.ZFileSystemNodeType.html +0 -4
- package/dist/functions/_zthun_helpful-fn.bash.html +0 -14
- package/dist/functions/_zthun_helpful-fn.commaJoinDefined.html +0 -5
- package/dist/functions/_zthun_helpful-fn.createGuid.html +0 -11
- package/dist/functions/_zthun_helpful-fn.css.html +0 -16
- package/dist/functions/_zthun_helpful-fn.cssJoinDefined.html +0 -5
- package/dist/functions/_zthun_helpful-fn.html.html +0 -16
- package/dist/functions/_zthun_helpful-fn.javascript.html +0 -14
- package/dist/functions/_zthun_helpful-fn.js.html +0 -16
- package/dist/functions/_zthun_helpful-fn.markdown.html +0 -14
- package/dist/functions/_zthun_helpful-fn.md.html +0 -16
- package/dist/functions/_zthun_helpful-fn.pipeJoinDefined.html +0 -5
- package/dist/functions/_zthun_helpful-fn.semiColonJoinDefined.html +0 -5
- package/dist/functions/_zthun_helpful-fn.sh.html +0 -14
- package/dist/functions/_zthun_helpful-fn.spaceJoinDefined.html +0 -5
- package/dist/functions/_zthun_helpful-fn.ts.html +0 -16
- package/dist/functions/_zthun_helpful-fn.typescript.html +0 -14
- package/dist/functions/_zthun_helpful-fn.zsh.html +0 -14
- package/dist/functions/_zthun_helpful-node.walk.html +0 -12
- package/dist/functions/_zthun_helpful-react.ZFileSelectContext.html +0 -10
- package/dist/functions/_zthun_helpful-react.ZWindowServiceContext.html +0 -10
- package/dist/interfaces/_zthun_helpful-node.IZFileSystemNode.html +0 -11
- package/dist/interfaces/_zthun_helpful-node.IZFileSystemSearchOptions.html +0 -5
- package/dist/interfaces/_zthun_helpful-node.IZFileSystemService.html +0 -11
- package/dist/interfaces/_zthun_helpful-node.ZWalkOptions.html +0 -13
- package/dist/variables/_zthun_helpful-node.ZFileSystemToken.html +0 -3
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
<!DOCTYPE html><html class="default" lang="en" data-base="
|
|
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>DefaultActivateCodes | Helpful</title><link rel="icon" href="../assets/favicon.svg" type="image/svg+xml"/><meta name="description" content="Documentation for Helpful"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><a href="../index.html" class="title">Helpful</a><div id="tsd-toolbar-links"></div><button id="tsd-search-trigger" class="tsd-widget" aria-label="Search"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></button><dialog id="tsd-search" aria-label="Search"><input role="combobox" id="tsd-search-input" aria-controls="tsd-search-results" aria-autocomplete="list" aria-expanded="true" autocapitalize="off" autocomplete="off" placeholder="Search the docs" maxLength="100"/><ul role="listbox" id="tsd-search-results"></ul><div id="tsd-search-status" aria-live="polite" aria-atomic="true"><div>Preparing search index...</div></div></dialog><a href="#" class="tsd-widget menu" id="tsd-toolbar-menu-trigger" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb" aria-label="Breadcrumb"><li><a href="../modules/_zthun_helpful-react.html">@zthun/helpful-react</a></li><li><a href="" aria-current="page">DefaultActivateCodes</a></li></ul><h1>Variable DefaultActivateCodes<code class="tsd-tag">Const</code></h1></div><div class="tsd-signature"><span class="tsd-kind-variable">DefaultActivateCodes</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> = ...</span></div><div class="tsd-comment tsd-typography"><p>The default codes that will cause the proxy handler to be invoked.</p>
|
|
2
2
|
<p>This will normally be 'Enter' and 'Space', but you can override them
|
|
3
3
|
in <a href="../functions/_zthun_helpful-react.useKeyboardActivate.html" class="tsd-kind-function">useKeyboardActivate</a>.</p>
|
|
4
|
-
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/
|
|
4
|
+
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/3e88f38b916d0973f2520566526efbd1519ed6af/packages/helpful-react/src/keyboard-activate/use-keyboard-activate.mts#L37">keyboard-activate/use-keyboard-activate.mts:37</a></li></ul></aside></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,2 +1,2 @@
|
|
|
1
|
-
<!DOCTYPE html><html class="default" lang="en" data-base="
|
|
2
|
-
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/
|
|
1
|
+
<!DOCTYPE html><html class="default" lang="en" data-base="../"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>ZAsyncLoading | Helpful</title><link rel="icon" href="../assets/favicon.svg" type="image/svg+xml"/><meta name="description" content="Documentation for Helpful"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><a href="../index.html" class="title">Helpful</a><div id="tsd-toolbar-links"></div><button id="tsd-search-trigger" class="tsd-widget" aria-label="Search"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></button><dialog id="tsd-search" aria-label="Search"><input role="combobox" id="tsd-search-input" aria-controls="tsd-search-results" aria-autocomplete="list" aria-expanded="true" autocapitalize="off" autocomplete="off" placeholder="Search the docs" maxLength="100"/><ul role="listbox" id="tsd-search-results"></ul><div id="tsd-search-status" aria-live="polite" aria-atomic="true"><div>Preparing search index...</div></div></dialog><a href="#" class="tsd-widget menu" id="tsd-toolbar-menu-trigger" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb" aria-label="Breadcrumb"><li><a href="../modules/_zthun_helpful-react.html">@zthun/helpful-react</a></li><li><a href="" aria-current="page">ZAsyncLoading</a></li></ul><h1>Variable ZAsyncLoading<code class="tsd-tag">Const</code></h1></div><div class="tsd-signature"><span class="tsd-kind-variable">ZAsyncLoading</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-keyword">typeof</span> <a href="" class="tsd-signature-type tsd-kind-variable">ZAsyncLoading</a><span class="tsd-signature-symbol"> = ...</span></div><div class="tsd-comment tsd-typography"><p>The value that will be set on an ZAsyncDataState when the data is being loaded.</p>
|
|
2
|
+
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/3e88f38b916d0973f2520566526efbd1519ed6af/packages/helpful-react/src/async-state/use-async-state.mts#L10">async-state/use-async-state.mts:10</a></li></ul></aside></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>
|
|
@@ -0,0 +1,2 @@
|
|
|
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>ZFileSelectContext | Helpful</title><link rel="icon" href="../assets/favicon.svg" type="image/svg+xml"/><meta name="description" content="Documentation for Helpful"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><a href="../index.html" class="title">Helpful</a><div id="tsd-toolbar-links"></div><button id="tsd-search-trigger" class="tsd-widget" aria-label="Search"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></button><dialog id="tsd-search" aria-label="Search"><input role="combobox" id="tsd-search-input" aria-controls="tsd-search-results" aria-autocomplete="list" aria-expanded="true" autocapitalize="off" autocomplete="off" placeholder="Search the docs" maxLength="100"/><ul role="listbox" id="tsd-search-results"></ul><div id="tsd-search-status" aria-live="polite" aria-atomic="true"><div>Preparing search index...</div></div></dialog><a href="#" class="tsd-widget menu" id="tsd-toolbar-menu-trigger" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb" aria-label="Breadcrumb"><li><a href="../modules/_zthun_helpful-react.html">@zthun/helpful-react</a></li><li><a href="" aria-current="page">ZFileSelectContext</a></li></ul><h1>Variable ZFileSelectContext<code class="tsd-tag">Const</code></h1></div><div class="tsd-signature"><span class="tsd-kind-variable">ZFileSelectContext</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Context</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/_zthun_helpful-react.IZFileSelect.html" class="tsd-signature-type tsd-kind-interface">IZFileSelect</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol"> = ...</span></div><div class="tsd-comment tsd-typography"><p>Represents the context for using a file select object.</p>
|
|
2
|
+
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/3e88f38b916d0973f2520566526efbd1519ed6af/packages/helpful-react/src/file-select/file-select.mts#L104">file-select/file-select.mts:104</a></li></ul></aside></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>
|
|
@@ -0,0 +1,2 @@
|
|
|
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>ZWindowServiceContext | Helpful</title><link rel="icon" href="../assets/favicon.svg" type="image/svg+xml"/><meta name="description" content="Documentation for Helpful"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><a href="../index.html" class="title">Helpful</a><div id="tsd-toolbar-links"></div><button id="tsd-search-trigger" class="tsd-widget" aria-label="Search"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></button><dialog id="tsd-search" aria-label="Search"><input role="combobox" id="tsd-search-input" aria-controls="tsd-search-results" aria-autocomplete="list" aria-expanded="true" autocapitalize="off" autocomplete="off" placeholder="Search the docs" maxLength="100"/><ul role="listbox" id="tsd-search-results"></ul><div id="tsd-search-status" aria-live="polite" aria-atomic="true"><div>Preparing search index...</div></div></dialog><a href="#" class="tsd-widget menu" id="tsd-toolbar-menu-trigger" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb" aria-label="Breadcrumb"><li><a href="../modules/_zthun_helpful-react.html">@zthun/helpful-react</a></li><li><a href="" aria-current="page">ZWindowServiceContext</a></li></ul><h1>Variable ZWindowServiceContext<code class="tsd-tag">Const</code></h1></div><div class="tsd-signature"><span class="tsd-kind-variable">ZWindowServiceContext</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Context</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-keyword">typeof</span> <span class="tsd-signature-type">globalThis</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol"> = ...</span></div><div class="tsd-comment tsd-typography"><p>Represents the window context.</p>
|
|
2
|
+
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/3e88f38b916d0973f2520566526efbd1519ed6af/packages/helpful-react/src/window/window-service.mts#L7">window/window-service.mts:7</a></li></ul></aside></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>
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@zthun/helpful-web",
|
|
3
|
-
"version": "
|
|
3
|
+
"version": "8.0.0",
|
|
4
4
|
"description": "A documentation website for showing helpful.",
|
|
5
5
|
"author": "Anthony Bonta",
|
|
6
6
|
"license": "MIT",
|
|
@@ -10,7 +10,6 @@
|
|
|
10
10
|
"url": "https://github.com/zthun/helpful",
|
|
11
11
|
"directory": "packages/helpful-web"
|
|
12
12
|
},
|
|
13
|
-
"main": "./dist/main.js",
|
|
14
13
|
"scripts": {
|
|
15
14
|
"build": "typedoc"
|
|
16
15
|
},
|
|
@@ -18,19 +17,20 @@
|
|
|
18
17
|
"access": "public"
|
|
19
18
|
},
|
|
20
19
|
"devDependencies": {
|
|
21
|
-
"@zthun/helpful-brands": "^
|
|
22
|
-
"@zthun/helpful-fn": "^
|
|
23
|
-
"@zthun/helpful-internet": "^
|
|
24
|
-
"@zthun/helpful-node": "^
|
|
25
|
-
"@zthun/helpful-query": "^
|
|
26
|
-
"@zthun/helpful-react": "^
|
|
27
|
-
"@zthun/helpful-validation": "^
|
|
28
|
-
"
|
|
29
|
-
"
|
|
20
|
+
"@zthun/helpful-brands": "^8.0.0",
|
|
21
|
+
"@zthun/helpful-fn": "^8.0.0",
|
|
22
|
+
"@zthun/helpful-internet": "^8.0.0",
|
|
23
|
+
"@zthun/helpful-node": "^8.0.0",
|
|
24
|
+
"@zthun/helpful-query": "^8.0.0",
|
|
25
|
+
"@zthun/helpful-react": "^8.0.0",
|
|
26
|
+
"@zthun/helpful-validation": "^8.0.0",
|
|
27
|
+
"@zthun/janitor-build-config": "^19.1.5",
|
|
28
|
+
"typedoc": "^0.28.5",
|
|
29
|
+
"typescript": "~5.8.3"
|
|
30
30
|
},
|
|
31
31
|
"files": [
|
|
32
32
|
"dist"
|
|
33
33
|
],
|
|
34
34
|
"sideEffects": false,
|
|
35
|
-
"gitHead": "
|
|
35
|
+
"gitHead": "ffd5b22ef5da2643562a12aab61873c9b956ac11"
|
|
36
36
|
}
|
|
@@ -1,11 +0,0 @@
|
|
|
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>ZFileSystemNodeBuilder | Helpful</title><link rel="icon" href="../assets/favicon.svg" type="image/svg+xml"/><meta name="description" content="Documentation for Helpful"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search"><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">Helpful</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../modules.html">Helpful</a></li><li><a href="../modules/_zthun_helpful-node.html">@zthun/helpful-node</a></li><li><a href="_zthun_helpful-node.ZFileSystemNodeBuilder.html">ZFileSystemNodeBuilder</a></li></ul><h1>Class ZFileSystemNodeBuilder</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>Represents a builder for a file system node.</p>
|
|
2
|
-
</div><div class="tsd-comment tsd-typography"></div></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/e0425cedbb61f1914a89cb867f0d1618a11ea537/packages/helpful-node/src/file-system/file-system-node.mts#L41">packages/helpful-node/src/file-system/file-system-node.mts:41</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Constructors</h3><div class="tsd-index-list"><a href="_zthun_helpful-node.ZFileSystemNodeBuilder.html#constructor" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a>
|
|
3
|
-
</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="_zthun_helpful-node.ZFileSystemNodeBuilder.html#file" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>file</span></a>
|
|
4
|
-
<a href="_zthun_helpful-node.ZFileSystemNodeBuilder.html#folder" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>folder</span></a>
|
|
5
|
-
</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Methods</h3><div class="tsd-index-list"><a href="_zthun_helpful-node.ZFileSystemNodeBuilder.html#build" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>build</span></a>
|
|
6
|
-
<a href="_zthun_helpful-node.ZFileSystemNodeBuilder.html#created" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>created</span></a>
|
|
7
|
-
<a href="_zthun_helpful-node.ZFileSystemNodeBuilder.html#path" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>path</span></a>
|
|
8
|
-
<a href="_zthun_helpful-node.ZFileSystemNodeBuilder.html#size" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>size</span></a>
|
|
9
|
-
<a href="_zthun_helpful-node.ZFileSystemNodeBuilder.html#type" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>type</span></a>
|
|
10
|
-
<a href="_zthun_helpful-node.ZFileSystemNodeBuilder.html#updated" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>updated</span></a>
|
|
11
|
-
</div></section></div></details></section></section><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Constructors"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Constructors</h2></summary><section><section class="tsd-panel tsd-member"><a id="constructor" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>constructor</span><a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="constructorzfilesystemnodebuilder" class="tsd-anchor"></a><span class="tsd-signature-keyword">new</span> <span class="tsd-kind-constructor-signature">ZFileSystemNodeBuilder</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <a href="_zthun_helpful-node.ZFileSystemNodeBuilder.html" class="tsd-signature-type tsd-kind-class">ZFileSystemNodeBuilder</a><a href="#constructorzfilesystemnodebuilder" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <a href="_zthun_helpful-node.ZFileSystemNodeBuilder.html" class="tsd-signature-type tsd-kind-class">ZFileSystemNodeBuilder</a></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/e0425cedbb61f1914a89cb867f0d1618a11ea537/packages/helpful-node/src/file-system/file-system-node.mts#L44">packages/helpful-node/src/file-system/file-system-node.mts:44</a></li></ul></aside></li></ul></section></section></details><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Properties"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Properties</h2></summary><section><section class="tsd-panel tsd-member"><a id="file" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>file</span><a href="#file" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">file</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">args</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">[</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=></span> <a href="_zthun_helpful-node.ZFileSystemNodeBuilder.html" class="tsd-signature-type tsd-kind-class">ZFileSystemNodeBuilder</a><span class="tsd-signature-symbol"> = ...</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/e0425cedbb61f1914a89cb867f0d1618a11ea537/packages/helpful-node/src/file-system/file-system-node.mts#L79">packages/helpful-node/src/file-system/file-system-node.mts:79</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="folder" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>folder</span><a href="#folder" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">folder</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">args</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">[</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=></span> <a href="_zthun_helpful-node.ZFileSystemNodeBuilder.html" class="tsd-signature-type tsd-kind-class">ZFileSystemNodeBuilder</a><span class="tsd-signature-symbol"> = ...</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/e0425cedbb61f1914a89cb867f0d1618a11ea537/packages/helpful-node/src/file-system/file-system-node.mts#L80">packages/helpful-node/src/file-system/file-system-node.mts:80</a></li></ul></aside></section></section></details><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Methods"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Methods</h2></summary><section><section class="tsd-panel tsd-member"><a id="build" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>build</span><a href="#build" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="build-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">build</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/_zthun_helpful-node.IZFileSystemNode.html" class="tsd-signature-type tsd-kind-interface">IZFileSystemNode</a><a href="#build-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <a href="../interfaces/_zthun_helpful-node.IZFileSystemNode.html" class="tsd-signature-type tsd-kind-interface">IZFileSystemNode</a></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/e0425cedbb61f1914a89cb867f0d1618a11ea537/packages/helpful-node/src/file-system/file-system-node.mts#L82">packages/helpful-node/src/file-system/file-system-node.mts:82</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="created" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>created</span><a href="#created" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="created-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">created</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">at</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">Date</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="_zthun_helpful-node.ZFileSystemNodeBuilder.html" class="tsd-signature-type tsd-kind-class">ZFileSystemNodeBuilder</a><a href="#created-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">at</span>: <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">Date</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <a href="_zthun_helpful-node.ZFileSystemNodeBuilder.html" class="tsd-signature-type tsd-kind-class">ZFileSystemNodeBuilder</a></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/e0425cedbb61f1914a89cb867f0d1618a11ea537/packages/helpful-node/src/file-system/file-system-node.mts#L51">packages/helpful-node/src/file-system/file-system-node.mts:51</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="path" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>path</span><a href="#path" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="path-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">path</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">path</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="_zthun_helpful-node.ZFileSystemNodeBuilder.html" class="tsd-signature-type tsd-kind-class">ZFileSystemNodeBuilder</a><a href="#path-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">path</span>: <span class="tsd-signature-type">string</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <a href="_zthun_helpful-node.ZFileSystemNodeBuilder.html" class="tsd-signature-type tsd-kind-class">ZFileSystemNodeBuilder</a></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/e0425cedbb61f1914a89cb867f0d1618a11ea537/packages/helpful-node/src/file-system/file-system-node.mts#L69">packages/helpful-node/src/file-system/file-system-node.mts:69</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="size" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>size</span><a href="#size" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="size-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">size</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">bytes</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">number</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">bigint</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="_zthun_helpful-node.ZFileSystemNodeBuilder.html" class="tsd-signature-type tsd-kind-class">ZFileSystemNodeBuilder</a><a href="#size-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">bytes</span>: <span class="tsd-signature-type">undefined</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">number</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">bigint</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <a href="_zthun_helpful-node.ZFileSystemNodeBuilder.html" class="tsd-signature-type tsd-kind-class">ZFileSystemNodeBuilder</a></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/e0425cedbb61f1914a89cb867f0d1618a11ea537/packages/helpful-node/src/file-system/file-system-node.mts#L63">packages/helpful-node/src/file-system/file-system-node.mts:63</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="type" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>type</span><a href="#type" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="type-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">type</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">type</span><span class="tsd-signature-symbol">:</span> <a href="../enums/_zthun_helpful-node.ZFileSystemNodeType.html" class="tsd-signature-type tsd-kind-enum">ZFileSystemNodeType</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="_zthun_helpful-node.ZFileSystemNodeBuilder.html" class="tsd-signature-type tsd-kind-class">ZFileSystemNodeBuilder</a><a href="#type-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">type</span>: <a href="../enums/_zthun_helpful-node.ZFileSystemNodeType.html" class="tsd-signature-type tsd-kind-enum">ZFileSystemNodeType</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <a href="_zthun_helpful-node.ZFileSystemNodeBuilder.html" class="tsd-signature-type tsd-kind-class">ZFileSystemNodeBuilder</a></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/e0425cedbb61f1914a89cb867f0d1618a11ea537/packages/helpful-node/src/file-system/file-system-node.mts#L74">packages/helpful-node/src/file-system/file-system-node.mts:74</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="updated" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>updated</span><a href="#updated" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="updated-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">updated</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">at</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">Date</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="_zthun_helpful-node.ZFileSystemNodeBuilder.html" class="tsd-signature-type tsd-kind-class">ZFileSystemNodeBuilder</a><a href="#updated-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">at</span>: <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">Date</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <a href="_zthun_helpful-node.ZFileSystemNodeBuilder.html" class="tsd-signature-type tsd-kind-class">ZFileSystemNodeBuilder</a></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/e0425cedbb61f1914a89cb867f0d1618a11ea537/packages/helpful-node/src/file-system/file-system-node.mts#L57">packages/helpful-node/src/file-system/file-system-node.mts:57</a></li></ul></aside></li></ul></section></section></details></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Constructors"><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Constructors</summary><div><a href="#constructor" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a></div></details><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Properties</summary><div><a href="#file" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>file</span></a><a href="#folder" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>folder</span></a></div></details><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Methods"><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Methods</summary><div><a href="#build" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>build</span></a><a href="#created" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>created</span></a><a href="#path" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>path</span></a><a href="#size" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>size</span></a><a href="#type" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>type</span></a><a href="#updated" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>updated</span></a></div></details></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html">Helpful</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
|
|
@@ -1,12 +0,0 @@
|
|
|
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>ZFileSystemService | Helpful</title><link rel="icon" href="../assets/favicon.svg" type="image/svg+xml"/><meta name="description" content="Documentation for Helpful"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search"><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">Helpful</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../modules.html">Helpful</a></li><li><a href="../modules/_zthun_helpful-node.html">@zthun/helpful-node</a></li><li><a href="_zthun_helpful-node.ZFileSystemService.html">ZFileSystemService</a></li></ul><h1>Class ZFileSystemService</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>Represents a node implementation of a file system service.</p>
|
|
2
|
-
</div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel"><h4>Implements</h4><ul class="tsd-hierarchy"><li><a href="../interfaces/_zthun_helpful-node.IZFileSystemService.html" class="tsd-signature-type tsd-kind-interface">IZFileSystemService</a></li></ul></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/e0425cedbb61f1914a89cb867f0d1618a11ea537/packages/helpful-node/src/file-system/file-system-service.mts#L60">packages/helpful-node/src/file-system/file-system-service.mts:60</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Constructors</h3><div class="tsd-index-list"><a href="_zthun_helpful-node.ZFileSystemService.html#constructor" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a>
|
|
3
|
-
</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Methods</h3><div class="tsd-index-list"><a href="_zthun_helpful-node.ZFileSystemService.html#info" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>info</span></a>
|
|
4
|
-
<a href="_zthun_helpful-node.ZFileSystemService.html#search" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>search</span></a>
|
|
5
|
-
</div></section></div></details></section></section><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Constructors"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Constructors</h2></summary><section><section class="tsd-panel tsd-member"><a id="constructor" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>constructor</span><a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="constructorzfilesystemservice" class="tsd-anchor"></a><span class="tsd-signature-keyword">new</span> <span class="tsd-kind-constructor-signature">ZFileSystemService</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <a href="_zthun_helpful-node.ZFileSystemService.html" class="tsd-signature-type tsd-kind-class">ZFileSystemService</a><a href="#constructorzfilesystemservice" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <a href="_zthun_helpful-node.ZFileSystemService.html" class="tsd-signature-type tsd-kind-class">ZFileSystemService</a></h4></li></ul></section></section></details><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Methods"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Methods</h2></summary><section><section class="tsd-panel tsd-member"><a id="info" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>info</span><a href="#info" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="info-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">info</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">path</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/_zthun_helpful-node.IZFileSystemNode.html" class="tsd-signature-type tsd-kind-interface">IZFileSystemNode</a><span class="tsd-signature-symbol">></span><a href="#info-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Gets information about a node.</p>
|
|
6
|
-
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">path</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The path to get information for.</p>
|
|
7
|
-
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/_zthun_helpful-node.IZFileSystemNode.html" class="tsd-signature-type tsd-kind-interface">IZFileSystemNode</a><span class="tsd-signature-symbol">></span></h4><p>Information about the node.</p>
|
|
8
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/_zthun_helpful-node.IZFileSystemService.html">IZFileSystemService</a>.<a href="../interfaces/_zthun_helpful-node.IZFileSystemService.html#info">info</a></p><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/e0425cedbb61f1914a89cb867f0d1618a11ea537/packages/helpful-node/src/file-system/file-system-service.mts#L61">packages/helpful-node/src/file-system/file-system-service.mts:61</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="search" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>search</span><a href="#search" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="search-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">search</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">pattern</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">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../interfaces/_zthun_helpful-node.IZFileSystemSearchOptions.html" class="tsd-signature-type tsd-kind-interface">IZFileSystemSearchOptions</a><span class="tsd-signature-symbol">,</span><br/><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 href="../interfaces/_zthun_helpful-node.IZFileSystemNode.html" class="tsd-signature-type tsd-kind-interface">IZFileSystemNode</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><a href="#search-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Reads all nodes that match a pattern.</p>
|
|
9
|
-
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">pattern</span>: <span class="tsd-signature-type">string</span> <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 pattern string to match against.</p>
|
|
10
|
-
</div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">options</span>: <a href="../interfaces/_zthun_helpful-node.IZFileSystemSearchOptions.html" class="tsd-signature-type tsd-kind-interface">IZFileSystemSearchOptions</a></span><div class="tsd-comment tsd-typography"><p>The options for the search.</p>
|
|
11
|
-
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/_zthun_helpful-node.IZFileSystemNode.html" class="tsd-signature-type tsd-kind-interface">IZFileSystemNode</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h4><p>A list of path strings that match the given patterns.</p>
|
|
12
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/_zthun_helpful-node.IZFileSystemService.html">IZFileSystemService</a>.<a href="../interfaces/_zthun_helpful-node.IZFileSystemService.html#search">search</a></p><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/e0425cedbb61f1914a89cb867f0d1618a11ea537/packages/helpful-node/src/file-system/file-system-service.mts#L66">packages/helpful-node/src/file-system/file-system-service.mts:66</a></li></ul></aside></li></ul></section></section></details></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Constructors"><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Constructors</summary><div><a href="#constructor" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a></div></details><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Methods"><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Methods</summary><div><a href="#info" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>info</span></a><a href="#search" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>search</span></a></div></details></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html">Helpful</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
|
|
@@ -1,4 +0,0 @@
|
|
|
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>ZFileSystemNodeType | Helpful</title><link rel="icon" href="../assets/favicon.svg" type="image/svg+xml"/><meta name="description" content="Documentation for Helpful"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search"><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">Helpful</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../modules.html">Helpful</a></li><li><a href="../modules/_zthun_helpful-node.html">@zthun/helpful-node</a></li><li><a href="_zthun_helpful-node.ZFileSystemNodeType.html">ZFileSystemNodeType</a></li></ul><h1>Enumeration ZFileSystemNodeType</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>Represents a type of a file system node.</p>
|
|
2
|
-
</div><div class="tsd-comment tsd-typography"></div></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/e0425cedbb61f1914a89cb867f0d1618a11ea537/packages/helpful-node/src/file-system/file-system-node.mts#L6">packages/helpful-node/src/file-system/file-system-node.mts:6</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Enumeration Members</h3><div class="tsd-index-list"><a href="_zthun_helpful-node.ZFileSystemNodeType.html#file" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-16"></use></svg><span>File</span></a>
|
|
3
|
-
<a href="_zthun_helpful-node.ZFileSystemNodeType.html#folder" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-16"></use></svg><span>Folder</span></a>
|
|
4
|
-
</div></section></div></details></section></section><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Enumeration Members"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Enumeration Members</h2></summary><section><section class="tsd-panel tsd-member"><a id="file" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>File</span><a href="#file" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-enum-member">File</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"file"</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/e0425cedbb61f1914a89cb867f0d1618a11ea537/packages/helpful-node/src/file-system/file-system-node.mts#L7">packages/helpful-node/src/file-system/file-system-node.mts:7</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="folder" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>Folder</span><a href="#folder" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-enum-member">Folder</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"folder"</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/e0425cedbb61f1914a89cb867f0d1618a11ea537/packages/helpful-node/src/file-system/file-system-node.mts#L8">packages/helpful-node/src/file-system/file-system-node.mts:8</a></li></ul></aside></section></section></details></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Enumeration Members"><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Enumeration Members</summary><div><a href="#file" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-16"></use></svg><span>File</span></a><a href="#folder" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-16"></use></svg><span>Folder</span></a></div></details></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html">Helpful</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
|
|
@@ -1,14 +0,0 @@
|
|
|
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>bash | Helpful</title><link rel="icon" href="../assets/favicon.svg" type="image/svg+xml"/><meta name="description" content="Documentation for Helpful"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search"><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">Helpful</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../modules.html">Helpful</a></li><li><a href="../modules/_zthun_helpful-fn.html">@zthun/helpful-fn</a></li><li><a href="_zthun_helpful-fn.bash.html">bash</a></li></ul><h1>Function bash</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>An alias for <a href="_zthun_helpful-fn.tag.html" class="tsd-kind-function">tag</a>.</p>
|
|
2
|
-
</div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel"><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="bash" class="tsd-anchor"></a><span class="tsd-kind-call-signature">bash</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">strings</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">TemplateStringsArray</span><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">expressions</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><a href="#bash" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>This is just a method that allows you to tag an interpolation
|
|
3
|
-
string as a syntax language.</p>
|
|
4
|
-
<p>This is useful with IDE extensions that can detect the language
|
|
5
|
-
and do the syntax highlighting for you.</p>
|
|
6
|
-
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">strings</span>: <span class="tsd-signature-type">TemplateStringsArray</span></span><div class="tsd-comment tsd-typography"><p>The string breaks for interpolation.</p>
|
|
7
|
-
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">expressions</span>: <span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">[]</span></span><div class="tsd-comment tsd-typography"><p>The equivalent expressions that break apart
|
|
8
|
-
the single string literal.</p>
|
|
9
|
-
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><p>The compiled string literal. This is no different
|
|
10
|
-
than letting native JavaScript do it for you.</p>
|
|
11
|
-
<div class="tsd-comment tsd-typography"><div class="tsd-tag-example"><h4 class="tsd-anchor-link"><a id="example" class="tsd-anchor"></a>Example<a href="#example" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-4">const</span><span class="hl-2"> </span><span class="hl-7">html</span><span class="hl-2"> = </span><span class="hl-6">tag</span><span class="hl-2">;</span><br/><span class="hl-4">const</span><span class="hl-2"> </span><span class="hl-7">css</span><span class="hl-2"> = </span><span class="hl-6">tag</span><span class="hl-2">;</span><br/><br/><span class="hl-4">const</span><span class="hl-2"> </span><span class="hl-7">$html</span><span class="hl-2"> = </span><span class="hl-1">html</span><span class="hl-3">`</span><br/><span class="hl-3"> <div>Some IDE extensions will highlight this as html</div></span><br/><span class="hl-3">`</span><br/><br/><span class="hl-4">const</span><span class="hl-2"> </span><span class="hl-7">$css</span><span class="hl-2"> = </span><span class="hl-1">css</span><span class="hl-3">`</span><br/><span class="hl-3"> button {</span><br/><span class="hl-3"> display: grid;</span><br/><span class="hl-3"> }</span><br/><span class="hl-3">`</span>
|
|
12
|
-
</code><button type="button">Copy</button></pre>
|
|
13
|
-
|
|
14
|
-
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/e0425cedbb61f1914a89cb867f0d1618a11ea537/packages/helpful-fn/src/tag/tag.mts#L112">packages/helpful-fn/src/tag/tag.mts:112</a></li></ul></aside></li></ul></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html">Helpful</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
|
|
@@ -1,5 +0,0 @@
|
|
|
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>commaJoinDefined | Helpful</title><link rel="icon" href="../assets/favicon.svg" type="image/svg+xml"/><meta name="description" content="Documentation for Helpful"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search"><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">Helpful</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../modules.html">Helpful</a></li><li><a href="../modules/_zthun_helpful-fn.html">@zthun/helpful-fn</a></li><li><a href="_zthun_helpful-fn.commaJoinDefined.html">commaJoinDefined</a></li></ul><h1>Function commaJoinDefined</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>Alias of joinList with a comma delimiter.</p>
|
|
2
|
-
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-see"><h4 class="tsd-anchor-link"><a id="see" class="tsd-anchor"></a>See<a href="#see" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p><a href="_zthun_helpful-fn.joinDefined.html" class="tsd-kind-function">joinDefined</a> for more information and examples.</p>
|
|
3
|
-
</div></div></section><section class="tsd-panel"><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="commajoindefined" class="tsd-anchor"></a><span class="tsd-kind-call-signature">commaJoinDefined</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful-fn.commaJoinDefined.html#commajoindefinedt">T</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">items</span><span class="tsd-signature-symbol">:</span> <a href="../types/_zthun_helpful-fn.JoinListInputParameter.html" class="tsd-signature-type tsd-kind-type-alias">JoinListInputParameter</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful-fn.commaJoinDefined.html#commajoindefinedt">T</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><a href="#commajoindefined" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a id="commajoindefinedt" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">T</span></span></li></ul></section><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">items</span>: <a href="../types/_zthun_helpful-fn.JoinListInputParameter.html" class="tsd-signature-type tsd-kind-type-alias">JoinListInputParameter</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="_zthun_helpful-fn.commaJoinDefined.html#commajoindefinedt">T</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">[]</span></span><div class="tsd-comment tsd-typography"><p>The items to join.</p>
|
|
4
|
-
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><p>A string that joins the items that are defined, separated by a comma delimiter.</p>
|
|
5
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/e0425cedbb61f1914a89cb867f0d1618a11ea537/packages/helpful-fn/src/join-defined/join-defined.mts#L89">packages/helpful-fn/src/join-defined/join-defined.mts:89</a></li></ul></aside></li></ul></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html">Helpful</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
|
|
@@ -1,11 +0,0 @@
|
|
|
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>createGuid | Helpful</title><link rel="icon" href="../assets/favicon.svg" type="image/svg+xml"/><meta name="description" content="Documentation for Helpful"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search"><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">Helpful</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../modules.html">Helpful</a></li><li><a href="../modules/_zthun_helpful-fn.html">@zthun/helpful-fn</a></li><li><a href="_zthun_helpful-fn.createGuid.html">createGuid</a></li></ul><h1>Function createGuid</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>Creates a globally unique identifier.</p>
|
|
2
|
-
<p>The identifier holds to v4 of the UUID specification. A summary
|
|
3
|
-
of the specification can be found at
|
|
4
|
-
<a href="https://commons.apache.org/sandbox/commons-id/uuid.html">Apache Commons UUID Documentation</a>.</p>
|
|
5
|
-
<p>The official documentation of the UUID specification is under
|
|
6
|
-
<a href="https://www.rfc-editor.org/info/rfc4122">RFC 4122</a></p>
|
|
7
|
-
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-example"><h4 class="tsd-anchor-link"><a id="example" class="tsd-anchor"></a>Example<a href="#example" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-0">// Will get a value similar to 53e33fb6-d05a-4fa9-8dc0-b78e4feaa702</span><br/><span class="hl-4">const</span><span class="hl-2"> </span><span class="hl-7">guidA</span><span class="hl-2"> = </span><span class="hl-1">createGuid</span><span class="hl-2">();</span><br/><span class="hl-0">// Will most likely not ever be equal to guidA</span><br/><span class="hl-4">const</span><span class="hl-2"> </span><span class="hl-7">guidB</span><span class="hl-2"> = </span><span class="hl-1">createGuid</span><span class="hl-2">();</span>
|
|
8
|
-
</code><button type="button">Copy</button></pre>
|
|
9
|
-
|
|
10
|
-
</div></div></section><section class="tsd-panel"><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="createguid" class="tsd-anchor"></a><span class="tsd-kind-call-signature">createGuid</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><a href="#createguid" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><p>A new generated globally unique identifier based on random bytes.</p>
|
|
11
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zthun/helpful/blob/e0425cedbb61f1914a89cb867f0d1618a11ea537/packages/helpful-fn/src/create-guid/create-guid.mts#L25">packages/helpful-fn/src/create-guid/create-guid.mts:25</a></li></ul></aside></li></ul></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html">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>
|