Skip to content

docs: Correct return type of Search.find() #5711

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.

Sign up for GitHub

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

Merged
akoreman merged 2 commits into from
Jan 13, 2025
Merged

docs: Correct return type of Search.find() #5711

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a1b9703
Correct return type of Search.find()
ferdnyc Jan 6, 2025
ddfa069
Update types
ferdnyc Jan 12, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion src/search.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ class Search {
/**
* Searches for `options.needle`. If found, this method returns the [[Range `Range`]] where the text first occurs. If `options.backwards` is `true`, the search goes backwards in the session.
* @param {EditSession} session The session to search with
* @returns {Range|false}
* @returns {Range | null | false}
**/
find(session) {
var options = this.$options;
Expand Down
4 changes: 2 additions & 2 deletions types/ace-modules.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -890,7 +890,7 @@ declare module "ace-code/src/virtual_renderer" {
* @param {EditSession} session The session to associate with
**/
setSession(session: EditSession): void;
session: import("ace-code").Ace.EditSession;
session: import("ace-code/src/edit_session").EditSession;
/**
* Triggers a partial update of the text, from the range given by the two parameters.
* @param {Number} firstRow The first row to update
Expand Down Expand Up @@ -1819,7 +1819,7 @@ declare module "ace-code/src/search" {
* Searches for `options.needle`. If found, this method returns the [[Range `Range`]] where the text first occurs. If `options.backwards` is `true`, the search goes backwards in the session.
* @param {EditSession} session The session to search with
**/
find(session: EditSession): Range | false;
find(session: EditSession): Range | null | false;
/**
* Searches for all occurrances `options.needle`. If found, this method returns an array of [[Range `Range`s]] where the text first occurs. If `options.backwards` is `true`, the search goes backwards in the session.
* @param {EditSession} session The session to search with
Expand Down