Skip to content

feat(serializer): allow null to clear all param values from base #657

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 3 commits into from
Sep 27, 2024
Merged

feat(serializer): allow null to clear all param values from base #657

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
5139ef4
feat(serializer): allow `null` to clear all param values from base
neefrehman Sep 27, 2024
a6afede
test: Add test to show that externally managed params are kept
neefrehman Sep 27, 2024
7199adc
chore: Apply formatting
franky47 Sep 27, 2024
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
12 changes: 11 additions & 1 deletion packages/nuqs/src/serializer.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,11 +70,21 @@ describe('serializer', () => {
const result = serialize(url, { str: 'foo' })
expect(result).toBe('https://example.com/path?bar=egg&str=foo')
})
test('null deletes from base', () => {
test('null value deletes from base', () => {
const serialize = createSerializer(parsers)
const result = serialize('?str=bar&int=-1', { str: 'foo', int: null })
expect(result).toBe('?str=foo')
})
test('null deletes all from base', () => {
const serialize = createSerializer(parsers)
const result = serialize('?str=bar&int=-1', null)
expect(result).toBe('')
})
test('null keeps search params not managed by the serializer', () => {
const serialize = createSerializer(parsers)
const result = serialize('?str=foo&external=kept', null)
expect(result).toBe('?external=kept')
})
test('clears value when setting the default value when `clearOnDefault` is used', () => {
const serialize = createSerializer({
int: parseAsInteger.withOptions({ clearOnDefault: true }).withDefault(0),
Expand Down
12 changes: 9 additions & 3 deletions packages/nuqs/src/serializer.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,15 +27,21 @@ export function createSerializer<
* - another value is given for an existing key, in which case the
* search param will be updated
*/
function serialize(base: Base, values: Values<Parsers>): string
function serialize(base: Base, values: Values<Parsers> | null): string
function serialize(
baseOrValues: Base | Values<Parsers>,
values: Values<Parsers> = {}
baseOrValues: Base | Values<Parsers> | null,
values: Values<Parsers> | null = {}
) {
const [base, search] = isBase(baseOrValues)
? splitBase(baseOrValues)
: ['', new URLSearchParams()]
const vals = isBase(baseOrValues) ? values : baseOrValues
if (vals === null) {
for (const key in parsers) {
search.delete(key)
}
return base + renderQueryString(search)
}
for (const key in parsers) {
const parser = parsers[key]
const value = vals[key]
Expand Down