Undocumented linter cleanup

This commit is contained in:
Travis Ralston 2020-12-07 15:12:26 -07:00
parent 2c992c456e
commit 550a5220d9
7 changed files with 17 additions and 22 deletions

View file

@ -2,7 +2,6 @@
Copyright 2020 Nurjin Jafar
Copyright 2020 Nordeck IT + Consulting GmbH.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
@ -20,10 +19,10 @@
*/
export interface ICanvasEffectConstructable {
/**
* @param {{[key:string]:any}} options? Optional animation options
* @param {{[key:string]:any}} options? Optional animation options
* @returns ICanvasEffect Returns a new instance of the canvas effect
*/
new(options?: { [key: string]: any }): ICanvasEffect
new(options?: { [key: string]: any }): ICanvasEffect;
}
/**
@ -31,16 +30,18 @@ export interface ICanvasEffectConstructable {
*/
export default interface ICanvasEffect {
/**
* @param {HTMLCanvasElement} canvas The canvas instance as the render target of the animation
* @param {number} timeout? A timeout that defines the runtime of the animation (defaults to false)
* @param {HTMLCanvasElement} canvas The canvas instance as the render target of the animation
* @param {number} timeout? A timeout that defines the runtime of the animation (defaults to false)
*/
start: (canvas: HTMLCanvasElement, timeout?: number) => Promise<void>,
start: (canvas: HTMLCanvasElement, timeout?: number) => Promise<void>;
/**
* Stops the current animation
*/
stop: () => Promise<void>,
stop: () => Promise<void>;
/**
* Returns a value that defines if the animation is currently running
*/
isRunning: boolean
isRunning: boolean;
}