Skip to content

Latest commit

 

History

History
202 lines (126 loc) · 5.94 KB

README.md

File metadata and controls

202 lines (126 loc) · 5.94 KB
Raw

Typegoose Automatic Increment

Build Status codecov.io npm

Automaticly Increment properties

Basic Usage

Simple

(mongoose)

const schema = new mongoose.Schema({
  somefield: Number
});
schema.plugin(AutoIncrementSimple, [{ field: 'somefield' }]);
const model = mongoose.model('SomeModel', schema);

const doc = await model.create({ somefield: 10 });

await doc.save(); // somefield will be 11

(typegoose)

@plugin(AutoIncrementSimple, [{ field: "someIncrementedField" }])
class SomeClass {
  @prop() // does not need to be empty
  public someIncrementedField: number;
}

const SomeModel = getModelForClass(SomeClass);

const doc = await SomeModel.create({ someIncrementedField: 10 });

await doc.save(); // someIncrementedField will be 11

For Identification

(mongoose)

const schema = new mongoose.Schema({
  _id: Number,
  somefield: Number
});
schema.plugin(AutoIncrementID, {});
const model = mongoose.model('SomeModel', schema);

const doc = await model.create({ somefield: 10 }); // _id will be 1

(typegoose)

@plugin(AutoIncrementID, {})
class SomeClass {
  @prop()
  public _id: number;

  @prop() // does not need to be empty
  public someIncrementedField: number;
}

const SomeModel = getModelForClass(SomeClass);

const doc = await SomeModel.create({ someIncrementedField: 10 }); // _id will be 1

Motivation

I started @typegoose/auto-increment because mongoose-auto-increment and mongoose-auto-increment-reworked are archived and didnt get any update for at least 2 years, and there were many issues about them in typegoose so i thought it will be easy to make an up-to-date automatic incrementing plugin.

Requirements

  • Node 16.20.1+
  • TypeScript 5.3+ (older versions could work, but are not tested)
  • mongoose 8.8.0+

Install

npm i -s @typegoose/auto-increment

You also need to install mongoose, because this plugin is made for mongoose.

Testing

npm run test / npm run test:watch

Versioning

Major.Minor.Fix (or how npm expresses it Major.Minor.Patch)
(This Project should comply with Semver)

Join Our Discord Server

To ask questions or just talk with us join our Discord Server

Documentation

AutoIncrementSimple - Options

The options can either be an object or an array of objects (single field / multiple fields).

Note: This function will only increment if the document is not new, this is to apply the default value.

field

string

This option is always required to get which field to increment.

incrementBy

number default 1

This option is optional, default is to increment by 1.

AutoIncrementID - Options

The options can only be one single object.

This plugin variant uses a model and a collection to store tracking(/counter) infomation to keep track of the ID in case the latest one gets deleted.

Note: the model used to keep track of the counter, will use the connection that the assigned schema uses.
Note: when the model is completly new, the first document will be "1", see here as on why.

if the hook should be skipped, use AutoIncrementIDSkipSymbol:

const doc = new Model();

doc[AutoIncrementIDSkipSymbol] = true;
await doc.save();

// the symbol can also be set on the connection
Model.db[AutoIncrementIDSkipSymbol] = true;
await Model.create({ _id: something });
// dont forget to unset it again
Model.db[AutoIncrementIDSkipSymbol] = true;
// or
delete Model.db[AutoIncrementIDSkipSymbol];

Note: AutoIncrementIDSkipSymbol can also be set inside hooks, but hooks might be called before others.
Note: AutoIncrementIDSkipSymbol cannot be used for .create (unless set via connection), because AutoIncrementIDSkipSymbol works on the current document and .create({ [AutoIncrementIDSkipSymbol]: true }) will not transfer symbols to the document.
Note: if AutoIncrementIDSkipSymbol is set to false on either method, no modification will be done

incrementBy

number default 1

This option is optional, default is to increment by 1.

field

string

This option is optional, defaults to _id.

trackerCollection

string

Set the Collection the tracker-model should use to store tracking infomation (/ to store the tracking documents).

This option is optional, defaults to identitycounters.

trackerModelName

string

Set the tracker-model's name (sets the model-name of the tracker model like mongoose.model(NameHere, ...)).

This option is optional, defaults to identitycounter.

startAt

number default 0

Set the starting number of the counter. (the first document will be this number)

overwriteModelName

string default's to the documents's model-name
(modelName: string, model: Model) => string

Overwrite the used value for the modelName property on the tracker-document, this can be used when wanting to use the same tracker document across different models.
If the value is falsy, then it will default to the modelName.
Can also be used as a function to generate a name to use based on modelName or the model itself, needs to return a non-empty string, when wanting to default back to default behavior just return the parameter modelName.

Notes

  • Please dont add comments with +1 or something like that, use the Reactions
  • npm run doc generates all documentation for all files that can be used as modules (is used for github-pages)
  • npm run doc:all generates documentation even for internal modules