@xylabs/mongo

@xylabs/mongo

Base functionality used throughout XYO TypeScript/JavaScript libraries that access Mongo DB

Reference

@xylabs/mongo

Classes

• BaseMongoSdk
• MongoClientWrapper

Interfaces

• BaseMongoSdkPublicConfig
• BaseMongoSdkPrivateConfig

Type Aliases

• BaseMongoSdkConfig

classes

BaseMongoSdk

@xylabs/mongo

Type Parameters

T

T extends Document

Constructors

Constructor

new BaseMongoSdk<T>(config): BaseMongoSdk<T>;

Parameters

config

BaseMongoSdkConfig

Returns

BaseMongoSdk<T>

Properties

config

config: BaseMongoSdkConfig;

Accessors

uri

Get Signature

get uri(): string;

Returns

string

Methods

deleteMany()

deleteMany(filter): Promise<DeleteResult>;

Parameters

filter

Filter<T>

Returns

Promise<DeleteResult>

deleteOne()

deleteOne(filter): Promise<DeleteResult>;

Parameters

filter

Filter<T>

Returns

Promise<DeleteResult>

find()

find(filter): Promise<FindCursor<WithId<T>>>;

Parameters

filter

Filter<T>

Returns

Promise<FindCursor<WithId<T>>>

findOne()

findOne(filter): Promise<null | WithId<T>>;

Parameters

filter

Filter<T>

Returns

Promise<null | WithId<T>>

insertMany()

insertMany(items, options?): Promise<InsertManyResult<T>>;

Parameters

items

OptionalUnlessRequiredId<T>[]

options?

BulkWriteOptions

Returns

Promise<InsertManyResult<T>>

insertOne()

insertOne(item, options?): Promise<InsertOneResult<T>>;

Parameters

item

OptionalUnlessRequiredId<T>

options?

InsertOneOptions

Returns

Promise<InsertOneResult<T>>

replaceOne()

replaceOne(
   filter, 
   item, 
options?): Promise<UpdateResult<T>>;

Parameters

filter

Filter<T>

item

OptionalUnlessRequiredId<T>

options?

ReplaceOptions

Returns

Promise<UpdateResult<T>>

updateOne()

updateOne(filter, fields): Promise<UpdateResult<T>>;

Parameters

filter

Filter<T>

fields

UpdateFilter<T>

Returns

Promise<UpdateResult<T>>

upsertOne()

upsertOne(filter, fields): Promise<UpdateResult<T>>;

Parameters

filter

Filter<T>

fields

UpdateFilter<T>

Returns

Promise<UpdateResult<T>>

useCollection()

useCollection<R>(func): Promise<R>;

Type Parameters

R

R

Parameters

func

(collection) => R | Promise<R>

Returns

Promise<R>

useMongo()

useMongo<R>(func): Promise<R>;

Type Parameters

R

R

Parameters

func

(client) => R | Promise<R>

Returns

Promise<R>

MongoClientWrapper

@xylabs/mongo

Constructors

Constructor

new MongoClientWrapper(
   uri, 
   maxPoolSize?, 
   closeDelay?): MongoClientWrapper;

Parameters

uri

string

maxPoolSize?

number

closeDelay?

number

Returns

MongoClientWrapper

Properties

clients

readonly static clients: Map<string, MongoClientWrapper>;

Methods

get()

static get(
   uri, 
   poolSize?, 
   closeDelay?): MongoClientWrapper;

Parameters

uri

string

poolSize?

number

closeDelay?

number

Returns

MongoClientWrapper

connect()

connect(): Promise<MongoClient>;

Returns

Promise<MongoClient>

disconnect()

disconnect(): Promise<number>;

Returns

Promise<number>

initiateClose()

initiateClose(): Promise<void>;

Returns

Promise<void>

interfaces

BaseMongoSdkPrivateConfig

@xylabs/mongo

Properties

dbConnectionString?

optional dbConnectionString: string;

dbDomain?

optional dbDomain: string;

dbName?

optional dbName: string;

dbPassword?

optional dbPassword: string;

dbUserName?

optional dbUserName: string;

BaseMongoSdkPublicConfig

@xylabs/mongo

Properties

closeDelay?

optional closeDelay: number;

collection

collection: string;

maxPoolSize?

optional maxPoolSize: number;

type-aliases

BaseMongoSdkConfig

@xylabs/mongo

type BaseMongoSdkConfig = BaseMongoSdkPublicConfig & BaseMongoSdkPrivateConfig;

Part of sdk-js

Maintainers

• Arie Trouw (arietrouw.com)
• Matt Jones
• Joel Carter
• Jordan Trouw

License

See the LICENSE file for license details

Credits

Made with 🔥 and ❄️ by XYLabs