@manjiltamang/mongoose-util v0.0.1

Project Introduction

Easy lightweight mongoose utility helper functions to query your entity list.

Table of Contents

• Installation
• API documentation
• Contributing guide
• License

Installation

To install, you can use npm or yarn:

$ npm install --save @manjiltamang/mongoose-util
$ yarn add @manjiltamang/mongoose-util

API documentation

Build on top of mongoose you can use the helper functions in your Node.js application to create query with ease for faster development.

Get all example

A basic usage example for fetching a list.

const { getAll } = require("@manjiltamang/mongoose-util");
const Lyric = require("./models/Lyric"); // Your mongoose model

app.get("/lyrics", async (req, res) => {
  const [lyrics, total, size] = await getAll(Lyric, req.query).exec();

  res.status(200).json({
    status: "success",
    data: {
      lyrics,
      total,
      size,
    },
  });
});

GET /api/lyrics?artist=jindabaad&page=2&size=30&fields=lyric,artist,album&sort=-releaseYear&ratings[gte]=3&ratings[lte]=5

Above request will fetch second page of lyrics with size 30 per page jindabaad as artist name, , selecting only lyrics, artist and album attributes and sorted by release year in descending order with ratings of 3 to 5.

Date Range

GET /api/songs?artist=jindabaad&releaseYear[gte]=2012-01-01&releaseYear[lte]=2020-10-30

Get all songs from the artist Jindabaad that has been released between date 2012-01-01 and 2020-10-30

Wildcard

GET /api/songs?artist[match]=baad

Similar to LIKE operator in SQL. The match operator will fetch all the songs from artists containing baad (case in-sensitive) in their name.

Populate

const [lyrics, total, size] = await getAll(Lyric, req.params)
  .populate("artist")
  .exec();

You can add sorting, filters, paginations, field limiting by adding the request params to the request.

Contributing guide

Read our contributing guide to learn about our development process, how to propose bugfixes and improvements, and how to build and test your changes.

License

Licensed under the MIT License.