@steambrew/client
Version:
A support library for creating plugins with Millennium.
47 lines (46 loc) • 1.53 kB
TypeScript
/** Returnable IPC types */
type IPC_types = (string | number | boolean);
type Millennium = {
/**
* @brief Call a method on the backend
* @deprecated Use `callable` instead.
* Example usage:
* ```typescript
* // before
* const result = await Millennium.callServerMethod('methodName', { arg1: 'value' });
* // after
* const method = callable<[{ arg1: string }]>("methodName");
*
* const result1 = await method({ arg1: 'value1' });
* const result2 = await method({ arg1: 'value2' });
* ```
*/
callServerMethod: (methodName: string, kwargs?: object) => Promise<any>;
findElement: (privateDocument: Document, querySelector: string, timeOut?: number) => Promise<NodeListOf<Element>>;
exposeObj?: <T extends object>(obj: T) => any;
AddWindowCreateHook?: (callback: (context: object) => void) => void;
};
/**
* Make reusable IPC call declarations
*
* frontend:
* ```typescript
* const method = callable<[{ arg1: string }]>("methodName"); // declare the method
* method({ arg1: 'value' }); // call the method
* ```
*
* backend:
* ```python
* def methodName(arg1: str):
* pass
* ```
*/
declare const callable: <Args extends any[] = [], T = IPC_types>(route: string) => (...args: Args) => Promise<T>;
export declare const pluginSelf: any;
declare global {
interface Window {
Millennium: Millennium;
}
}
declare const Millennium: Millennium;
export { Millennium, callable };