https://github.com/iamhectorsosa/search-params
Read and update URLSearchParams with full type-safety
https://github.com/iamhectorsosa/search-params
react typescript
Last synced: 3 months ago
JSON representation
Read and update URLSearchParams with full type-safety
- Host: GitHub
- URL: https://github.com/iamhectorsosa/search-params
- Owner: iamhectorsosa
- Created: 2023-11-19T16:23:27.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2023-12-05T08:38:58.000Z (over 1 year ago)
- Last Synced: 2025-03-01T13:39:08.552Z (4 months ago)
- Topics: react, typescript
- Language: TypeScript
- Homepage: https://search-params-playground.vercel.app
- Size: 291 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
Awesome Lists containing this project
README
# Search Params
Read and write [URLSearchParams](https://developer.mozilla.org/en-US/docs/Web/API/URLSearchParams) with full type-safety using `@search-params/react` using any React Framework and any schema validation library.
## Documentation
For usage please reference `@search-params/react` [readme.md](/packages/react/readme.md) for more detailed information.
## Development
### Installation
The Search Params repository uses [PNPM Workspaces](https://pnpm.io/workspaces) and [Turborepo](https://github.com/vercel/turborepo). To install dependencies, run in the project's root directory:
```bash
pnpm install
```
### Development
You can also test/debug `@search-params/react` with the docs locally. Any change to the docs will re-render instantly. If you update the package, a rebuild is required but using Turborepo this has been set to watch mode.
```bash
pnpm dev
```
### Build
```bash
pnpm build
```