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

feat(useArrayUnique): new function #2597

Merged
merged 1 commit into from Jan 3, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
1 change: 1 addition & 0 deletions packages/shared/index.ts
Expand Up @@ -39,6 +39,7 @@ export * from './useArrayJoin'
export * from './useArrayMap'
export * from './useArrayReduce'
export * from './useArraySome'
export * from './useArrayUnique'
export * from './useCounter'
export * from './useDateFormat'
export * from './useDebounceFn'
Expand Down
38 changes: 38 additions & 0 deletions packages/shared/useArrayUnique/index.md
@@ -0,0 +1,38 @@
---
category: Array
---

# useArrayUnique

reactive unique array

## Usage

### Use with array of multiple refs

```js
import { useArrayUnique } from '@vueuse/core'
const item1 = ref(0)
const item2 = ref(1)
const item3 = ref(1)
const item4 = ref(2)
const item5 = ref(3)
const list = [item1, item2, item3, item4, item5]
const result = useArrayUnique(list)
// result.value: [0, 1, 2, 3]
item5.value = 1
// result.value: [0, 1, 2]
```

### Use with reactive array

```js
import { useArrayUnique } from '@vueuse/core'

const list = reactive([1, 2, 2, 3])
const result = useArrayUnique(list)
// result.value: [1, 2, 3]

result.value.push(1)
// result.value: [1, 2, 3]
```
29 changes: 29 additions & 0 deletions packages/shared/useArrayUnique/index.test.ts
@@ -0,0 +1,29 @@
import { ref } from 'vue-demi'
import { useArrayUnique } from '../useArrayUnique'

describe('useArraySome', () => {
it('should be defined', () => {
expect(useArrayUnique).toBeDefined()
})

it('should work with array of refs', () => {
const item1 = ref(0)
const item2 = ref(1)
const item3 = ref(1)
const item4 = ref(2)
const item5 = ref(3)
const list = [item1, item2, item3, item4, item5]
const result = useArrayUnique(list)
expect(result.value.length).toBe(4)
item5.value = 2
expect(result.value.length).toBe(3)
})

it('should work with reactive array', () => {
const list = ref([1, 2, 2, 3])
const result = useArrayUnique(list)
expect(result.value.length).toBe(3)
list.value.push(1)
expect(result.value.length).toBe(3)
})
})
15 changes: 15 additions & 0 deletions packages/shared/useArrayUnique/index.ts
@@ -0,0 +1,15 @@
import type { ComputedRef } from 'vue-demi'
import { computed } from 'vue-demi'
import type { MaybeComputedRef } from '../utils'
import { resolveUnref } from '../resolveUnref'

/**
* reactive unique array
* @see https://vueuse.org/useArrayUnique
* @param {Array} list - the array was called upon.
* @returns {Array} A computed ref that returns a unique array of items.
*/
export function useArrayUnique<T>(
list: MaybeComputedRef<MaybeComputedRef<T>[]>): ComputedRef<T[]> {
return computed<T[]>(() => [...new Set<T>(resolveUnref(list).map(element => resolveUnref(element)))])
}