-
Notifications
You must be signed in to change notification settings - Fork 87
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
Add typescript definition #19
Open
dderevjanik
wants to merge
1
commit into
bevacqua:master
Choose a base branch
from
dderevjanik:master
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,14 @@ | ||
declare namespace fuzzysearch { | ||
|
||
} | ||
|
||
/** | ||
* The method will return true only if each character in the needle can be found in the haystack and occurs after the preceding matches. | ||
* @param needle {string} the search value you're looking for | ||
* @param haystack {string} find one or more occurrences of the "needle" within the "haystack" | ||
* @example fuzzysearch('twl', 'cartwheel') // <- true | ||
* @returns {boolean} `true` if needle matches haystack using a fuzzy-searching algorithm | ||
*/ | ||
declare function fuzzysearch(needle: string, haystack: string): boolean; | ||
|
||
export = fuzzysearch; | ||
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
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.
I think
would be better here.
@dderevjanik
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.
I tried it, but now I'm getting this error
export = fuzzysearch
works as expected.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.
@jskrnbindra @dderevjanik Without the empty namespace but with the default export it should work.
The default export would match the libraries real export, I think.
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.
As weird as it looks, these typings are correct as-is. (It matches the underlying implementation of
module.exports = fuzzysearch;
)Writing the types as a default export would work in some cases but not others, depending on which module loader a given project is using. Would love to see this get merged! 🙏