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

sieve-ts

v1.1.1

Published

Node.js/Typescript types and services for [Biarity/Sieve](https://github.com/Biarity/Sieve).

Downloads

609

Readme

Sieve

Node.js/Typescript types and services for Biarity/Sieve.

Build Status Maintainability Rating Security Rating Vulnerabilities

HttpParam or Sieve

If you use the Sieve package for filtering in your (.NET) back-end then you probably only have to look at the SieveFilterService. If however, you use this package for multiple back-ends you can use the HttpParamFilterService as the fall-back to use "regular" HTTP-params

Usage

  1. install & import the package:

    yarn add sieve-ts
     import { Filter, SieveFilterService } from "sieve-ts";
  2. construct a filter using the models:

     const filter = new Filter({
      pageIndex: 2,
      pageSize: 45,
      sorts: [
        {
          field: "testField",
          direction: SortDirection.Ascending,
        },
      ],
      filters: [
        {
          fields: ["firstField", "secondField"],
          values: ["singleValue"],
          operator: Operators.CONTAINS,
        },
      ],
    })
  3. create a service and use it:

    // user either one, both will return a string
    const service = new SieveFilterService();
    const service = new HttpParamService();
  4. use the service to create a usable value:

    console.log(service.toValue(filter));
  5. Observe the output:

    // The Sieve service will have combined the fields together into a single filter:
    page=3&pageSize=45&Filters=(firstField|secondField)@=singleValue&Sorts=testField
    
    // the HTTP service will simply pass both variables:
    page=3&pageSize=45&firstField=singleValue&secondField=singleValue&testField=+

Retrieving filter objects from the URL

You can also give the FilterService the URL query parameter string and have it figure out the filter structure. Let's try it with a rather complicated query param string: page=3&pageSize=45&Filters=(firstField|secondField)@=singleValue&Sorts=testField

// create service
const sieveService = new SieveFilterService();

// parse filter
const filters = sieveService.parse(
  "page=3&pageSize=45&Filters=(firstField|secondField)@=singleValue&Sorts=testField",
);

// output
console.log(JSON.stringify(filters, null, 2));

Extra/custom parameters

To include extra/custom parameters simply call the toValue or getFilterValue functions with the optional second argument (key:value):

console.log(service.toValue(filter, {firstKey: "firstValue", secondKey: "secondValue"}));

Customized Sieve instances

If you have customized parts of your back-end Sieve you can also pass along the custom options to the SieveService. Let's say we've customized the word "page" to someOtherWordForPage and the character to split filter keys from | to ~, our config would look like this:

  const sieveService = new SieveFilterService({
    ...SIEVE_CONSTANTS,
    page: "someOtherWordForPage",
    keySplitChar: "~",
  });

Which would result in the following result instead:

  someOtherWordForPage=3&pagesize=45&Filters=(firstField~secondField)@=singleValue&Sorts=testField