Giter VIP home page Giter VIP logo

angular2-minimongo's Introduction

angular2-minimongo

Build Status

Use minimongo in your Angular 2 app. This package exposes the minimongo library as an Angular2 module with providers.

How to install:

$ npm install --save angular2-minimongo

How to use:

Import the Minimongo module in your bootstrap module:

import { MinimongoModule } from 'angular2-minimongo';

@NgModule({
    imports: [
        MinimongoModule.forRoot({ namespace: '#your-database-namespace' }),
    ]
})
export class AppModule { }

Import and use the Minimongo service:

import { MinimongoService } from 'angular2-minimongo';

@Injectable()
export class TaskService {
  tasksCollection = this.minimongo.getCollection<Task>('tasks');

  constructor(private minimongo: MinimongoService) {

  }
}

Usage: the collection interface

/*
Types are the best documentation.
Collections provided by the Minimongo service implement the ObservableCollection interface.
Parameters named selector and docs are standard mongo selectors.
*/
export interface ObservableCollection<T> {
    findOne(id: string): Observable<T>;
    findOne(selector: any, options?: any): Observable<T>;
    find(selector?: any, options?: any): Observable<T[]>;
    upsert(doc: T): Observable<T>;
    upsert(docs: T[]): Observable<T[]>;
    remove(id: string): Observable<void>;
}

How to build and test:

Project is based on the angular-cli. To run tests on this package just run:

ng test

Roadmap:

  • Implement additional and more robust collection methods

angular2-minimongo's People

Contributors

s-soltys avatar

Watchers

James Cloos avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.