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

slug-mongoose

v1.0.5

Published

slug-mongoose is a versatile npm package that simplifies the process of adding slug functionality to your Mongoose schemas...

Downloads

5

Readme

slug-mongoose

slug-mongoose is a versatile npm package that simplifies the process of adding slug functionality to your Mongoose schemas. This package seamlessly integrates with Mongoose models, enabling you to automatically generate slugs based on specified fields while ensuring their uniqueness. By effortlessly handling slug creation and management, slug-mongoose streamlines URL-friendly naming for your MongoDB documents, enhancing the readability and searchability of your applications.

Installation

To get started, install the slug-mongoose package via npm:

npm install slug-mongoose

Usage

To use slug-mongoose, import the package:

const slugMongoose = require("slug-mongoose");

Apply the slug-mongoose plugin to your Mongoose schema:

const mongoose = require("mongoose");

const schema = new mongoose.Schema({
  title: String, // Example field to generate slug from
});

schema.plugin(slugMongoose, {
  field: "title", // Field to generate the slug from
  slugField: "slug", // Field to store the generated slug
});

const Model = mongoose.model("Model", schema);

When you create and save documents using the Model, the slug field will be automatically generated:

const instance = new Model({ title: "Sample Title" });
instance.save();

/**
 * Object Created
 * {
 *      "_id": "64dba901cced64bf4a950e50",
 *      "title": "Sample Title",
 *      "slug": "sample-title",
 *      "__v": 0
 * }
 */

Retrieve documents using the generated slug:

const foundInstance = await Model.findBySlug("sample-title");

Options

The slug-mongoose plugin accepts the following options:

  • field: The field to generate the slug from (default: "name").
  • slugField: The field to store the generated slug (default: "slug").

Compatibility

slug-mongoose supports both CommonJS and ES Modules environments and latest mongoose versions, making it easy to integrate with your projects.

License

This project is licensed under the MIT License.

Issues and Contributions

If you encounter any issues or have suggestions for improvements, please feel free to open an issue on the GitHub repository. Contributions are also welcome!