Update CreateJS libs with formatting and header comments

This commit is contained in:
Boris Yankov 2012-11-02 05:36:50 +02:00
parent 2a02b65c06
commit 3bf4e60dbe
5 changed files with 671 additions and 718 deletions

File diff suppressed because it is too large Load Diff

View File

@ -1,82 +1,77 @@
// Type definitions for PreloadJS 0.2
// Project: http://www.createjs.com/#!/PreloadJS
// Definitions by: Pedro Ferreira <https://bitbucket.org/drk4>
// Definitions: https://github.com/borisyankov/DefinitelyTyped
/*
See https://bitbucket.org/drk4/createjs_ts_definitions for updates/examples
Copyright (c) 2012 Pedro Ferreira
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
*/
module createjs
{
export class AbstractLoader
{
module createjs {
export class AbstractLoader {
// properties
canceled: bool;
loaded: bool;
progress: number;
canceled: bool;
loaded: bool;
progress: number;
// methods
cancel(): void;
getItem(): Object;
load(): void;
cancel(): void;
getItem(): Object;
load(): void;
// events
onComplete: () => any;
onError: () => any;
onFileLoad: () => any;
onFileProgress: () => any;
onLoadStart: () => any;
onProgress: () => any;
onComplete: () => any;
onError: () => any;
onFileLoad: () => any;
onFileProgress: () => any;
onLoadStart: () => any;
onProgress: () => any;
}
export class PreloadJS extends AbstractLoader
{
constructor( useXHR2?: bool );
export class PreloadJS extends AbstractLoader {
constructor (useXHR2?: bool);
// properties
static CSS: string;
static IMAGE: string;
static JAVASCRIPT: string;
static JSON: string;
maintainScriptOrder: bool;
next: PreloadJS;
static SOUND: string;
stopOnError: bool;
static TEXT: string;
static TIMEOUT_TIME: number;
useXHR: bool;
static XML: string;
static CSS: string;
static IMAGE: string;
static JAVASCRIPT: string;
static JSON: string;
maintainScriptOrder: bool;
next: PreloadJS;
static SOUND: string;
stopOnError: bool;
static TEXT: string;
static TIMEOUT_TIME: number;
useXHR: bool;
static XML: string;
// methods
BrowserDetect(): Object;
close(): void;
getResult( value: string ): Object;
initialize( useXHR: bool ): void;
installPlugin( plugin: () => any ): void;
load(): void;
loadFile( file: Object, loadNow: bool ): void;
loadFile( file: string, loadNow: bool ): void;
loadManifest( manifest: Object[], loadNow: bool ): void;
loadManifest( manifest: string[], loadNow: bool ): void;
setMaxConnections( value: number ): void;
setPaused( value: bool ): void;
BrowserDetect(): Object;
close(): void;
getResult(value: string): Object;
initialize(useXHR: bool): void;
installPlugin(plugin: () => any): void;
load(): void;
loadFile(file: Object, loadNow: bool): void;
loadFile(file: string, loadNow: bool): void;
loadManifest(manifest: Object[], loadNow: bool): void;
loadManifest(manifest: string[], loadNow: bool): void;
setMaxConnections(value: number): void;
setPaused(value: bool): void;
}
export class TagLoader extends AbstractLoader
{
constructor( item: Object, srcAttr: string, useXHR: bool );
constructor( item: string, srcAttr: string, useXHR: bool );
export class TagLoader extends AbstractLoader {
constructor (item: Object, srcAttr: string, useXHR: bool);
constructor (item: string, srcAttr: string, useXHR: bool);
}
export class XHRLoader extends AbstractLoader
{
constructor( file: Object );
export class XHRLoader extends AbstractLoader {
constructor (file: Object);
}
}

View File

@ -1,112 +1,107 @@
// Type definitions for SoundJS 0.3
// Project: http://www.createjs.com/#!/SoundJS
// Definitions by: Pedro Ferreira <https://bitbucket.org/drk4>
// Definitions: https://github.com/borisyankov/DefinitelyTyped
/*
See https://bitbucket.org/drk4/createjs_ts_definitions for updates/examples
Copyright (c) 2012 Pedro Ferreira
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
*/
module createjs
{
export class FlashPlugin
{
module createjs {
export class FlashPlugin {
// properties
static BASE_PATH: string;
static capabilities: Object;
showOutput: bool;
static BASE_PATH: string;
static capabilities: Object;
showOutput: bool;
// methods
create( src: string ): SoundInstance;
static generateCapabilities(): void;
static isSupported(): bool;
register( src: string, instances: number ): Object;
create(src: string): SoundInstance;
static generateCapabilities(): void;
static isSupported(): bool;
register(src: string, instances: number): Object;
}
export class HTMLAudioPlugin
{
export class HTMLAudioPlugin {
// properties
static capabilities: Object;
static MAX_INSTANCES: number;
static capabilities: Object;
static MAX_INSTANCES: number;
// methods
create( src: string ): SoundInstance;
static generateCapabilities(): void;
static isSupported(): bool;
register( src: string, instances: number ): Object;
create(src: string): SoundInstance;
static generateCapabilities(): void;
static isSupported(): bool;
register(src: string, instances: number): Object;
}
export class SoundInstance
{
constructor( src: string );
export class SoundInstance {
constructor (src: string);
// properties
muted: bool;
owner: HTMLAudioPlugin;
paused: bool;
playState: string;
src: string;
uniqueId: string; //HERE string or number
muted: bool;
owner: HTMLAudioPlugin;
paused: bool;
playState: string;
src: string;
uniqueId: string; //HERE string or number
// methods
getDuration(): number;
getPan(): number;
getPosition(): number;
getVolume(): number;
mute( isMuted: bool ): bool;
pause(): bool;
play( interrupt: string, delay: number, offset: number, loop: number, volume: number, pan: number ): void;
resume(): bool;
setPan( value: number ): number;
setPosition( value: number ): void;
setVolume( value: number ): bool;
stop(): bool;
getDuration(): number;
getPan(): number;
getPosition(): number;
getVolume(): number;
mute(isMuted: bool): bool;
pause(): bool;
play(interrupt: string, delay: number, offset: number, loop: number, volume: number, pan: number): void;
resume(): bool;
setPan(value: number): number;
setPosition(value: number): void;
setVolume(value: number): bool;
stop(): bool;
// events
onComplete: () => any;
onLoop: () => any;
onPlayFailed: () => any;
onPlayInterrupted: () => any;
onReady: () => any;
onComplete: () => any;
onLoop: () => any;
onPlayFailed: () => any;
onPlayInterrupted: () => any;
onReady: () => any;
}
export class SoundJS
{
export class SoundJS {
// properties
static activePlugin: Object;
static AUDIO_TIMEOUT: number;
static DELIMITER: string;
static INTERRUPT_ANY: string;
static INTERRUPT_EARLY: string;
static INTERRUPT_LATE: string;
static INTERRUPT_NONE: string;
static muted: bool;
static PLAY_FAILED: string;
static PLAY_FINISHED: string;
static PLAY_INITED: string;
static PLAY_INTERRUPTED: string;
static PLAY_SUCCEEDED: string;
static activePlugin: Object;
static AUDIO_TIMEOUT: number;
static DELIMITER: string;
static INTERRUPT_ANY: string;
static INTERRUPT_EARLY: string;
static INTERRUPT_LATE: string;
static INTERRUPT_NONE: string;
static muted: bool;
static PLAY_FAILED: string;
static PLAY_FINISHED: string;
static PLAY_INITED: string;
static PLAY_INTERRUPTED: string;
static PLAY_SUCCEEDED: string;
// methods
static checkPlugin( initializeDefault: bool ): bool;
static getCapabilities(): Object;
static getCapability( key: string ); //HERE can return string | number | bool
static getInstanceById( uniqueId: string ): SoundInstance;
static getMasterVolume(): number;
static getSrcFromId( value: string ): string;
static isReady(): bool;
static pause( id: string ): void;
static play( value: string, interrupt?: string, delay?: number, offset?: number, loop?: number, volume?: number, pan?: number ): SoundInstance;
static registerPlugin( plugin: Object ): bool;
static registerPlugins( plugins: Object[] ): bool;
static resume( id: string ): void;
static setMasterVolume( value: number ): bool;
static setMute( isMuted: bool, id: string ): bool;
static setVolume( value: number, id?: string ): bool;
static stop( id?: string ): bool;
static checkPlugin(initializeDefault: bool): bool;
static getCapabilities(): Object;
static getCapability(key: string); //HERE can return string | number | bool
static getInstanceById(uniqueId: string): SoundInstance;
static getMasterVolume(): number;
static getSrcFromId(value: string): string;
static isReady(): bool;
static pause(id: string): void;
static play(value: string, interrupt?: string, delay?: number, offset?: number, loop?: number, volume?: number, pan?: number): SoundInstance;
static registerPlugin(plugin: Object): bool;
static registerPlugins(plugins: Object[]): bool;
static resume(id: string): void;
static setMasterVolume(value: number): bool;
static setMute(isMuted: bool, id: string): bool;
static setVolume(value: number, id?: string): bool;
static stop(id?: string): bool;
}
}

View File

@ -1,137 +1,133 @@
// Type definitions for TweenJS 0.3
// Project: http://www.createjs.com/#!/TweenJS
// Definitions by: Pedro Ferreira <https://bitbucket.org/drk4>
// Definitions: https://github.com/borisyankov/DefinitelyTyped
/*
See https://bitbucket.org/drk4/createjs_ts_definitions for updates/examples
Copyright (c) 2012 Pedro Ferreira
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
*/
module createjs
{
export class CSSPlugin
{
module createjs {
export class CSSPlugin {
// properties
static cssSuffixMap: Object;
static cssSuffixMap: Object;
// methods
static install(): void;
static install(): void;
}
export class Ease
{
export class Ease {
// methods
static backIn(): number;
static backInOut(): number;
static backOut(): number;
static bounceIn( amount: number ): number;
static bounceInOut( amount: number ): number;
static bounceOut( amount: number ): number;
static circIn( amount: number ): number;
static circInOut( amount: number ): number;
static circOut( amount: number ): number;
static cubicIn(): number;
static cubicInOut(): number;
static cubicOut(): number;
static elasticIn(): number;
static elasticInOut(): number;
static elasticOut(): number;
static get( amount: number ): ( amount: number ) => number;
static getBackIn( amount: number ): ( amount: number ) => number;
static getBackInOut( amount: number ): ( amount: number ) => number;
static getBackOut( amount: number ): ( amount: number ) => number;
static getElasticIn( amplitude: number, period: number ): ( amount: number ) => number;
static getElasticInOut( amplitude: number, period: number ): ( amount: number ) => number;
static getElasticOut( amplitude: number, period: number ): ( amount: number ) => number;
static getPowIn( pow: number ): ( amount: number ) => number;
static getPowInOut( pow: number ): ( amount: number ) => number;
static getPowOut( pow: number ): ( amount: number ) => number;
static linear( amount: number ): number;
static none( amount: number ): number; // same as linear
static quadIn(): ( amount: number ) => number;
static quadInOut(): ( amount: number ) => number;
static quadOut(): ( amount: number ) => number;
static quartIn(): ( amount: number ) => number;
static quartInOut(): ( amount: number ) => number;
static quartOut(): ( amount: number ) => number;
static quintIn(): ( amount: number ) => number;
static quintInOut(): ( amount: number ) => number;
static quintOut(): ( amount: number ) => number;
static sineIn( amount: number ): number;
static sineInOut( amount: number ): number;
static sineOut( amount: number ): number;
static backIn(): number;
static backInOut(): number;
static backOut(): number;
static bounceIn(amount: number): number;
static bounceInOut(amount: number): number;
static bounceOut(amount: number): number;
static circIn(amount: number): number;
static circInOut(amount: number): number;
static circOut(amount: number): number;
static cubicIn(): number;
static cubicInOut(): number;
static cubicOut(): number;
static elasticIn(): number;
static elasticInOut(): number;
static elasticOut(): number;
static get(amount: number): (amount: number) => number;
static getBackIn(amount: number): (amount: number) => number;
static getBackInOut(amount: number): (amount: number) => number;
static getBackOut(amount: number): (amount: number) => number;
static getElasticIn(amplitude: number, period: number): (amount: number) => number;
static getElasticInOut(amplitude: number, period: number): (amount: number) => number;
static getElasticOut(amplitude: number, period: number): (amount: number) => number;
static getPowIn(pow: number): (amount: number) => number;
static getPowInOut(pow: number): (amount: number) => number;
static getPowOut(pow: number): (amount: number) => number;
static linear(amount: number): number;
static none(amount: number): number; // same as linear
static quadIn(): (amount: number) => number;
static quadInOut(): (amount: number) => number;
static quadOut(): (amount: number) => number;
static quartIn(): (amount: number) => number;
static quartInOut(): (amount: number) => number;
static quartOut(): (amount: number) => number;
static quintIn(): (amount: number) => number;
static quintInOut(): (amount: number) => number;
static quintOut(): (amount: number) => number;
static sineIn(amount: number): number;
static sineInOut(amount: number): number;
static sineOut(amount: number): number;
}
export class Timeline
{
constructor( tweens: Tween[], labels: Object, props: Object );
export class Timeline {
constructor (tweens: Tween[], labels: Object, props: Object);
// properties
duration: number;
ignoreGlobalPause: bool;
loop: bool;
position: number;
duration: number;
ignoreGlobalPause: bool;
loop: bool;
position: number;
// methods
addLabel( label: string, position: number ): void;
addTween( ...tween: Tween[] ): void;
gotoAndPlay( positionOrLabel: string ): void;
gotoAndPlay( positionOrLabel: number ): void;
gotoAndStop( positionOrLabel: string ): void;
gotoAndStop( positionOrLabel: number ): void;
removeTween( ...tween: Tween[] ): void;
resolve( positionOrLabel: string ): number;
resolve( positionOrLabel: number ): number;
setPaused( value: bool ): void;
setPosition( value: number, actionsMode?: number ): void;
tick( delta: number ): void;
toString(): string;
updateDuration(): void;
addLabel(label: string, position: number): void;
addTween(...tween: Tween[]): void;
gotoAndPlay(positionOrLabel: string): void;
gotoAndPlay(positionOrLabel: number): void;
gotoAndStop(positionOrLabel: string): void;
gotoAndStop(positionOrLabel: number): void;
removeTween(...tween: Tween[]): void;
resolve(positionOrLabel: string): number;
resolve(positionOrLabel: number): number;
setPaused(value: bool): void;
setPosition(value: number, actionsMode?: number): void;
tick(delta: number): void;
toString(): string;
updateDuration(): void;
// events
onChange: ( instance: Timeline ) => any;
onChange: (instance: Timeline) => any;
}
export class Tween
{
constructor( target: Object, props: Object );
export class Tween {
constructor (target: Object, props: Object);
// properties
duration: number;
static IGNORE: Object;
ignoreGlobalPause: bool;
loop: bool;
static LOOP: number;
static NONE: number;
pluginData: Object;
position: number;
static REVERSE: number;
target: Object;
duration: number;
static IGNORE: Object;
ignoreGlobalPause: bool;
loop: bool;
static LOOP: number;
static NONE: number;
pluginData: Object;
position: number;
static REVERSE: number;
target: Object;
// methods
call( callback: ( tweenObject: Tween ) => any, params?: any[], scope?: Object ); // when 'params' isn't given, the callback receives a tweenObject
call( callback: ( ...params:any[] ) => any, params?: any[], scope?: Object ); // otherwise, it receives the params only
static get( target, props: Object ): Tween;
static hasActiveTweens( target? ): void;
static installPlugin( plugin: Object, properties: Object ): void;
pause( tween: Tween ): void;
play( tween: Tween ): void;
static removeTweens( target ): void;
set( props: Object, target? ): void;
setPaused( value: bool ): void;
setPosition( value: number, actionsMode: number ): void;
static tick( delta: number, paused: bool ): void;
to( props: Object, duration?: number, ease?: ( amount: number ) => number ): Tween;
toString(): string;
wait( duration: number ): void;
call(callback: (tweenObject: Tween) => any, params?: any[], scope?: Object); // when 'params' isn't given, the callback receives a tweenObject
call(callback: (...params: any[]) => any, params?: any[], scope?: Object); // otherwise, it receives the params only
static get(target, props: Object): Tween;
static hasActiveTweens(target? ): void;
static installPlugin(plugin: Object, properties: Object): void;
pause(tween: Tween): void;
play(tween: Tween): void;
static removeTweens(target): void;
set(props: Object, target? ): void;
setPaused(value: bool): void;
setPosition(value: number, actionsMode: number): void;
static tick(delta: number, paused: bool): void;
to(props: Object, duration?: number, ease?: (amount: number) => number): Tween;
toString(): string;
wait(duration: number): void;
// events
onChange: ( instance: Tween ) => any;
onChange: (instance: Tween) => any;
}
}

View File

@ -14,7 +14,7 @@ Complete
* [CodeMirror](http://codemirror.net) (by [François de Campredon](https://github.com/fdecampredon))
* [Chosen](http://harvesthq.github.com/chosen/)
* [dynatree](http://code.google.com/p/dynatree/) (by [François de Campredon](https://github.com/fdecampredon))
* [EaselJS](http://www.createjs.com/#!/EaselJS)
* [EaselJS](http://www.createjs.com/#!/EaselJS) (by [Pedro Ferreira](https://bitbucket.org/drk4))
* [ember.js](http://emberjs.com/)
* [Express](http://expressjs.com/)
* [Fancybox](http://fancybox.net/)
@ -38,11 +38,14 @@ Complete
* [Node.js](http://nodejs.org/) (from TypeScript samples)
* [node_redis](https://github.com/mranney/node_redis)
* [node-sqlserver](https://github.com/WindowsAzure/node-sqlserver)
* [PreloadJS](http://www.createjs.com/#!/PreloadJS) (by [Pedro Ferreira](https://bitbucket.org/drk4))
* [QUnit](http://qunitjs.com/) (by [Diullei Gomes](https://github.com/Diullei))
* [Raphael](http://raphaeljs.com/) (by [CheCoxshall](https://github.com/CheCoxshall))
* [Sammy.js](http://sammyjs.org/)
* [SoundJS](http://www.createjs.com/#!/SoundJS) (by [Pedro Ferreira](https://bitbucket.org/drk4))
* [Spin](http://fgnass.github.com/spin.js/)
* [Teechart](http://www.steema.com) (by [Steema])(http://www.steema.com)
* [TweenJS](http://www.createjs.com/#!/TweenJS) (by [Pedro Ferreira](https://bitbucket.org/drk4))
* [Underscore.js](http://underscorejs.org/)
Next