Skip to main content

documentStatusCache

Workspace API

Workspace API / services/documentStatusCache

services/documentStatusCache

Classes​

DocumentStatusCache​

Defined in: services/documentStatusCache.ts:37

Cache for document extraction status to reduce database load during polling of document processing status

Constructors​

Constructor​

new DocumentStatusCache(): DocumentStatusCache

Defined in: services/documentStatusCache.ts:45

Returns​

DocumentStatusCache

Methods​

get()​

get(documentId): CachedDocumentStatus | null

Defined in: services/documentStatusCache.ts:107

Get cached status for a document

Parameters​
documentId​

string

Returns​

CachedDocumentStatus | null

set()​

set(documentId, organizationId, status): void

Defined in: services/documentStatusCache.ts:126

Cache a document status

Parameters​
documentId​

string

organizationId​

string

status​

CachedDocumentStatus

Returns​

void

invalidate()​

invalidate(documentId): void

Defined in: services/documentStatusCache.ts:173

Invalidate (remove) a specific document from cache

Parameters​
documentId​

string

Returns​

void

clear()​

clear(): void

Defined in: services/documentStatusCache.ts:182

Clear all cached entries

Returns​

void

getStats()​

getStats(): object

Defined in: services/documentStatusCache.ts:215

Get cache statistics

Returns​

object

size​

size: number

maxSize​

maxSize: number

utilizationPercent​

utilizationPercent: number

valkeySubscribed​

valkeySubscribed: boolean

destroy()​

destroy(): void

Defined in: services/documentStatusCache.ts:228

Cleanup resources on shutdown

Returns​

void

Interfaces​

CachedDocumentStatus​

Defined in: services/documentStatusCache.ts:15

Properties​

extraction_status​

extraction_status: string

Defined in: services/documentStatusCache.ts:16

fast_extraction_status?​

optional fast_extraction_status: string

Defined in: services/documentStatusCache.ts:17

docling_extraction_status?​

optional docling_extraction_status: string

Defined in: services/documentStatusCache.ts:18

extraction_method?​

optional extraction_method: string

Defined in: services/documentStatusCache.ts:19

extraction_started_at?​

optional extraction_started_at: string

Defined in: services/documentStatusCache.ts:20

extraction_completed_at?​

optional extraction_completed_at: string

Defined in: services/documentStatusCache.ts:21

extraction_failed_at?​

optional extraction_failed_at: string

Defined in: services/documentStatusCache.ts:22

extraction_error?​

optional extraction_error: string

Defined in: services/documentStatusCache.ts:23

extraction_metadata?​

optional extraction_metadata: Record<string, unknown>

Defined in: services/documentStatusCache.ts:24

Functions​

getDocumentStatusCache()​

getDocumentStatusCache(): DocumentStatusCache

Defined in: services/documentStatusCache.ts:248

Get the singleton DocumentStatusCache instance

Returns​

DocumentStatusCache

destroyDocumentStatusCache()​

destroyDocumentStatusCache(): void

Defined in: services/documentStatusCache.ts:258

Destroy the cache instance (for testing or graceful shutdown)

Returns​

void