-
Notifications
You must be signed in to change notification settings - Fork 49
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Update documentation on intraRules, search example #54
base: main
Are you sure you want to change the base?
Conversation
// Order may be null when doing out of order searching | ||
// when the # of search terms exceed the max allowed |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
actually, any of them can be null.
iirc 🤣 ...
idxs
can be null if the search string ends up empty after trimming whitespace and removing non-alphanumeric chars (except those in quotes, for exact matches)info
will be null if the number of results exceedsinfoThresh
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
and they're null in sequence.
if order is not null, then idxs and info is not null.
if info is not null then idxs is not null
if idxs is null, everything is null
thanks! i actually want to encourage people to use the integrated search, so feel like it should be listed first, but struggle with how to explain the concepts of |
Added some more detail to explain it some more, let me know what you think. Forgot to mention it originally, but I left the variable declarations as |
Anything you need to be able to close this out? |
Updated the docs on the few things I struggled a bit with:
intraRules
wasn't documented, so I added it based on Single Error mode only allowing exact matches under 5 characters #53intraSub
,intraTrn
, andintraDel
, I kept finding myself having to re-search through the docs to remember what they meant, as it only said in theintraMode: 1
section.For the search example, I didn't include it in the doc but I did test it out via Codepen: https://codepen.io/ascendedguard/pen/PoLZdBJ