AdvancedUrlSearchParams

AdvancedUrlSearchParams is a TypeScript class that facilitates the parsing and extraction of filtering, pagination, and sorting information from URL search parameters.

Table of Contents

• Installation
• Usage
• Examples
• API
• Contributing
• License

Installation

To use AdvancedUrlSearchParams in your project, you can install it via npm:

npm install advanced-url-search-params

Usage

import { AdvancedUrlSearchParams } from "advanced-url-search-params";

const searchParamsString = "page=1&size=10&column=name&direction=asc&filter=name:contains:john";

const urlSearchParams = new AdvancedUrlSearchParams(searchParamsString);

// Accessing parsed values
const pagination = urlSearchParams.pagination;
const sorting = urlSearchParams.sorting;
const filters = urlSearchParams.filters;

Examples

Here are some examples demonstrating how to use AdvancedUrlSearchParams:

Basic Usage

import { AdvancedUrlSearchParams } from "advanced-url-search-params";

const searchParamsString = "page=1&size=10&name:eq=john&sort=startDate";

const urlSearchParams = new AdvancedUrlSearchParams(searchParamsString);

console.log(urlSearchParams.pagination); // { page: 1, size: 10 }
console.log(urlSearchParams.sorting); // [{ column: 'name', direction: 'asc' }]
console.log(urlSearchParams.filters); // [{ column: 'name', value: 'john', rule: 'eq' }]

API

AdvancedUrlSearchParams

Constructor

• new AdvancedUrlSearchParams(searchParams: string): AdvancedUrlSearchParams

  Creates an instance of AdvancedUrlSearchParams by parsing the provided search parameters.

Properties

• pagination: Pagination

  Gets the pagination information from the URL search parameters.

• sorting: Sorting[]

  Gets the sorting information from the URL search parameters.

• filters: Filter[]

  Gets the filter information from the URL search parameters.

Pagination

• page?: number

  The current page number.

• size?: number

  The number of items per page.

Sorting

• column: string

  The column to sort by.

• direction: SortingDirection

  The sorting direction (enum).

Filter

• column: string

  The column to filter by.

• value: string

  The value to filter.

• rule: FilterRule

  The filter rule (enum).

Filter rules:

  Equal = "eq",
  NotEqual = "ne",
  GreaterThan = "gt",
  GreaterThanOrEqual = "ge",
  LessThan = "lt",
  LessThanOrEqual = "le",
  Contains = "contains",
  NotContains = "not_contains",
  StartsWith = "starts_with",
  EndsWith = "ends_with",
  In = "in",
  NotIn = "not_in",
  Between = "between",
  NotBetween = "not_between",
  IsNull = "is_null",
  IsNotNull = "is_not_null",
  IsEmpty = "is_empty",
  IsNotEmpty = "is_not_empty",
  IsTrue = "is_true",
  IsFalse = "is_false",

Special thanks to @dszwcz for his support and contribution.

Contributing

Contributions are welcome! If you find any issues or have suggestions for improvement, please open an issue or submit a pull request.

License

This project is licensed under the MIT License.