Class: ClientStack

Defined in: packages/client/src/core/index.ts:63

Extends

• Stack

Properties

appVersion

appVersion: string = "0.0.1"

Defined in: packages/client/src/core/index.ts:72

Overrides

Stack.appVersion

---

cache

cache: object

Defined in: packages/client/src/core/index.ts:74

Index Signature

[className: string]: CachedClass

Overrides

Stack.cache

---

connection

connection: string

Defined in: packages/client/src/core/index.ts:70

Overrides

Stack.connection

---

db

db: Database<{ }>

Defined in: packages/client/src/core/index.ts:65

Overrides

Stack.db

---

lastDocId

lastDocId: number

Defined in: packages/client/src/core/index.ts:68

Overrides

Stack.lastDocId

---

listeners

listeners: Changes<{ }>[] = []

Defined in: packages/client/src/core/index.ts:79

Overrides

Stack.listeners

---

modelWorker

modelWorker: null | Worker = null

Defined in: packages/client/src/core/index.ts:81

Overrides

Stack.modelWorker

---

name

name: string

Defined in: packages/client/src/core/index.ts:66

Overrides

Stack.name

---

options?

optional options: StackOptions

Defined in: packages/client/src/core/index.ts:71

Overrides

Stack.options

---

patchCount

patchCount: number

Defined in: packages/client/src/core/index.ts:77

Overrides

Stack.patchCount

---

patches

patches: Patch[] = []

Defined in: packages/client/src/core/index.ts:83

Overrides

Stack.patches

---

schemaVersion

schemaVersion: undefined | string

Defined in: packages/client/src/core/index.ts:82

Overrides

Stack.schemaVersion

Methods

addClass()

addClass(classObj): Promise<ClassModel>

Defined in: packages/client/src/core/index.ts:724

Parameters

classObj

Class

Returns

Promise<ClassModel>

Overrides

Stack.addClass

---

addClassLock()

addClassLock(className): Promise<boolean>

Defined in: packages/client/src/core/index.ts:407

Parameters

className

string

Returns

Promise<boolean>

Overrides

Stack.addClassLock

---

addDesignDocumentPKs()

addDesignDocumentPKs(className, pKs, temp): Promise<string>

Defined in: packages/client/src/core/index.ts:765

Parameters

className

string

pKs

string[]

temp

boolean = false

Returns

Promise<string>

Overrides

Stack.addDesignDocumentPKs

---

addEventListener()

addEventListener(type, callback, options?): void

Defined in: node_modules/typescript/lib/lib.dom.d.ts:11569

The addEventListener() method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.

MDN Reference

Parameters

type

string

callback

null | EventListenerOrEventListenerObject

options?

boolean | AddEventListenerOptions

Returns

void

Inherited from

Stack.addEventListener

---

checkSystem()

checkSystem(): Promise<void>

Defined in: packages/client/src/core/index.ts:258

Returns

Promise<void>

---

clearClassLock()

clearClassLock(className): Promise<boolean>

Defined in: packages/client/src/core/index.ts:428

Parameters

className

string

Returns

Promise<boolean>

Overrides

Stack.clearClassLock

---

close()

close(): void

Defined in: packages/client/src/core/index.ts:465

Returns

void

Overrides

Stack.close

---

createDoc()

createDoc(docId, type, classObj, params): Promise<null | Document>

Defined in: packages/client/src/core/index.ts:1037

Parameters

docId

null | string

type

string

classObj

Class

params

Returns

Promise<null | Document>

Overrides

Stack.createDoc

---

deleteDocument()

deleteDocument(_id): Promise<boolean>

Defined in: packages/client/src/core/index.ts:1127

Sets the active param of a document to false

Parameters

_id

string

Returns

Promise<boolean>

Promise

Overrides

Stack.deleteDocument

---

destroyDb()

destroyDb(): Promise<undefined | false>

Defined in: packages/client/src/core/index.ts:693

Returns

Promise<undefined | false>

---

dispatchEvent()

dispatchEvent(event): boolean

Defined in: node_modules/typescript/lib/lib.dom.d.ts:11575

The dispatchEvent() method of the EventTarget sends an Event to the object, (synchronously) invoking the affected event listeners in the appropriate order.

MDN Reference

Parameters

event

Event

Returns

boolean

Inherited from

Stack.dispatchEvent

---

dump()

dump(): Promise<AllDocsResponse<{ }>>

Defined in: packages/client/src/core/index.ts:136

Returns

Promise<AllDocsResponse<{ }>>

Overrides

Stack.dump

---

findDocument()

findDocument(selector, fields, skip, limit): Promise<null | Document>

Defined in: packages/client/src/core/index.ts:589

Parameters

selector

any

fields

undefined = undefined

skip

undefined = undefined

limit

undefined = undefined

Returns

Promise<null | Document>

---

findDocuments()

findDocuments(selector, fields?, skip?, limit?): Promise<{[key: string]: any; docs: Document[]; }>

Defined in: packages/client/src/core/index.ts:545

Parameters

selector

fields?

string[]

skip?

number

limit?

number

Returns

Promise<{[key: string]: any; docs: Document[]; }>

Overrides

Stack.findDocuments

---

getAllClasses()

getAllClasses(): Promise<Class[]>

Defined in: packages/client/src/core/index.ts:627

Returns

Promise<Class[]>

---

getAllClassModels()

getAllClassModels(): Promise<ClassModel[]>

Defined in: packages/client/src/core/index.ts:642

Returns

Promise<ClassModel[]>

---

getClass()

getClass(className, fresh): Promise<null | Class>

