Skip to content
On this page

AthenaClient.systems.plugins ​

Modules ​

Functions ​

addAPI ​

Usage

AthenaClient.systems.plugins.addAPI(pluginName, functions): void

Injects a 'plugin' API into the runtime.

The runtime injection can be obtained with Athena.systems.plugins.use.

See that function for additional information.

Export

Parameters ​

NameType
pluginNamestring
functionsObject

Returns ​

void

Defined in ​

client/systems/plugins.ts:21


useAPI ​

Usage

AthenaClient.systems.plugins.useAPI<K>(apiName): Promise<ClientPluginAPI[K]>

Used to obtain a runtime API and its valid functionality.

This makes it so you can 'import' without knowing the plugin pathways.

As long as you know the 'plugin name' you can import anything.

Export

Type parameters ​

NameType
Kextends ExtractStringKeys<ClientPluginAPI>

Parameters ​

NameType
apiNameK

Returns ​

Promise<ClientPluginAPI[K]>

Defined in ​

client/systems/plugins.ts:42

Created by Stuyk | Est. 2020