Archivist | mage
Hierarchy
- Archivist
Index
Methods
add
- add<T>(topicName: string, index: IArchivistIndex, data: T, mediaType?: ArchivistMediaType, encoding?: ArchivistEncoding, expirationTime?: number): void
-
Type parameters
-
T
Parameters
-
topicName: string
-
index: IArchivistIndex
-
data: T
-
Optional mediaType: ArchivistMediaType
-
Optional encoding: ArchivistEncoding
-
Optional expirationTime: number
Returns void
-
clearCache
- clear
Cache(): void
-
Returns void
del
- del(topicName: string, index: IArchivistIndex): void
-
Parameters
-
topicName: string
-
index: IArchivistIndex
Returns void
-
distribute
- distribute(callback: ArchivistDistributeCallback): void
-
Parameters
-
callback: ArchivistDistributeCallback
Returns void
-
exists
- exists(topicName: string, index: IArchivistIndex, callback: ArchivistExistsCallback): void
-
Parameters
-
topicName: string
-
index: IArchivistIndex
-
callback: ArchivistExistsCallback
Returns void
-
get
- get<T>(topicName: string, index: IArchivistIndex, options: IArchivistGetOptions | undefined, callback: ArchivistGetCallback<T>): void
- get<T>(topicName: string, index: IArchivistIndex, callback: ArchivistGetCallback<T>): void
-
Type parameters
-
T
Parameters
-
topicName: string
-
index: IArchivistIndex
-
options: IArchivistGetOptions | undefined
-
callback: ArchivistGetCallback<T>
Returns void
-
-
Type parameters
-
T
Parameters
-
topicName: string
-
index: IArchivistIndex
-
callback: ArchivistGetCallback<T>
Returns void
-
getValue
- get
Value(topicName: string, index: IArchivistIndex, options: IArchivistGetOptions | undefined, callback: ArchivistGetCallback<IVaultValue>): void - get
Value(topicName: string, index: IArchivistIndex, callback: ArchivistGetCallback<IVaultValue>): void
-
Parameters
-
topicName: string
-
index: IArchivistIndex
-
options: IArchivistGetOptions | undefined
-
callback: ArchivistGetCallback<IVaultValue>
Returns void
-
-
Parameters
-
topicName: string
-
index: IArchivistIndex
-
callback: ArchivistGetCallback<IVaultValue>
Returns void
-
list
- list(topicName: string, partialIndex: IArchivistIndex, options: IArchivistListOptions | undefined, callback: ArchivistListCallback): void
- list(topicName: string, partialIndex: IArchivistIndex, callback: ArchivistListCallback): void
-
Parameters
-
topicName: string
-
partialIndex: IArchivistIndex
-
options: IArchivistListOptions | undefined
-
callback: ArchivistListCallback
Returns void
-
-
Parameters
-
topicName: string
-
partialIndex: IArchivistIndex
-
callback: ArchivistListCallback
Returns void
-
mget
- mget<T>(queries: IArchivistQuery[], options: IArchivistGetOptions | undefined, callback: ArchivistMGetCallback<T>): void
- mget<T>(queries: INamedArchivistQuery, options: IArchivistGetOptions | undefined, callback: ArchivistNamedMGetCallback<T>): void
- mget<T>(queries: IArchivistQuery[], callback: ArchivistMGetCallback<T>): void
- mget<T>(queries: INamedArchivistQuery, callback: ArchivistNamedMGetCallback<T>): void
-
Type parameters
-
T
Parameters
-
queries: IArchivistQuery[]
-
options: IArchivistGetOptions | undefined
-
callback: ArchivistMGetCallback<T>
Returns void
-
-
Type parameters
-
T
Parameters
-
queries: INamedArchivistQuery
-
options: IArchivistGetOptions | undefined
-
callback: ArchivistNamedMGetCallback<T>
Returns void
-
-
Type parameters
-
T
Parameters
-
queries: IArchivistQuery[]
-
callback: ArchivistMGetCallback<T>
Returns void
-
-
Type parameters
-
T
Parameters
-
queries: INamedArchivistQuery
-
callback: ArchivistNamedMGetCallback<T>
Returns void
-
mgetValues
- mget
Values(queries: IArchivistQuery[], options: IArchivistGetOptions | undefined, callback: ArchivistMGetCallback<IVaultValue>): void - mget
Values(queries: IArchivistQuery[], callback: ArchivistMGetCallback<IVaultValue>): void
-
Parameters
-
queries: IArchivistQuery[]
-
options: IArchivistGetOptions | undefined
-
callback: ArchivistMGetCallback<IVaultValue>
Returns void
-
-
Parameters
-
queries: IArchivistQuery[]
-
callback: ArchivistMGetCallback<IVaultValue>
Returns void
-
reset
- reset(): void
-
Returns void
scan
- scan<T>(topicName: string, partialIndex: IArchivistIndex, options: ArchivistScanOptions | undefined, callback: ArchivistMGetCallback<T>): void
- scan<T>(topicName: string, partialIndex: IArchivistIndex, callback: ArchivistMGetCallback<T>): void
-
Type parameters
-
T
Parameters
-
topicName: string
-
partialIndex: IArchivistIndex
-
options: ArchivistScanOptions | undefined
-
callback: ArchivistMGetCallback<T>
Returns void
-
-
Type parameters
-
T
Parameters
-
topicName: string
-
partialIndex: IArchivistIndex
-
callback: ArchivistMGetCallback<T>
Returns void
-
set
- set<T>(topicName: string, index: IArchivistIndex, data: T, mediaType?: ArchivistMediaType, encoding?: ArchivistEncoding, expirationTime?: number): void
-
Type parameters
-
T
Parameters
-
topicName: string
-
index: IArchivistIndex
-
data: T
-
Optional mediaType: ArchivistMediaType
-
Optional encoding: ArchivistEncoding
-
Optional expirationTime: number
Returns void
-
touch
- touch(topicName: string, index: IArchivistIndex, expirationTime?: number): void
-
Parameters
-
topicName: string
-
index: IArchivistIndex
-
Optional expirationTime: number
Returns void
-