Defined in: packages/client/src/core/index.ts:471

Parameters

className

string

fresh

boolean = false

Returns

Promise<null | Class>

Overrides

Stack.getClass

---

getClassModel()

getClassModel(className): Promise<null | ClassModel>

Defined in: packages/client/src/core/index.ts:595

Parameters

className

string

Returns

Promise<null | ClassModel>

Overrides

Stack.getClassModel

---

getClassModels()

getClassModels(classNames): Promise<ClassModel[]>

Defined in: packages/client/src/core/index.ts:653

Parameters

classNames

string[]

Returns

Promise<ClassModel[]>

---

getDb()

getDb(): Database<{ }>

Defined in: packages/client/src/core/index.ts:124

Returns

Database<{ }>

---

getDbInfo()

getDbInfo(): Promise<DatabaseInfo>

Defined in: packages/client/src/core/index.ts:128

Returns

Promise<DatabaseInfo>

---

getDbName()

getDbName(): string

Defined in: packages/client/src/core/index.ts:132

Returns

string

---

getDocRevision()

getDocRevision(docId): Promise<null | string>

Defined in: packages/client/src/core/index.ts:532

Parameters

docId

string

Returns

Promise<null | string>

---

getDocument()

getDocument(docId): Promise<null | ExistingDocument<{ }>>

Defined in: packages/client/src/core/index.ts:517

Parameters

docId

string

Returns

Promise<null | ExistingDocument<{ }>>

---

getLastDocId()

getLastDocId(): Promise<number>

Defined in: packages/client/src/core/index.ts:149

Returns

Promise<number>

---

getSystem()

getSystem(): Promise<null | SystemDoc>

Defined in: packages/client/src/core/index.ts:164

Returns

Promise<null | SystemDoc>

---

incrementLastDocId()

incrementLastDocId(): Promise<undefined | number>

Defined in: packages/client/src/core/index.ts:664

Returns

Promise<undefined | number>

---

initdb()

initdb(): Promise<ClientStack>

Defined in: packages/client/src/core/index.ts:458

Returns

Promise<ClientStack>

---

initIndex()

initIndex(): Promise<void>

Defined in: packages/client/src/core/index.ts:488

Returns

Promise<void>

---

onClassDoc()

onClassDoc(className): Changes<{ }>

Defined in: packages/client/src/core/index.ts:442

Parameters

className

string

Returns

Changes<{ }>

Overrides

Stack.onClassDoc

---

onClassLock()

onClassLock(className): Changes<{ }>

Defined in: packages/client/src/core/index.ts:394

Parameters

className

string

Returns

Changes<{ }>

Overrides

Stack.onClassLock

---

onClassModelChanges()

onClassModelChanges(): Changes<{ }>

Defined in: packages/client/src/core/index.ts:367

Returns

Changes<{ }>

PouchDB.Core.Changes<{}>

---

onClassModelPropagationComplete()

onClassModelPropagationComplete(event): void

Defined in: packages/client/src/core/index.ts:354

Parameters

event

CustomEvent<ClassModelPropagationComplete>

Returns

void

Description

When a class model propagation comes to completion remove the corresponding ~lock from the database

---

onClassModelPropagationStart()

onClassModelPropagationStart(event): void

Defined in: packages/client/src/core/index.ts:339

Parameters

event

CustomEvent<ClassModelPropagationStart>

Returns

void

Description

When a class model propagation starts write the ~lock document to the database. It prevents any further modifications on the class data model

Overrides

Stack.onClassModelPropagationStart

---

prepareDoc()

prepareDoc(_id, type, params): object

Defined in: packages/client/src/core/index.ts:1027

Parameters

_id

string

type

string

params

Returns

object

---

removeAllListeners()

removeAllListeners(): void

Defined in: packages/client/src/core/index.ts:328

Returns

void

Description

Clears all listeners from the Stack

Overrides

Stack.removeAllListeners

---

removeEventListener()

removeEventListener(type, callback, options?): void

Defined in: node_modules/typescript/lib/lib.dom.d.ts:11581

The removeEventListener() method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.

MDN Reference

Parameters

type

string

callback

null | EventListenerOrEventListenerObject

options?

boolean | EventListenerOptions

Returns

void

Inherited from

Stack.removeEventListener

---

reset()

reset(): Promise<ClientStack>

Defined in: packages/client/src/core/index.ts:682

Returns

Promise<ClientStack>

---

setListeners()

setListeners(): void

Defined in: packages/client/src/core/index.ts:296

Returns

void

Overrides

Stack.setListeners

---

updateClass()

updateClass(classObj): Promise<null | Document>

Defined in: packages/client/src/core/index.ts:758

Parameters

classObj

Class

Returns

Promise<null | Document>

Overrides

Stack.updateClass

---

validateObject()

validateObject(obj, type, schema): Promise<boolean>

Defined in: packages/client/src/core/index.ts:827

Parameters

obj

any

type

string

schema

Returns

Promise<boolean>

---

validateObjectByType()

validateObjectByType(obj, type, schema?): Promise<boolean>

Defined in: packages/client/src/core/index.ts:1000

Parameters

obj

any

type

string

schema?

Returns

Promise<boolean>

Overrides

Stack.validateObjectByType

---

clear()

static clear(conn): Promise<unknown>

Defined in: packages/client/src/core/index.ts:709

Parameters

conn

string

Returns

Promise<unknown>

---

create()

static create(conn, options?): Promise<ClientStack>

Defined in: packages/client/src/core/index.ts:142

Parameters

conn

string

options?

StackOptions

Returns

Promise<ClientStack>