Data Table Stream Params

Encodes and decodes stream request parameters using the shared data-table query convention.

Installation

bash

pnpm dlx shadcn@latest add @cs/data-table-stream-params

tsx

import { encodeStreamParams } from "@/lib/cs/data-table-stream-params";

tsx

const params = encodeStreamParams({ skip: 0, take: 10, sorting: [], columnFilters: [], columns: [], globalFilter: null });

Serializes data-table stream parameters using the shared server convention.

Name	Type	Default	Description
columnFilters *	ColumnFiltersState	-	Table column filter state.
columns *	ColumnServer[]	-	Base info about columns.
extraWhere	object \| undefined	-	Aditional filters.
globalFilter *	string \| null	-	-
select	{ field: string; values: unknown[]; } \| undefined	-	Optional selection filter — adds `{ [field]: { in: values } }` to the where clause.
skip *	number	-	Count of skiped rouws.
sorting *	SortingState	-	Table soritng state.
take *	number	-	Page size.

Reconstructs table stream parameters from the shared readable params.

Name	Type	Default	Description
search *	URLSearchParams	-	-

Returns: DataTableOnData