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

yo-generic-api

v1.1.1

Published

generic api for basic CRUD operations

Downloads

5

Readme

Generic api

(Rough sketch v1)

Note: All logic is blocking, i.e validation is blocking, can be changed to async pattern too!

Important files:

config.js contains example config for a resource.

	module.exports = {
		PAGE_SIZE: 10,
		DEMO_CONFIG: {
			model: 'User',
			enableModifiers: true,
			modifierRules: { slug: ['slugify', 'uppercase'] },
			methods: ['get', 'post', 'put'],
			path: '/user',
			paramsArray: ['id', 'email', 'name'],
			paramsRulesList: {
				name: {
					rules: [{ name: 'length', max: 3, min: 2 }]
				},
				email: {
					rules: [{ name: 'email' }]
				}
			}
	}
}```

You can create new instance of generic-api for different resources. A resource in this context refers to an entity like User, Car, Product etc.

# Steps to use

require('yo-generic-api')
const Resource = require('yo-generic-api').Resource
const user = new Resource()
user.init(app, config)

## Note: app parameter should have mongoose model attached for database calls to work. Eg: app.db.models.User

Current working routes:

get: Fetch Items (use queryStrings for searching)
post: Create an item
put: Update items (use queryStrings for creating filters)
delete: Delete items (Use ?operator=in&by=id for deleting multiple items by _id, also pass array of id:['1st id','2nd id'] as body)