c8oalldocslocal.md

c8osdkjscore › C8oAlldocsLocal

Class: C8oAlldocsLocal

Hierarchy

• C8oAlldocsLocal

Index

Constructors

• constructor

Properties

• ATTACH_STORE
• DB_VERSION
• LOCAL_STORE
• c8o

Methods

• allDocsKeys
• allDocsKeysParse
• alldocs
• createKeyRange
• decodeMetadata
• doOpenBase
• getAll
• idbAllDocs
• isRemote
• openBase
• openTransactionSafely
• restaureDb
• runBatchedCursor

Constructors

constructor

+ new C8oAlldocsLocal(c8o: C8oCore): C8oAlldocsLocal

Defined in c8osdk-js-core/src/c8o/c8oAlldocsLocal.ts:3

Parameters:

Name	Type
c8o	C8oCore

Returns: C8oAlldocsLocal

Properties

Private ATTACH_STORE

• ATTACH_STORE: string = "attach-store"

Defined in c8osdk-js-core/src/c8o/c8oAlldocsLocal.ts:9

---

Private DB_VERSION

• DB_VERSION: number = 5

Defined in c8osdk-js-core/src/c8o/c8oAlldocsLocal.ts:7

---

Private LOCAL_STORE

• LOCAL_STORE: string = "local-store"

Defined in c8osdk-js-core/src/c8o/c8oAlldocsLocal.ts:8

---

Private c8o

• c8o: C8oCore

Defined in c8osdk-js-core/src/c8o/c8oAlldocsLocal.ts:5

Methods

Private allDocsKeys

▸ allDocsKeys(keys: any, docStore: any, onBatch: any): void

Defined in c8osdk-js-core/src/c8o/c8oAlldocsLocal.ts:371

Parameters:

Name	Type
keys	any
docStore	any
onBatch	any

Returns: void

---

Private allDocsKeysParse

▸ allDocsKeysParse(opts: any): void

Defined in c8osdk-js-core/src/c8o/c8oAlldocsLocal.ts:425

Parameters:

Name	Type
opts	any

Returns: void

---

alldocs

▸ alldocs(opts: any, db: any): Promise‹any›

Defined in c8osdk-js-core/src/c8o/c8oAlldocsLocal.ts:11

Parameters:

Name	Type
opts	any
db	any

Returns: Promise‹any›

---

Private createKeyRange

▸ createKeyRange(start: any, end: any, inclusiveEnd: any, key: any, descending: any): IDBKeyRange | object

Defined in c8osdk-js-core/src/c8o/c8oAlldocsLocal.ts:438

Parameters:

Name	Type
start	any
end	any
inclusiveEnd	any
key	any
descending	any

Returns: IDBKeyRange | object

---

Private decodeMetadata

▸ decodeMetadata(storedObject: any): object

Defined in c8osdk-js-core/src/c8o/c8oAlldocsLocal.ts:391

Parameters:

Name	Type
storedObject	any

Returns: object

---

Private doOpenBase

▸ doOpenBase(DB_NAME: any, resolve: any, reject: any): void

Defined in c8osdk-js-core/src/c8o/c8oAlldocsLocal.ts:70

Parameters:

Name	Type	Default
DB_NAME	any	-
resolve	any	null
reject	any	null

Returns: void

---

Private getAll

▸ getAll(objectStore: any, keyRange: any, onSuccess: any): void

Defined in c8osdk-js-core/src/c8o/c8oAlldocsLocal.ts:345

Parameters:

Name	Type
objectStore	any
keyRange	any
onSuccess	any

Returns: void

---

Private idbAllDocs

▸ idbAllDocs(opts: any, callback: any, DB_NAME: any): Promise‹any›

Defined in c8osdk-js-core/src/c8o/c8oAlldocsLocal.ts:127

Parameters:

Name	Type
opts	any
callback	any
DB_NAME	any

Returns: Promise‹any›

---

Private isRemote

▸ isRemote(db: any): any

Defined in c8osdk-js-core/src/c8o/c8oAlldocsLocal.ts:413

Parameters:

Name	Type
db	any

Returns: any

---

Private openBase

▸ openBase(DB_NAME: any, resolve: any, reject: any): Promise‹unknown›

Defined in c8osdk-js-core/src/c8o/c8oAlldocsLocal.ts:61

Parameters:

Name	Type	Default
DB_NAME	any	-
resolve	any	null
reject	any	null

Returns: Promise‹unknown›

---

Private openTransactionSafely

▸ openTransactionSafely(idb: any, stores: any, mode: any): object | object

Defined in c8osdk-js-core/src/c8o/c8oAlldocsLocal.ts:401

Parameters:

Name	Type
idb	any
stores	any
mode	any

Returns: object | object

---

Private restaureDb

▸ restaureDb(DB_NAME: any): Promise‹unknown›

Defined in c8osdk-js-core/src/c8o/c8oAlldocsLocal.ts:97

Parameters:

Name	Type
DB_NAME	any

Returns: Promise‹unknown›

---

Private runBatchedCursor

▸ runBatchedCursor(objectStore: any, keyRange: any, descending: any, batchSize: any, onBatch: any): void

Defined in c8osdk-js-core/src/c8o/c8oAlldocsLocal.ts:266

Parameters:

Name	Type
objectStore	any
keyRange	any
descending	any
batchSize	any
onBatch	any

Returns: void