Skip to content

feat: add preserve empty array option #148

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
merged 5 commits into from
Sep 11, 2025
Merged

feat: add preserve empty array option #148

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
f2fc785
feat: add preserve empty array option
eaglethrost Sep 10, 2025
2b2d8c1
feat: update readme & more test coverage
eaglethrost Sep 10, 2025
0ad5ee1
Merge branch 'main' into dimas/CX-1511-preserve-empty-array
eaglethrost Sep 10, 2025
9556ad1
style: merge from next & lint
eaglethrost Sep 10, 2025
0be4a2e
doc: add more example in readme
eaglethrost Sep 11, 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
16 changes: 13 additions & 3 deletions src/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,15 @@ function isObject(obj: unknown) {
}

function isEmptyObject(obj: unknown) {
return typeof obj === 'object' && obj !== null && !Object.keys(obj).length;
return typeof obj === 'object' && obj !== null && !Array.isArray(obj) && !Object.keys(obj).length;
}

function isEmptyArray(arr: unknown) {
return Array.isArray(arr) && arr.length === 0;
}

interface RemovalOptions {
preserveEmptyArray?: boolean;
removeAllFalsy?: boolean;
}

Expand Down Expand Up @@ -41,6 +46,8 @@ function stripEmptyObjects(obj: any, options: RemovalOptions = {}) {

if (isEmptyObject(value)) {
delete cleanObj[key];
} else if (isEmptyArray(value) && !options.preserveEmptyArray) {
delete cleanObj[key];
} else {
cleanObj[key] = value;
}
Expand All @@ -56,6 +63,8 @@ function stripEmptyObjects(obj: any, options: RemovalOptions = {}) {

if (isEmptyObject(value)) {
delete cleanObj[idx];
} else if (isEmptyArray(value) && !options.preserveEmptyArray) {
delete cleanObj[idx];
} else {
cleanObj[idx] = value;
}
Expand Down Expand Up @@ -83,8 +92,9 @@ export default function removeUndefinedObjects<T>(obj?: T, options?: RemovalOpti
// Then we recursively remove all empty objects and nullish arrays.
withoutUndefined = stripEmptyObjects(withoutUndefined, options);

// If the only thing that's leftover is an empty object then return nothing.
if (isEmptyObject(withoutUndefined)) return undefined;
// If the only thing that's leftover is an empty object or empty array then return nothing.
if (isEmptyObject(withoutUndefined) || (isEmptyArray(withoutUndefined) && !options?.preserveEmptyArray))
return undefined;

return withoutUndefined;
}
6 changes: 6 additions & 0 deletions test/index.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,12 @@ test("should also remove '' and null values when removeAllFalsy is true", () =>
expect(removeUndefinedObjects({ value: undefined }, { removeAllFalsy: true })).toBeUndefined();
});

test('should not remove empty arrays when preserveEmptyArray is true', () => {
expect(removeUndefinedObjects({ value: [] }, { preserveEmptyArray: true })).toStrictEqual({ value: [] });
expect(removeUndefinedObjects({ value: [undefined] }, { preserveEmptyArray: true })).toStrictEqual({ value: [] });
expect(removeUndefinedObjects({ value: [null] }, { preserveEmptyArray: true })).toStrictEqual({ value: [] });
Copy link
Member

@erunion erunion Sep 10, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you add another case in here for an array with non-falsy values to assert that it is left alone. Also can you add some more examples for arrays in a nested object?

});

test('should remove empty objects with only empty properties', () => {
const obj = {
a: {
Expand Down