# electronade-mongodbclient-util

> It's a package that provides some utilities for electronade-mongodbclient.

Latest version **0.1.0** (published 2022-10-13) · MIT license · 0 weekly downloads

## Install

```sh
npm install electronade-mongodbclient-util
pnpm add electronade-mongodbclient-util
yarn add electronade-mongodbclient-util
bun add electronade-mongodbclient-util
```

## Health

**Score 30/100 (F)** — status: abandoned.

Positive: has types; esm support; no vulnerabilities; high quality score.

Warnings: low downloads; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.0 |
| Published | 2022-10-13 |
| First published | 2022-10-13 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 0 |
| Unpacked size | 10.6 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | tom |
| Maintainers | tomsd |
| Keywords | electronade |

## Links

- npm: https://www.npmjs.com/package/electronade-mongodbclient-util
- Repository: https://github.com/tomsdoo/electronade-mongodbclient-util
- Homepage: https://github.com/tomsdoo/electronade-mongodbclient-util#readme
- Issues: https://github.com/tomsdoo/electronade-mongodbclient-util/issues
- npm.io page: https://npm.io/package/electronade-mongodbclient-util

## Recent versions

- 0.1.0 (latest) — 2022-10-13

## README

# electronade-mongodbclient-util

It's a package that provides some utilities for `electronade-mongodbclient`.

It's an optional module for `electronade-mongodbclient` so `electronade-mongodbclient` should be installed before using `electronade-mongodbclient-util`.

See [electronade-mongodbclient-util.netlify.app](https://electronade-mongodbclient-util.netlify.app/) for details.

![npm](https://img.shields.io/npm/v/electronade-mongodbclient-util)
![NPM](https://img.shields.io/npm/l/electronade-mongodbclient-util)
![npms.io (quality)](https://img.shields.io/npms-io/quality-score/electronade-mongodbclient-util)
![Libraries.io dependency status for latest release](https://img.shields.io/librariesio/release/npm/electronade-mongodbclient-util)
![Maintenance](https://img.shields.io/maintenance/yes/2022)

## Installation
``` shell
npm install electronade-mongodbclient-util
```

## Interfaces

``` typescript
class MongoDbClient {
  constructor(uri: string, db: string, collection: string, exposedName?: string);
  public insertMany(items: object[]) => Promise<any>;
  public read(condition?: any) => Promise<any[]>;
  public upsert(item: object) => Promise<any>;
  public remove(condition: any) => Promise<any>;
  public count(condition?: any) => Promise<number>;
  public distinct(key: string, condition?: any) => Promise<any>;
}
```

## Usage

import and use MongoDbClient class in Renderer process.

``` typescript
import { MongoDbClient } from "electronade-mongodbclient-util";

const client = new MongoDbClient(
  "mongodb://...",
  "db",
  "collection"
);


console.log(
  await client.insertMany([
    { name: "test1" },
    { name: "test2" }
  ])
  .then(({ insertedCount }) => insertedCount)
); // 2

console.log(
  await client.distinct("name")
); // ["test1", "test2"]

console.log(
  await client.read({ name: "test1" })
    .then(({ name }) => name)
); // "test1"

console.log(
  await client.remove({ name: "test1" })
    .then(({ deletedCount }) => deletedCount)
); // 1
```

---
_Source: https://npm.io/package/electronade-mongodbclient-util · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._