Skip to main content

Interface: INotesApi

Defined in: Extensions/ExtensionApiTypes.ts:284

Properties

onDidChange

onDidChange: IEventApi<{ id: string; type: "created" | "updated" | "deleted"; }>

Defined in: Extensions/ExtensionApiTypes.ts:290

Methods

create()

create(note): Promise<UserNoteDto>

Defined in: Extensions/ExtensionApiTypes.ts:287

Parameters

note

NewNoteDto

Returns

Promise<UserNoteDto>


delete()

delete(id): Promise<void>

Defined in: Extensions/ExtensionApiTypes.ts:289

Parameters

id

string

Returns

Promise<void>


get()

get(id): Promise<UserNoteDto | null>

Defined in: Extensions/ExtensionApiTypes.ts:286

Parameters

id

string

Returns

Promise<UserNoteDto | null>


list()

list(query?): Promise<UserNoteDto[]>

Defined in: Extensions/ExtensionApiTypes.ts:285

Parameters

query?

NoteQueryDto

Returns

Promise<UserNoteDto[]>


update()

update(id, patch): Promise<UserNoteDto>

Defined in: Extensions/ExtensionApiTypes.ts:288

Parameters

id

string

patch

Partial<UserNoteDto>

Returns

Promise<UserNoteDto>