Product
Introducing SSO
Streamline your login process and enhance security by enabling Single Sign-On (SSO) on the Socket platform, now available for all customers on the Enterprise plan, supporting 20+ identity providers.
zod-search-params
Advanced tools
Readme
zod-search-params is a library for parsing and validating search params in the browser.
yarn add zod-search-params
Do NOT use coerce
in the schema, coerce is applied automatically (to prevent casting undefined
to "undefined"
etc.) for enabled types, when it's needed.
const schema = z.object({
search: z.string().catch(''),
page: z.number().catch(1),
});
import { parseSearchParams } from 'zod-search-params';
const parsedSearchParams = parseSearchParams(schema, urlSearchParams);
If all object properties within the zod schema are defined with .catch()
, the output will always be an object with the same properties as the schema, but with the default values.
import { parseSearchParams } from 'zod-search-params';
const schema = z.object({
search: z.string().catch(''),
page: z.number().catch(1),
});
const parsedSearchParams = parseSearchParams(schema);
/*
typeof parsedSearchParams
{
search: string,
page: number,
}
*/
If one or all object properties within the zod schema don't have .catch()
, the output will be an object with the same properties as the schema or undefined
. Where the undefined
will return if parsing of the search params fail (for example passing string into a number).
import { parseSearchParams } from 'zod-search-params';
const schema = z.object({
search: z.string().catch(''),
page: z.number(),
});
const parsedSearchParams = parseSearchParams(schema);
/*
typeof parsedSearchParams
undefined | {
search: string,
page: number,
}
*/
Using .optional()
on a property will make the property optional, can be also chained with .default()
to provide a default value.
import { parseSearchParams } from 'zod-search-params';
const schema = z.object({
search: z.string().catch(''),
page: z.number().optional().catch(undefined),
sort: z.string().optional().default('name').catch('name'),
});
const parsedSearchParams = parseSearchParams(schema);
/*
typeof parsedSearchParams
{
search: string,
page?: number,
sort: string,
}
*/
import { URLSearchParams } from 'url';
const schema = z.object({
search: z.string().catch(''),
page: z.number().catch(1),
});
const objectParams = {
search: 'hello',
page: '2',
};
const urlParams = new URLSearchParams();
urlParams.append('search', 'hello');
urlParams.append('page', '2');
console.log(parseSearchParams(schema, objectParams));
console.log(parseSearchParams(schema, urlParams));
/*
OUTPUTS:
{
search: 'hello',
page: 2,
}
*/
import { URLSearchParams } from 'url';
const schema = z.object({
tags: z.array(z.string()).catch([]),
ids: z.array(z.number()).catch([]),
});
const objectParams = {
tags: ['zod', 'typescript'],
ids: '42',
};
const urlParams = new URLSearchParams();
urlParams.append('tags', 'zod');
urlParams.append('tags', 'typescript');
urlParams.append('ids', '42');
console.log(parseSearchParams(schema, objectParams));
console.log(parseSearchParams(schema, urlParams));
/*
OUTPUTS:
{
tags: ['zod', 'typescript'],
ids: [42],
}
*/
FAQs
Zod utility for parsing search params
The npm package zod-search-params receives a total of 22 weekly downloads. As such, zod-search-params popularity was classified as not popular.
We found that zod-search-params demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Product
Streamline your login process and enhance security by enabling Single Sign-On (SSO) on the Socket platform, now available for all customers on the Enterprise plan, supporting 20+ identity providers.
Security News
Tea.xyz, a crypto project aimed at rewarding open source contributions, is once again facing backlash due to an influx of spam packages flooding public package registries.
Security News
As cyber threats become more autonomous, AI-powered defenses are crucial for businesses to stay ahead of attackers who can exploit software vulnerabilities at scale.