Skip to content
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

fix(useArrayFilter): match type to Array.prototype.filter #4175

Merged
merged 3 commits into from
Sep 16, 2024

Conversation

Jesse205
Copy link
Contributor

Before submitting the PR, please make sure you do the following

  • Read the Contributing Guidelines.
  • Read the Pull Request Guidelines.
  • Check that there isn't already a PR that solves the problem the same way to avoid creating a duplicate.
  • Provide a description in this PR that addresses what the PR is solving, or reference the issue that it solves (e.g. fixes #123).
  • Ideally, include relevant tests that fail without this PR but pass with it.
⚠️ Slowing down new functions

Warning: Slowing down new functions

As the VueUse audience continues to grow, we have been inundated with an overwhelming number of feature requests and pull requests. As a result, maintaining the project has become increasingly challenging and has stretched our capacity to its limits. As such, in the near future, we may need to slow down our acceptance of new features and prioritize the stability and quality of existing functions. Please note that new features for VueUse may not be accepted at this time. If you have any new ideas, we suggest that you first incorporate them into your own codebase, iterate on them to suit your needs, and assess their generalizability. If you strongly believe that your ideas are beneficial to the community, you may submit a pull request along with your use cases, and we would be happy to review and discuss them. Thank you for your understanding.


Description

Make the function signature of useArrayFilter match that of Array.prototype.filter.

/**
     * Returns the elements of an array that meet the condition specified in a callback function.
     * @param predicate A function that accepts up to three arguments. The filter method calls the predicate function one time for each element in the array.
     * @param thisArg An object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value.
     */
    filter<S extends T>(predicate: (value: T, index: number, array: T[]) => value is S, thisArg?: any): S[];
    /**
     * Returns the elements of an array that meet the condition specified in a callback function.
     * @param predicate A function that accepts up to three arguments. The filter method calls the predicate function one time for each element in the array.
     * @param thisArg An object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value.
     */
    filter(predicate: (value: T, index: number, array: T[]) => unknown, thisArg?: any): T[];

Array.prototype.filter 的函数签名具有以下特点:

The function signature of Array.prototype.filter has the following features:

  1. When fn returns a type other than boolean, it can also work, just like using if ().
  2. The return type can filter the case of undefined.
// feature1
const list = [0, undefined, 2, undefined, 4, undefined]
const result = list.filter(i => i) // [2, 4]

// feature2
const list: (number|undefined)[] = [0, undefined, 2, undefined, 4, undefined]
const result: number[] = list.filter(i => i !== undefined)

Additional context

@dosubot dosubot bot added the size:S This PR changes 10-29 lines, ignoring generated files. label Aug 25, 2024
@Jesse205
Copy link
Contributor Author

I can't use vitest, I tried to write type based tests (https://vitest.dev/guide/testing-types) but it doesn't work. So there is no type test within the final pr

@dosubot dosubot bot added the lgtm This PR has been approved by a maintainer label Sep 16, 2024
@antfu antfu added this pull request to the merge queue Sep 16, 2024
Merged via the queue into vueuse:main with commit 71fd140 Sep 16, 2024
8 checks passed
@Jesse205 Jesse205 deleted the feat-useArrayFilter-drop-undefined branch September 16, 2024 15:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
lgtm This PR has been approved by a maintainer size:S This PR changes 10-29 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants