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

@frabbit/mongoose-paginate

v7.2.6

Published

Mongoose paginate plugin with full typescript support and support for latest mongoose package and types.

Downloads

109

Readme

@frabbit/mongoose-paginate npm

Mongoose paginate plugin with full typescript support and support for latest mongoose package and types.

Main idea is to add pagination options to find() and aggregate() without duplicating other params. Mongoose seems to be adding more typescript support, so old pagination plugins gets old.

Features

Major version is same as mongoose version

Provides 2 new methods on model

async function findPaginated(
  filter: FilterQuery<T> = {}, // same as  mongoose.find 
  pagination: PaginationOptions<T>, // plugin's param
  projection?: ProjectionType<T> | null, // same as  mongoose.find
  options?: QueryOptions<T> | null // same as  mongoose.find
): Promise<PaginatedResult<T>> {
}
async function aggregatePaginated(
  pipeline: PipelineStage[], // same as mongoose.aggregate
  paginate: PaginationOptions<T>, // plugin's param
  options?: AggregateOptions // same as mongoose.aggregate
): Promise<PaginatedResult<T>> {
}

the result is:

export class PaginatedResult<T> {
  /**
   * Documents on page
   */
  items: T[] = []

  /**
   * total documents count
   */
  total: number = 0

  /**
   * page
   */
  page: number = 1
  /**
   * total pages count
   */
  totalPages?: number = undefined

  /**
   * items per page
   */
  limit?: number = undefined

  /**
   * has previous page
   */
  hasPrevPage?: Boolean = false
  /**
   * has next page
   */
  hasNextPage?: Boolean = false

  /**
   * previous page number
   */
  prevPage?: number = undefined
  /**
   * next page number
   */
  nextPage?: number = undefined

  /**
   * The starting index/serial/chronological number of first document in current page.
   * (Eg: if page=2 and limit=10, then pagingCounter will be 11)
   */
  pagingCounter?: number = undefined

}

Install

npm i -D @frabbit/mongoose-paginate

Usage

import {mongoosePaginate, PaginatedModel, PaginatedResult} from "@frabbit/mongoose-paginate";

interface Some {
  field: string
}

type SomeDocument = Document & Some

const someSchema = new Schema({
  field: String,
});

someSchema.plugin(mongoosePaginate);

const someModel: PaginatedModel<SomeDocument>
("Some", someSchema);

const items: PaginatedResult<SomeDocument> = await someModel.findPaginated({}, {limit: 10, page: 1})
const items2: PaginatedResult<Some> = await someModel.findPaginated({}, {limit: 10, page: 1}, {field: 1}, {lean: true})

License

MIT License © 2023-PRESENT frenchrabbit