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 ​
Name | Type |
---|---|
pluginName | string |
functions | Object |
Returns ​
void
Defined in ​
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 ​
Name | Type |
---|---|
K | extends ExtractStringKeys <ClientPluginAPI > |
Parameters ​
Name | Type |
---|---|
apiName | K |
Returns ​
Promise
<ClientPluginAPI
[K
]>