Class: MockNoSqlAdapter

Defined in: src/nosql/adapters/MockNoSqlAdapter.ts:23

In-memory NoSQL document database adapter for fast, zero-dependency unit tests.

Implements

• INoSqlAdapter

Constructors

Constructor

new MockNoSqlAdapter(): MockNoSqlAdapter

Returns

MockNoSqlAdapter

Methods

connect()

connect(): Promise<void>

Defined in: src/nosql/adapters/MockNoSqlAdapter.ts:29

Returns

Promise<void>

Implementation of

INoSqlAdapter.connect

---

disconnect()

disconnect(): Promise<void>

Defined in: src/nosql/adapters/MockNoSqlAdapter.ts:33

Returns

Promise<void>

Implementation of

INoSqlAdapter.disconnect

---

ping()

ping(): Promise<boolean>

Defined in: src/nosql/adapters/MockNoSqlAdapter.ts:37

Returns

Promise<boolean>

Implementation of

INoSqlAdapter.ping

---

clear()

clear(collection?): void

Defined in: src/nosql/adapters/MockNoSqlAdapter.ts:41

Parameters

Parameter	Type
collection?	string

Returns

void

---

getRawData()

getRawData(collection): any[]

Defined in: src/nosql/adapters/MockNoSqlAdapter.ts:49

Parameters

Parameter	Type
collection	string

Returns

any[]

---

getCollection()

getCollection<T>(name): T

Defined in: src/nosql/adapters/MockNoSqlAdapter.ts:53

Type Parameters

Type Parameter	Default type
T	any

Parameters

Parameter	Type
name	string

Returns

T

Implementation of

INoSqlAdapter.getCollection

---

insertOne()

insertOne<T>(collection, doc, _options?): Promise<InsertOneResult>

Defined in: src/nosql/adapters/MockNoSqlAdapter.ts:73

Type Parameters

Type Parameter	Default type
T	unknown

Parameters

Parameter	Type
collection	string
doc	T
_options?	InsertOptions

Returns

Promise<InsertOneResult>

Implementation of

INoSqlAdapter.insertOne

---

insertMany()

insertMany<T>(collection, docs, _options?): Promise<InsertManyResult>

Defined in: src/nosql/adapters/MockNoSqlAdapter.ts:90

Type Parameters

Type Parameter	Default type
T	unknown

Parameters

Parameter	Type
collection	string
docs	T[]
_options?	InsertOptions

Returns

Promise<InsertManyResult>

Implementation of

INoSqlAdapter.insertMany

---

find()

find<T>(collection, filter?, options?): Promise<T[]>

Defined in: src/nosql/adapters/MockNoSqlAdapter.ts:112

Type Parameters

Type Parameter	Default type
T	unknown

Parameters

Parameter	Type
collection	string
filter?	NoSqlFilter
options?	FindOptions

Returns

Promise<T[]>

Implementation of

INoSqlAdapter.find

---

findOne()

findOne<T>(collection, filter?, options?): Promise<T | null>

Defined in: src/nosql/adapters/MockNoSqlAdapter.ts:137

Type Parameters

Type Parameter	Default type
T	unknown

Parameters

Parameter	Type
collection	string
filter?	NoSqlFilter
options?	Omit<FindOptions, "limit">

Returns

Promise<T | null>

Implementation of

INoSqlAdapter.findOne

---

updateOne()

updateOne(collection, filter, update, options?): Promise<UpdateResult>

Defined in: src/nosql/adapters/MockNoSqlAdapter.ts:146

Parameters

Parameter	Type
collection	string
filter	NoSqlFilter
update	NoSqlUpdate
options?	UpdateOptions

Returns

Promise<UpdateResult>

Implementation of

INoSqlAdapter.updateOne

---

updateMany()

updateMany(collection, filter, update, options?): Promise<UpdateResult>

Defined in: src/nosql/adapters/MockNoSqlAdapter.ts:178

Parameters

Parameter	Type
collection	string
filter	NoSqlFilter
update	NoSqlUpdate
options?	UpdateOptions

Returns

Promise<UpdateResult>

Implementation of

INoSqlAdapter.updateMany

---

deleteOne()

deleteOne(collection, filter, _options?): Promise<DeleteResult>

Defined in: src/nosql/adapters/MockNoSqlAdapter.ts:203

Parameters

Parameter	Type
collection	string
filter	NoSqlFilter
_options?	DeleteOptions

Returns

Promise<DeleteResult>

Implementation of

INoSqlAdapter.deleteOne

---

deleteMany()

deleteMany(collection, filter, _options?): Promise<DeleteResult>

Defined in: src/nosql/adapters/MockNoSqlAdapter.ts:217

Parameters

Parameter	Type
collection	string
filter	NoSqlFilter
_options?	DeleteOptions

Returns

Promise<DeleteResult>

Implementation of

INoSqlAdapter.deleteMany

---

countDocuments()

countDocuments(collection, filter?, options?): Promise<number>

Defined in: src/nosql/adapters/MockNoSqlAdapter.ts:229

Parameters

Parameter	Type
collection	string
filter?	NoSqlFilter
options?	CountOptions

Returns

Promise<number>

Implementation of

INoSqlAdapter.countDocuments

---

aggregate()

aggregate<T>(collection, pipeline, _options?): Promise<T[]>

Defined in: src/nosql/adapters/MockNoSqlAdapter.ts:238

Type Parameters

Type Parameter	Default type
T	unknown

Parameters

Parameter	Type
collection	string
pipeline	AggregationStage[]
_options?	AggregateOptions

Returns

Promise<T[]>

Implementation of

INoSqlAdapter.aggregate

---

beginTransaction()

beginTransaction(): Promise<NoSqlTransaction>

Defined in: src/nosql/adapters/MockNoSqlAdapter.ts:356

Returns

Promise<NoSqlTransaction>

Implementation of

INoSqlAdapter.beginTransaction

---

createIndex()

createIndex(_collection, keys, options?): Promise<string>

Defined in: src/nosql/adapters/MockNoSqlAdapter.ts:375

Parameters

Parameter	Type
_collection	string
keys	Record<string, 1 | -1 | "text" | "2dsphere" | string>
options?	{ unique?: boolean; name?: string; background?: boolean; ttl?: number; }
options.unique?	boolean
options.name?	string
options.background?	boolean
options.ttl?	number

Returns

Promise<string>

Implementation of

INoSqlAdapter.createIndex

---

executeStream()

executeStream<T>(collection, filter?, options?): AsyncIterable<T>

Defined in: src/nosql/adapters/MockNoSqlAdapter.ts:383

Type Parameters

Type Parameter	Default type
T	unknown

Parameters

Parameter	Type
collection	string
filter?	NoSqlFilter
options?	FindOptions

Returns

AsyncIterable<T>

Implementation of

INoSqlAdapter.executeStream

Properties

provider

readonly provider: NoSqlProvider = 'mock'

Defined in: src/nosql/adapters/MockNoSqlAdapter.ts:24

Implementation of

INoSqlAdapter.provider

---

connected

connected: boolean = false

Defined in: src/nosql/adapters/MockNoSqlAdapter.ts:25