PluginAPI

@azrtydxb/server

---

Interface: PluginAPI

Defined in: types.ts:99

Properties

events

events: object

Defined in: types.ts:108

off()

off(event, handler): void

Parameters

event

PluginEvent

handler

PluginEventHandler

Returns

void

on()

on(event, handler): void

Parameters

event

PluginEvent

handler

PluginEventHandler

Returns

void

---

log

log: object

Defined in: types.ts:133

error()

error(message, …args): void

Parameters

message

string

args

…unknown[]

Returns

void

info()

info(message, …args): void

Parameters

message

string

args

…unknown[]

Returns

void

warn()

warn(message, …args): void

Parameters

message

string

args

…unknown[]

Returns

void

---

notes

notes: object

Defined in: types.ts:100

create()

create(userId, path, content): Promise<void>

Parameters

userId

string

path

string

content

string

Returns

Promise<void>

delete()

delete(userId, path): Promise<void>

Parameters

userId

string

path

string

Returns

Promise<void>

get()

get(userId, path): Promise<Note>

Parameters

userId

string

path

string

Returns

Promise<Note>

list()

list(userId, folder?): Promise<NoteEntry[]>

Parameters

userId

string

folder?

string

Returns

Promise<NoteEntry[]>

update()

update(userId, path, content): Promise<void>

Parameters

userId

string

path

string

content

string

Returns

Promise<void>

---

plugin

plugin: object

Defined in: types.ts:139

dataDir

dataDir: string

id

id: string

version

version: string

---

routes

routes: object

Defined in: types.ts:113

register()

register(method, path, handler): void

Parameters

method

HttpMethod

path

string

handler

PluginRouteHandler

Returns

void

---

search

search: object

Defined in: types.ts:128

index()

index(userId, path, fields): Promise<void>

Parameters

userId

string

path

string

fields

IndexFields

Returns

Promise<void>

query()

query(userId, query): Promise<SearchResult[]>

Parameters

userId

string

query

string

Returns

Promise<SearchResult[]>

---

settings

settings: object

Defined in: types.ts:124

get()

get(key, userId?): Promise<unknown>

Parameters

key

string

userId?

string

Returns

Promise<unknown>

---

storage

storage: object

Defined in: types.ts:117

delete()

delete(key, userId?): Promise<void>

Parameters

key

string

userId?

string

Returns

Promise<void>

get()

get(key, userId?): Promise<unknown>

Parameters

key

string

userId?

string

Returns

Promise<unknown>

list()

list(prefix?, userId?): Promise<StorageEntry[]>

Parameters

prefix?

string

userId?

string

Returns

Promise<StorageEntry[]>

set()

set(key, value, userId?): Promise<void>

Parameters

key

string

value

unknown

userId?

string

Returns

Promise<void>