Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
also including CHANGELOG.md in docs
- Loading branch information
Showing
9 changed files
with
421 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Binary file not shown.
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,215 @@ | ||
| <!DOCTYPE html> | ||
| <html> | ||
| <head> | ||
| <meta charset="utf-8"> | ||
| <base data-ice="baseUrl" href="../"> | ||
| <title data-ice="title">Manual | MiniSearch</title> | ||
| <link type="text/css" rel="stylesheet" href="css/style.css"> | ||
| <link type="text/css" rel="stylesheet" href="css/prettify-tomorrow.css"> | ||
| <script src="script/prettify/prettify.js"></script> | ||
| <script src="script/manual.js"></script> | ||
| <meta name="description" content="Tiny but powerful full-text search"><meta property="twitter:card" content="summary"><meta property="twitter:title" content="MiniSearch"><meta property="twitter:description" content="Tiny but powerful full-text search"></head> | ||
| <body class="layout-container manual-root" data-ice="rootContainer"> | ||
|
|
||
| <header> | ||
| <a href="./" style="display: flex; align-items: center;"><img src="./image/brand_logo.png" style="width:34px;"></a> | ||
| <a href="./manual/index.html" data-ice="manualHeaderLink">Manual</a> | ||
| <a href="identifiers.html">Reference</a> | ||
| <a href="source.html">Source</a> | ||
|
|
||
| <div class="search-box"> | ||
| <span> | ||
| <img src="./image/search.png"> | ||
| <span class="search-input-edge"></span><input class="search-input"><span class="search-input-edge"></span> | ||
| </span> | ||
| <ul class="search-result"></ul> | ||
| </div> | ||
| <a style="position:relative; top:3px;" href="https://github.com/lucaong/minisearch"><img width="20px" src="./image/github.png"></a></header> | ||
|
|
||
| <nav class="navigation" data-ice="nav"><div class="manual-toc-root"> | ||
|
|
||
| <div data-ice="manual"> | ||
| <ul class="manual-toc"> | ||
|
|
||
| <li data-ice="manualNav" class="indent-h1" data-link="manual/README.html"><a href="manual/README.html" data-ice="link"> MiniSearch</a></li> | ||
| <li data-ice="manualNav" class="indent-h2" data-link="manual/README.html"><a href="manual/README.html#use-case" data-ice="link">Use case</a></li> | ||
| <li data-ice="manualNav" class="indent-h2" data-link="manual/README.html"><a href="manual/README.html#features" data-ice="link">Features</a></li> | ||
| <li data-ice="manualNav" class="indent-h2" data-link="manual/README.html"><a href="manual/README.html#installation" data-ice="link">Installation</a></li> | ||
| <li data-ice="manualNav" class="indent-h2" data-link="manual/README.html"><a href="manual/README.html#usage" data-ice="link">Usage</a></li> | ||
| <li data-ice="manualNav" class="indent-h3" data-link="manual/README.html"><a href="manual/README.html#basic-usage" data-ice="link">Basic usage</a></li> | ||
| <li data-ice="manualNav" class="indent-h3" data-link="manual/README.html"><a href="manual/README.html#search-options" data-ice="link">Search options</a></li> | ||
| <li data-ice="manualNav" class="indent-h3" data-link="manual/README.html"><a href="manual/README.html#auto-suggestions" data-ice="link">Auto suggestions</a></li> | ||
| <li data-ice="manualNav" class="indent-h3" data-link="manual/README.html"><a href="manual/README.html#field-extraction" data-ice="link">Field extraction</a></li> | ||
| <li data-ice="manualNav" class="indent-h3" data-link="manual/README.html"><a href="manual/README.html#tokenization" data-ice="link">Tokenization</a></li> | ||
| <li data-ice="manualNav" class="indent-h3" data-link="manual/README.html"><a href="manual/README.html#term-processing" data-ice="link">Term processing</a></li> | ||
| <li data-ice="manualNav" class="indent-h3" data-link="manual/README.html"><a href="manual/README.html#api-documentation" data-ice="link">API Documentation</a></li> | ||
| <li data-ice="manualNav" class="indent-h2" data-link="manual/README.html"><a href="manual/README.html#browser-compatibility" data-ice="link">Browser compatibility</a></li> | ||
| <li data-ice="manualNav" class="indent-h2" data-link="manual/README.html"><a href="manual/README.html#contributing" data-ice="link">Contributing</a></li> | ||
| </ul> | ||
| </div> | ||
| <div data-ice="manual"> | ||
| <ul class="manual-toc"> | ||
|
|
||
| <li data-ice="manualNav" class="indent-h1" data-link="manual/CONTRIBUTING.html"><a href="manual/CONTRIBUTING.html" data-ice="link">Contributing</a></li> | ||
| <li data-ice="manualNav" class="indent-h2" data-link="manual/CONTRIBUTING.html"><a href="manual/CONTRIBUTING.html#bugs-and-feature-requests" data-ice="link">Bugs and feature requests</a></li> | ||
| <li data-ice="manualNav" class="indent-h2" data-link="manual/CONTRIBUTING.html"><a href="manual/CONTRIBUTING.html#pull-requests" data-ice="link">Pull requests</a></li> | ||
| </ul> | ||
| </div> | ||
| <div data-ice="manual"> | ||
| <ul class="manual-toc"> | ||
|
|
||
| <li data-ice="manualNav" class="indent-h1" data-link="manual/CODE_OF_CONDUCT.html"><a href="manual/CODE_OF_CONDUCT.html" data-ice="link">Code of Conduct</a></li> | ||
| <li data-ice="manualNav" class="indent-h2" data-link="manual/CODE_OF_CONDUCT.html"><a href="manual/CODE_OF_CONDUCT.html#our-pledge" data-ice="link">Our Pledge</a></li> | ||
| <li data-ice="manualNav" class="indent-h2" data-link="manual/CODE_OF_CONDUCT.html"><a href="manual/CODE_OF_CONDUCT.html#our-standards" data-ice="link">Our Standards</a></li> | ||
| <li data-ice="manualNav" class="indent-h2" data-link="manual/CODE_OF_CONDUCT.html"><a href="manual/CODE_OF_CONDUCT.html#our-responsibilities" data-ice="link">Our Responsibilities</a></li> | ||
| <li data-ice="manualNav" class="indent-h2" data-link="manual/CODE_OF_CONDUCT.html"><a href="manual/CODE_OF_CONDUCT.html#scope" data-ice="link">Scope</a></li> | ||
| <li data-ice="manualNav" class="indent-h2" data-link="manual/CODE_OF_CONDUCT.html"><a href="manual/CODE_OF_CONDUCT.html#enforcement" data-ice="link">Enforcement</a></li> | ||
| <li data-ice="manualNav" class="indent-h2" data-link="manual/CODE_OF_CONDUCT.html"><a href="manual/CODE_OF_CONDUCT.html#attribution" data-ice="link">Attribution</a></li> | ||
| </ul> | ||
| </div> | ||
| <div data-ice="manual"> | ||
| <ul class="manual-toc"> | ||
|
|
||
| <li data-ice="manualNav" class="indent-h1" data-link="manual/DESIGN_DOCUMENT.html"><a href="manual/DESIGN_DOCUMENT.html" data-ice="link">Design Document</a></li> | ||
| <li data-ice="manualNav" class="indent-h2" data-link="manual/DESIGN_DOCUMENT.html"><a href="manual/DESIGN_DOCUMENT.html#goals--and-non-goals-" data-ice="link">Goals (and non-goals)</a></li> | ||
| <li data-ice="manualNav" class="indent-h2" data-link="manual/DESIGN_DOCUMENT.html"><a href="manual/DESIGN_DOCUMENT.html#technical-design" data-ice="link">Technical design</a></li> | ||
| <li data-ice="manualNav" class="indent-h3" data-link="manual/DESIGN_DOCUMENT.html"><a href="manual/DESIGN_DOCUMENT.html#index-data-structure" data-ice="link">Index data structure</a></li> | ||
| <li data-ice="manualNav" class="indent-h3" data-link="manual/DESIGN_DOCUMENT.html"><a href="manual/DESIGN_DOCUMENT.html#fuzzy-search-algorithm" data-ice="link">Fuzzy search algorithm</a></li> | ||
| <li data-ice="manualNav" class="indent-h3" data-link="manual/DESIGN_DOCUMENT.html"><a href="manual/DESIGN_DOCUMENT.html#search-api-layer" data-ice="link">Search API layer</a></li> | ||
| </ul> | ||
| </div> | ||
| <div data-ice="manual"> | ||
| <ul class="manual-toc"> | ||
|
|
||
| <li data-ice="manualNav" class="indent-h1" data-link="manual/CHANGELOG.html"><a href="manual/CHANGELOG.html" data-ice="link">Changelog</a></li> | ||
| <li data-ice="manualNav" class="indent-h2" data-link="manual/CHANGELOG.html"><a href="manual/CHANGELOG.html#v2-1-1" data-ice="link">v2.1.1</a></li> | ||
| <li data-ice="manualNav" class="indent-h2" data-link="manual/CHANGELOG.html"><a href="manual/CHANGELOG.html#v2-1-0" data-ice="link">v2.1.0</a></li> | ||
| <li data-ice="manualNav" class="indent-h2" data-link="manual/CHANGELOG.html"><a href="manual/CHANGELOG.html#v2-0-6" data-ice="link">v2.0.6</a></li> | ||
| <li data-ice="manualNav" class="indent-h2" data-link="manual/CHANGELOG.html"><a href="manual/CHANGELOG.html#v2-0-5" data-ice="link">v2.0.5</a></li> | ||
| <li data-ice="manualNav" class="indent-h2" data-link="manual/CHANGELOG.html"><a href="manual/CHANGELOG.html#v2-0-4" data-ice="link">v2.0.4</a></li> | ||
| <li data-ice="manualNav" class="indent-h2" data-link="manual/CHANGELOG.html"><a href="manual/CHANGELOG.html#v2-0-3" data-ice="link">v2.0.3</a></li> | ||
| <li data-ice="manualNav" class="indent-h2" data-link="manual/CHANGELOG.html"><a href="manual/CHANGELOG.html#v2-0-2" data-ice="link">v2.0.2</a></li> | ||
| <li data-ice="manualNav" class="indent-h2" data-link="manual/CHANGELOG.html"><a href="manual/CHANGELOG.html#v2-0-1" data-ice="link">v2.0.1</a></li> | ||
| <li data-ice="manualNav" class="indent-h2" data-link="manual/CHANGELOG.html"><a href="manual/CHANGELOG.html#v2-0-0" data-ice="link">v2.0.0</a></li> | ||
| <li data-ice="manualNav" class="indent-h2" data-link="manual/CHANGELOG.html"><a href="manual/CHANGELOG.html#v1-3-1" data-ice="link">v1.3.1</a></li> | ||
| <li data-ice="manualNav" class="indent-h2" data-link="manual/CHANGELOG.html"><a href="manual/CHANGELOG.html#v1-3-0" data-ice="link">v1.3.0</a></li> | ||
| <li data-ice="manualNav" class="indent-h2" data-link="manual/CHANGELOG.html"><a href="manual/CHANGELOG.html#v1-2-1" data-ice="link">v1.2.1</a></li> | ||
| <li data-ice="manualNav" class="indent-h2" data-link="manual/CHANGELOG.html"><a href="manual/CHANGELOG.html#v1-2-0" data-ice="link">v1.2.0</a></li> | ||
| <li data-ice="manualNav" class="indent-h2" data-link="manual/CHANGELOG.html"><a href="manual/CHANGELOG.html#v1-1-2" data-ice="link">v1.1.2</a></li> | ||
| <li data-ice="manualNav" class="indent-h2" data-link="manual/CHANGELOG.html"><a href="manual/CHANGELOG.html#v1-1-1" data-ice="link">v1.1.1</a></li> | ||
| <li data-ice="manualNav" class="indent-h2" data-link="manual/CHANGELOG.html"><a href="manual/CHANGELOG.html#v1-1-0" data-ice="link">v1.1.0</a></li> | ||
| <li data-ice="manualNav" class="indent-h2" data-link="manual/CHANGELOG.html"><a href="manual/CHANGELOG.html#v1-0-1" data-ice="link">v1.0.1</a></li> | ||
| <li data-ice="manualNav" class="indent-h2" data-link="manual/CHANGELOG.html"><a href="manual/CHANGELOG.html#v1-0-0" data-ice="link">v1.0.0</a></li> | ||
| </ul> | ||
| </div> | ||
| </div> | ||
| </nav> | ||
|
|
||
| <div class="content" data-ice="content"><div class="github-markdown" data-ice="content"><h1 id="changelog">Changelog</h1><p><code>MiniSearch</code> follows <a href="https://semver.org/spec/v2.0.0.html">semantic versioning</a>.</p> | ||
| <h2 id="v2-1-1">v2.1.1</h2><ul> | ||
| <li>[fix] Fix TypeScript definitions adding <code>filter</code> and <code>storeFields</code> options | ||
| (by <a href="https://github.com/emilianox">@emilianox</a>)</li> | ||
| </ul> | ||
| <h2 id="v2-1-0">v2.1.0</h2><ul> | ||
| <li><p>[feature] Add support for stored fields</p> | ||
| </li> | ||
| <li><p>[feature] Add filtering of search results and auto suggestions</p> | ||
| </li> | ||
| </ul> | ||
| <h2 id="v2-0-6">v2.0.6</h2><ul> | ||
| <li>Better TypeScript definitions (by <a href="https://github.com/samuelmeuli">@samuelmeuli</a>)</li> | ||
| </ul> | ||
| <h2 id="v2-0-5">v2.0.5</h2><ul> | ||
| <li>Add TypeScript definitions for ease of use in TypeScript projects</li> | ||
| </ul> | ||
| <h2 id="v2-0-4">v2.0.4</h2><ul> | ||
| <li>[fix] tokenizer behavior with newline characters (by <a href="https://github.com/samuelmeuli">@samuelmeuli</a>)</li> | ||
| </ul> | ||
| <h2 id="v2-0-3">v2.0.3</h2><ul> | ||
| <li>Fix small imprecision in documentation</li> | ||
| </ul> | ||
| <h2 id="v2-0-2">v2.0.2</h2><ul> | ||
| <li>Add <code>addAllAsync</code> method, adding many documents asynchronously and in chunks | ||
| to avoid blocking the main thread</li> | ||
| </ul> | ||
| <h2 id="v2-0-1">v2.0.1</h2><ul> | ||
| <li>Throw a more descriptive error when <code>loadJSON</code> is called without options</li> | ||
| </ul> | ||
| <h2 id="v2-0-0">v2.0.0</h2><p>This release introduces better defaults. It is considered a major release, as | ||
| the default options are slightly different, but the API is not changed.</p> | ||
| <ul> | ||
| <li><p><em>Breaking change</em>: default tokenizer splits by Unicode space or punctuation | ||
| (before it was splitting by space, punctuation, or <em>symbol</em>). The difference | ||
| is that currency symbols and other non-punctuation symbols will not be | ||
| discarded: "it's 100€" is now tokenized as <code>["it", "s", "100€"]</code> instead of | ||
| <code>["it", "s", "100"]</code>.</p> | ||
| </li> | ||
| <li><p><em>Breaking change</em>: default term processing does not discard 1-character | ||
| words.</p> | ||
| </li> | ||
| <li><p><em>Breaking change</em>: auto suggestions by default perform prefix search only on | ||
| the last term in the query. So "super cond" will suggest "super | ||
| conductivity", but not "superposition condition".</p> | ||
| </li> | ||
| </ul> | ||
| <h2 id="v1-3-1">v1.3.1</h2><ul> | ||
| <li>Better and more compact regular expression in the default tokenizer, | ||
| separating on Unicode spaces, punctuation, and symbols</li> | ||
| </ul> | ||
| <h2 id="v1-3-0">v1.3.0</h2><ul> | ||
| <li>Support for non-latin scripts</li> | ||
| </ul> | ||
| <h2 id="v1-2-1">v1.2.1</h2><ul> | ||
| <li>Improve fuzzy search performance (common cases are now ~4x faster, as shown | ||
| by the benchmark)</li> | ||
| </ul> | ||
| <h2 id="v1-2-0">v1.2.0</h2><ul> | ||
| <li>Add possibility to configure a custom field extraction function by setting | ||
| the <code>extractField</code> option (to support cases like nested fields, non-string | ||
| fields, getter methods, field pre-processing, etc.)</li> | ||
| </ul> | ||
| <h2 id="v1-1-2">v1.1.2</h2><ul> | ||
| <li>Add <code>getDefault</code> static method to get the default value of configuration options</li> | ||
| </ul> | ||
| <h2 id="v1-1-1">v1.1.1</h2><ul> | ||
| <li>Do not minify library when published as NPM package. Run <code>yarn | ||
| build-minified</code> (or <code>npm run build-minified</code>) to produce a minified build | ||
| with source maps.</li> | ||
| <li><strong>Bugfix</strong>: as per specification, <code>processTerm</code> is called with only one | ||
| argument upon search (see <a href="https://github.com/lucaong/minisearch/issues/5">#5</a>)</li> | ||
| </ul> | ||
| <h2 id="v1-1-0">v1.1.0</h2><ul> | ||
| <li>Add possibility to configure separate index-time and search-time | ||
| tokenization and term processing functions</li> | ||
| <li>The <code>processTerm</code> function can now reject a term by returning a falsy value</li> | ||
| <li>Upon indexing, the <code>tokenize</code> and <code>processTerm</code> functions receive the field | ||
| name as the second argument. This makes it possible to process or tokenize | ||
| each field differently.</li> | ||
| </ul> | ||
| <h2 id="v1-0-1">v1.0.1</h2><ul> | ||
| <li>Reduce bundle size by optimizing babel preset env options</li> | ||
| </ul> | ||
| <h2 id="v1-0-0">v1.0.0</h2><p>Production-ready release.</p> | ||
| <p>Features:</p> | ||
| <ul> | ||
| <li>Space-optimized index</li> | ||
| <li>Exact match, prefix match, fuzzy search</li> | ||
| <li>Auto suggestions</li> | ||
| <li>Add/remove documents at any time</li> | ||
| </ul> | ||
| </div> | ||
| </div> | ||
|
|
||
| <footer class="footer"> | ||
| Generated by <a href="https://esdoc.org">ESDoc<span data-ice="esdocVersion">(1.1.0)</span><img src="./image/esdoc-logo-mini-black.png"></a> | ||
| </footer> | ||
|
|
||
| <script src="script/search_index.js"></script> | ||
| <script src="script/search.js"></script> | ||
| <script src="script/pretty-print.js"></script> | ||
| <script src="script/inherited-summary.js"></script> | ||
| <script src="script/test-summary.js"></script> | ||
| <script src="script/inner-link.js"></script> | ||
| <script src="script/patch-for-local.js"></script> | ||
| </body> | ||
| </html> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.