Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/swimlane/mongtype
🚀 MongoDB Repository Pattern for Node written in TypeScript
https://github.com/swimlane/mongtype
hacktoberfest mongo mongodb nodejs typescript
Last synced: 8 days ago
JSON representation
🚀 MongoDB Repository Pattern for Node written in TypeScript
- Host: GitHub
- URL: https://github.com/swimlane/mongtype
- Owner: swimlane
- License: mit
- Created: 2017-04-13T18:23:52.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2023-04-18T09:55:19.000Z (over 1 year ago)
- Last Synced: 2024-04-14T20:06:40.548Z (7 months ago)
- Topics: hacktoberfest, mongo, mongodb, nodejs, typescript
- Language: TypeScript
- Homepage:
- Size: 1.18 MB
- Stars: 65
- Watchers: 31
- Forks: 10
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# MongType
[](https://www.codacy.com/app/Swimlane/mongtype?utm_source=github.com&utm_medium=referral&utm_content=swimlane/mongtype&utm_campaign=Badge_Grade) [](https://www.codacy.com/app/Swimlane/mongtype?utm_source=github.com&utm_medium=referral&utm_content=swimlane/mongtype&utm_campaign=Badge_Coverage) [](https://travis-ci.org/swimlane/mongtype) [](https://badge.fury.io/js/mongtype)
MongoDB Repository pattern for NodeJS written in TypeScript.
## Install
`npm i mongtype --S`
## Building
`npm run build`
## Usage
[Migrating from 2.X to 3.X](UPGRADE.md)
[Migrating from 1.X to 2.X](UPGRADE.md)
### DatabaseClient
The `DatabaseClient` class provides a wrapper around a mongodb connection
It has a single method called `connect` that allows you to provide a uri to a MongoDB instance and optionally include an already established `MongoClient`.
```typescript
import { DatabaseClient } from 'mongtype';
const uri = 'mongodb://localhost/Foo';
const dbc = new DatabaseClient();
// DatabaseClient manages the connection
dbc.connect(uri);
// DatabaseClient reuses an existing connection
dbc.connect(uri, mongoClient);
```
### Using DI
```javascript
import { MongoRepository, Collection, Pre, Post } from 'mongtype';
import { Injectable } from 'injection-js';
interface User {
name: string;
}
@Injectable()
@Collection({
name: 'user',
capped: true,
size: 10000
})
export class UserRepository extends MongoRepository {
@Before('save')
doSomethingBeforeSave() {}
@After('save')
doSomethingAfterSave() { }
}
@Injectable()
export class App {
constructor(private userRepo: UserRepository) { }
async findUsers() {
const one = await this.userRepo.findById('3434-34-34343-3434');
const many = await this.userRepo.find({ conditions: { name: 'foo' } });
const newOne = await this.userRepo.create({ foo: true });
const updated = await this.userRepo.save(newOne);
}
}
```
### Without DI
```javascript
const dbc = new DatabaseClient();
dbc.connect('mongodb://your.mongo.url'); // optional existing connection as second arg
const svc = new UserRepository(dbc);
const one = await svc.findById('3434-34-34343-3434');
const many = await svc.find({ conditions: { name: 'foo' } });
const newOne = await svc.create({ foo: true });
const updated = await svc.save(newOne);
```
## Similar
- [ts-mongo](https://github.com/joesonw/ts-mongo/)
## Credits
MongType is a [Swimlane](http://swimlane.com) open-source project; we believe in giving back to the open-source community by sharing some of the projects we build for our application. Swimlane is an automated cyber security operations and incident response platform that enables cyber security teams to leverage threat intelligence, speed up incident response and automate security operations.