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

@sigmaott/paginate

v3.4.7

Published

A pagination, filtering and sorting lib for nestjs using mongoose orm

Downloads

186

Readme

nestjs-mongoose-paginate

A pagination, filtering and sorting lib for nestjs using mongoose orm

Usage

Exposing properties

Create a class to hold information about filterable and sortable properties You need to @ExposeQuery properties of this class. By default none of it is filterable nor sortable. You should set this parameters explicitly. In case you want to expose some of the properties with a different name, you need to specify a name option in this decorator.

import {
  CollectionProperties,
  ExposeQuery
} from '@sigmaott/paginate';

export class MyCollectionEntity {
  @ExposeQuery({ name: 'createdAt', sortable: true })
  readonly created_at: 'desc' | 'asc';

  @ExposeQuery({ sortable: true, default: true, filterable: true })
  readonly userName: 'desc' | 'asc';

  readonly unsortable: string;
}

Validation Pipe

import {
  CollectionDto,
  CollectionValidationPipe,
  CollectionResponse
} from '@sigmaott/paginate';

@Controller()
export class AppController {
  @Get('list')
  async filter(
    @Query(new CollectionValidationPipe(MyCollectionEntity))
    collectionDto: CollectionDto,
  ): Promise<CollectionResponse<MyDocument>> {
    return await this.service.list(collectionDto);
  }
}

Document collector usage

import { Model } from 'mongoose';
import { InjectModel } from '@nestjs/mongoose';
import {
  CollectionDto,
  DocumentCollector,
  CollectionResponse
} from '@sigmaott/paginate';

@Injectable()
export class AppService {
  private moduleCollection
  constructor(
    @InjectModel('MyModel') private readonly model: Model<MyDocument>,
  )

  onModuleInit() {
    this.modelCollection = new DocumentCollector<MyDocument>(this.model);
  }

  async list(
      collectionDto: CollectionDto,
  ): Promise<CollectionResponse<MyDocument>> {
    return this.modelCollection.find(collectionDto);
  }
}

Queries

You may now send a request, like in example below:

http://localhost:3000/list?username=test&sort=createdAt|asc&page=0&perPage=10

query parameter

you can make complex query mongo via field q

q={"$and":[{"userInput.selectedOption":"0"}]}

Selection

You can limit field return in response by fields

fields=id,name,age,!sex

field start with character ! meaning you will receive response without this field

Sort

You can specify more than one field for sorting by providing a list of them separated by a semicolon: createdAt|asc,userName|desc.

Filter

filter format example

field=$gte:3&name=$cont:name

A subset of mongoose query language is supported. Currently only these operators are supported:

  • $eq (=, equal)
  • $ne (!=, not equal)
  • $gt (>, greater than)
  • $lt (<, lower that)
  • $gte (>=, greater than or equal)
  • $lte (<=, lower than or equal)
  • $in (IN, in range, accepts multiple values)
  • $nin (NOT IN, not in range, accepts multiple values)
  • $regex (REGEX, regex)
  • $not (NOT, negation)
  • $like (LIKE, %like%)

populate

You can populate nested documents by providing a list of them separated by a semicolon: populate=user,author