@enonic/js-utils

Version:

Enonic XP JavaScript Utils

28 lines (24 loc) • 22.2 kB

HTML

<!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>@enonic/js-utils</title><meta name="description" content="Documentation for @enonic/js-utils"/><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></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base="."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="index.html" class="title">@enonic/js-utils</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"><h1>@enonic/js-utils</h1></div><div class="tsd-panel tsd-typography"><a id="md:javascript-utilities" class="tsd-anchor"></a><h1 class="tsd-anchor-link">JavaScript Utilities<a href="#md:javascript-utilities" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h1>A library of constants and functions that should work in any <ul> <li>typescript</li> <li>ecmascript</li> <li>javascript</li> </ul> The intention is that the library should not depend upon any node-module that doesn't work in at least these environments: <ul> <li>Enonic XP serverside code</li> <li>Modern browser</li> <li>Newest LTS version of Node</li> </ul> It should work in at least these frameworks: <ul> <li>React</li> </ul> <a id="md:examples" class="tsd-anchor"></a><h2 class="tsd-anchor-link">Examples<a href="#md:examples" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h2><a id="md:dsl" class="tsd-anchor"></a><h3 class="tsd-anchor-link">DSL<a href="#md:dsl" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h3><pre><code class="typescript">import {storage} from '@enonic/js-utils'; const and = storage.query.dsl.and; const bool = storage.query.dsl.bool; const fulltext = storage.query.dsl.fulltext; const ngram = storage.query.dsl.ngram; const stemmed = storage.query.dsl.stemmed; const fields = 'url^1.2,title^1.1,text'; const searchString = 'fun video'; const operator = 'OR'; const query = bool(and( fulltext(fields, searchString, operator), stemmed(fields, searchString, operator, 'no', 0.9), stemmed(fields, searchString, operator, 'en', 0.8), ngram(fields, searchString, operator, 0.7) )); console.debug(JSON.stringify(query, null, 4)); /* { "boolean": { "must": [ { "boolean": { "should": [ { "fulltext": { "fields": [ "url" ], "query": "fun video", "operator": "OR", "boost": 1.2 } }, { "fulltext": { "fields": [ "title" ], "query": "fun video", "operator": "OR", "boost": 1.1 } }, { "fulltext": { "fields": [ "text" ], "query": "fun video", "operator": "OR" } } ] } }, { "boolean": { "should": [ { "stemmed": { "fields": [ "url" ], "query": "fun video", "operator": "OR", "language": "no", "boost": 1.08 } }, { "stemmed": { "fields": [ "title" ], "query": "fun video", "operator": "OR", "language": "no", "boost": 0.9900000000000001 } }, { "stemmed": { "fields": [ "text" ], "query": "fun video", "operator": "OR", "language": "no", "boost": 0.9 } } ] } }, { "boolean": { "should": [ { "stemmed": { "fields": [ "url" ], "query": "fun video", "operator": "OR", "language": "en", "boost": 0.96 } }, { "stemmed": { "fields": [ "title" ], "query": "fun video", "operator": "OR", "language": "en", "boost": 0.8800000000000001 } }, { "stemmed": { "fields": [ "text" ], "query": "fun video", "operator": "OR", "language": "en", "boost": 0.8 } } ] } }, { "boolean": { "should": [ { "ngram": { "fields": [ "url" ], "query": "fun video", "operator": "OR", "boost": 0.84 } }, { "ngram": { "fields": [ "title" ], "query": "fun video", "operator": "OR", "boost": 0.77 } }, { "ngram": { "fields": [ "text" ], "query": "fun video", "operator": "OR", "boost": 0.7 } } ] } } ] } }; */ </code><button type="button">Copy</button></pre> <a id="md:filter" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Filter<a href="#md:filter" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h3><pre><code class="javascript">import {addQueryFilter} from '@enonic/js-utils'; const filters = addQueryFilter({ filter: { exists: { field: 'required' } } }); /*{ boolean: { must: { exists: { field: 'required' } } } }*/ </code><button type="button">Copy</button></pre> <a id="md:release" class="tsd-anchor"></a><h2 class="tsd-anchor-link">Release<a href="#md:release" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h2><pre><code>git tag vX.Y.Z git push origin vX.Y.Z </code><button>Copy</button></pre> This will trigger release & publish on NPM. </div></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">Member Visibility<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>Protected</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>Inherited</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>External</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"><a href="#md:javascript-utilities">JavaScript Utilities</a><ul><li><a href="#md:examples">Examples</a></li><li><ul><li><a href="#md:dsl">DSL</a></li><li><a href="#md:filter">Filter</a></li></ul></li><li><a href="#md:release">Release</a></li></ul></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="modules.html" class="current"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-1"></use></svg>@enonic/js-utils</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base="."><li>Loading...</li></ul></nav></div></div></div><footer>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></footer><div class="overlay"></div></body></html>