@pumpkin-plugins/docs API / node / loadInfo

Function: loadInfo()

loadInfo(pluginDir): Promise<PluginInfo<string>>

Defined in: tools/docs/src/node.ts:29

Loads the info export of a plugin's info module. Node strips the TypeScript types.

Parameters

pluginDir

string

The plugin's folder.

Returns

Promise<PluginInfo<string>>

What the plugin says about itself.

Throws

When the module is missing or doesn't export a usable info.