npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@n3/filters-utils

v0.1.6

Published

Utils for working with filter values

Downloads

467

Readme

@n3/filters-utils

Набор утилиты для работы со значениями фильтров.

Для работы используется массив с данными фильтров и объект с описаниями фильтров. С помощью них можно получить имена фильтров для отправки, сериализованные значения фильтров для отправки, проверку возможности сброса фильтров, а также парсинг значений для инициализации.

Установка

npm install @n3/filters-utils

или

yarn add @n3/filters-utils

Использование

Описание каждого фильтра представляется следующим объектом:

type FilterType<Payload> = {
  getNames?: (payload: Payload, getFilter: GetFilter<Payload>) => string[];
  serializeValues?: (values: Values, payload: Payload, getFilter: GetFilter<Payload>) => Values;
  serializeValuesForQueryString?: (values: Values, payload: Payload, getFilter: GetFilter<Payload>) => Values;
  checkCanReset?: (values: Values, payload: Payload, getFilter: GetFilter<Payload>) => boolean;
  parseValues?: (values: Values, payload: Payload, getFilter: GetFilter<Payload>) => Values | Promise<Values>;
  getResetTo?: (payload: Payload, getFilter: GetFilter<Payload>) => Values;
};
  • getNames: Function - необязательная, функция получения имён полей фильтра. Должна возвращать массив имён полей фильтра. По умолчанию, возвращает массив из одного элемента payload.name. Аргументы:

    • payload: Object - данные фильтра
    • getFilter: Function - получение описания фильтра по объекту данных (может быть использовано для описания вложенных структур)
  • serializeValues: Function - необязательная, функция получения значений для отправки. Должна возвращать объект значений. Аргументы:

    • appliedFilters - Object - текущие значения примененных фильтров
    • payload: Object - данные фильтра
    • getFilter: Function - получение описания фильтра по объекту данных (может быть использовано для описания вложенных структур)
  • serializeValuesForQueryString: Function - необязательная, функция получения значений для адресной строки. Должна возвращать объект значений. Аргументы:

    • appliedFilters - Object - текущие значения примененных фильтров
    • payload: Object - данные фильтра
    • getFilter: Function - получение описания фильтра по объекту данных (может быть использовано для описания вложенных структур)
  • checkCanReset: Function - необязательная, определяет, возможен ли сброс данного фильтра. Должна возвращать булево значение. По умолчанию, берёт значение из appliedFilters по ключу payload.name и проверяет его на не ложность. Аргументы:

    • appliedFilters - Object - текущие значения примененных фильтров
    • payload: Object - данные фильтра
    • getFilter: Function - получение описания фильтра по объекту данных (может быть использовано для описания вложенных структур)
  • parseValues: Function - необязательная, асинхронная функция получения значений для инициализации. Должна возвращать объект значений. Аргументы:

    • values - Object - необработанные значения фильтров, например, после парсинга значений браузерной строки
    • payload: Object - данные фильтра
    • getFilter: Function - получение описания фильтра по объекту данных (может быть использовано для описания вложенных структур)
  • getResetTo: Function - необязательная, функция получения значений фильтров после сброса. Должна возвращать объект значений. Аргументы:

    • payload: Object - данные фильтра
    • getFilter: Function - получение описания фильтра по объекту данных (может быть использовано для описания вложенных структур)

Утилиты

getFilterNames

import { getFilterNames } from '@n3/filters-utils';

Собирает имена фильтров. Аргументы:

  • filterData: Object[] - массив данных фильтров
  • getFilter: Function - получение описания фильтра по объекту данных

serializeValues

import { serializeValues } from '@n3/filters-utils';

Собирает значения фильтров для отправки. Аргументы:

  • appliedFilters - Object - текущие значения примененных фильтров
  • filterData: Object[] - массив данных фильтров
  • getFilter: Function - получение описания фильтра по объекту данных

serializeValuesForQueryString

import { serializeValues } from '@n3/filters-utils';

Собирает значения фильтров для сериализации в адресную строку. Аргументы:

  • appliedFilters - Object - текущие значения примененных фильтров
  • filterData: Object[] - массив данных фильтров
  • getFilter: Function - получение описания фильтра по объекту данных

checkCanResetFilters

import { checkCanResetFilters } from '@n3/filters-utils';

Определяет, возможен ли сброс фильтров. Аргументы:

  • appliedFilters - Object - текущие значения примененных фильтров
  • filterData: Object[] - массив данных фильтров
  • getFilter: Function - получение описания фильтра по объекту данных

parseValues

import { parseValues } from '@n3/filters-utils';

Асинхронная функция. Собирает значения фильтров для инициализации. Аргументы:

  • values - Object - необработанные значения фильтров, например, после парсинга значений браузерной строки
  • filterData: Object[] - массив данных фильтров
  • getFilter: Function - получение описания фильтра по объекту данных

getResetFiltersTo

import { getResetFiltersTo } from '@n3/filters-utils';

Собирает значения фильтров для сброса. АргументыЖ

  • filterData: Object[] - массив данных фильтров
  • getFilter: Function - получение описания фильтра по объекту данных

Локальная разработка

Репозиторий использует стабильную версию yarn.

Инструкция по установке.

Команды

  • yarn build - сборка;

  • yarn clean - удалить все собранне файлы;

  • yarn test - валидация кода.