Skip to content

apollo-code


apollo-code / storage/src / MemoryService

Interface: MemoryService

Methods

create()

create(input): Promise<MemoryRecord>

Parameters

input

NewMemoryRecord

Returns

Promise<MemoryRecord>


delete()

delete(scope, id, options?): Promise<MemoryRecord>

Parameters

scope

MemoryRecordScope

id

string

options?

MemoryMutationOptions

Returns

Promise<MemoryRecord>


deleteAttachment()

deleteAttachment(scope, id, attachmentId, options?): Promise<MemoryRecord>

Parameters

scope

MemoryRecordScope

id

string

attachmentId

string

options?

MemoryMutationOptions

Returns

Promise<MemoryRecord>


flush()

flush(): Promise<void>

Returns

Promise<void>


get()

get(scope, id): Promise<MemoryRecord | undefined>

Parameters

scope

MemoryRecordScope

id

string

Returns

Promise<MemoryRecord | undefined>


invalidateAttachment()

invalidateAttachment(scope, id, attachmentId, options?): Promise<MemoryRecord>

Parameters

scope

MemoryRecordScope

id

string

attachmentId

string

options?

MemoryMutationOptions

Returns

Promise<MemoryRecord>


list()

list(scope, options?): Promise<MemoryRecord[]>

Parameters

scope

MemoryRecordScope

options?

Omit<MemoryListOptions, "cursor">

Returns

Promise<MemoryRecord[]>


listPage()

listPage(scope, options?): Promise<MemoryPage>

Parameters

scope

MemoryRecordScope

options?

MemoryListOptions

Returns

Promise<MemoryPage>


onDidChange()?

optional onDidChange(listener): object

Parameters

listener

() => void

Returns

object

dispose()

dispose(): void

Returns

void


pin()

pin(scope, id, options?): Promise<MemoryRecord>

Parameters

scope

MemoryRecordScope

id

string

options?

MemoryMutationOptions

Returns

Promise<MemoryRecord>


start()

start(): Promise<void>

Returns

Promise<void>


unpin()

unpin(scope, id, options?): Promise<MemoryRecord>

Parameters

scope

MemoryRecordScope

id

string

options?

MemoryMutationOptions

Returns

Promise<MemoryRecord>


update()

update(scope, id, patch, options?): Promise<MemoryRecord>

Parameters

scope

MemoryRecordScope

id

string

patch

Partial<Pick<MemoryRecord, "content" | "tags" | "pinned" | "provenance" | "attachments">>

options?

MemoryMutationOptions

Returns

Promise<MemoryRecord>


validateWrite()?

optional validateWrite(input, operation?): Promise<void>

Parameters

input

NewMemoryRecord

operation?

"create" | "update"

Returns

Promise<void>