Skip to content

feat(core): add support for comparing getter-only properties in shallow #222

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

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

feat(core): add support for comparing getter-only properties in shallow #222

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
a340c11
feat(core): add support for comparing getter-only properties in shall…
jiji-hoon96 Aug 13, 2025
2cfc458
ci: apply automated fixes and generate docs
autofix-ci[bot] Aug 13, 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
46 changes: 40 additions & 6 deletions packages/angular-store/src/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -91,17 +91,51 @@ function shallow<T>(objA: T, objB: T) {
}

const keysA = Object.keys(objA)
if (keysA.length !== Object.keys(objB).length) {
const keysB = Object.keys(objB)

if (keysA.length !== keysB.length) {
return false
}

for (let i = 0; i < keysA.length; i++) {
if (
!Object.prototype.hasOwnProperty.call(objB, keysA[i] as string) ||
!Object.is(objA[keysA[i] as keyof T], objB[keysA[i] as keyof T])
) {
if (keysA.length > 0) {
for (const key of keysA) {
if (
!Object.prototype.hasOwnProperty.call(objB, key) ||
!Object.is(objA[key as keyof T], objB[key as keyof T])
) {
return false
}
}
return true
}

if (keysA.length === 0) {
const descriptorsA = Object.getOwnPropertyDescriptors(objA)
const descriptorsB = Object.getOwnPropertyDescriptors(objB)

const getterKeysA = Object.keys(descriptorsA).filter(
(key) => descriptorsA[key]?.get !== undefined,
)
const getterKeysB = Object.keys(descriptorsB).filter(
(key) => descriptorsB[key]?.get !== undefined,
)

if (getterKeysA.length !== getterKeysB.length) {
return false
}

for (const key of getterKeysA) {
if (
!getterKeysB.includes(key) ||
!Object.is(
(objA as Record<string, unknown>)[key],
(objB as Record<string, unknown>)[key],
)
) {
return false
}
}
}

return true
}
46 changes: 40 additions & 6 deletions packages/react-store/src/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,17 +67,51 @@ export function shallow<T>(objA: T, objB: T) {
}

const keysA = Object.keys(objA)
if (keysA.length !== Object.keys(objB).length) {
const keysB = Object.keys(objB)

if (keysA.length !== keysB.length) {
return false
}

for (let i = 0; i < keysA.length; i++) {
if (
!Object.prototype.hasOwnProperty.call(objB, keysA[i] as string) ||
!Object.is(objA[keysA[i] as keyof T], objB[keysA[i] as keyof T])
) {
if (keysA.length > 0) {
for (const key of keysA) {
if (
!Object.prototype.hasOwnProperty.call(objB, key) ||
!Object.is(objA[key as keyof T], objB[key as keyof T])
) {
return false
}
}
return true
}

if (keysA.length === 0) {
const descriptorsA = Object.getOwnPropertyDescriptors(objA)
const descriptorsB = Object.getOwnPropertyDescriptors(objB)

const getterKeysA = Object.keys(descriptorsA).filter(
(key) => descriptorsA[key]?.get !== undefined,
)
const getterKeysB = Object.keys(descriptorsB).filter(
(key) => descriptorsB[key]?.get !== undefined,
)

if (getterKeysA.length !== getterKeysB.length) {
return false
}

for (const key of getterKeysA) {
if (
!getterKeysB.includes(key) ||
!Object.is(
(objA as Record<string, unknown>)[key],
(objB as Record<string, unknown>)[key],
)
) {
return false
}
}
}

return true
}
34 changes: 19 additions & 15 deletions packages/react-store/tests/index.test.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -145,23 +145,27 @@ describe('shallow', () => {
expect(shallow(objA, objB)).toBe(false)
})

test('should return false for one object being undefined', () => {
const objA = { a: 1, b: 'hello' }
const objB = undefined
expect(shallow(objA, objB)).toBe(false)
})
test('should handle empty objects', () => {
expect(shallow({}, {})).toBe(true)
})

test('should handle getter-only objects', () => {
function createGetterOnlyObject(value: number) {
const obj = Object.create({})
Object.defineProperty(obj, 'value', {
get: () => value,
enumerable: false,
configurable: true,
})
return obj
}

test('should return true for two null objects', () => {
const objA = null
const objB = null
expect(shallow(objA, objB)).toBe(true)
})
const objA = createGetterOnlyObject(42)
const objB = createGetterOnlyObject(42)
const objC = createGetterOnlyObject(24)

test('should return false for objects with different types', () => {
const objA = { a: 1, b: 'hello' }
const objB = { a: '1', b: 'hello' }
// @ts-expect-error
expect(shallow(objA, objB)).toBe(false)
expect(shallow(objA, objB)).toBe(true)
expect(shallow(objA, objC)).toBe(false)
})

test('should return true for shallowly equal maps', () => {
Expand Down
46 changes: 40 additions & 6 deletions packages/solid-store/src/index.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -74,17 +74,51 @@ export function shallow<T>(objA: T, objB: T) {
}

const keysA = Object.keys(objA)
if (keysA.length !== Object.keys(objB).length) {
const keysB = Object.keys(objB)

if (keysA.length !== keysB.length) {
return false
}

for (let i = 0; i < keysA.length; i++) {
if (
!Object.prototype.hasOwnProperty.call(objB, keysA[i] as string) ||
!Object.is(objA[keysA[i] as keyof T], objB[keysA[i] as keyof T])
) {
if (keysA.length > 0) {
for (const key of keysA) {
if (
!Object.prototype.hasOwnProperty.call(objB, key) ||
!Object.is(objA[key as keyof T], objB[key as keyof T])
) {
return false
}
}
return true
}

if (keysA.length === 0) {
const descriptorsA = Object.getOwnPropertyDescriptors(objA)
const descriptorsB = Object.getOwnPropertyDescriptors(objB)

const getterKeysA = Object.keys(descriptorsA).filter(
(key) => descriptorsA[key]?.get !== undefined,
)
const getterKeysB = Object.keys(descriptorsB).filter(
(key) => descriptorsB[key]?.get !== undefined,
)

if (getterKeysA.length !== getterKeysB.length) {
return false
}

for (const key of getterKeysA) {
if (
!getterKeysB.includes(key) ||
!Object.is(
(objA as Record<string, unknown>)[key],
(objB as Record<string, unknown>)[key],
)
) {
return false
}
}
}

return true
}
46 changes: 40 additions & 6 deletions packages/svelte-store/src/index.svelte.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,17 +76,51 @@ export function shallow<T>(objA: T, objB: T) {
}

const keysA = Object.keys(objA)
if (keysA.length !== Object.keys(objB).length) {
const keysB = Object.keys(objB)

if (keysA.length !== keysB.length) {
return false
}

for (let i = 0; i < keysA.length; i++) {
if (
!Object.prototype.hasOwnProperty.call(objB, keysA[i] as string) ||
!Object.is(objA[keysA[i] as keyof T], objB[keysA[i] as keyof T])
) {
if (keysA.length > 0) {
for (const key of keysA) {
if (
!Object.prototype.hasOwnProperty.call(objB, key) ||
!Object.is(objA[key as keyof T], objB[key as keyof T])
) {
return false
}
}
return true
}

if (keysA.length === 0) {
const descriptorsA = Object.getOwnPropertyDescriptors(objA)
const descriptorsB = Object.getOwnPropertyDescriptors(objB)

const getterKeysA = Object.keys(descriptorsA).filter(
(key) => descriptorsA[key]?.get !== undefined,
)
const getterKeysB = Object.keys(descriptorsB).filter(
(key) => descriptorsB[key]?.get !== undefined,
)

if (getterKeysA.length !== getterKeysB.length) {
return false
}

for (const key of getterKeysA) {
if (
!getterKeysB.includes(key) ||
!Object.is(
(objA as Record<string, unknown>)[key],
(objB as Record<string, unknown>)[key],
)
) {
return false
}
}
}

return true
}
46 changes: 40 additions & 6 deletions packages/vue-store/src/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -80,17 +80,51 @@ export function shallow<T>(objA: T, objB: T) {
}

const keysA = Object.keys(objA)
if (keysA.length !== Object.keys(objB).length) {
const keysB = Object.keys(objB)

if (keysA.length !== keysB.length) {
return false
}

for (let i = 0; i < keysA.length; i++) {
if (
!Object.prototype.hasOwnProperty.call(objB, keysA[i] as string) ||
!Object.is(objA[keysA[i] as keyof T], objB[keysA[i] as keyof T])
) {
if (keysA.length > 0) {
for (const key of keysA) {
if (
!Object.prototype.hasOwnProperty.call(objB, key) ||
!Object.is(objA[key as keyof T], objB[key as keyof T])
) {
return false
}
}
return true
}

if (keysA.length === 0) {
const descriptorsA = Object.getOwnPropertyDescriptors(objA)
const descriptorsB = Object.getOwnPropertyDescriptors(objB)

const getterKeysA = Object.keys(descriptorsA).filter(
(key) => descriptorsA[key]?.get !== undefined,
)
const getterKeysB = Object.keys(descriptorsB).filter(
(key) => descriptorsB[key]?.get !== undefined,
)

if (getterKeysA.length !== getterKeysB.length) {
return false
}

for (const key of getterKeysA) {
if (
!getterKeysB.includes(key) ||
!Object.is(
(objA as Record<string, unknown>)[key],
(objB as Record<string, unknown>)[key],
)
) {
return false
}
}
}

return true
}