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

mongoose-schema-decorators

v2.0.0-rc2

Published

Define your mongoose models/schemas easily with @decorators

Downloads

5

Readme

mongoose-schema-decorators

NPM version Downloads

Define your mongoose models/schemas easily with @decorators

Installation

npm install mongoose-schema-decorators --save

API

Functions

  • buildSchema(target: Function, loadClass:boolean = true) - helper function to generate mongoose schema
    • {Function} target name of the decorated class
    • {boolean} loadClass indicating if load setters + getters, static methods, and instance methods from the target class to schema. Default to true

Decorators

  • @schema(options?: Mongoose.SchemaTypeOpts) - decorates a class for mongoose schema generation
  • @field(options?: Mongoose.SchemaTypeOpts) - decorates a property with schema options if any
  • @required - decorates a property which is a required field in schema
  • @indexed - decorates a property which is a indexed field in schema
  • @unique - decorates a property which is unique field in schema
  • @statics - decorates a property/method which to be registered as schema statics
  • @methods - decorates a method which to be registered as schema instance methods
  • @virtuals(options?: any) - decorates a getter/setter/property (virtual reference to build relationship between collections) as schema virtuals

Sample usage

@schema({
  toJSON: {
    getters: true,
    virtuals: true,
  },
})
class Service {
  @indexed
  @field(Mongoose.Schema.Types.ObjectId)
  _id: Mongoose.Schema.Types.ObjectId;

  @field
  product: string;

  @field
  description: string;

  @field({ ref: 'Customer' })
  customer: number;
}

@schema({ _id: false })
class Contact {
  @field
  public firstname: string;

  @field
  public lastname: string;

  @field
  public phone: string;

  @field
  public address: string;
}

@schema({
  toJSON: {
    getters: true,
    virtuals: true,
  },
})
class Customer {
  @indexed
  @unique
  _id: number;

  @field
  @indexed
  name: string;

  @field(Date)
  createdDate: Date;

  @field([Contact])
  contacts: [Contact];

  @virtuals({
    ref: 'Service',
    localField: '_id',
    foreignField: 'customer',
    justOne: false,
  })
  public services: Service[];

  get getRef(): string {
    return `${this._id}-${this.name}`;
  }
}

const serviceSchema: Mongoose.Schema = buildSchema(Service);
type ServiceDocument = Service & Mongoose.Document;
const ServiceModel = Mongoose.model<ServiceDocument, Mongoose.Model<ServiceDocument>>('Service', serviceSchema);

const CustomerSchema: Mongoose.Schema = buildSchema(Customer);
type CustomerDocument = Customer & Mongoose.Document;
const CustomerModel = Mongoose.model<CustomerDocument, Mongoose.Model<CustomerDocument>>('Customer', CustomerSchema);

const customer1 = new CustomerModel({
  _id: 1,
  name: 'customer one',
  createdDate: Date.now(),
});
customer1.save();

const service1 = new ServiceModel({
  product: 'S1',
  description: 'service one',
  customer: 1,
} as Service);
service1.save();

License

MIT