Phials developer documentation
User guide
AI Notice: Most documentation right now was auto-generated by an LLM. Handwritten documentation will be implemented over time on the road to 1.0

MetadataAPI

Metadata API - extended API for metadata providers

extends PluginAPI

Signature

interface MetadataAPI extends PluginAPI {
    readFile(path: string): Promise<Uint8Array>;
    readTextFile(path: string): Promise<string>;
}

Members

NameTypeRequiredDescription
readFile(path: string) => Promise<Uint8Array>yesRead file content as bytes
readTextFile(path: string) => Promise<string>yesRead text file content