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

@idcargill/mongodb-connector

v3.0.4

Published

[NPM](https://www.npmjs.com/package/@idcargill/mongodb-connector)

Downloads

11

Readme

Mongodb Connector - App Wrapper

NPM

A simple MongoDB wrapper for CRUD operations in typescript.

Methods are wrapped async to simplify basic crud connections. Each manages a single collection.

Methods can accept type generics for return values with added MongoId.

Can also return the mongodb collection to run methods on for more complicated operations.

Usage

Build an object implementing the MongoDbConfigI interface.

import MongoDBConnector, { MongoDbConfigI } from 'mongodb-connector';

const config: MongoDbConfigI = {
  databaseName: 'MyDataBase',
  collectionName: 'spoons',
  connectionString: 'mongodb://localhost:27017/?serverSelectionTimeoutMS=2000',
};

// Create mongo connector instance
const spoons = new MongoDbConnector(config);

type GrapefruitSpoon = { sharpEdges: true };

const gfSpoon = await spoons.insertOne<GrapefruitSpoon>(payloadObj);
// gfSpoon has _id and sharp edges

CURD Methods

  • isMongoConnected() => boolean

  • insertOne(payload) => DatabaseDocument | null

  • findById(ObjectId | string) => DatabaseDocument | null

  • find(query, FindOptions) => DatabaseDocument[] | []

  • updateOne(ObjectId | string, payload) => DatabaseDocument | null

  • deleteOneItem(objectId | string) => DeleteResult

Mongo Collection for direct control

const db = mongo.getDb();

await db.connect();

await db.insertOne({});

await db.close();

Development

Start mongodb in docker:

yarn start:db

Example output

To experiment, modify src/playground.ts and run:

yarn play

Testing

Test are run against a docker mongo image.

Start the docker container:

yarn start:db

Run all tests w/ coverage:

yarn test

Run single file tests:

yarn test-file <file_name>

Stop Docker

yarn stop:db

Deploy changes to NPM

  • merge in changes to main branch
  • update local main

yarn pack

yarn publish

  • enter new version number
  • enter authentication