Giter VIP home page Giter VIP logo

typescript-mongodb's Introduction

typescript-mongodb

Simple API layer for MongoDB with TypeScript support.

This is a work in progress.

Usage

Client

import { Client } from "typescript-mongodb"

type Config = {
  'my-db': ['collection1', 'collection2']
}

const client = new Client<Config>({
  uri,
})

const ref = client.ref('my-db.collection1') // typesafe

Model

const PersonModel = client.model(
  "my-db.collection1",
  type.object({
    name: type.string,
    age: type.number,
    pets: type.array(type.objectId).optional(),
    favorite: type.objectId.optional(),
  }),
  {
    refs: {
      pets: "collection2",
      favorite: "collection2",
    },
  },
)

const person = await PersonModel.findById(personId)
//  typed as:
//  {
//    name: string;
//    age: number;
//    pets: ObjectId[] | undefined;
//    favorite: ObjectId | undefined;
//    _id: ObjectId;
//  } | undefined

const populated = await PersonModel.findById(personId, { populate: { pets: true, },})
//  typed as:
//  {
//    name: string;
//    age: number;
//    pets: unknown;
//    favorite: ObjectId | undefined;
//    _id: ObjectId;
//  } | undefined

const persons = await PersonModel.find(...)
//  typed as:
//  {
//    name: string;
//    age: number;
//    pets: ObjectId[] | undefined;
//    favorite: ObjectId | undefined;
//    _id: ObjectId;
//  }[]

typescript-mongodb's People

Contributors

chlouzada avatar

Watchers

 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.