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

@swarmjs/crud

v1.3.10

Published

CRUD handler for mongoose models

Downloads

6

Readme

Version Downloads License Build

Table Of Contents

About The Project

This package aims to help developers quickly create CRUD controllers.

Built With

  • TypeScript@4

Getting Started

Installation

yarn add @swarmjs/crud

or

npm install --save @swarmjs/crud

Usage

import { Crud } from '@swarmjs/crud'
import User from './models/User'

const crud = new Crud(User)

const userSchema = {
  type: 'object',
  properties: {
    email: {
      type: 'string',
      format: 'email'
    },
    name: {
      type: 'string'
    }
  }
}

export default class UsersController {
  @Returns(200, crud.getListSchema(userSchema), 'The users list')
  static list(request, reply) {
    crud.list(request, reply, {
      defaultLimit: 20,
      filter: null, // You can use a MongoDB query
      defaultSort: '_id'
    })
  }

  @Returns(201, { type: 'object' }, 'Document created')
  static create(request, reply) {
    crud.create(request, reply)
  }

  @Returns(200, userSchema, 'The searched user')
  static get(request, reply) {
    crud.get(request, reply, {
      idParam: 'id', // The params field where is the searched document ID
      primaryKey: '_id' // The primary key in the mongoose model where we search the value passed in params
    })
  }

  @Returns(200, { type: 'object' }, 'Update successful')
  @Returns(404, { type: 'object' }, 'Document not found')
  static update(request, reply) {
    crud.update(request, reply, {
      idParam: 'id', // The params field where is the searched document ID
      primaryKey: '_id' // The primary key in the mongoose model where we search the value passed in params
    })
  }

  @Returns(200, { type: 'object' }, 'Update successful')
  @Returns(201, { type: 'object' }, 'Document created')
  static replace(request, reply) {
    crud.replace(request, reply, {
      idParam: 'id', // The params field where is the searched document ID
      primaryKey: '_id' // The primary key in the mongoose model where we search the value passed in params
    })
  }

  @Returns(204, { type: 'object' }, 'Delete successful')
  @Returns(404, { type: 'object' }, 'Document not found')
  static delete(request, reply) {
    crud.delete(request, reply, {
      idParam: 'id', // The params field where is the searched document ID
      primaryKey: '_id' // The primary key in the mongoose model where we search the value passed in params
    })
  }
}

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

  • If you have suggestions for adding or removing projects, feel free to open an issue to discuss it, or directly create a pull request after you edit the README.md file with necessary changes.
  • Please make sure you check your spelling and grammar.
  • Create individual PR for each suggestion.
  • Please also read through the Code Of Conduct before posting your first idea as well.

Creating A Pull Request

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.

Crudors