Skip to main content
zerotal

Documentation


Documentation / @zerotal/admin / index / MediaProvider

Interface: MediaProvider

Defined in: admin/src/media.ts:49

What the app supplies so the library can be listed and maintained.

Methods

list()

list(query): MediaItem[] | Promise<MediaItem[]>

Defined in: admin/src/media.ts:51

Catalogued files, newest first, optionally narrowed by folder or search.

Parameters

query
folder?

string

string

limit

number

Returns

MediaItem[] | Promise<MediaItem[]>


save()

save(item): MediaItem | Promise<MediaItem>

Defined in: admin/src/media.ts:57

Record a newly stored file. The panel supplies everything but the id.

Parameters

item

Omit<MediaItem, "id">

Returns

MediaItem | Promise<MediaItem>


remove()

remove(id): void | Promise<void>

Defined in: admin/src/media.ts:59

Forget a file, and delete its bytes.

Parameters

id

string

Returns

void | Promise<void>


update()?

optional update(id, changes): void | Promise<void>

Defined in: admin/src/media.ts:61

Update the editable metadata on one item.

Parameters

id

string

changes

Pick<MediaItem, "alt" | "folder">

Returns

void | Promise<void>