From 41f0abac3f7b1740c86028ac859e969abdde0c3d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Rub=C3=A9n=20Valseca?= Date: Wed, 30 Mar 2022 13:26:03 +0200 Subject: [PATCH] Change this.$import with this.$searchLoad on README The $impot method is not documented and it looks like the $searchLoad does the same but with a higher level of abstraction. --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 16d8fd0..0ac9d8f 100644 --- a/README.md +++ b/README.md @@ -110,7 +110,7 @@ Previous versions of this plugin(`<=1.0`) supported using the GraphQL source plu | ---------- | --------| | `chunk` | Defaults to false. If `true` or a Number (docs array chunk size), it will split up the FlexSearch index & docs JSON file to reduce filesizes - useful if you have a huge amount of data. | | `compress` | Defaults to false. If you have a large amount of data (5k+ nodes) you can compress this data to substantially decrease the JSON size. Note that this may actually _increase_ the JSON size if you have a small amount of data, due to the way compression works. | -| `autoFetch` | Defaults to true. This plugin will usually automatically fetch and import the generated FlexSearch index & docs as soon as the site is loaded, but if you only want this to happen on a certain route (i.e. `/search`) to reduce other page load times for example, you can specify that route with this option, or disable it completely and import yourself with `this.$search.import({ ...`] | +| `autoFetch` | Defaults to true. This plugin will usually automatically fetch and import the generated FlexSearch index & docs as soon as the site is loaded, but if you only want this to happen on a certain route (i.e. `/search`) to reduce other page load times for example, you can specify that route with this option, or disable it completely (setting it to `false`) and import yourself with `this.$searchLoad()`] | Some examples of these configurations are shown below: