galeforce-tmp-sea
Version:
A customizable, promise-based, and command-oriented TypeScript library for the Riot Games API.
27 lines • 1.23 kB
TypeScript
import { Game } from '../../../riot-api';
import { Constructor, Executable } from './executable';
/**
* An interface containing method type signatures for any Action containing a `.game()` method.
*/
export interface GameChainable {
game?: <K extends GameChainable & Executable>(this: K, game: Game) => Omit<K, 'game'>;
}
/**
* A mixin for the `.game()` method.
* @template TBase The type of the object inside. Defaults to `typeof Action`.
* @param Base The target class.
*/
export declare function TakesGame<TBase extends Constructor>(Base: TBase): {
new (...args: any[]): {
/**
* Modifies the **game** associated with the Action object it is called from.
* Note that associated runtime type checks are performed to ensure that
* the provided Riot game matches one of the expected queues for the corresponding game.
* @param game The Riot game to update the calling Action object with.
* @throws Will throw an error if an invalid game is provided or the provided
* game fails the runtime type check.
*/
game<K extends GameChainable & Executable>(this: K, game: Game): Omit<K, "game">;
};
} & TBase;
//# sourceMappingURL=game.d.ts.map