diff --git a/AfterEffects/10.5/package.json b/AfterEffects/10.5/package.json new file mode 100644 index 00000000..2bd1c1d7 --- /dev/null +++ b/AfterEffects/10.5/package.json @@ -0,0 +1,6 @@ +{ + "name": "types-for-adobe/AfterEffects/10.5", + "version": "1.0.0", + "main": "index.d.ts", + "types": "index.d.ts" +} diff --git a/AfterEffects/10.5/tsconfig.json b/AfterEffects/10.5/tsconfig.json index 169c0222..28d68ad9 100644 --- a/AfterEffects/10.5/tsconfig.json +++ b/AfterEffects/10.5/tsconfig.json @@ -2,7 +2,8 @@ "compilerOptions": { "module": "none", "strict": true, - "noLib": true, + "noLib": false, + "lib": ["ES5"], "typeRoots": [] }, "exclude": ["node_modules"] diff --git a/AfterEffects/11.0/package.json b/AfterEffects/11.0/package.json new file mode 100644 index 00000000..1611f958 --- /dev/null +++ b/AfterEffects/11.0/package.json @@ -0,0 +1,6 @@ +{ + "name": "types-for-adobe/AfterEffects/11.0", + "version": "1.0.0", + "main": "index.d.ts", + "types": "index.d.ts" +} diff --git a/AfterEffects/11.0/tsconfig.json b/AfterEffects/11.0/tsconfig.json index 169c0222..28d68ad9 100644 --- a/AfterEffects/11.0/tsconfig.json +++ b/AfterEffects/11.0/tsconfig.json @@ -2,7 +2,8 @@ "compilerOptions": { "module": "none", "strict": true, - "noLib": true, + "noLib": false, + "lib": ["ES5"], "typeRoots": [] }, "exclude": ["node_modules"] diff --git a/AfterEffects/12.0/package.json b/AfterEffects/12.0/package.json new file mode 100644 index 00000000..f08bbb08 --- /dev/null +++ b/AfterEffects/12.0/package.json @@ -0,0 +1,6 @@ +{ + "name": "types-for-adobe/AfterEffects/12.0", + "version": "1.0.0", + "main": "index.d.ts", + "types": "index.d.ts" +} diff --git a/AfterEffects/12.0/tsconfig.json b/AfterEffects/12.0/tsconfig.json index 169c0222..28d68ad9 100644 --- a/AfterEffects/12.0/tsconfig.json +++ b/AfterEffects/12.0/tsconfig.json @@ -2,7 +2,8 @@ "compilerOptions": { "module": "none", "strict": true, - "noLib": true, + "noLib": false, + "lib": ["ES5"], "typeRoots": [] }, "exclude": ["node_modules"] diff --git a/AfterEffects/13.0/package.json b/AfterEffects/13.0/package.json new file mode 100644 index 00000000..3efe1bda --- /dev/null +++ b/AfterEffects/13.0/package.json @@ -0,0 +1,6 @@ +{ + "name": "types-for-adobe/AfterEffects/13.0", + "version": "1.0.0", + "main": "index.d.ts", + "types": "index.d.ts" +} diff --git a/AfterEffects/13.0/tsconfig.json b/AfterEffects/13.0/tsconfig.json index 169c0222..28d68ad9 100644 --- a/AfterEffects/13.0/tsconfig.json +++ b/AfterEffects/13.0/tsconfig.json @@ -2,7 +2,8 @@ "compilerOptions": { "module": "none", "strict": true, - "noLib": true, + "noLib": false, + "lib": ["ES5"], "typeRoots": [] }, "exclude": ["node_modules"] diff --git a/AfterEffects/13.1/package.json b/AfterEffects/13.1/package.json new file mode 100644 index 00000000..dbf2d6cf --- /dev/null +++ b/AfterEffects/13.1/package.json @@ -0,0 +1,6 @@ +{ + "name": "types-for-adobe/AfterEffects/13.1", + "version": "1.0.0", + "main": "index.d.ts", + "types": "index.d.ts" +} diff --git a/AfterEffects/13.1/tsconfig.json b/AfterEffects/13.1/tsconfig.json index 169c0222..28d68ad9 100644 --- a/AfterEffects/13.1/tsconfig.json +++ b/AfterEffects/13.1/tsconfig.json @@ -2,7 +2,8 @@ "compilerOptions": { "module": "none", "strict": true, - "noLib": true, + "noLib": false, + "lib": ["ES5"], "typeRoots": [] }, "exclude": ["node_modules"] diff --git a/AfterEffects/13.2/package.json b/AfterEffects/13.2/package.json new file mode 100644 index 00000000..44116a5c --- /dev/null +++ b/AfterEffects/13.2/package.json @@ -0,0 +1,6 @@ +{ + "name": "types-for-adobe/AfterEffects/13.2", + "version": "1.0.0", + "main": "index.d.ts", + "types": "index.d.ts" +} diff --git a/AfterEffects/13.2/tsconfig.json b/AfterEffects/13.2/tsconfig.json index 169c0222..28d68ad9 100644 --- a/AfterEffects/13.2/tsconfig.json +++ b/AfterEffects/13.2/tsconfig.json @@ -2,7 +2,8 @@ "compilerOptions": { "module": "none", "strict": true, - "noLib": true, + "noLib": false, + "lib": ["ES5"], "typeRoots": [] }, "exclude": ["node_modules"] diff --git a/AfterEffects/13.6/package.json b/AfterEffects/13.6/package.json new file mode 100644 index 00000000..4cb7d68e --- /dev/null +++ b/AfterEffects/13.6/package.json @@ -0,0 +1,6 @@ +{ + "name": "types-for-adobe/AfterEffects/13.6", + "version": "1.0.0", + "main": "index.d.ts", + "types": "index.d.ts" +} diff --git a/AfterEffects/13.6/tsconfig.json b/AfterEffects/13.6/tsconfig.json index 169c0222..28d68ad9 100644 --- a/AfterEffects/13.6/tsconfig.json +++ b/AfterEffects/13.6/tsconfig.json @@ -2,7 +2,8 @@ "compilerOptions": { "module": "none", "strict": true, - "noLib": true, + "noLib": false, + "lib": ["ES5"], "typeRoots": [] }, "exclude": ["node_modules"] diff --git a/AfterEffects/13.8/package.json b/AfterEffects/13.8/package.json new file mode 100644 index 00000000..02782549 --- /dev/null +++ b/AfterEffects/13.8/package.json @@ -0,0 +1,6 @@ +{ + "name": "types-for-adobe/AfterEffects/13.8", + "version": "1.0.0", + "main": "index.d.ts", + "types": "index.d.ts" +} diff --git a/AfterEffects/13.8/tsconfig.json b/AfterEffects/13.8/tsconfig.json index 169c0222..28d68ad9 100644 --- a/AfterEffects/13.8/tsconfig.json +++ b/AfterEffects/13.8/tsconfig.json @@ -2,7 +2,8 @@ "compilerOptions": { "module": "none", "strict": true, - "noLib": true, + "noLib": false, + "lib": ["ES5"], "typeRoots": [] }, "exclude": ["node_modules"] diff --git a/AfterEffects/14.0/package.json b/AfterEffects/14.0/package.json new file mode 100644 index 00000000..9ce41472 --- /dev/null +++ b/AfterEffects/14.0/package.json @@ -0,0 +1,6 @@ +{ + "name": "types-for-adobe/AfterEffects/14.0", + "version": "1.0.0", + "main": "index.d.ts", + "types": "index.d.ts" +} diff --git a/AfterEffects/14.0/tsconfig.json b/AfterEffects/14.0/tsconfig.json index 169c0222..28d68ad9 100644 --- a/AfterEffects/14.0/tsconfig.json +++ b/AfterEffects/14.0/tsconfig.json @@ -2,7 +2,8 @@ "compilerOptions": { "module": "none", "strict": true, - "noLib": true, + "noLib": false, + "lib": ["ES5"], "typeRoots": [] }, "exclude": ["node_modules"] diff --git a/AfterEffects/14.2/package.json b/AfterEffects/14.2/package.json new file mode 100644 index 00000000..d29abe69 --- /dev/null +++ b/AfterEffects/14.2/package.json @@ -0,0 +1,6 @@ +{ + "name": "types-for-adobe/AfterEffects/14.2", + "version": "1.0.0", + "main": "index.d.ts", + "types": "index.d.ts" +} diff --git a/AfterEffects/14.2/tsconfig.json b/AfterEffects/14.2/tsconfig.json index 169c0222..28d68ad9 100644 --- a/AfterEffects/14.2/tsconfig.json +++ b/AfterEffects/14.2/tsconfig.json @@ -2,7 +2,8 @@ "compilerOptions": { "module": "none", "strict": true, - "noLib": true, + "noLib": false, + "lib": ["ES5"], "typeRoots": [] }, "exclude": ["node_modules"] diff --git a/AfterEffects/15.0/package.json b/AfterEffects/15.0/package.json new file mode 100644 index 00000000..ccb59dd5 --- /dev/null +++ b/AfterEffects/15.0/package.json @@ -0,0 +1,6 @@ +{ + "name": "types-for-adobe/AfterEffects/15.0", + "version": "1.0.0", + "main": "index.d.ts", + "types": "index.d.ts" +} diff --git a/AfterEffects/15.0/tsconfig.json b/AfterEffects/15.0/tsconfig.json index 169c0222..28d68ad9 100644 --- a/AfterEffects/15.0/tsconfig.json +++ b/AfterEffects/15.0/tsconfig.json @@ -2,7 +2,8 @@ "compilerOptions": { "module": "none", "strict": true, - "noLib": true, + "noLib": false, + "lib": ["ES5"], "typeRoots": [] }, "exclude": ["node_modules"] diff --git a/AfterEffects/16.0/package.json b/AfterEffects/16.0/package.json new file mode 100644 index 00000000..885bbf3a --- /dev/null +++ b/AfterEffects/16.0/package.json @@ -0,0 +1,6 @@ +{ + "name": "types-for-adobe/AfterEffects/16.0", + "version": "1.0.0", + "main": "index.d.ts", + "types": "index.d.ts" +} diff --git a/AfterEffects/16.0/tsconfig.json b/AfterEffects/16.0/tsconfig.json index 169c0222..28d68ad9 100644 --- a/AfterEffects/16.0/tsconfig.json +++ b/AfterEffects/16.0/tsconfig.json @@ -2,7 +2,8 @@ "compilerOptions": { "module": "none", "strict": true, - "noLib": true, + "noLib": false, + "lib": ["ES5"], "typeRoots": [] }, "exclude": ["node_modules"] diff --git a/AfterEffects/16.1/package.json b/AfterEffects/16.1/package.json new file mode 100644 index 00000000..cd396ebe --- /dev/null +++ b/AfterEffects/16.1/package.json @@ -0,0 +1,6 @@ +{ + "name": "types-for-adobe/AfterEffects/16.1", + "version": "1.0.0", + "main": "index.d.ts", + "types": "index.d.ts" +} diff --git a/AfterEffects/16.1/tsconfig.json b/AfterEffects/16.1/tsconfig.json index 169c0222..28d68ad9 100644 --- a/AfterEffects/16.1/tsconfig.json +++ b/AfterEffects/16.1/tsconfig.json @@ -2,7 +2,8 @@ "compilerOptions": { "module": "none", "strict": true, - "noLib": true, + "noLib": false, + "lib": ["ES5"], "typeRoots": [] }, "exclude": ["node_modules"] diff --git a/AfterEffects/17.0/package.json b/AfterEffects/17.0/package.json new file mode 100644 index 00000000..7daca547 --- /dev/null +++ b/AfterEffects/17.0/package.json @@ -0,0 +1,6 @@ +{ + "name": "types-for-adobe/AfterEffects/17.0", + "version": "1.0.0", + "main": "index.d.ts", + "types": "index.d.ts" +} diff --git a/AfterEffects/17.0/tsconfig.json b/AfterEffects/17.0/tsconfig.json index 169c0222..28d68ad9 100644 --- a/AfterEffects/17.0/tsconfig.json +++ b/AfterEffects/17.0/tsconfig.json @@ -2,7 +2,8 @@ "compilerOptions": { "module": "none", "strict": true, - "noLib": true, + "noLib": false, + "lib": ["ES5"], "typeRoots": [] }, "exclude": ["node_modules"] diff --git a/AfterEffects/17.1/package.json b/AfterEffects/17.1/package.json new file mode 100644 index 00000000..8c8cd00c --- /dev/null +++ b/AfterEffects/17.1/package.json @@ -0,0 +1,6 @@ +{ + "name": "types-for-adobe/AfterEffects/17.1", + "version": "1.0.0", + "main": "index.d.ts", + "types": "index.d.ts" +} diff --git a/AfterEffects/17.1/tsconfig.json b/AfterEffects/17.1/tsconfig.json index 169c0222..28d68ad9 100644 --- a/AfterEffects/17.1/tsconfig.json +++ b/AfterEffects/17.1/tsconfig.json @@ -2,7 +2,8 @@ "compilerOptions": { "module": "none", "strict": true, - "noLib": true, + "noLib": false, + "lib": ["ES5"], "typeRoots": [] }, "exclude": ["node_modules"] diff --git a/AfterEffects/18.0/package.json b/AfterEffects/18.0/package.json new file mode 100644 index 00000000..41854509 --- /dev/null +++ b/AfterEffects/18.0/package.json @@ -0,0 +1,6 @@ +{ + "name": "types-for-adobe/AfterEffects/18.0", + "version": "1.0.0", + "main": "index.d.ts", + "types": "index.d.ts" +} diff --git a/AfterEffects/18.0/tsconfig.json b/AfterEffects/18.0/tsconfig.json index 169c0222..28d68ad9 100644 --- a/AfterEffects/18.0/tsconfig.json +++ b/AfterEffects/18.0/tsconfig.json @@ -2,7 +2,8 @@ "compilerOptions": { "module": "none", "strict": true, - "noLib": true, + "noLib": false, + "lib": ["ES5"], "typeRoots": [] }, "exclude": ["node_modules"] diff --git a/AfterEffects/8.0/package.json b/AfterEffects/8.0/package.json new file mode 100644 index 00000000..b7a4804f --- /dev/null +++ b/AfterEffects/8.0/package.json @@ -0,0 +1,6 @@ +{ + "name": "types-for-adobe/AfterEffects/8.0", + "version": "1.0.0", + "main": "index.d.ts", + "types": "index.d.ts" +} diff --git a/AfterEffects/8.0/tsconfig.json b/AfterEffects/8.0/tsconfig.json index 169c0222..28d68ad9 100644 --- a/AfterEffects/8.0/tsconfig.json +++ b/AfterEffects/8.0/tsconfig.json @@ -2,7 +2,8 @@ "compilerOptions": { "module": "none", "strict": true, - "noLib": true, + "noLib": false, + "lib": ["ES5"], "typeRoots": [] }, "exclude": ["node_modules"] diff --git a/AfterEffects/9.0/package.json b/AfterEffects/9.0/package.json new file mode 100644 index 00000000..bb77331f --- /dev/null +++ b/AfterEffects/9.0/package.json @@ -0,0 +1,6 @@ +{ + "name": "types-for-adobe/AfterEffects/9.0", + "version": "1.0.0", + "main": "index.d.ts", + "types": "index.d.ts" +} diff --git a/AfterEffects/9.0/tsconfig.json b/AfterEffects/9.0/tsconfig.json index 169c0222..28d68ad9 100644 --- a/AfterEffects/9.0/tsconfig.json +++ b/AfterEffects/9.0/tsconfig.json @@ -2,7 +2,8 @@ "compilerOptions": { "module": "none", "strict": true, - "noLib": true, + "noLib": false, + "lib": ["ES5"], "typeRoots": [] }, "exclude": ["node_modules"] diff --git a/Animate/2013/package.json b/Animate/2013/package.json new file mode 100644 index 00000000..6234b52b --- /dev/null +++ b/Animate/2013/package.json @@ -0,0 +1,6 @@ +{ + "name": "types-for-adobe/Animate/2013", + "version": "1.0.0", + "main": "index.d.ts", + "types": "index.d.ts" +} diff --git a/Animate/2013/tsconfig.json b/Animate/2013/tsconfig.json index 169c0222..28d68ad9 100644 --- a/Animate/2013/tsconfig.json +++ b/Animate/2013/tsconfig.json @@ -2,7 +2,8 @@ "compilerOptions": { "module": "none", "strict": true, - "noLib": true, + "noLib": false, + "lib": ["ES5"], "typeRoots": [] }, "exclude": ["node_modules"] diff --git a/Audition/2015.2/package.json b/Audition/2015.2/package.json new file mode 100644 index 00000000..7a22eb67 --- /dev/null +++ b/Audition/2015.2/package.json @@ -0,0 +1,6 @@ +{ + "name": "types-for-adobe/Audition/2015.2", + "version": "1.0.0", + "main": "index.d.ts", + "types": "index.d.ts" +} diff --git a/Audition/2015.2/tsconfig.json b/Audition/2015.2/tsconfig.json index 169c0222..28d68ad9 100644 --- a/Audition/2015.2/tsconfig.json +++ b/Audition/2015.2/tsconfig.json @@ -2,7 +2,8 @@ "compilerOptions": { "module": "none", "strict": true, - "noLib": true, + "noLib": false, + "lib": ["ES5"], "typeRoots": [] }, "exclude": ["node_modules"] diff --git a/Audition/2017/package.json b/Audition/2017/package.json new file mode 100644 index 00000000..7b62dcf9 --- /dev/null +++ b/Audition/2017/package.json @@ -0,0 +1,6 @@ +{ + "name": "types-for-adobe/Audition/2017", + "version": "1.0.0", + "main": "index.d.ts", + "types": "index.d.ts" +} diff --git a/Audition/2017/tsconfig.json b/Audition/2017/tsconfig.json index 169c0222..28d68ad9 100644 --- a/Audition/2017/tsconfig.json +++ b/Audition/2017/tsconfig.json @@ -2,7 +2,8 @@ "compilerOptions": { "module": "none", "strict": true, - "noLib": true, + "noLib": false, + "lib": ["ES5"], "typeRoots": [] }, "exclude": ["node_modules"] diff --git a/Audition/2018/package.json b/Audition/2018/package.json new file mode 100644 index 00000000..f99cbc5d --- /dev/null +++ b/Audition/2018/package.json @@ -0,0 +1,6 @@ +{ + "name": "types-for-adobe/Audition/2018", + "version": "1.0.0", + "main": "index.d.ts", + "types": "index.d.ts" +} diff --git a/Audition/2018/tsconfig.json b/Audition/2018/tsconfig.json index 169c0222..28d68ad9 100644 --- a/Audition/2018/tsconfig.json +++ b/Audition/2018/tsconfig.json @@ -2,7 +2,8 @@ "compilerOptions": { "module": "none", "strict": true, - "noLib": true, + "noLib": false, + "lib": ["ES5"], "typeRoots": [] }, "exclude": ["node_modules"] diff --git a/Illustrator/2015.3/package.json b/Illustrator/2015.3/package.json new file mode 100644 index 00000000..ae006fa1 --- /dev/null +++ b/Illustrator/2015.3/package.json @@ -0,0 +1,6 @@ +{ + "name": "types-for-adobe/Illustrator/2015.3", + "version": "1.0.0", + "main": "index.d.ts", + "types": "index.d.ts" +} diff --git a/Illustrator/2015.3/tsconfig.json b/Illustrator/2015.3/tsconfig.json index 169c0222..28d68ad9 100644 --- a/Illustrator/2015.3/tsconfig.json +++ b/Illustrator/2015.3/tsconfig.json @@ -2,7 +2,8 @@ "compilerOptions": { "module": "none", "strict": true, - "noLib": true, + "noLib": false, + "lib": ["ES5"], "typeRoots": [] }, "exclude": ["node_modules"] diff --git a/InDesign/2015.3/package.json b/InDesign/2015.3/package.json new file mode 100644 index 00000000..f3608174 --- /dev/null +++ b/InDesign/2015.3/package.json @@ -0,0 +1,6 @@ +{ + "name": "types-for-adobe/InDesign/2015.3", + "version": "1.0.0", + "main": "index.d.ts", + "types": "index.d.ts" +} diff --git a/InDesign/2015.3/tsconfig.json b/InDesign/2015.3/tsconfig.json index 33026c5d..82e568f1 100644 --- a/InDesign/2015.3/tsconfig.json +++ b/InDesign/2015.3/tsconfig.json @@ -2,7 +2,8 @@ "compilerOptions": { "module": "none", "strict": true, - "noLib": true, + "noLib": false, + "lib": ["ES5"], "typeRoots": [] }, "exclude": [ diff --git a/InDesign/2018/package.json b/InDesign/2018/package.json new file mode 100644 index 00000000..999d6e90 --- /dev/null +++ b/InDesign/2018/package.json @@ -0,0 +1,6 @@ +{ + "name": "types-for-adobe/InDesign/2018", + "version": "1.0.0", + "main": "index.d.ts", + "types": "index.d.ts" +} diff --git a/InDesign/2018/tsconfig.json b/InDesign/2018/tsconfig.json index 33026c5d..82e568f1 100644 --- a/InDesign/2018/tsconfig.json +++ b/InDesign/2018/tsconfig.json @@ -2,7 +2,8 @@ "compilerOptions": { "module": "none", "strict": true, - "noLib": true, + "noLib": false, + "lib": ["ES5"], "typeRoots": [] }, "exclude": [ diff --git a/JavaScript/index.d.ts b/JavaScript/index.d.ts new file mode 100644 index 00000000..4458eacc --- /dev/null +++ b/JavaScript/index.d.ts @@ -0,0 +1,1307 @@ +/// + +interface ObjectConstructor { + readonly prototype: Object + + /** + * Creates and returns a new object of a given type. + * @param what The object type. + */ + new(what: any): Object + (): any + (what: any): any + + /** + * Reports whether an object is still valid. + * @param what The object to check. + */ + isValid(what: Object): boolean +} +declare const Object: ObjectConstructor + +/** + * The base class of all JavaScript objects. + */ +interface Object { + /** + * Points to the constructor function that created this object. + * Note that this property is treated as an XML element in the XML class. + */ + readonly constructor: Function + + /** + * Points to the prototype object for this object. + * Note that this property is treated as an XML element in the XML class. + */ + readonly prototype: Object + + /** + * Retrieves and returns the Reflection object associated with this method or a property. + * Note that this property is treated as an XML element in the XML class. + */ + readonly reflect: Reflection + + /** + * Reports whether a given property is defined with an instance or within the prototype chain. + * @param name The name of the property to check. + */ + hasOwnProperty(name: string): boolean + + /** + * Checks whether the given object is a prototype of this object. + * @param what The object to check. + */ + isPrototypeOf(what: Object): boolean + + /** + * Reports whether a given property is enumerable. + * @param name The name of the property to check. + */ + propertyIsEnumerable(name: string): boolean + + /** + * Creates and returns a string representing this object, localized for the current locale. See toString(). + */ + toLocaleString(): string + + /** + * Creates and returns a string representation of this object. + * This function serializes the object, so that it can, for example, be passed between engines. Pass the returned string back to eval() to recreate the object. Works only with built-in classes. + */ + toSource(): string + + /** + * Creates and returns a string representing this object. + * Many objects (such as Date) override this method in favor of their own implementation. If an object has no string value and no user-defined toString() method, the default method returns [object type], where type is the object type or the name of the constructor function that created the object. + */ + toString(): string + + /** + * Removes the watch function of a property. + * @param name The name of the property to unwatch. + */ + unwatch(name: string): void + + /** + * Retrieves and returns the primitive value of this object. + * If the object has no primitive value, returns the object itself.Note that you rarely need to call this method yourself.The JavaScript interpreter automatically invokes it when encountering an object where a primitive value is expected. + */ + valueOf(): Object + + /** + * Adds a watch function to a property, which is called when the value changes. + * This function can accept, modify, or reject a new value that the user, application, or a script has attempted to place in a property. + * @param name The name of the property to watch. + * @param func The function to be called when the value of this property changes. This function must three arguments, and return as its result the value to be stored in the property. The arguments are: name: the name of the property that changes. oldValue: The old property value. newValue: The new property value that was specified. + */ + watch(name: string, func: Function): void +} + +interface ArrayConstructor { + readonly prototype: Array + + /** + * Creates and returns a new array. + * Takes any number of parameters, which become the elements of the array, or a single value which becomes the length of an empty array. Note that you cannot create a one-element array, as the single parameter value is interpreted as the length. Returns the new array. + * @param arrayLength If no other parameters are passed, the initial length of the empty array. Otherwise, the first element. + * @param values If there is more than one parameter, the array is initialized with the given parameters. + */ + new(arrayLength?: number): any[] + new (arrayLength: number): T[] + new (...values: T[]): T[] + (arrayLength?: number): any[] + (arrayLength: number): T[] + (...values: T[]): T[] +} +declare const Array: ArrayConstructor + +/** + * An array with integer indexing and a length property. + */ +interface Array { + [n: number]: T + + /** + * The length of the array + */ + length: number + + /** + * Returns a new array created by concatenating the given values to the end of the original array. + * The original array is unchanged.If an array is provided as a parameter to concat(), each of its elements are appended as separate array elements at the end of the new array.Returns a new array, the result of concatenation the given values to the end of the original array. + * @param values Any number of values to be added to the end of the array. Can also be arrays. + */ + concat(...values: T[][]): T[] + + /** + * Joins all elements of the array into a string; optionally, each element is separated by delimiter. + * Returns the string containing the joined elements and delimiters. + * @param delimiter A string used to separate each element of the array. If omitted, the array elements are separated with a comma. + */ + join(delimiter?: string): string + + /** + * Removes the last element from the array, decreases the length by 1, and returns the value of the element. + * Returns the value of the deleted array element. + */ + pop(): T | undefined + + /** + * Places one or more values onto the end of the array and increases length by n. + * Returns the new length of the array. + * @param values Any number of values to be pushed onto the end of the array. + */ + push(...values: T[]): number + + /** + * Reverses the order of the elements in the array. + * Returns the reversed array. + */ + reverse(): T[] + + /** + * Removes the first element from the array, decreases the length by 1, and returns the value of the element. + * Returns the value of the deleted array element. + */ + shift(): T | undefined + + /** + * Creates a new array, which contains a subset of the original array's elements. + * The slice begins with the index start, and continues up to, but not including the index, end.If start or end is a negative number, the indexed is resolved counting backwards from the end of the array resulting in the element array[array. length + negativeIndex]. Returns a new array containing elements array[start] through array[end-1]. + */ + slice(start?: number, end?: number): T[] + + /** + * Sorts the elements of the array in place, using the given function to compare to elements. + * If no function is provided, the elements are sorted alphabetically.Returns no return value. + * @param userFunction A user-supplied function of the form userFunction(a, b) which returns less than 0 if a is greater than b, 0 if a and b are equal, and greater than 0 if b is greater than a. + */ + sort(userFunction?: (a: T, b: T) => number): this + + /** + * Removes num elements from the array beginning with index, start. + * Optionally insert new elements beginning at index start.To ensure contiguity, elements are moved up to fill in any gaps.Returns a new array containing any elements deleted from the original array. + * @param start The index of the first element to remove. Negative values are relative to the end of the array. + * @param deleteCount The number of array elements to remove, including start. If omitted, all elements from array index start to the end of the array are removed. + * @param values A list of one or more values to be added to the array starting at index start. Must specify a value for num, to use this argument. + */ + splice(start: number, deleteCount?: number, ...values: T[]): T[] + + /** + * Converts an array to a string and returns the string (localized). + */ + toLocaleString(): string + + /** + * Creates a string representation of this object that can be fed back to eval() to re-create an object. Works only with built-in classes. + */ + toSource(): string + + /** + * Converts an array to a string and returns the string. + * Yields the same result as array. join() when called without a parameter.Returns a comma-separated list of all the elements of the array. + */ + toString(): string + + /** + * Adds one or more elements to the beginning of the array. + * Returns the new array length. + * @param values The values of one or more elements to be added to the beginning of the array. + */ + unshift(...values: T[]): number +} + +/** + * A global object containing a set of math functions and constants. + */ +interface Math { + /** + * Euler's constant and the base of natural logarithms. + */ + readonly E: number + + /** + * The natural logarithm of 10. + */ + readonly LN10: number + + /** + * The natural logarithm of 2. + */ + readonly LN2: number + + /** + * The base 10 logarithm of e. + */ + readonly LOG10E: number + + /** + * The base 2 logarithm of e. + */ + readonly LOG2E: number + + /** + * The ratio of the circumference of a circle to its diameter. + */ + readonly PI: number + + /** + * The reciprocal of the square root of 1/2. + */ + readonly SQRT1_2: number + + /** + * The square root of 2. + */ + readonly SQRT2: number + + /** + * Returns the absolute value of a number. + * @param x A number. + */ + abs(x: number): number + + /** + * Returns the arc cosine(in radians) of a number. + * @param x A number. + */ + acos(x: number): number + + /** + * Returns the arc sin(in radians) of a number. + * @param x A number. + */ + asin(x: number): number + + /** + * Returns the arc tangent(in radians) of a number. + * @param x A number. + */ + atan(x: number): number + + /** + * Returns the arc tangent of the quotient of its arguments (y/x). + * @param y A number. + * @param x A number. + */ + atan2(y: number, x: number): number + + /** + * Rounds the number up to the nearest integer. + * @param x A number. + */ + ceil(x: number): number + + /** + * Returns the cosine of an angle provided in radians. + * @param x An angle, in radians. + */ + cos(x: number): number + + /** + * Returns Math.E raised to the power of a number. + * @param x A number. + */ + exp(x: number): number + + /** + * Rounds a number down to the nearest integer. + * @param x A number. + */ + floor(x: number): number + + /** + * Returns the natural logarithm of a number. + * @param x A number. + */ + log(x: number): number + + /** + * Returns the largest of zero or more numbers. + * @param rest Numbers. + */ + max(...rest: number[]): number + + /** + * Returns the smallest of zero or more numbers. + * @param rest Numbers. + */ + min(...rest: number[]): number + + /** + * Returns x raised to the power of y. + * @param x Numbers. + * @param y + */ + pow(x: number, y: number): number + + /** + * Returns a pseudo-random number from 0.0 up to but not including 1.0. + */ + random(): number + + /** + * Rounds a number to the nearest integer. + * @param x A number. + */ + round(x: number): number + + /** + * Returns the sine of an angle provided in radians. + * @param x An angle, in radians. + */ + sin(x: number): number + + /** + * Returns the square root of a number. + * @param x A number. + */ + sqrt(x: number): number + + /** + * Returns the tangent of an angle provided in radians. + * @param x An angle, in radians. + */ + tan(x: number): number +} +declare const Math: Math + +interface DateConstructor { + readonly prototype: Date + + /** + * Returns a new Date object holding the current date and time. + * If parameters are supplied, returns a new Date object holding the supplied date and time. + * @param year The year expressed in four digits. + * @param month An integer value from 0 (Jan) to 11 (Dec). + * @param day An integer value from 1 to 31, If this argument is not supplied, its value is set to 0. + * @param hours An integer value from 0 (midnight) to 23 (11 PM). If this argument is not supplied, its value is set to 0. + * @param min An integer value from 0 to 59. If this argument is not supplied, its value is set to 0. + * @param sec An Integer value from 0 to 59. If this argument is not supplied, its value is set to 0. + * @param ms An integer value from 0 to 999. If this argument is not supplied, its value is set to 0. + */ + new(): Date + new(value: number): Date + new(value: string): Date + new( + year: number, + month: number, + day?: number, + hours?: number, + min?: number, + sec?: number, + ms?: number, + ): Date + + /** + * Parses a string, returning a new Date object. The string should be similar to the string returned bt toString(). + * @param text The string to parse. + */ + parse(text: string): Date + + /** + * Returns the number of milliseconds between midnight January 1, 1970, UTC, and the specified time. + * @param year The year expressed in four digits, for example, 2001. To indicate for a year from 1900 to 1999, you can specify a value from 0 to 99. + * @param month An integer value from 0 (Jan) to 11 (Dec). + * @param day An integer value from 1 to 31, If this argument is not supplied, its value is set to 0. + * @param hours An integer value from 0 (midnight) to 23 (11 PM). If this argument is not supplied, its value is set to 0. + * @param min An integer value from 0 to 59. If this argument is not supplied, its value is set to 0. + * @param sec An Integer value from 0 to 59. If this argument is not supplied, its value is set to 0. + * @param ms An integer value from 0 to 999. If this argument is not supplied, its value is set to 0. + */ + UTC( + year: number, + month?: number, + day?: number, + hours?: number, + min?: number, + sec?: number, + ms?: number, + ): Date +} +declare const Date: DateConstructor + +/** + * A date/time object. + */ +interface Date { + /** + * Returns the day of the month of the specified Date object in local time. + */ + getDate(): number + + /** + * Returns the day of the week for the specified Date object in local time. + * This is an integer from 0 (Sunday) to 6 (Saturday).Returns the day of the week for date. + */ + getDay(): number + + /** + * Returns the four digit year of the specified Date object in local time. + */ + getFullYear(): number + + /** + * Returns the hour of the specified Date object in local time. + */ + getHours(): number + + /** + * Returns the milliseconds of the specified Date object in local time. + */ + getMilliseconds(): number + + /** + * Returns the minutes of the specified Date object in local time. + */ + getMinutes(): number + + /** + * Returns the month of the specified Date object in local time. + */ + getMonth(): number + + /** + * Returns the seconds of the specified Date object in local time. + */ + getSeconds(): number + + /** + * Returns the number of milliseconds since midnight January 1,1970 UTC for the specified Date object. + */ + getTime(): number + + /** + * Returns the difference in minutes between the computer's local time and UTC. + */ + getTimezoneOffset(): number + + /** + * Returns the day of the month of the specified Date object according to UTC. + */ + getUTCDate(): number + + /** + * Returns the day of the week for the specified Date object according to UTC. + */ + getUTCDay(): number + + /** + * Returns the four digit year of the specified Date object according to UTC. + */ + getUTCFullYear(): number + + /** + * Returns the hour of the specified Date object according to UTC. + */ + getUTCHours(): number + + /** + * Returns the milliseconds of the specified Date object according to UTC. + */ + getUTCMilliseconds(): number + + /** + * Returns the minutes of the specified Date object according to UTC. + */ + getUTCMinutes(): number + + /** + * Returns the month of the specified Date object according to UTC. + */ + getUTCMonth(): number + + /** + * Returns the seconds of the specified Date object according to UTC. + */ + getUTCSeconds(): number + + /** + * Returns the year of the specified Date object, as a difference from 1900, in local time. + */ + getYear(): number + + /** + * Sets the day of the month of a specified Date object according to local time. + * Returns the number of milliseconds between the new date and midnight, January 1, 1970. + * @param date An integer from 1 to 31 indicating the day of the month. + */ + setDate(date: number): number + + /** + * Sets the year of a specified Date object according to local time. + * This method can also set month and date if those arguments are specified. Returns the number of milliseconds between the new date and midnight, January 1, 1970. + * @param year A four-digit integer value indicating the year to set. + */ + setFullYear(year: number): number + + /** + * Sets the hours of a specified Date object according to local time. + * Returns the number of milliseconds between the new date and midnight, January 1, 1970. + * @param hour An integer value from 0 (midnight) to 23 (11 PM). + */ + setHours(hour: number): number + + /** + * Sets the milliseconds of a specified Date object according to local time. + * Returns the number of milliseconds between the new date and midnight, January 1, 1970. + * @param ms An integer value from 0 to 999. + */ + setMilliseconds(ms: number): number + + /** + * Sets the minutes of a specified Date object according to local time. + * Returns the number of milliseconds between the new date and midnight, January 1, 1970. + * @param minutes An integer value from 0 to 59. + */ + setMinutes(minutes: number): number + + /** + * Sets the month of a specified Date object according to local time. + * Returns the number of milliseconds between the new date and midnight, January 1, 1970. + * @param month An integer value from 0 (Jan) to 11 (Dec). + */ + setMonth(month: number): number + + /** + * Sets the seconds of a specified Date object according to local time. + * Returns the number of milliseconds between the new date and midnight, January 1, 1970. + * @param seconds An integer value from 0 to 59. + */ + setSeconds(seconds: number): number + + /** + * Sets the date of a specified Date object in milliseconds since midnight, January 1, 1970. + * Returns the value of ms. + * @param ms An integer indicating the number of milliseconds between the date set and midnight, January 1, 1970. + */ + setTime(ms: number): number + + /** + * Sets the date of a specified Date object according to universal time. + * Returns the number of milliseconds between the new date and midnight, January 1, 1970 in UTC time. + * @param date An integer from 1 to 31 indicating the day of the month. + */ + setUTCDate(date: number): number + + /** + * Sets the year of a specified Date object according to UTC, can also set the month and date. + * Returns the number of milliseconds between the date set and midnight, January 1, 1970, in UTC. + * @param year The year expressed in four digits. + */ + setUTCFullYear(year: number): number + + /** + * Sets the hours of a specified Date object according to UTC. + * Returns the number of milliseconds between the date set and midnight, January 1, 1970, in UTC. + * @param hours An integer value from 0 (midnight) to 23 (11 PM) indicating the hour to be set. + */ + setUTCHours(hours: number): number + + /** + * Sets the milliseconds of a specified Date object according to UTC. + * Returns the number of milliseconds between the date set and midnight, January 1, 1970, in UTC. + * @param ms An integer value in the range of 0 to 999 indicating the number of milliseconds to set. + */ + setUTCMilliseconds(ms: number): number + + /** + * Sets the minutes of a specified Date object according to UTC. + * Returns the number of milliseconds between the date set and midnight, January 1, 1970, in UTC. + * @param min An integer value in the range 0 to 59 indicating the number of minutes to be set. + */ + setUTCMinutes(min: number): number + + /** + * Sets the month of a specified Date object according to UTC. + * Returns the number of milliseconds between the date set and midnight, January 1, 1970, in UTC. + * @param month An integer value in the range 0 (Jan.) to 11 (Dec.) indicating the month to set. + */ + setUTCMonth(month: number): number + + /** + * Sets the seconds of a specified Date object according to UTC. + * Returns the number of milliseconds between the date set and midnight, January 1, 1970, in UTC. + * @param sec An integer value in the range 0 to 59 indicating the number of seconds to set. + */ + setUTCSeconds(sec: number): number + + /** + * Sets the year of a specified Date object according to local time, as a difference between the current year and 1900. + * Returns the number of milliseconds between the date set and midnight, January 1, 1970. + * @param year An integer value indicating the year to set. The method interprets a 1- or 2- digit value to mean the 1900s; for example, 13 is interpreted to mean 1913. + */ + setYear(year: number): number + + /** + * Returns the date as a string. + */ + toDateString(): string + + /** + * Returns the date and time adjusted to GMT (UTC) as a string. + */ + toGMTString(): string + + /** + * Returns the date as a localized string. + */ + toLocaleDateString(): string + + /** + * Returns a string value representing the date and time stored in the Date object in human readable format (localized). + */ + toLocaleString(): string + + /** + * Returns the time as a localized string. + */ + toLocaleTimeString(): string + + /** + * Creates a string representation of this object that can be fed back to eval() to re-create an object. Works only with built-in classes. + */ + toSource(): string + + /** + * Returns a string value representing the date and time stored in the Date object in human readable format. + * Returns the following string is an example of the format returned by this method: Mon Aug 13, 10:54:21 GMT-0700 2001. + */ + toString(): string + + /** + * Returns the time as a string. + */ + toTimeString(): string + + /** + * Returns the date and time adjusted to UTC as a string. + */ + toUTCString(): string + + /** + * The valueOf() method returns the number of milliseconds that have passed since midnight, Returns an integer. + */ + valueOf(): number +} + +interface FunctionConstructor { + readonly prototype: Function + + /** + * The Function constructor parses the argument list and creates a Function object. + * @param arguments The list of formal arguments, separated by commas. The formal arguments can also be supplied one by one; in this case, the last argument to the Function constructor is considered to be the function body. + * @param body The body of the function to create. + */ + new(arguments: string, body: string): Function + (arguments: string, body: string): Function +} +declare const Function: FunctionConstructor + +/** + * Wraps a built-in or JavaScript function. + */ +interface Function { + /** + * The function arguments, packed into an array. + * This property is deprecated; use the arguments property within the function body. + */ + arguments: object + + /** + * The number of formal arguments. + * This property is deprecated; use the length property instead. + */ + readonly arity: number + + /** + * The number of formal arguments. + */ + readonly length: number + + /** + * The function name. + */ + readonly name: string + + /** + * Apply a this object and an argument list to a function. + * This function is different from call(); here, the arguments are suppliedas an Array object. + * @param thisObj The object to be used as this. + * @param args An array of arguments. + */ + apply(thisObj: object, args: any): any + + /** + * Apply a this object and arguments to a function. + * This function is different from apply(); here, the arguments are supplied one by one. + * @param thisObj The object to be used as this. + * @param arguments The first agument to the function. Add as many as needed. + */ + call(thisObj: object, ...arguments: any[]): any + + /** + * Creates a string representation of this object that can be fed back to eval() to re-create an object. Works only with JavaScript functions. + */ + toSource(): string + + /** + * Returns the function definition as a string. + */ + toString(): string +} + +interface StringConstructor { + readonly prototype: String + + /** + * Returns a string representation of the value given as an argument. + * @param value A number, variable, or object to convert to a string. + */ + new(value?: any): String + (value: any): string + + /** + * Returns a string created by concatenation one or more characters specified as ASCII values. + * @param value1 One or more ASCII values. + */ + fromCharCode(value1: number): string +} +declare const String: StringConstructor + +/** + * A character string. Each character is adressable by index. + */ +interface String { + /** + * The length of the string. + */ + readonly length: number + + /** + * Get character at index. + */ + readonly [index: number]: string + + /** + * Returns a string consisting of this string enclosed in a tag. + * @param name The text to be stored in the anchors' name attribute. + */ + anchor(name: string): string + + /** + * Returns a string consisting of this string enclosed in a tag. + */ + big(): string + + /** + * Returns a string consisting of this string enclosed in a tag. + */ + blink(): string + + /** + * Returns a string consisting of this string enclosed in a tag. + */ + bold(): string + + /** + * Returns the character at the specified index. + * @param index An integer between 0 and string.length -1, specifying the character to return. + */ + charAt(index: number): string + + /** + * Returns the Unicode value of the character at the given index. + * @param index An integer between 0 and string.length -1, specifying the character. + */ + charCodeAt(index: number): number + + /** + * If necessary, converts the one or more given values to strings. + * Those values are concatenated with the original string, the result is returned. The original string is not effected.Returns the concatenated string. + * @param value The values to be concatenated with the given string. + */ + concat(value: string): string + + /** + * Returns a string consisting of this string enclosed in a tag. + */ + fixed(): string + + /** + * Returns a string consisting of this string enclosed in a tag. + * @param color The value to be stored in the tag's color attribute. + */ + fontcolor(color: string): string + + /** + * Returns a string consisting of this string enclosed in a tag. + * @param size The value to be stored in the tag's size attribute. + */ + fontsize(size: number): string + + /** + * Returns the index within the string of the first occurrence of the specified string, starting the search at fromIndex if provided. + * @param searchValue The string for which to search. + * @param offset The starting offset of the search. + */ + indexOf(searchValue: string, offset?: number): number + + /** + * Returns a string consisting of this string enclosed in a tag. + */ + italics(): string + + /** + * Returns the index within the string of the last occurrence of the specified value. + * The string is searched backward, starting at fromIndex.Returns the index within the string where the last occurrence of searchValue was found, or -1 if it was not found. + * @param searchValue The string for which to search. + * @param offset The starting offset of the search. + */ + lastIndexOf(searchValue: string, offset?: number): number + + /** + * Returns a string consisting of this string enclosed in a tag. + * @param href The value to be stored in the tag's href attribute. + */ + link(href: string): string + + /** + * Performs a localized comparison of two strings. + * @param what The string to compare with. + */ + localeCompare(what: string): number + + /** + * Matches a string against a regular expression. + * @param regexp The regular expression to use. + */ + match(regexp: RegExp | string): RegExpMatchArray | null + + /** + * + * @param what + * @param with_ + */ + replace(what: any, with_: string): string + + /** + * + * @param search + */ + search(search: RegExp): number + + /** + * Extracts a substring of the given string and returns it as a new string. + * The substring begins at startSlice, and includes all characters up to, but not including the character at the index endSlice. A negative value indexes from the end of the string.For example, a negative value for startSlice is resolved as: string. length + startSlice.The original string is unchanged.Returns a substring of characters from the given string, starting at startSlice and ending with endSlice-1. + * @param startSlice The index at which to begin extraction. + * @param endSlice The index at which to end extraction. If omitted, slice extracts to the end of the string. + */ + slice(startSlice: number, endSlice?: number): string + + /** + * Returns a string consisting of this string enclosed in a tag. + */ + small(): string + + /** + * Splits a string into a group of substrings, places those strings in an array, and returns the array. + * The substrings are created by breaking the original string at places that match delimiter, the delimiter characters are removed.Returns an array whose elements are the substrings. + * @param delimiter Specifies the string to use for delimiting. If delimiter is omitted, the array returned contains one element, consisting of the entire string. + * @param limit + */ + split(delimiter: string, limit?: number): string[] + + /** + * Returns a string consisting of this string enclosed in a tag. + */ + strike(): string + + /** + * Returns a string consisting of this string enclosed in a tag. + */ + sub(): string + + /** + * Returns a string containing the characters beginning at the specified index, start, through the specified number of characters. + * The original string is unchanged.Returns a string containing the extracted characters. + * @param start Location at which to begin extracting characters. + * @param length The number of characters to extract. + */ + substr(start: number, length?: number): string + + /** + * Returns a substring of the given string by extracting characters from indexA up to but not including indexB. + * The original string is unchanged.Returns a substring of characters from the given string, starting at indexA and ending with indexB-1. + * @param indexA The index to begin extracting. + * @param indexB The index at which to end extraction. If omitted, slice extracts to the end of the string. + */ + substring(indexA: number, indexB?: number): string + + /** + * Returns a string consisting of this string enclosed in a tag. + */ + sup(): string + + /** + * Returns a new string which contains all the characters of the original string converted to lowercase (localized). + * The original string is unchanged. + */ + toLocaleLowerCase(): string + + /** + * Returns a new string which contains all the characters of the original string converted to uppercase (localized). + * The original string is unchanged. + */ + toLocaleUpperCase(): string + + /** + * Returns a new string which contains all the characters of the original string converted to lowercase. + * The original string is unchanged. + */ + toLowerCase(): string + + /** + * Creates a string representation of this object that can be fed back to eval() to re-create an object. Works only with built-in classes. + */ + toSource(): string + + /** + * Returns itself. + */ + toString(): string + + /** + * Returns a new string which contains all the characters of the original string converted to uppercase. + * The original string is unchanged. + */ + toUpperCase(): string + + /** + * The valueOf() method returns the number of milliseconds that have passed since midnight, Returns an integer. + */ + valueOf(): string +} + +interface NumberConstructor { + readonly prototype: Number + + /** + * Returns a new Number object set to the value of the argument converted to a number. + * @param value The value of the object being created. + */ + new(value?: any): Number + (value: any): number + + /** + * A constant representing the largest representable number. + */ + readonly MAX_VALUE: number + + /** + * A constant representing the smallest representable number. + */ + readonly MIN_VALUE: number + + /** + * A constant representing negative infinity. + */ + readonly NEGATIVE_INFINITY: number + + /** + * A constant representing the special "Not a Number" value. + */ + readonly NaN: number + + /** + * A constant representing positive infinity. + */ + readonly POSITIVE_INFINITY: number +} +declare const Number: NumberConstructor + +/** + * Wraps a numeric value. + */ +interface Number { + /** + * Converts the Number object to a string in scientific notation. + * @param decimals The number of decimals. + */ + toExponential(decimals: number): string + + /** + * Converts the Number object to a string with fixed decimals. + * @param decimals The number of decimals. + */ + toFixed(decimals: number): string + + /** + * Returns the value of a Number object converted to a string, using localized conventions. + */ + toLocaleString(): string + + /** + * Converts the Number object to a string in either scientific or fixed notation, epending on its value. + * @param decimals The number of decimals. + */ + toPrecision(decimals: number): string + + /** + * Creates a string representation of this object that can be fed back to eval() to re-create an object. Works only with built-in classes. + */ + toSource(): string + + /** + * Returns the value of a Number object converted to a string. + * @param radix The optional conversion radix. + */ + toString(radix?: number): string + + /** + * Returns the value of a Number object as a primitive number. + */ + valueOf(): number +} + +interface BooleanConstructor { + readonly prototype: Boolean + + /** + * Creates and returns a new Boolean object set to the value of the argument converted to a boolean. + * @param value The value to be converted to a Boolean. + */ + new(value?: any): Boolean + (value: any): boolean +} +declare const Boolean: BooleanConstructor + +/** + * Wraps a Boolean value. + */ +interface Boolean { + /** + * Creates a string representation of this object that can be fed back to eval() to re-create an object. Works only with built-in classes. + */ + toSource(): string + + /** + * Returns the string representation of the value of bool. + * The method returns the string true if the primitive value of bool is true; otherwise it returns the string false. + */ + toString(): string + + /** + * Returns the primitive value of bool. + * The method returns true if the primitive value of bool is true; otherwise it returns false. + */ + valueOf(): boolean +} + +interface RegExpConstructor { + readonly prototype: RegExp + + /** + * Creates and returns a new RegExp object set to the value of the argument converted to a regular expression. + * @param pattern The pattern to convert. + * @param flags Flags that control how the conversion is performed. A string containing any combination of the letters i, m, g: "i" -- ignore case in pattern matching "m" -- treat the string as multiple lines "g" -- do global pattern matching + */ + new(pattern: string | RegExp, flags?: string): RegExp + (pattern: string | RegExp, flags?: string): RegExp + + /** + * The matched subexpression #1. + */ + readonly $1: string + + /** + * The matched subexpression #2. + */ + readonly $2: string + + /** + * The matched subexpression #3. + */ + readonly $3: string + + /** + * The matched subexpression #4. + */ + readonly $4: string + + /** + * The matched subexpression #5. + */ + readonly $5: string + + /** + * The matched subexpression #6. + */ + readonly $6: string + + /** + * The matched subexpression #7. + */ + readonly $7: string + + /** + * The matched subexpression #8. + */ + readonly $8: string + + /** + * The matched subexpression #9. + */ + readonly $9: string + + /** + * Indicates whether the match is a global match. + */ + global: boolean + + /** + * Indicates whether the match is not case sensitive. + */ + ignoreCase: boolean + + /** + * The original input string. + */ + input: string + + /** + * The last match. + */ + readonly lastMatch: string + + /** + * The value of the last matched subexpression. + */ + readonly lastParen: string + + /** + * The string before the match. + */ + readonly leftContext: string + + /** + * Indicates whether the match matches multiple lines. + */ + multiline: boolean + + /** + * The string after the match. + */ + readonly rightContext: string +} +declare const RegExp: RegExpConstructor + +/** + * Wraps a regular expression. + */ +interface RegExp { + /** + * Compiles a string to a regular expression. Returns true if the compilation was successful. + * @param pattern The pattern to compile. + */ + compile(pattern: string): boolean + + /** + * Execute a regular expression. + * The return value is an array of matches, with the first element containing the match, and successive elements containing the results of any matching subexpression in their order of appearance. If there is no match, the result is null. + * @param text The string to match. + */ + exec(text: string): RegExpExecArray | null + + /** + * Execute a regular expression, and return true if there is a match. + * @param text The string to match. + */ + test(text: string): boolean + + /** + * Converts this RegExp object to a string. + */ + toString(): string +} + +interface RegExpMatchArray extends Array { + index?: number + input?: string +} + +interface RegExpExecArray extends Array { + index: number + input: string +} + +interface ErrorConstructor { + readonly prototype: Error + + /** + * Creates a new Error object. + * @param msg The error message. + * @param file The name of the file. + * @param line The line number. + */ + new(msg: string, file?: string, line?: number): Error + (msg: string, file?: string, line?: number): Error +} +declare const Error: ErrorConstructor + +/** + * Wraps a runtime error. + */ +interface Error { + /** + * The error message. + */ + description: string + + /** + * Creates a string representation of this object that can be fed back to eval() to re-create an object. Works only with built-in classes. + */ + toSource(): string + + /** + * Convert this object to a string. + */ + toString(): string +} + +/** + * Only for TypeScript compatibility + */ +interface CallableFunction extends Function { + +} + +interface NewableFunction extends Function { + +} + +interface IArguments { + [index: number]: any + length: number + callee: Function +} + +/** + * Make all properties in T optional + */ +type Partial = { [P in keyof T]?: T[P] } + +/** + * Make all properties in T readonly + */ +type Readonly = { readonly [P in keyof T]: T[P] } + +/** + * From T pick a set of properties K + */ +type Pick = { [P in K]: T[P] } + +/** + * Construct a type with a set of properties K of type T + */ +type Record = { [P in K]: T } diff --git a/JavaScript/package.json b/JavaScript/package.json new file mode 100644 index 00000000..8b458ce7 --- /dev/null +++ b/JavaScript/package.json @@ -0,0 +1,6 @@ +{ + "name": "types-for-adobe/JavaScript", + "version": "1.0.0", + "main": "index.d.ts", + "types": "index.d.ts" +} \ No newline at end of file diff --git a/JavaScript/tsconfig.json b/JavaScript/tsconfig.json new file mode 100644 index 00000000..6069b809 --- /dev/null +++ b/JavaScript/tsconfig.json @@ -0,0 +1,11 @@ +{ + "compilerOptions": { + "module": "none", + "strict": true, + "noLib": true, + "typeRoots": [] + }, + "exclude": [ + "node_modules" + ] +} \ No newline at end of file diff --git a/Photoshop/2015.5/package.json b/Photoshop/2015.5/package.json new file mode 100644 index 00000000..71d49e96 --- /dev/null +++ b/Photoshop/2015.5/package.json @@ -0,0 +1,6 @@ +{ + "name": "types-for-adobe/Photoshop/2015.5", + "version": "1.0.0", + "main": "index.d.ts", + "types": "index.d.ts" +} diff --git a/Photoshop/2015.5/tsconfig.json b/Photoshop/2015.5/tsconfig.json index 169c0222..28d68ad9 100644 --- a/Photoshop/2015.5/tsconfig.json +++ b/Photoshop/2015.5/tsconfig.json @@ -2,7 +2,8 @@ "compilerOptions": { "module": "none", "strict": true, - "noLib": true, + "noLib": false, + "lib": ["ES5"], "typeRoots": [] }, "exclude": ["node_modules"] diff --git a/shared/PlugPlugExternalObject.d.ts b/PlugPlugExternalObject/index.d.ts similarity index 94% rename from shared/PlugPlugExternalObject.d.ts rename to PlugPlugExternalObject/index.d.ts index 8138887d..36077df4 100644 --- a/shared/PlugPlugExternalObject.d.ts +++ b/PlugPlugExternalObject/index.d.ts @@ -1,12 +1,10 @@ -/// - interface ExternalObjectConstructor { readonly prototype: ExternalObject /** * Creates a new ExternalObject object. */ - new (lib: string): ExternalObject + new(lib: string): ExternalObject (lib: string): ExternalObject } declare const ExternalObject: ExternalObjectConstructor @@ -53,7 +51,7 @@ interface CSXSEventConstructor { /** * Creates a new CSXSEvent object. */ - new (type?: string, scope?: string, data?: string): CSXSEvent + new(type?: string, scope?: string, data?: string): CSXSEvent (type?: string, scope?: string, data?: string): CSXSEvent } declare const CSXSEvent: CSXSEventConstructor diff --git a/PlugPlugExternalObject/package.json b/PlugPlugExternalObject/package.json new file mode 100644 index 00000000..587f31bf --- /dev/null +++ b/PlugPlugExternalObject/package.json @@ -0,0 +1,6 @@ +{ + "name": "types-for-adobe/PlugPlugExternalObject", + "version": "1.0.0", + "main": "index.d.ts", + "types": "index.d.ts" +} \ No newline at end of file diff --git a/PlugPlugExternalObject/tsconfig.json b/PlugPlugExternalObject/tsconfig.json new file mode 100644 index 00000000..6f7f3f97 --- /dev/null +++ b/PlugPlugExternalObject/tsconfig.json @@ -0,0 +1,12 @@ +{ + "compilerOptions": { + "module": "none", + "strict": true, + "noLib": false, + "lib": ["ES5"], + "typeRoots": [] + }, + "exclude": [ + "node_modules" + ] +} \ No newline at end of file diff --git a/Premiere/2018/package.json b/Premiere/2018/package.json new file mode 100644 index 00000000..2ada5ebd --- /dev/null +++ b/Premiere/2018/package.json @@ -0,0 +1,6 @@ +{ + "name": "types-for-adobe/Premiere/2018", + "version": "1.0.0", + "main": "index.d.ts", + "types": "index.d.ts" +} diff --git a/Premiere/2018/tsconfig.json b/Premiere/2018/tsconfig.json index 169c0222..28d68ad9 100644 --- a/Premiere/2018/tsconfig.json +++ b/Premiere/2018/tsconfig.json @@ -2,7 +2,8 @@ "compilerOptions": { "module": "none", "strict": true, - "noLib": true, + "noLib": false, + "lib": ["ES5"], "typeRoots": [] }, "exclude": ["node_modules"] diff --git a/README.md b/README.md index 755365fa..888bac42 100644 --- a/README.md +++ b/README.md @@ -26,10 +26,13 @@ npm init -y npm i types-for-adobe # create tsconfig.json -printf '{"compilerOptions":{"module":"none","noLib":true}}' > tsconfig.json +printf '{"compilerOptions":{"module":"none","noLib": true, "types": ["types-for-adobe/JavaScript", "types-for-adobe/PlugPlugExternalObject", "types-for-adobe/Illustrator/2015.3"],}}' > tsconfig.json -# create index.ts and change reference types to Adobe product you're targeting -printf '/// \nalert(String(app));\n' > index.ts +# optionally, use the ES5 lib from TypeScript (note: you have to do the shimming yourself, this is more unsafe! +# printf '{"compilerOptions":{"module":"none","lib": ["ES5"], "types": ["types-for-adobe/Illustrator/2015.3", "types-for-adobe/PlugPlugExternalObject"],}}' > tsconfig.json + +# create index.ts and write typed code! +printf 'alert(String(app));\n' > index.ts # compile typescript files tsc diff --git a/_bin/test.sh b/_bin/test.sh index 4fe4a831..341cdda6 100755 --- a/_bin/test.sh +++ b/_bin/test.sh @@ -7,19 +7,20 @@ set -e set -u # To show what we are doing. -set -x +# set -x # To be always in project root. cd "${0%/*}/.." # To test if everything compiles. -tsc --pretty --noEmit -p ./AfterEffects/17.1 -tsc --pretty --noEmit -p ./Animate/2013 -tsc --pretty --noEmit -p ./Audition/2015.2 -tsc --pretty --noEmit -p ./Audition/2017 -tsc --pretty --noEmit -p ./Audition/2018 -tsc --pretty --noEmit -p ./Illustrator/2015.3 -tsc --pretty --noEmit -p ./InDesign/2015.3 -tsc --pretty --noEmit -p ./InDesign/2018 -tsc --pretty --noEmit -p ./Photoshop/2015.5 -tsc --pretty --noEmit -p ./Premiere/2018 +for app in AfterEffects Animate Audition Illustrator InDesign Photoshop Premiere; do + for version in `ls $app`; do + echo "Testing $app/$version" + tsc --pretty --noEmit -p ./$app/$version + done +done + +echo "Testing PlugPlugExternalObject" +tsc --pretty --noEmit -p ./PlugPlugExternalObject +echo "Testing JavaScript" +tsc --pretty --noEmit -p ./JavaScript diff --git a/package.json b/package.json index 4fe6814e..e74fe536 100644 --- a/package.json +++ b/package.json @@ -7,7 +7,9 @@ "Audition", "InDesign", "Illustrator", + "JavaScript", "Photoshop", + "PlugPlugExternalObject", "Premiere", "shared" ], diff --git a/shared/JavaScript.d.ts b/shared/JavaScript.d.ts deleted file mode 100644 index 59b28b80..00000000 --- a/shared/JavaScript.d.ts +++ /dev/null @@ -1,2708 +0,0 @@ -/** - * The $ object provides a number of debugging facilities and informational methods. - */ -interface $ { - /** - * The ExtendScript build information. - */ - readonly build: string - - /** - * The ExtendScript build date. - */ - readonly buildDate: Date - - /** - * The character used as the decimal point character in formatted numeric output. - */ - decimalPoint: string - - /** - * The name of the current ExtendScript engine, if set. - */ - readonly engineName: string - - /** - * The most recent run-time error information. - * Assigning error text to this property generates a run-time error; however, the preferred way to generate a run-time error is to throw an Error object. - */ - error: Error - - /** - * The file name of the current script. - */ - readonly fileName: string - - /** - * Gets or sets low-level debug output flags. - * A logical AND of bit flag values: - * 0x0002 (2): Displays each line with its line number as it is executed. - * 0x0040 (64): Enables excessive garbage collection. Usually, garbage collection starts when the number of objects has increased by a certain amount since the last garbage collection. This flag causes ExtendScript to garbage collect after almost every statement. This impairs performance severely, but is useful when you suspect that an object gets released too soon. - * 0x0080 (128): Displays all calls with their arguments and the return value. - * 0x0100 (256): Enables extended error handling (see strict). - * 0x0200 (512): Enables the localization feature of the toString method. Equivalent to the localize property. - */ - flags: number - - /** - * A reference to the global object, which contains the JavaScript global namespace. - */ - readonly global: any - - /** - * A high-resolution timer, measuring the time in microseconds. The timer starts when ExtendScript is - * initialized during the application startup sequence. Every read access resets the timer to Zero. - */ - readonly hiresTimer: number - - /** - * The path for include files for the current script. - */ - readonly includePath: string - - /** - * The current debugging level, which enables or disables the JavaScript debugger. - * One of 0 (no debugging), 1 (break on runtime errors), or 2 (full debug mode). - */ - level: number - - /** - * The current line number of the currently executing script. - */ - readonly line: number - - /** - * Gets or sets the current locale. - * The string contains five characters in the form LL_RR, where LL is an ISO 639 language specifier, and RR is an ISO 3166 region specifier.Initially, this is the value that the application or the platform returns for the current user. You can set it to temporarily change the locale for testing. To return to the application or platform setting, set to undefined, null, or the empty string. - */ - locale: string - - /** - * Set to true to enable the extended localization features of the built-in toString() method. - */ - localize: boolean - - /** - * The ExtendScript memory cache size, in bytes. - */ - memCache: number - - /** - * The current operating system version information. - */ - readonly os: string - - /** - * An array of objects containing information about the display screens attached to your computer. - * Each object has the properties left, top, right, bottom, which contain the four corners of each screen in global coordinates.A property primary is true if that object describes the primary display. - */ - readonly screens: object[] - - /** - * The current stack trace. - */ - readonly stack: string - - /** - * Sets or clears strict mode for object modification. - * When true, any attempt to write to a read-only property causes a runtime error. Some objects do not permit the creation of new properties when true. - */ - strict: any - - /** - * The version number of the ExtendScript engine. - * Formatted as a three-part number and description; for example: "3.92.95 (debug)". - */ - readonly version: string - - /** - * Shows an About box for the ExtendScript component, and returns the text for the box. - */ - about(): string - - /** - * Breaks execution at the current position. - * @param condition A string containing a JavaScript statement to be used as a condition. If the statement evaluates to true or nonzero when this point is reached, execution stops. - */ - bp(condition?: any): void - - /** - * Invokes the platform-specific color selection dialog, and returns the selected color. - * @param color The color to be preselected in the dialog, as 0xRRGGBB, or -1 for the platform default. - */ - colorPicker(color: number): number - - /** - * Loads and evaluates a file. - * @param file The file to load. - * @param timeout An optional timeout in milliseconds. - */ - evalFile(file: File, timeout?: number): any - - /** - * Initiates garbage collection in the ExtendScript engine. - */ - gc(): void - - /** - * Retrieves the value of an environment variable. - * @param name The name of the variable. - */ - getenv(name: string): string - - /** - * Sets the value of an environment variable. - * @param name The name of the variable. - * @param value The value of the variable. - */ - setenv(name: string, value: string): void - - /** - * Suspends the calling thread for a number of milliseconds. - * During a sleep period, checks at 100 millisecond intervals to see whether the sleep should be terminated. This can happen if there is a break request, or if the script timeout has expired. - * @param msecs Number of milliseconds to sleep. - */ - sleep(msecs: number): void - - /** - * Converts this object to a string. - */ - toString(): string - - /** - * Prints text to the Console. - * @param text The text to print. All arguments are concatenated. - */ - write(text: any): void - - /** - * Prints text to the Console, and adds a newline character. - * @param text The text to print. All arguments are concatenated. - */ - writeln(text: any): void -} -declare const $: $ - -interface ObjectConstructor { - readonly prototype: Object - - /** - * Creates and returns a new object of a given type. - * @param what The object type. - */ - new (what: any): Object - (): any - (what: any): any - - /** - * Reports whether an object is still valid. - * @param what The object to check. - */ - isValid(what: Object): boolean -} -declare const Object: ObjectConstructor - -/** - * The base class of all JavaScript objects. - */ -interface Object { - /** - * Points to the constructor function that created this object. - * Note that this property is treated as an XML element in the XML class. - */ - readonly constructor: Function - - /** - * Points to the prototype object for this object. - * Note that this property is treated as an XML element in the XML class. - */ - readonly prototype: Object - - /** - * Retrieves and returns the Reflection object associated with this method or a property. - * Note that this property is treated as an XML element in the XML class. - */ - readonly reflect: Reflection - - /** - * Reports whether a given property is defined with an instance or within the prototype chain. - * @param name The name of the property to check. - */ - hasOwnProperty(name: string): boolean - - /** - * Checks whether the given object is a prototype of this object. - * @param what The object to check. - */ - isPrototypeOf(what: Object): boolean - - /** - * Reports whether a given property is enumerable. - * @param name The name of the property to check. - */ - propertyIsEnumerable(name: string): boolean - - /** - * Creates and returns a string representing this object, localized for the current locale. See toString(). - */ - toLocaleString(): string - - /** - * Creates and returns a string representation of this object. - * This function serializes the object, so that it can, for example, be passed between engines. Pass the returned string back to eval() to recreate the object. Works only with built-in classes. - */ - toSource(): string - - /** - * Creates and returns a string representing this object. - * Many objects (such as Date) override this method in favor of their own implementation. If an object has no string value and no user-defined toString() method, the default method returns [object type], where type is the object type or the name of the constructor function that created the object. - */ - toString(): string - - /** - * Removes the watch function of a property. - * @param name The name of the property to unwatch. - */ - unwatch(name: string): void - - /** - * Retrieves and returns the primitive value of this object. - * If the object has no primitive value, returns the object itself.Note that you rarely need to call this method yourself.The JavaScript interpreter automatically invokes it when encountering an object where a primitive value is expected. - */ - valueOf(): Object - - /** - * Adds a watch function to a property, which is called when the value changes. - * This function can accept, modify, or reject a new value that the user, application, or a script has attempted to place in a property. - * @param name The name of the property to watch. - * @param func The function to be called when the value of this property changes. This function must three arguments, and return as its result the value to be stored in the property. The arguments are: name: the name of the property that changes. oldValue: The old property value. newValue: The new property value that was specified. - */ - watch(name: string, func: Function): void -} - -interface ArrayConstructor { - readonly prototype: Array - - /** - * Creates and returns a new array. - * Takes any number of parameters, which become the elements of the array, or a single value which becomes the length of an empty array. Note that you cannot create a one-element array, as the single parameter value is interpreted as the length. Returns the new array. - * @param arrayLength If no other parameters are passed, the initial length of the empty array. Otherwise, the first element. - * @param values If there is more than one parameter, the array is initialized with the given parameters. - */ - new (arrayLength?: number): any[] - new (arrayLength: number): T[] - new (...values: T[]): T[] - (arrayLength?: number): any[] - (arrayLength: number): T[] - (...values: T[]): T[] -} -declare const Array: ArrayConstructor - -/** - * An array with integer indexing and a length property. - */ -interface Array { - [n: number]: T - - /** - * The length of the array - */ - length: number - - /** - * Returns a new array created by concatenating the given values to the end of the original array. - * The original array is unchanged.If an array is provided as a parameter to concat(), each of its elements are appended as separate array elements at the end of the new array.Returns a new array, the result of concatenation the given values to the end of the original array. - * @param values Any number of values to be added to the end of the array. Can also be arrays. - */ - concat(...values: T[][]): T[] - - /** - * Joins all elements of the array into a string; optionally, each element is separated by delimiter. - * Returns the string containing the joined elements and delimiters. - * @param delimiter A string used to separate each element of the array. If omitted, the array elements are separated with a comma. - */ - join(delimiter?: string): string - - /** - * Removes the last element from the array, decreases the length by 1, and returns the value of the element. - * Returns the value of the deleted array element. - */ - pop(): T | undefined - - /** - * Places one or more values onto the end of the array and increases length by n. - * Returns the new length of the array. - * @param values Any number of values to be pushed onto the end of the array. - */ - push(...values: T[]): number - - /** - * Reverses the order of the elements in the array. - * Returns the reversed array. - */ - reverse(): T[] - - /** - * Removes the first element from the array, decreases the length by 1, and returns the value of the element. - * Returns the value of the deleted array element. - */ - shift(): T | undefined - - /** - * Creates a new array, which contains a subset of the original array's elements. - * The slice begins with the index start, and continues up to, but not including the index, end.If start or end is a negative number, the indexed is resolved counting backwards from the end of the array resulting in the element array[array. length + negativeIndex]. Returns a new array containing elements array[start] through array[end-1]. - */ - slice(start?: number, end?: number): T[] - - /** - * Sorts the elements of the array in place, using the given function to compare to elements. - * If no function is provided, the elements are sorted alphabetically.Returns no return value. - * @param userFunction A user-supplied function of the form userFunction(a, b) which returns less than 0 if a is greater than b, 0 if a and b are equal, and greater than 0 if b is greater than a. - */ - sort(userFunction?: (a: T, b: T) => number): this - - /** - * Removes num elements from the array beginning with index, start. - * Optionally insert new elements beginning at index start.To ensure contiguity, elements are moved up to fill in any gaps.Returns a new array containing any elements deleted from the original array. - * @param start The index of the first element to remove. Negative values are relative to the end of the array. - * @param deleteCount The number of array elements to remove, including start. If omitted, all elements from array index start to the end of the array are removed. - * @param values A list of one or more values to be added to the array starting at index start. Must specify a value for num, to use this argument. - */ - splice(start: number, deleteCount?: number, ...values: T[]): T[] - - /** - * Converts an array to a string and returns the string (localized). - */ - toLocaleString(): string - - /** - * Creates a string representation of this object that can be fed back to eval() to re-create an object. Works only with built-in classes. - */ - toSource(): string - - /** - * Converts an array to a string and returns the string. - * Yields the same result as array. join() when called without a parameter.Returns a comma-separated list of all the elements of the array. - */ - toString(): string - - /** - * Adds one or more elements to the beginning of the array. - * Returns the new array length. - * @param values The values of one or more elements to be added to the beginning of the array. - */ - unshift(...values: T[]): number -} - -/** - * A global object containing a set of math functions and constants. - */ -interface Math { - /** - * Euler's constant and the base of natural logarithms. - */ - readonly E: number - - /** - * The natural logarithm of 10. - */ - readonly LN10: number - - /** - * The natural logarithm of 2. - */ - readonly LN2: number - - /** - * The base 10 logarithm of e. - */ - readonly LOG10E: number - - /** - * The base 2 logarithm of e. - */ - readonly LOG2E: number - - /** - * The ratio of the circumference of a circle to its diameter. - */ - readonly PI: number - - /** - * The reciprocal of the square root of 1/2. - */ - readonly SQRT1_2: number - - /** - * The square root of 2. - */ - readonly SQRT2: number - - /** - * Returns the absolute value of a number. - * @param x A number. - */ - abs(x: number): number - - /** - * Returns the arc cosine(in radians) of a number. - * @param x A number. - */ - acos(x: number): number - - /** - * Returns the arc sin(in radians) of a number. - * @param x A number. - */ - asin(x: number): number - - /** - * Returns the arc tangent(in radians) of a number. - * @param x A number. - */ - atan(x: number): number - - /** - * Returns the arc tangent of the quotient of its arguments (y/x). - * @param y A number. - * @param x A number. - */ - atan2(y: number, x: number): number - - /** - * Rounds the number up to the nearest integer. - * @param x A number. - */ - ceil(x: number): number - - /** - * Returns the cosine of an angle provided in radians. - * @param x An angle, in radians. - */ - cos(x: number): number - - /** - * Returns Math.E raised to the power of a number. - * @param x A number. - */ - exp(x: number): number - - /** - * Rounds a number down to the nearest integer. - * @param x A number. - */ - floor(x: number): number - - /** - * Returns the natural logarithm of a number. - * @param x A number. - */ - log(x: number): number - - /** - * Returns the largest of zero or more numbers. - * @param rest Numbers. - */ - max(...rest: number[]): number - - /** - * Returns the smallest of zero or more numbers. - * @param rest Numbers. - */ - min(...rest: number[]): number - - /** - * Returns x raised to the power of y. - * @param x Numbers. - * @param y - */ - pow(x: number, y: number): number - - /** - * Returns a pseudo-random number from 0.0 up to but not including 1.0. - */ - random(): number - - /** - * Rounds a number to the nearest integer. - * @param x A number. - */ - round(x: number): number - - /** - * Returns the sine of an angle provided in radians. - * @param x An angle, in radians. - */ - sin(x: number): number - - /** - * Returns the square root of a number. - * @param x A number. - */ - sqrt(x: number): number - - /** - * Returns the tangent of an angle provided in radians. - * @param x An angle, in radians. - */ - tan(x: number): number -} -declare const Math: Math - -interface DateConstructor { - readonly prototype: Date - - /** - * Returns a new Date object holding the current date and time. - * If parameters are supplied, returns a new Date object holding the supplied date and time. - * @param year The year expressed in four digits. - * @param month An integer value from 0 (Jan) to 11 (Dec). - * @param day An integer value from 1 to 31, If this argument is not supplied, its value is set to 0. - * @param hours An integer value from 0 (midnight) to 23 (11 PM). If this argument is not supplied, its value is set to 0. - * @param min An integer value from 0 to 59. If this argument is not supplied, its value is set to 0. - * @param sec An Integer value from 0 to 59. If this argument is not supplied, its value is set to 0. - * @param ms An integer value from 0 to 999. If this argument is not supplied, its value is set to 0. - */ - new (): Date - new (value: number): Date - new (value: string): Date - new ( - year: number, - month: number, - day?: number, - hours?: number, - min?: number, - sec?: number, - ms?: number, - ): Date - - /** - * Parses a string, returning a new Date object. The string should be similar to the string returned bt toString(). - * @param text The string to parse. - */ - parse(text: string): Date - - /** - * Returns the number of milliseconds between midnight January 1, 1970, UTC, and the specified time. - * @param year The year expressed in four digits, for example, 2001. To indicate for a year from 1900 to 1999, you can specify a value from 0 to 99. - * @param month An integer value from 0 (Jan) to 11 (Dec). - * @param day An integer value from 1 to 31, If this argument is not supplied, its value is set to 0. - * @param hours An integer value from 0 (midnight) to 23 (11 PM). If this argument is not supplied, its value is set to 0. - * @param min An integer value from 0 to 59. If this argument is not supplied, its value is set to 0. - * @param sec An Integer value from 0 to 59. If this argument is not supplied, its value is set to 0. - * @param ms An integer value from 0 to 999. If this argument is not supplied, its value is set to 0. - */ - UTC( - year: number, - month?: number, - day?: number, - hours?: number, - min?: number, - sec?: number, - ms?: number, - ): Date -} -declare const Date: DateConstructor - -/** - * A date/time object. - */ -interface Date { - /** - * Returns the day of the month of the specified Date object in local time. - */ - getDate(): number - - /** - * Returns the day of the week for the specified Date object in local time. - * This is an integer from 0 (Sunday) to 6 (Saturday).Returns the day of the week for date. - */ - getDay(): number - - /** - * Returns the four digit year of the specified Date object in local time. - */ - getFullYear(): number - - /** - * Returns the hour of the specified Date object in local time. - */ - getHours(): number - - /** - * Returns the milliseconds of the specified Date object in local time. - */ - getMilliseconds(): number - - /** - * Returns the minutes of the specified Date object in local time. - */ - getMinutes(): number - - /** - * Returns the month of the specified Date object in local time. - */ - getMonth(): number - - /** - * Returns the seconds of the specified Date object in local time. - */ - getSeconds(): number - - /** - * Returns the number of milliseconds since midnight January 1,1970 UTC for the specified Date object. - */ - getTime(): number - - /** - * Returns the difference in minutes between the computer's local time and UTC. - */ - getTimezoneOffset(): number - - /** - * Returns the day of the month of the specified Date object according to UTC. - */ - getUTCDate(): number - - /** - * Returns the day of the week for the specified Date object according to UTC. - */ - getUTCDay(): number - - /** - * Returns the four digit year of the specified Date object according to UTC. - */ - getUTCFullYear(): number - - /** - * Returns the hour of the specified Date object according to UTC. - */ - getUTCHours(): number - - /** - * Returns the milliseconds of the specified Date object according to UTC. - */ - getUTCMilliseconds(): number - - /** - * Returns the minutes of the specified Date object according to UTC. - */ - getUTCMinutes(): number - - /** - * Returns the month of the specified Date object according to UTC. - */ - getUTCMonth(): number - - /** - * Returns the seconds of the specified Date object according to UTC. - */ - getUTCSeconds(): number - - /** - * Returns the year of the specified Date object, as a difference from 1900, in local time. - */ - getYear(): number - - /** - * Sets the day of the month of a specified Date object according to local time. - * Returns the number of milliseconds between the new date and midnight, January 1, 1970. - * @param date An integer from 1 to 31 indicating the day of the month. - */ - setDate(date: number): number - - /** - * Sets the year of a specified Date object according to local time. - * This method can also set month and date if those arguments are specified. Returns the number of milliseconds between the new date and midnight, January 1, 1970. - * @param year A four-digit integer value indicating the year to set. - */ - setFullYear(year: number): number - - /** - * Sets the hours of a specified Date object according to local time. - * Returns the number of milliseconds between the new date and midnight, January 1, 1970. - * @param hour An integer value from 0 (midnight) to 23 (11 PM). - */ - setHours(hour: number): number - - /** - * Sets the milliseconds of a specified Date object according to local time. - * Returns the number of milliseconds between the new date and midnight, January 1, 1970. - * @param ms An integer value from 0 to 999. - */ - setMilliseconds(ms: number): number - - /** - * Sets the minutes of a specified Date object according to local time. - * Returns the number of milliseconds between the new date and midnight, January 1, 1970. - * @param minutes An integer value from 0 to 59. - */ - setMinutes(minutes: number): number - - /** - * Sets the month of a specified Date object according to local time. - * Returns the number of milliseconds between the new date and midnight, January 1, 1970. - * @param month An integer value from 0 (Jan) to 11 (Dec). - */ - setMonth(month: number): number - - /** - * Sets the seconds of a specified Date object according to local time. - * Returns the number of milliseconds between the new date and midnight, January 1, 1970. - * @param seconds An integer value from 0 to 59. - */ - setSeconds(seconds: number): number - - /** - * Sets the date of a specified Date object in milliseconds since midnight, January 1, 1970. - * Returns the value of ms. - * @param ms An integer indicating the number of milliseconds between the date set and midnight, January 1, 1970. - */ - setTime(ms: number): number - - /** - * Sets the date of a specified Date object according to universal time. - * Returns the number of milliseconds between the new date and midnight, January 1, 1970 in UTC time. - * @param date An integer from 1 to 31 indicating the day of the month. - */ - setUTCDate(date: number): number - - /** - * Sets the year of a specified Date object according to UTC, can also set the month and date. - * Returns the number of milliseconds between the date set and midnight, January 1, 1970, in UTC. - * @param year The year expressed in four digits. - */ - setUTCFullYear(year: number): number - - /** - * Sets the hours of a specified Date object according to UTC. - * Returns the number of milliseconds between the date set and midnight, January 1, 1970, in UTC. - * @param hours An integer value from 0 (midnight) to 23 (11 PM) indicating the hour to be set. - */ - setUTCHours(hours: number): number - - /** - * Sets the milliseconds of a specified Date object according to UTC. - * Returns the number of milliseconds between the date set and midnight, January 1, 1970, in UTC. - * @param ms An integer value in the range of 0 to 999 indicating the number of milliseconds to set. - */ - setUTCMilliseconds(ms: number): number - - /** - * Sets the minutes of a specified Date object according to UTC. - * Returns the number of milliseconds between the date set and midnight, January 1, 1970, in UTC. - * @param min An integer value in the range 0 to 59 indicating the number of minutes to be set. - */ - setUTCMinutes(min: number): number - - /** - * Sets the month of a specified Date object according to UTC. - * Returns the number of milliseconds between the date set and midnight, January 1, 1970, in UTC. - * @param month An integer value in the range 0 (Jan.) to 11 (Dec.) indicating the month to set. - */ - setUTCMonth(month: number): number - - /** - * Sets the seconds of a specified Date object according to UTC. - * Returns the number of milliseconds between the date set and midnight, January 1, 1970, in UTC. - * @param sec An integer value in the range 0 to 59 indicating the number of seconds to set. - */ - setUTCSeconds(sec: number): number - - /** - * Sets the year of a specified Date object according to local time, as a difference between the current year and 1900. - * Returns the number of milliseconds between the date set and midnight, January 1, 1970. - * @param year An integer value indicating the year to set. The method interprets a 1- or 2- digit value to mean the 1900s; for example, 13 is interpreted to mean 1913. - */ - setYear(year: number): number - - /** - * Returns the date as a string. - */ - toDateString(): string - - /** - * Returns the date and time adjusted to GMT (UTC) as a string. - */ - toGMTString(): string - - /** - * Returns the date as a localized string. - */ - toLocaleDateString(): string - - /** - * Returns a string value representing the date and time stored in the Date object in human readable format (localized). - */ - toLocaleString(): string - - /** - * Returns the time as a localized string. - */ - toLocaleTimeString(): string - - /** - * Creates a string representation of this object that can be fed back to eval() to re-create an object. Works only with built-in classes. - */ - toSource(): string - - /** - * Returns a string value representing the date and time stored in the Date object in human readable format. - * Returns the following string is an example of the format returned by this method: Mon Aug 13, 10:54:21 GMT-0700 2001. - */ - toString(): string - - /** - * Returns the time as a string. - */ - toTimeString(): string - - /** - * Returns the date and time adjusted to UTC as a string. - */ - toUTCString(): string - - /** - * The valueOf() method returns the number of milliseconds that have passed since midnight, Returns an integer. - */ - valueOf(): number -} - -interface FunctionConstructor { - readonly prototype: Function - - /** - * The Function constructor parses the argument list and creates a Function object. - * @param arguments The list of formal arguments, separated by commas. The formal arguments can also be supplied one by one; in this case, the last argument to the Function constructor is considered to be the function body. - * @param body The body of the function to create. - */ - new (arguments: string, body: string): Function - (arguments: string, body: string): Function -} -declare const Function: FunctionConstructor - -/** - * Wraps a built-in or JavaScript function. - */ -interface Function { - /** - * The function arguments, packed into an array. - * This property is deprecated; use the arguments property within the function body. - */ - arguments: object - - /** - * The number of formal arguments. - * This property is deprecated; use the length property instead. - */ - readonly arity: number - - /** - * The number of formal arguments. - */ - readonly length: number - - /** - * The function name. - */ - readonly name: string - - /** - * Apply a this object and an argument list to a function. - * This function is different from call(); here, the arguments are suppliedas an Array object. - * @param thisObj The object to be used as this. - * @param args An array of arguments. - */ - apply(thisObj: object, args: any): any - - /** - * Apply a this object and arguments to a function. - * This function is different from apply(); here, the arguments are supplied one by one. - * @param thisObj The object to be used as this. - * @param arguments The first agument to the function. Add as many as needed. - */ - call(thisObj: object, ...arguments: any[]): any - - /** - * Creates a string representation of this object that can be fed back to eval() to re-create an object. Works only with JavaScript functions. - */ - toSource(): string - - /** - * Returns the function definition as a string. - */ - toString(): string -} - -interface StringConstructor { - readonly prototype: String - - /** - * Returns a string representation of the value given as an argument. - * @param value A number, variable, or object to convert to a string. - */ - new (value?: any): String - (value: any): string - - /** - * Returns a string created by concatenation one or more characters specified as ASCII values. - * @param value1 One or more ASCII values. - */ - fromCharCode(value1: number): string -} -declare const String: StringConstructor - -/** - * A character string. Each character is adressable by index. - */ -interface String { - /** - * The length of the string. - */ - readonly length: number - - /** - * Get character at index. - */ - readonly [index: number]: string - - /** - * Returns a string consisting of this string enclosed in a tag. - * @param name The text to be stored in the anchors' name attribute. - */ - anchor(name: string): string - - /** - * Returns a string consisting of this string enclosed in a tag. - */ - big(): string - - /** - * Returns a string consisting of this string enclosed in a tag. - */ - blink(): string - - /** - * Returns a string consisting of this string enclosed in a tag. - */ - bold(): string - - /** - * Returns the character at the specified index. - * @param index An integer between 0 and string.length -1, specifying the character to return. - */ - charAt(index: number): string - - /** - * Returns the Unicode value of the character at the given index. - * @param index An integer between 0 and string.length -1, specifying the character. - */ - charCodeAt(index: number): number - - /** - * If necessary, converts the one or more given values to strings. - * Those values are concatenated with the original string, the result is returned. The original string is not effected.Returns the concatenated string. - * @param value The values to be concatenated with the given string. - */ - concat(value: string): string - - /** - * Returns a string consisting of this string enclosed in a tag. - */ - fixed(): string - - /** - * Returns a string consisting of this string enclosed in a tag. - * @param color The value to be stored in the tag's color attribute. - */ - fontcolor(color: string): string - - /** - * Returns a string consisting of this string enclosed in a tag. - * @param size The value to be stored in the tag's size attribute. - */ - fontsize(size: number): string - - /** - * Returns the index within the string of the first occurrence of the specified string, starting the search at fromIndex if provided. - * @param searchValue The string for which to search. - * @param offset The starting offset of the search. - */ - indexOf(searchValue: string, offset?: number): number - - /** - * Returns a string consisting of this string enclosed in a tag. - */ - italics(): string - - /** - * Returns the index within the string of the last occurrence of the specified value. - * The string is searched backward, starting at fromIndex.Returns the index within the string where the last occurrence of searchValue was found, or -1 if it was not found. - * @param searchValue The string for which to search. - * @param offset The starting offset of the search. - */ - lastIndexOf(searchValue: string, offset?: number): number - - /** - * Returns a string consisting of this string enclosed in a tag. - * @param href The value to be stored in the tag's href attribute. - */ - link(href: string): string - - /** - * Performs a localized comparison of two strings. - * @param what The string to compare with. - */ - localeCompare(what: string): number - - /** - * Matches a string against a regular expression. - * @param regexp The regular expression to use. - */ - match(regexp: RegExp | string): RegExpMatchArray | null - - /** - * - * @param what - * @param with_ - */ - replace(what: any, with_: string): string - - /** - * - * @param search - */ - search(search: RegExp): number - - /** - * Extracts a substring of the given string and returns it as a new string. - * The substring begins at startSlice, and includes all characters up to, but not including the character at the index endSlice. A negative value indexes from the end of the string.For example, a negative value for startSlice is resolved as: string. length + startSlice.The original string is unchanged.Returns a substring of characters from the given string, starting at startSlice and ending with endSlice-1. - * @param startSlice The index at which to begin extraction. - * @param endSlice The index at which to end extraction. If omitted, slice extracts to the end of the string. - */ - slice(startSlice: number, endSlice?: number): string - - /** - * Returns a string consisting of this string enclosed in a tag. - */ - small(): string - - /** - * Splits a string into a group of substrings, places those strings in an array, and returns the array. - * The substrings are created by breaking the original string at places that match delimiter, the delimiter characters are removed.Returns an array whose elements are the substrings. - * @param delimiter Specifies the string to use for delimiting. If delimiter is omitted, the array returned contains one element, consisting of the entire string. - * @param limit - */ - split(delimiter: string, limit?: number): string[] - - /** - * Returns a string consisting of this string enclosed in a tag. - */ - strike(): string - - /** - * Returns a string consisting of this string enclosed in a tag. - */ - sub(): string - - /** - * Returns a string containing the characters beginning at the specified index, start, through the specified number of characters. - * The original string is unchanged.Returns a string containing the extracted characters. - * @param start Location at which to begin extracting characters. - * @param length The number of characters to extract. - */ - substr(start: number, length?: number): string - - /** - * Returns a substring of the given string by extracting characters from indexA up to but not including indexB. - * The original string is unchanged.Returns a substring of characters from the given string, starting at indexA and ending with indexB-1. - * @param indexA The index to begin extracting. - * @param indexB The index at which to end extraction. If omitted, slice extracts to the end of the string. - */ - substring(indexA: number, indexB?: number): string - - /** - * Returns a string consisting of this string enclosed in a tag. - */ - sup(): string - - /** - * Returns a new string which contains all the characters of the original string converted to lowercase (localized). - * The original string is unchanged. - */ - toLocaleLowerCase(): string - - /** - * Returns a new string which contains all the characters of the original string converted to uppercase (localized). - * The original string is unchanged. - */ - toLocaleUpperCase(): string - - /** - * Returns a new string which contains all the characters of the original string converted to lowercase. - * The original string is unchanged. - */ - toLowerCase(): string - - /** - * Creates a string representation of this object that can be fed back to eval() to re-create an object. Works only with built-in classes. - */ - toSource(): string - - /** - * Returns itself. - */ - toString(): string - - /** - * Returns a new string which contains all the characters of the original string converted to uppercase. - * The original string is unchanged. - */ - toUpperCase(): string - - /** - * The valueOf() method returns the number of milliseconds that have passed since midnight, Returns an integer. - */ - valueOf(): string -} - -interface NumberConstructor { - readonly prototype: Number - - /** - * Returns a new Number object set to the value of the argument converted to a number. - * @param value The value of the object being created. - */ - new (value?: any): Number - (value: any): number - - /** - * A constant representing the largest representable number. - */ - readonly MAX_VALUE: number - - /** - * A constant representing the smallest representable number. - */ - readonly MIN_VALUE: number - - /** - * A constant representing negative infinity. - */ - readonly NEGATIVE_INFINITY: number - - /** - * A constant representing the special "Not a Number" value. - */ - readonly NaN: number - - /** - * A constant representing positive infinity. - */ - readonly POSITIVE_INFINITY: number -} -declare const Number: NumberConstructor - -/** - * Wraps a numeric value. - */ -interface Number { - /** - * Converts the Number object to a string in scientific notation. - * @param decimals The number of decimals. - */ - toExponential(decimals: number): string - - /** - * Converts the Number object to a string with fixed decimals. - * @param decimals The number of decimals. - */ - toFixed(decimals: number): string - - /** - * Returns the value of a Number object converted to a string, using localized conventions. - */ - toLocaleString(): string - - /** - * Converts the Number object to a string in either scientific or fixed notation, epending on its value. - * @param decimals The number of decimals. - */ - toPrecision(decimals: number): string - - /** - * Creates a string representation of this object that can be fed back to eval() to re-create an object. Works only with built-in classes. - */ - toSource(): string - - /** - * Returns the value of a Number object converted to a string. - * @param radix The optional conversion radix. - */ - toString(radix?: number): string - - /** - * Returns the value of a Number object as a primitive number. - */ - valueOf(): number -} - -interface BooleanConstructor { - readonly prototype: Boolean - - /** - * Creates and returns a new Boolean object set to the value of the argument converted to a boolean. - * @param value The value to be converted to a Boolean. - */ - new (value?: any): Boolean - (value: any): boolean -} -declare const Boolean: BooleanConstructor - -/** - * Wraps a Boolean value. - */ -interface Boolean { - /** - * Creates a string representation of this object that can be fed back to eval() to re-create an object. Works only with built-in classes. - */ - toSource(): string - - /** - * Returns the string representation of the value of bool. - * The method returns the string true if the primitive value of bool is true; otherwise it returns the string false. - */ - toString(): string - - /** - * Returns the primitive value of bool. - * The method returns true if the primitive value of bool is true; otherwise it returns false. - */ - valueOf(): boolean -} - -interface RegExpConstructor { - readonly prototype: RegExp - - /** - * Creates and returns a new RegExp object set to the value of the argument converted to a regular expression. - * @param pattern The pattern to convert. - * @param flags Flags that control how the conversion is performed. A string containing any combination of the letters i, m, g: "i" -- ignore case in pattern matching "m" -- treat the string as multiple lines "g" -- do global pattern matching - */ - new (pattern: string | RegExp, flags?: string): RegExp - (pattern: string | RegExp, flags?: string): RegExp - - /** - * The matched subexpression #1. - */ - readonly $1: string - - /** - * The matched subexpression #2. - */ - readonly $2: string - - /** - * The matched subexpression #3. - */ - readonly $3: string - - /** - * The matched subexpression #4. - */ - readonly $4: string - - /** - * The matched subexpression #5. - */ - readonly $5: string - - /** - * The matched subexpression #6. - */ - readonly $6: string - - /** - * The matched subexpression #7. - */ - readonly $7: string - - /** - * The matched subexpression #8. - */ - readonly $8: string - - /** - * The matched subexpression #9. - */ - readonly $9: string - - /** - * Indicates whether the match is a global match. - */ - global: boolean - - /** - * Indicates whether the match is not case sensitive. - */ - ignoreCase: boolean - - /** - * The original input string. - */ - input: string - - /** - * The last match. - */ - readonly lastMatch: string - - /** - * The value of the last matched subexpression. - */ - readonly lastParen: string - - /** - * The string before the match. - */ - readonly leftContext: string - - /** - * Indicates whether the match matches multiple lines. - */ - multiline: boolean - - /** - * The string after the match. - */ - readonly rightContext: string -} -declare const RegExp: RegExpConstructor - -/** - * Wraps a regular expression. - */ -interface RegExp { - /** - * Compiles a string to a regular expression. Returns true if the compilation was successful. - * @param pattern The pattern to compile. - */ - compile(pattern: string): boolean - - /** - * Execute a regular expression. - * The return value is an array of matches, with the first element containing the match, and successive elements containing the results of any matching subexpression in their order of appearance. If there is no match, the result is null. - * @param text The string to match. - */ - exec(text: string): RegExpExecArray | null - - /** - * Execute a regular expression, and return true if there is a match. - * @param text The string to match. - */ - test(text: string): boolean - - /** - * Converts this RegExp object to a string. - */ - toString(): string -} - -interface RegExpMatchArray extends Array { - index?: number - input?: string -} - -interface RegExpExecArray extends Array { - index: number - input: string -} - -interface ErrorConstructor { - readonly prototype: Error - - /** - * Creates a new Error object. - * @param msg The error message. - * @param file The name of the file. - * @param line The line number. - */ - new (msg: string, file?: string, line?: number): Error - (msg: string, file?: string, line?: number): Error -} -declare const Error: ErrorConstructor - -/** - * Wraps a runtime error. - */ -interface Error { - /** - * The error message. - */ - description: string - - /** - * Creates a string representation of this object that can be fed back to eval() to re-create an object. Works only with built-in classes. - */ - toSource(): string - - /** - * Convert this object to a string. - */ - toString(): string -} - -interface FileConstructor { - readonly prototype: File - - /** - * Creates and returns a new File object referring to a given file system location. - * @param path The full or partial path name of the file,in platform-specific or URI format. The value stored in the object is the absolute path. The file that the path refers to does not need to exist.If the path refers to an existing folder: The File function returns a Folder object instead of a File object. The new operator returns a File object for a nonexisting file with the same name. - */ - new (path?: string): File - (path?: string): File - - /** - * The name of the file system. - * This is a class property accessed through the File constructor. Valid values are "Windows", "Macintosh", and "Unix". - */ - readonly fs: string - - /** - * Decodes a UTF-8 encoded string as required by RFC 2396, and returns the decoded string. - * See also String.decodeURI(). - * @param uri The UTF-8 encoded string to decode. - */ - decode(uri: string): string - - /** - * Encodes a string as required by RFC 2396, and returns the encoded string. - * All special characters are encoded in UTF-8 and stored as escaped characters starting with the percent sign followed by two hexadecimal digits. For example, the string "my file" is encoded as "my%20file". - * Special characters are those with a numeric value greater than 127, except the following: / - _ . ! ~ * ' ( ) - * See also encodeURI(). - * @param name The string to encode. - */ - encode(name: string): string - - /** - * Reports whether a given encoding is available. - * @param name The encoding name. Typical values are "ASCII", "binary", or "UTF-8".For a complete list of supported encodings, see the JavaScript Tools Guide. - */ - isEncodingAvailable(name: string): boolean - - /** - * Opens a dialog so the user can select one or more files to open. - * Opens the built-in platform-specific file-browsing dialog in which a user can select an existing file or multiple files, and creates new File objects to represent the selected files. - * If the user clicks OK, returns a File object for the selected file, or an array of objects if multiple files are selected. - * If the user cancels, returns null. - * @param prompt The prompt text, displayed if the dialog allows a prompt. - * @param filter A filter that limits the types of files displayed in the dialog. In Windows,a filter expression such as "Javascript files:*.jsx;All files:*.*". In Mac OS, a filter function that takes a File instance and returns true if the file should be included in the display, false if it should not. - * @param multiSelect When true, the user can select multiple files and the return value is an array. - */ - openDialog(prompt?: string, filter?: any, multiSelect?: boolean): File - - /** - * Opens a dialog so the user can select a file name to save to. - * Opens the built-in platform-specific file-browsing dialog in which a user can select an existing file location to which to save information, and creates a new File object to represent the selected file location. - * If the user clicks OK, returns a File object for the selected file location. - * If the user cancels, returns null. - * @param prompt The prompt text, displayed if the dialog allows a prompt. - * @param filter In Windows only, a filter that limits the types of files displayed in the dialog. In Windows only,a filter expression such as "Javascript files:*.jsx;All files:*.*". Not used In Mac OS. - */ - saveDialog(prompt?: string, filter?: any): File -} -declare const File: FileConstructor - -/** - * Represents a file in the local file system in a platform-independent manner. - */ -interface File { - /** - * The full path name for the referenced file in URI notation. - */ - readonly absoluteURI: string - - /** - * If true, the object refers to a file system alias or shortcut. - */ - readonly alias: boolean - - /** - * The creation date of the referenced file, or null if the object does not refer to a file on disk. - */ - readonly created: Date - - /** - * In Mac OS, the file creator as a four-character string. In Windows or UNIX, value is "????". - */ - readonly creator: string - - /** - * The localized name of the referenced file, without the path specification. - */ - readonly displayName: string - - /** - * Gets or sets the encoding for subsequent read/write operations. - * One of the encoding constants listed in the JavaScript Tools Guide. If the value is not recognized, uses the system default encoding.A special encoder, BINARY, is used to read binary files. It stores each byte of the file as one Unicode character regardless of any encoding. When writing, the lower byte of each Unicode character is treated as a single byte to write. - */ - encoding: string - - /** - * When true, a read attempt caused the current position to be at the end of the file, or the file is not open. - */ - readonly eof: boolean - - /** - * A string containing a message describing the most recent file system error. - * Typically set by the file system, but a script can set it. Setting this value clears any error message and resets the error bit for opened files. Contains the empty string if there is no error. - */ - error: string - - /** - * If true, this object refers to a file or file-system alias that actually exists in the file system. - */ - readonly exists: boolean - - /** - * The platform-specific full path name for the referenced file. - */ - readonly fsName: string - - /** - * The full path name for the referenced file in URI notation. - */ - readonly fullName: string - - /** - * When true, the file is not shown in the platform-specific file browser. - * If the object references a file-system alias or shortcut, the flag is altered on the alias, not on the original file. - */ - hidden: boolean - - /** - * The size of the file in bytes. - * Can be set only for a file that is not open, in which case it truncates or pads the file with 0-bytes to the new length. - */ - length: number - - /** - * How line feed characters are written in the file system. - * One of the values "Windows", "Macintosh", or "Unix". - */ - lineFeed: string - - /** - * The date of the referenced file's last modification, or null if the object does not refer to a file on the disk. - */ - readonly modified: Date - - /** - * The file name portion of the absolute URI for the referenced file, without the path specification. - */ - readonly name: string - - /** - * The Folder object for the folder that contains this file. - */ - readonly parent: Folder - - /** - * The path portion of the absolute URI for the referenced file, without the file name. - */ - readonly path: string - - /** - * When true, prevents the file from being altered or deleted. - * If the referenced file is a file-system alias or shortcut, the flag is altered on the alias, not on the original file. - */ - readonly: boolean - - /** - * The path name for the object in URI notation, relative to the current folder. - */ - readonly relativeURI: string - - /** - * The file type as a four-character string. - * In Mac OS, the Mac OS file type. - * In Windows, "appl" for .EXE files, "shlb" for .DLL files and "TEXT" for any other file. - */ - readonly type: string - - /** - * Changes the path specification of the referenced file. - * @param path A string containing the new path, absolute or relative to the current folder. - */ - changePath(path: string): boolean - - /** - * Closes this open file. - * Returns true if the file was closed successfully, false if an I/O error occurred. - */ - close(): boolean - - /** - * Copies this object’s referenced file to the specified target location. - * Resolves any aliases to find the source file. If a file exists at the target location, it is overwritten. - * Returns true if the copy was successful. - * @param target A string with the URI path to the target location, or a File object that references the target location. - */ - copy(target: string): boolean - - /** - * Makes this file a file-system alias or shortcut to the specified file. - * The referenced file for this object must not yet exist on disk. Returns true if the operation was successful. - * @param path A string containing the path of the target file. - */ - createAlias(path: string): void - - /** - * Executes or opens this file using the appropriate application, as if it had been double-clicked in a file browser. - * You can use this method to run scripts, launch applications, and so on.Returns true immediately if the application launch was successful. - */ - execute(): boolean - - /** - * Retrieves and returns the path for this file, relative to the specified base path, in URI notation. - * If no base path is supplied, the URI is relative to the path of the current folder.Returns a string containing the relative URI. - * @param basePath A base path in URI notation. - */ - getRelativeURI(basePath: string): string - - /** - * Opens the referenced file for subsequent read/write operations. The method resolves any aliases to find the file. - * Returns true if the file was opened successfully.The method attempts to detect the encoding of the open file. It reads a few bytes at the current location and tries to detect the Byte Order Mark character 0xFFFE. If found, the current position is advanced behind the detected character and the encoding property is set to one of the strings UCS-2BE, UCS-2LE, UCS4-BE, UCS-4LE, or UTF-8. If the marker character is not found, it checks for zero bytes at the current location and makes an assumption about one of the above formats (except UTF-8). If everything fails, the encoding property is set to the system encoding. - * IMPORTANT: Be careful about opening a file more than once. The operating system usually permits you to do so, but if you start writing to the file using two different File objects, you can destroy your data. - * @param mode The read-write mode, a single-character string. One of these characters: r (read) Opens for reading. If the file does not exist or cannot be found, the call fails. w (write) Opens a file for writing. If the file exists, its contents are destroyed. If the file does not exist, creates a new, empty file. e (edit) Opens an existing file for reading and writing. a (append) Opens an existing file for reading and writing, and moves the current position to the end of the file. - * @param type In Mac OS, the type of a newly created file, a 4-character string. Ignored in Windows and UNIX. - * @param creator In Mac OS, the creator of a newly created file, a 4-character string. Ignored in Windows and UNIX. - */ - open(mode: string, type?: string, creator?: string): boolean - - /** - * Opens the built-in platform-specific file-browsing dialog, in which the user can select an existing file or files, and creates new File objects to represent the selected files. - * Differs from the class method openDialog() in that it presets the current folder to this File object’s parent folder and the current file to this object’s associated file. - * If the user clicks OK, returns a File or Folder object for the selected file or folder, or an array of objects. - * If the user cancels, returns null. - * @param prompt A string containing the prompt text, if the dialog allows a prompt. - * @param filter A filter that limits the types of files displayed in the dialog. In Windows,a filter expression such as "Javascript files:*.jsx;All files:*.*". In Mac OS, a filter function that takes a File instance and returns true if the file should be included in the display, false if it should not. - * @param multiSelect When true, the user can select multiple files and the return value is an array. - */ - openDlg(prompt?: string, filter?: any, multiSelect?: boolean): File - - /** - * Reads the contents of the file, starting at the current position. - * Returns a string that contains up to the specified number of characters. If a number of characters is not supplied, reads from the current position to the end of the file. If the file is encoded, multiple bytes might be read to create single Unicode characters. - * @param chars An integer specifying the number of characters to read. - */ - read(chars?: number): string - - /** - * Reads a single text character from the file at the current position. - * Line feeds are recognized as CR, LF, CRLF or LFCR pairs.If the file is encoded, multiple bytes might be read to create a single Unicode character. Returns a string that contains the character. - */ - readch(): string - - /** - * Reads a single line of text from the file at the current position. - * Line feeds are recognized as CR, LF, CRLF or LFCR pairs.. If the file is encoded, multiple bytes might be read to create single Unicode characters. Returns a string that contains the text. - */ - readln(): string - - /** - * Deletes the file associated with this object from disk immediately, without moving it to the system trash. - * Does not resolve aliases; instead, deletes the referenced alias or shortcut file itself. Returns true if the file was successfully removed. - * IMPORTANT: Cannot be undone. It is recommended that you prompt the user for permission before deleting. - */ - remove(): boolean - - /** - * Renames the associated file. - * Does not resolve aliases, but renames the referenced alias or shortcut file itself. Returns true if the file was successfully renamed. - * @param newName The new file name, with no path information. - */ - rename(newName: string): boolean - - /** - * Attempts to resolve the file-system alias or shortcut that this object refers to. - * If successful, creates and returns a new File object that points to the resolved file system element. Returns null if this object does not refer to an alias, or if the alias could not be resolved. - */ - resolve(): File - - /** - * Opens the built-in platform-specific file-browsing dialog, in which the user can select an existing file location to which to save information, and creates a new File object to represent the selected file. - * Differs from the class method saveDialog() in that it presets the current folder to this File object’s parent folder and the file to this object’s associated file. - * If the user clicks OK, returns a File object for the selected file. - * If the user cancels, returns null. - * @param prompt A string containing the prompt text, if the dialog allows a prompt. - * @param filter In Windows only, a filter that limits the types of files displayed in the dialog. In Windows only,a filter expression such as "Javascript files:*.jsx;All files:*.*". Not used In Mac OS. - */ - saveDlg(prompt?: string, filter?: any): File - - /** - * Seeks to a given position in the file. - * The new position cannot be less than 0 or greater than the current file size. Returns true if the position was changed. - * @param pos The new current position in the file as an offset in bytes from the start, current position, or end, depending on the mode. - * @param mode The seek mode. One of: 0: Seek to absolute position, where pos=0 is the first byte of the file. This is the default. 1: Seek relative to the current position. 2. Seek backward from the end of the file. - */ - seek(pos: number, mode?: number): boolean - - /** - * Retrieves the current position as a byte offset from the start of the file. - * Returns a number, the position index. - */ - tell(): number - - /** - * Creates and returns a serialized string representation of this object. - * Pass the resulting string to eval() to recreate the object. - */ - toSource(): string - - /** - * Converts this object to a string. - */ - toString(): string - - /** - * Writes the specified text to the file at the current position. - * You can supply multiple text values; the strings are concatenated to form a single string.For encoded files, writing a single Unicode character may write multiple bytes. Returns true if the write was successful.IMPORTANT: Be careful not to write to a file that is open in another application or object, as this can overwrite existing data. - * @param text A text string to be written. - */ - write(text: string): boolean - - /** - * Writes a string to the file at the current position and appends a line-feed sequence. - * You can supply multiple text values. The strings are concatenated into a single string, which is written in the file followed by one line-feed sequence, of the style specified by this object's linefeed property.For encoded files, writing a single Unicode character may write multiple bytes.Returns true if the write was successful.IMPORTANT: Be careful not to write to a file that is open in another application or object, as this can overwrite existing data. - * @param text A text string to be written. - */ - writeln(text: string): boolean -} - -interface FolderConstructor { - readonly prototype: Folder - - /** - * Creates and returns a new Folder object referring to a given file-system location. - * If the path name refers to an already existing disk file, a File object is returned instead.Returns the new Folder object. - * @param path The absolute or relative path to the folder associated with this object, specified in URI format. The value stored in the object is the absolute path.The path need not refer to an existing folder. If the path refers to an existing file, rather than a folder: The Folder() function returns a File object instead of a Folder object. The new operator returns a Folder object for a nonexisting folder with the same name. - */ - new (path?: string): Folder - (path?: string): Folder - - /** - * The folder containing the application data for all users. - * In Windows, the value of %APPDATA% (by default, C:\\Documents and Settings\\All Users\\Application Data) - * In Mac OS, /Library/Application Support - */ - readonly appData: Folder - - /** - * In Mac OS, a Folder object for the folder containing the bundle of the running application. - */ - readonly appPackage: Folder - - /** - * A Folder object for the folder containing common files for all programs installed by the user. - * In Windows, the value of %CommonProgramFiles% (by default, C:\\Program Files\\Common Files) - * In Mac OS, /Library/Application Support - */ - readonly commonFiles: Folder - - /** - * A Folder object for the current folder. - * Assign a Folder object or a string containing the new path name to set the current folder. This is a class property accessed through the Folder constructor. - */ - current: Folder - - /** - * A Folder object for the folder that contains the user’s desktop. - * In Windows, C:\\Documents and Settings\\username\\Desktop - * In Mac OS, ~/Desktop - */ - readonly desktop: Folder - - /** - * The name of the current file system. - * One of "Windows", "Macintosh", or "Unix". - */ - readonly fs: string - - /** - * A folder pointing to the user's My Documents folder. - * In Windows, C:\\Documents and Settings\\username\\My Documents - * In Mac OS,~/Documents - */ - readonly myDocuments: Folder - - /** - * A Folder object for the folder containing the executable image of the running application. - */ - readonly startup: Folder - - /** - * A Folder object for the folder containing the operating system files. - * In Windows, the value of %windir% (by default, C:\\Windows) - * In Mac OS, /System - */ - readonly system: Folder - - /** - * A Folder object for the default folder for temporary files. - */ - readonly temp: Folder - - /** - * A Folder object for the folder containing deleted items. On Windows, the trash folder is a virtual - * folder containing a database; therefore, the property value is null on Windows. - */ - readonly trash: Folder - - /** - * A Folder object for the folder containing the user's application data. - * In Windows, the value of %USERDATA% (by default, C:\\Documents and Settings\\username\\Application Data) - * In Mac OS,~/Library/Application Support. - */ - readonly userData: Folder - - /** - * Decodes a UTF-8 encoded string as required by RFC 2396, and returns the decoded string. - * See also String.decodeURI(). - * @param uri The UTF-8 string to decode. - */ - decode(uri: string): string - - /** - * Encodes a string as required by RFC 2396, and returns the encoded string. - * All special characters are encoded in UTF-8 and stored as escaped characters starting with the percent sign followed by two hexadecimal digits. For example, the string "my file" is encoded as "my%20file". - * Special characters are those with a numeric value greater than 127, except the following: / - _ . ! ~ * ' ( ) - * See also encodeURI(). - * @param name The string to encode. - */ - encode(name: string): string - - /** - * Reports whether a given encoding is available. - * @param name The encoding name. Typical values are "ASCII", "binary", or "UTF-8".For a complete list of supported encodings, see the JavaScript Tools Guide. - */ - isEncodingAvailable(name: string): boolean - - /** - * Opens the built-in platform-specific file-browsing dialog, and creates a new File or Folder object for the selected file or folder. - * Differs from the object method selectDlg() in that it does not preselect a folder. - * If the user clicks OK, returns a File or Folder object for the selected file or folder. - * If the user cancels, returns null. - * @param prompt The prompt text, if the dialog allows a prompt. - */ - selectDialog(prompt?: string): Folder -} -declare const Folder: FolderConstructor - -/** - * Represents a file-system folder or directory in a platform-independent manner. - */ -interface Folder { - /** - * The full path name for the referenced folder in URI notation. - */ - readonly absoluteURI: string - - /** - * When true, the object refers to a file system alias or shortcut. - */ - readonly alias: boolean - - /** - * The creation date of the referenced folder, or null if the object does not refer to a folder on disk. - */ - readonly created: Date - - /** - * The localized name portion of the absolute URI for the referenced folder, without the path specification. - */ - readonly displayName: string - - /** - * A message describing the most recent file system error. - * Typically set by the file system, but a script can set it. Setting this value clears any error message and resets the error bit for opened files. Contains the empty string if there is no error. - */ - error: string - - /** - * When true, this object refers to a folder that currently exists in the file system. - */ - readonly exists: boolean - - /** - * The platform-specific name of the referenced folder as a full path name. - */ - readonly fsName: string - - /** - * The full path name for the referenced folder in URI notation. . - */ - readonly fullName: string - - /** - * The date of the referenced folder's last modification, or null if the object does not refer to a folder on disk. - */ - readonly modified: Date - - /** - * The folder name portion of the absolute URI for the referenced file, without the path specification. - */ - readonly name: string - - /** - * TThe Folder object for the folder that contains this folder, or null if this object refers to the root folder of a volume. - */ - readonly parent: Folder - - /** - * The path portion of the object absolute URI for the referenced file, without the folder name. - */ - readonly path: string - - /** - * The path name for the referenced folder in URI notation, relative to the current folder. - */ - readonly relativeURI: string - - /** - * Changes the path specification of the referenced folder. - * @param path A string containing the new path, absolute or relative to the current folder. - */ - changePath(path: string): boolean - - /** - * Creates a folder at the location given by this object's path property. - * Returns true if the folder was created. - */ - create(): boolean - - /** - * Opens this folder in the platform-specific file browser (as if it had been double-clicked in the file browser). - * Returns true immediately if the folder was opened successfully. - */ - execute(): boolean - - /** - * Retrieves the contents of this folder, filtered by the supplied mask. - * Returns an array of File and Folder objects, or null if this object's referenced folder does not exist. - * @param mask A search mask for file names, specified as a string or a function. A mask string can contain question mark (?) and asterisk (*) wild cards. Default is "*", which matches all file names. Can also be the name of a function that takes a File or Folder object as its argument. It is called for each file or folder found in the search; if it returns true, the object is added to the return array. NOTE: In Windows, all aliases end with the extension .lnk. ExtendScript strips this from the file name when found, in order to preserve compatibility with other operating systems. You can search for all aliases by supplying the search mask "*.lnk", but note that such code is not portable. - */ - getFiles(mask?: any): Array - - /** - * Retrieves and returns the path for this file, relative to the specified base path, in URI notation. - * If no base path is supplied, the URI is relative to the path of the current folder.Returns a string containing the relative URI. - * @param basePath A base path in URI notation. - */ - getRelativeURI(basePath?: string): string - - /** - * Deletes the folder associated with this object from disk immediately, without moving it to the system trash. - * Folders must be empty before they can be deleted. Does not resolve aliases; instead, deletes the referenced alias or shortcut file itself. Returns true if the file was successfully removed. - * IMPORTANT: Cannot be undone. It is recommended that you prompt the user for permission before deleting. - */ - remove(): boolean - - /** - * Renames the associated folder. - * Does not resolve aliases, but renames the referenced alias or shortcut file itself. Returns true if the folder was successfully renamed. - * @param newName The new folder name, with no path information. - */ - rename(newName: string): boolean - - /** - * Attempts to resolve the file-system alias or shortcut that this object refers to. - * If successful, creates and returns a new Folder object that points to the resolved file system element. Returns null if this object does not refer to an alias, or if the alias could not be resolved. - */ - resolve(): Folder - - /** - * Opens the built-in platform-specific file-browsing dialog, and creates a new File or Folder object for the selected file or folder. - * Differs from the class method selectDialog() in that it preselects this folder. - * If the user clicks OK, returns a File or Folder object for the selected file or folder. - * If the user cancels, returns null. - * @param prompt The prompt text, if the dialog allows a prompt. - */ - selectDlg(prompt?: string): Folder - - /** - * Creates and returns a serialized string representation of this object. - * Pass the resulting string to eval() to recreate the object. - */ - toSource(): string - - /** - * Converts this object to a string. - */ - toString(): string -} - -interface SocketConstructor { - readonly prototype: Socket - - /** - * Creates a new Socket object. - */ - new (): Socket - (): Socket -} -declare const Socket: SocketConstructor - -/** - * Creates a TCP/IP connection, or establishes a TCP/IP server. - */ -interface Socket { - /** - * When true, the connection is active. - */ - readonly connected: boolean - - /** - * Sets or retrieves the name of the encoding used to transmit data. - * Typical values are "ASCII", "BINARY", or "UTF-8". - */ - encoding: string - - /** - * When true, the receive buffer is empty. - */ - readonly eof: boolean - - /** - * A message describing the most recent error. Setting this value clears any error message. - */ - error: string - - /** - * The name of the remote computer when a connection is established. - * If the connection is shut down or does not exist, the property contains the empty string. - */ - readonly host: string - - /** - * The timeout in seconds to be applied to read or write operations. - */ - timeout: number - - /** - * Terminates the open connection. - * Returns true if the connection was closed, false on I/O errors. - * Deleting the object also closes the connection, but not until JavaScript garbage-collects the object. The connection might stay open longer than you wish if you do not close it explicitly. - */ - close(): boolean - - /** - * Instructs the object to start listening for an incoming connection. - * The call to open() and the call to listen()are mutually exclusive. Call one function or the other, not both. - * @param port The TCP/IP port number to listen on. Valid port numbers are 1 to 65535. Typical values are 80 for a Web server, 23 for a Telnet server and so on. - * @param encoding The encoding to be used for the connection Typical values are "ASCII", "BINARY", or "UTF-8". - */ - listen(port: number, encoding?: string): boolean - - /** - * Opens the connection for subsequent read/write operations. - * The call to open() and the call to listen() are mutually exclusive. Call one function or the other, not both. - * @param host The server to connect to. This can be a DNS name, an IPv4 address, or an IPv6 address, followed by a colon and a port number. - * @param encoding The encoding to be used for the connection Typical values are "ASCII", "binary", or "UTF-8". - */ - open(host: string, encoding?: string): boolean - - /** - * Checks a listening object for a new incoming connection. - * If a connection request was detected, the method returns a new Socket object that wraps the new connection. Use this connection object to communicate with the remote computer. After use, close the connection and delete the JavaScript object. If no new connection request was detected, the method returns null. - */ - poll(): Socket - - /** - * Reads up to the specified number of characters from the connection. CR characters are ignored unless the encoding is set to "BINARY". - * Returns a string that contains up to the number of characters that were supposed to be read, or the number of characters read before the connection closed or timed out. - * @param count The number of characters to read. If not supplied, the connection attempts to read as many characters it can get and returns immediately. - */ - read(count?: number): string - - /** - * Reads one line of text up to the next line feed. - * Line feeds are recognized as LF or CRLF pairs. CR characters are ignored. Returns a string containing the characters. - */ - readln(): string - - /** - * Concatenates all arguments into a single string and writes that string to the connection. - * @param text Any number of string values. All arguments are concatenated to form the string to be written. CRLF sequences are converted to LFs unless the encoding is set to "BINARY". - */ - write(text: string): boolean - - /** - * Concatenates all arguments into a single string, appends a LF character, and writes that string to the connection. - * @param text Any number of string values. All arguments are concatenated to form the string to be written. CRLF sequences are converted to LFs unless the encoding is set to "BINARY". - */ - writeln(text: string): boolean -} - -/** - * Provides information about a method, a property or a method parameters. - */ -interface ReflectionInfo { - /** - * The description of method or function arguments. - */ - readonly arguments: ReflectionInfo[] - - /** - * The data type. - */ - readonly dataType: string - - /** - * The default value. - */ - readonly defaultValue: any - - /** - * The long description text. - */ - readonly description: string - - /** - * The short description text. - */ - readonly help: string - - /** - * Contains true if the class describes a collection class. - */ - readonly isCollection: boolean - - /** - * The maximum value. - */ - readonly max: number - - /** - * The minimum value. - */ - readonly min: number - - /** - * The element name. - */ - readonly name: string - - /** - * The class object that this element belongs to. - */ - readonly parent: Reflection - - /** - * Sample code, if present. - */ - readonly sampleCode: string - - /** - * A file containing sample code. May be null. - */ - readonly sampleFile: File - - /** - * The element type. - * One of unknown, readonly, readwrite, createonly, method or parameter. - */ - readonly type: string -} -declare const ReflectionInfo: ReflectionInfo - -/** - * Provides information about a class. - */ -interface Reflection { - /** - * The long description text. - */ - readonly description: string - - /** - * The short description text. - */ - readonly help: string - - /** - * An array of method descriptions. - */ - readonly methods: ReflectionInfo[] - - /** - * The class name. - */ - readonly name: string - - /** - * An array of property descriptions. - */ - readonly properties: ReflectionInfo[] - - /** - * Sample code, if present. - */ - readonly sampleCode: string - - /** - * A file containing sample code. May be null. - */ - readonly sampleFile: File - - /** - * An array of class method descriptions. - */ - readonly staticMethods: ReflectionInfo[] - - /** - * An array of class property descriptions. - */ - readonly staticProperties: ReflectionInfo[] - - /** - * Finds an element description by name. - * @param name The name of the element to find. - */ - find(name: string): ReflectionInfo - - /** - * Returns this class information as XML in OMV format. - */ - toXML(): XML -} -declare const Reflection: Reflection - -interface QNameConstructor { - readonly prototype: QName - - /** - * Creates a QName object. - * @param uri The URI, specified as a Namespace object, an existing QName object, or string. If this is a Namespace object, the URI is set to the namespace URI, and there is no local name. If this is a QName object, the URI and localName is set to those of that object. If this is a string, the URI is set to that string. - * @param name The local name. Used only if URI is given as a string. - */ - new (uri: any, name?: string): QName - (uri: any, name?: string): QName -} -declare const QName: QNameConstructor - -/** - * A qualified XML name, containing the URI and the local name. - */ -interface QName { - /** - * The local name part of the qualified name. - */ - readonly localName: string - - /** - * The URI part of the qualified name. - */ - readonly uri: string -} - -interface NamespaceConstructor { - readonly prototype: Namespace - - /** - * Creates a Namespace object. - * @param prefix The URIprefix, specified as an existing Namespace object, QName object, or string. If this is a Namespace or a QName object, the URI and prefix are set to that of the object. If this is a string, the prefix is set to that string, and the URI must be specified. - * @param uri The URI if the prefix is specified as a string. - */ - new (prefix: any, uri?: string): Namespace - (prefix: any, uri?: string): Namespace -} -declare const Namespace: NamespaceConstructor - -/** - * A XML namespace object. - */ -interface Namespace { - /** - * The named prefix. - */ - readonly prefix: string - - /** - * The URI. - */ - readonly uri: string -} - -interface XMLConstructor { - readonly prototype: XML - - /** - * Parses an XML string. Throws an error if the XML is incorrect. - * @param text The text to parse. - */ - new (text: string): XML - (text: string): XML - - /** - * Controls whether XML comments should be parsed (false) or ignored (true). - */ - ignoreComments: boolean - - /** - * Controls whether XML preprocessing instructions should be parsed (false) or ignored (true). - */ - ignoreProcessingInstructions: boolean - - /** - * Controls whether whitespace should be parsed (false) or ignored (true). - */ - ignoreWhitespace: boolean - - /** - * The number of spaces used to indent pretty-printed XML. - */ - prettyIndent: number - - /** - * When true, XML is pretty-printed when converting to a string. - */ - prettyPrinting: boolean - - /** - * Returns an object containing the default parsing and print settings for XML. - */ - defaultSettings(): object - - /** - * Sets the parsing and print setting for XML using an object returned by the settings() method. - * @param obj The object containing the settings to set. - */ - setSettings(obj: object): void - - /** - * Returns an object containing the current parsing and print settings for XML. - */ - settings(): object -} -declare const XML: XMLConstructor - -/** - * Wraps XML into an object. - */ -interface XML { - /** - * Adds a namespace declaration to the node. Returns the XML object itself. - * @param namespace The namespace to add. - */ - addNamespace(namespace: Namespace): XML - - /** - * Appends the given XML to this XML as a child. Returns the XML object itself. - * If the argument is not XML, creates a new XML element containing the argument as text. The element name of that new XML is the same as the last element in the original XML. - * @param child The child XML to add. - */ - appendChild(child: XML): XML - - /** - * Returns a list containing all attribute elements matching the given name. - * @param name The attribute name to look for. - */ - attribute(name: string): XML - - /** - * Returns a list containing all attribute elements. - */ - attributes(): XML - - /** - * Returns a list containing all children of this XML matching the given element name. - * If the argument is a number, uses the number as index into the array of children. - * @param name The name or the index of the child element. - */ - child(name: string): XML - - /** - * Returns a number representing the ordinal position of this XML object within the context of its parent. - */ - childIndex(): number - - /** - * Returns an XML object containing all the properties of this XML object in order. - */ - children(): XML - - /** - * Returns an XML object containing the properties of this XML object that represent XML comments. - */ - comments(): XML - - /** - * Checks if this XML object contains the given XML object. - * @param xml The XML to search for. - */ - contains(xml: XML): boolean - - /** - * Creates a copy of this XML object. - */ - copy(): XML - - /** - * Returns all the XML-valued descendants of this XML object with the given name. - * If the name parameter is omitted, returns all descendants of this XML object. - * @param name The name of the descendant to find. - */ - descendants(name?: string): XML - - /** - * Returns a list of XML children that are elements with a given name, or all children that are XML elements. - * @param name The element name. If not supplied, gets all children that are XML elements. - */ - elements(name?: string): XML - - /** - * Reports whether this XML object contains complex content. - * An XML object is considered to contain complex content if it represents an XML element that has child elements. XML objects representing attributes, comments, processing instructions and text nodes do not have complex content. The existence of attributes, comments, processing instructions and text nodes within an XML object is not significant in determining if it has complex content. - */ - hasComplexContent(): boolean - - /** - * Reports whether this XML object contains simple content. - * An XML object is considered to contain simple content if it represents a text node, represents an attribute node or if it represents an XML element that has no child elements. XML objects representing comments and processing instructions do not have simple content. The existence of attributes, comments, processing instructions and text nodes within an XML object is not significant in determining if it has simple content. - */ - hasSimpleContent(): boolean - - /** - * Returns an array of Namespace objects mirroring the current list of valid namespaces at this element. - * The last element of thereturned array is the default namespace. - */ - inScopeNamespaces(): Namespace[] - - /** - * Inserts the given child2 after the given child1 in this XML object and returns this XML object. - * If child1 is null, the method inserts child2 before all children of this XML object (that is, after none of them). If child1 does not exist in this XML object, the method returns without modifying this XML object. - * @param child1 The child to insert the other child after. If null, the method inserts child2 before all children of this XML object. - * @param child2 The XML to insert. - */ - insertChildAfter(child1: XML, child2: XML): void - - /** - * Inserts the given child2 before the given child1 in this XML object and returns this XML object. - * If child1 is null, the method inserts child2 after all children of this XML object (that is, before none of them). If child1 does not exist in this XML object, the method returns without modifying this XML object. - * @param child1 The child to search for. If null, the method inserts child2 after all children of this XML object. - * @param child2 The XML to insert. - */ - insertChildBefore(child1: XML, child2: XML): void - - /** - * Returns the number of elements contained in an XML list. If this XML object is not a list, returns 1. - */ - length(): number - - /** - * Returns the local name of this XML object. - * This value corresponds to the element name unless the name has a namespace prefix. For example, if the element has the name "ns:tag", the return value is "tag". - */ - localName(): string - - /** - * Returns a QName object containing the URI and the local name of the element. - */ - name(): QName - - /** - * Returns a Namespace object containing the namespace URI of the current element. - */ - namespace(): Namespace - - /** - * Returns an array containing all namespace declarations of this XML object. - */ - namespaceDeclarations(): Namespace[] - - /** - * Returns the type of this XML object as one of the strings "element", "attribute", "comment", "processing-instruction", or "text". - */ - nodeKind(): string - - /** - * Puts all text nodes in this and all descendant XML objects into a normal form by merging adjacent text nodes and eliminating empty text nodes. Returns this XML object. - */ - normalize(): XML - - /** - * Returns the parent object of this XML object. - * The root object, as returned by the XML constructor, does not have a parent and returns null. Note that the E4X standard does not define what happens if this XML object is a list containing elements with multiple parents. - */ - parent(): XML - - /** - * Inserts a given child into this object before its existing XML properties, and returns this XML object. - * @param child The XML to insert. - */ - prependChild(child: XML): XML - - /** - * Returns a list of preprocessing instructions. - * Collects processing-instructions with the given name, if supplied. Otherwise, returns an XML list containing all the children of this XML object that are processing-instructions regardless of their name. - * @param name The name of the preprocessing instruction to return. - */ - processingInstructions(name?: string): XML - - /** - * Removes the given namespace from this XML, and returns this XML. - * @param namespace The namespace to remove. - */ - removeNamespace(namespace: Namespace): XML - - /** - * Replaces the value of specified XML properties of this XML object returns this XML object. - * This method acts like the assignment operator. - * @param name The property name. Can be a numeric property name, a name for a set of XML elements, or the properties wildcard “*”. If this XML object contains no properties that match the name, the method returns without modifying this XML object. - * @param value The XML with which to replace the value of the matching property. Can be an XML object, XML list or any value that can be converted to a String with toString(). - */ - replace(name: string, value: XML): XML - - /** - * Replaces all of the XML-valued properties in this object with a new value, and returns this XML object. - * @param value The new value, which can be a single XML object or an XML list. - */ - setChildren(value: XML): XML - - /** - * Replaces the local name of this XML objectwith a string constructed from the given name - * The local name is any part behind a colon character. If there is no colon, it is the entire name. - * @param name The name to set. - */ - setLocalName(name: string): void - - /** - * Replaces the name of this XML object with the given QName object. - * @param name The fully qualified name. - */ - setName(name: QName): void - - /** - * Sets the namespace for this XML element. - * If the namespace has not been declared in the tree above this element, adds a namespace declaration. - * @param namespace The namespace to set. - */ - setNamespace(namespace: Namespace): void - - /** - * Returns an XML list containing all XML properties of this XML object that represent XML text nodes. - */ - text(): XML - - /** - * Returns the string representation of this object. - * For text and attribute nodes, this is the textual value of the node; for other elements, this is the result of calling the toXMLString() method. If this XML object is a list, concatenates the result of calling toString() on each element. - */ - toString(): string - - /** - * Returns an XML-encoded string representation of this XML object. - * Always includes the start tag, attributes and end tag of the XML object regardless of its content. It is provided for cases when the default XML to string conversion rules are not desired. Interprets the global settings XML.prettyPrint and XML.prettyIndent. - */ - toXMLString(): string - - /** - * Evaluates the given XPath expression in accordance with the W3C XPath recommendation, using this XML object as the context node. - * @param expr The XPath expression to use. - */ - xpath(expr: string): XML -} - -/** - * An XML list object. - * In this implementation, an XMLList object is synonymous to the XML object. The constructor accepts an XML list, but everything else works like theXML object. - */ -interface XMLList {} -declare const XMLList: XMLList - -interface UnitValueConstructor { - readonly prototype: UnitValue - - /** - * Creates a new UnitValue object. - */ - new (value: string | UnitValue): UnitValue - (value: string | UnitValue): UnitValue - - /** - * The base unit for all conversions. - */ - baseUnit: UnitValue -} -declare const UnitValue: UnitValueConstructor - -/** - * Represents a measurement as a combination of values and unit. - * Note that this object is not available in all applications. - */ -interface UnitValue { - /** - * The base unit. - */ - baseUnit: UnitValue - - /** - * The unit name. - */ - readonly type: string - - /** - * The numeric value. - */ - value: number - - /** - * Returns this instance as a different unit. - * @param unitName The unit name. - */ - as(unitName: string): UnitValue - - /** - * Converts this instance to a different unit. - * @param unitName The unit name. - */ - convert(unitName: string): any -} - -/** - * Only for TypeScript compatibility - */ -interface CallableFunction extends Function { - -} - -interface NewableFunction extends Function { - -} - -interface IArguments { - [index: number]: any - length: number - callee: Function -} - -/** - * Make all properties in T optional - */ -type Partial = { [P in keyof T]?: T[P] } - -/** - * Make all properties in T readonly - */ -type Readonly = { readonly [P in keyof T]: T[P] } - -/** - * From T pick a set of properties K - */ -type Pick = { [P in K]: T[P] } - -/** - * Construct a type with a set of properties K of type T - */ -type Record = { [P in K]: T } diff --git a/shared/ScriptUI.d.ts b/shared/ScriptUI.d.ts index 51b3c8a0..9063cacc 100644 --- a/shared/ScriptUI.d.ts +++ b/shared/ScriptUI.d.ts @@ -1,5 +1,3 @@ -/// - declare enum _Alignment { TOP = 1, BOTTOM, diff --git a/shared/global.d.ts b/shared/global.d.ts index 3ad81f85..81051a69 100644 --- a/shared/global.d.ts +++ b/shared/global.d.ts @@ -1,4 +1,187 @@ -/// +/** + * The $ object provides a number of debugging facilities and informational methods. + */ +interface $ { + /** + * The ExtendScript build information. + */ + readonly build: string + + /** + * The ExtendScript build date. + */ + readonly buildDate: Date + + /** + * The character used as the decimal point character in formatted numeric output. + */ + decimalPoint: string + + /** + * The name of the current ExtendScript engine, if set. + */ + readonly engineName: string + + /** + * The most recent run-time error information. + * Assigning error text to this property generates a run-time error; however, the preferred way to generate a run-time error is to throw an Error object. + */ + error: Error + + /** + * The file name of the current script. + */ + readonly fileName: string + + /** + * Gets or sets low-level debug output flags. + * A logical AND of bit flag values: + * 0x0002 (2): Displays each line with its line number as it is executed. + * 0x0040 (64): Enables excessive garbage collection. Usually, garbage collection starts when the number of objects has increased by a certain amount since the last garbage collection. This flag causes ExtendScript to garbage collect after almost every statement. This impairs performance severely, but is useful when you suspect that an object gets released too soon. + * 0x0080 (128): Displays all calls with their arguments and the return value. + * 0x0100 (256): Enables extended error handling (see strict). + * 0x0200 (512): Enables the localization feature of the toString method. Equivalent to the localize property. + */ + flags: number + + /** + * A reference to the global object, which contains the JavaScript global namespace. + */ + readonly global: any + + /** + * A high-resolution timer, measuring the time in microseconds. The timer starts when ExtendScript is + * initialized during the application startup sequence. Every read access resets the timer to Zero. + */ + readonly hiresTimer: number + + /** + * The path for include files for the current script. + */ + readonly includePath: string + + /** + * The current debugging level, which enables or disables the JavaScript debugger. + * One of 0 (no debugging), 1 (break on runtime errors), or 2 (full debug mode). + */ + level: number + + /** + * The current line number of the currently executing script. + */ + readonly line: number + + /** + * Gets or sets the current locale. + * The string contains five characters in the form LL_RR, where LL is an ISO 639 language specifier, and RR is an ISO 3166 region specifier.Initially, this is the value that the application or the platform returns for the current user. You can set it to temporarily change the locale for testing. To return to the application or platform setting, set to undefined, null, or the empty string. + */ + locale: string + + /** + * Set to true to enable the extended localization features of the built-in toString() method. + */ + localize: boolean + + /** + * The ExtendScript memory cache size, in bytes. + */ + memCache: number + + /** + * The current operating system version information. + */ + readonly os: string + + /** + * An array of objects containing information about the display screens attached to your computer. + * Each object has the properties left, top, right, bottom, which contain the four corners of each screen in global coordinates.A property primary is true if that object describes the primary display. + */ + readonly screens: object[] + + /** + * The current stack trace. + */ + readonly stack: string + + /** + * Sets or clears strict mode for object modification. + * When true, any attempt to write to a read-only property causes a runtime error. Some objects do not permit the creation of new properties when true. + */ + strict: any + + /** + * The version number of the ExtendScript engine. + * Formatted as a three-part number and description; for example: "3.92.95 (debug)". + */ + readonly version: string + + /** + * Shows an About box for the ExtendScript component, and returns the text for the box. + */ + about(): string + + /** + * Breaks execution at the current position. + * @param condition A string containing a JavaScript statement to be used as a condition. If the statement evaluates to true or nonzero when this point is reached, execution stops. + */ + bp(condition?: any): void + + /** + * Invokes the platform-specific color selection dialog, and returns the selected color. + * @param color The color to be preselected in the dialog, as 0xRRGGBB, or -1 for the platform default. + */ + colorPicker(color: number): number + + /** + * Loads and evaluates a file. + * @param file The file to load. + * @param timeout An optional timeout in milliseconds. + */ + evalFile(file: File, timeout?: number): any + + /** + * Initiates garbage collection in the ExtendScript engine. + */ + gc(): void + + /** + * Retrieves the value of an environment variable. + * @param name The name of the variable. + */ + getenv(name: string): string + + /** + * Sets the value of an environment variable. + * @param name The name of the variable. + * @param value The value of the variable. + */ + setenv(name: string, value: string): void + + /** + * Suspends the calling thread for a number of milliseconds. + * During a sleep period, checks at 100 millisecond intervals to see whether the sleep should be terminated. This can happen if there is a break request, or if the script timeout has expired. + * @param msecs Number of milliseconds to sleep. + */ + sleep(msecs: number): void + + /** + * Converts this object to a string. + */ + toString(): string + + /** + * Prints text to the Console. + * @param text The text to print. All arguments are concatenated. + */ + write(text: any): void + + /** + * Prints text to the Console, and adds a newline character. + * @param text The text to print. All arguments are concatenated. + */ + writeln(text: any): void +} +declare const $: $ /** * The global BridgeTalk object. @@ -149,3 +332,1222 @@ declare function unescape(stringExpression: string): string * @param what The object to uneval. */ declare function uneval(what: any): string + + +interface FileConstructor { + readonly prototype: File + + /** + * Creates and returns a new File object referring to a given file system location. + * @param path The full or partial path name of the file,in platform-specific or URI format. The value stored in the object is the absolute path. The file that the path refers to does not need to exist.If the path refers to an existing folder: The File function returns a Folder object instead of a File object. The new operator returns a File object for a nonexisting file with the same name. + */ + new(path?: string): File + (path?: string): File + + /** + * The name of the file system. + * This is a class property accessed through the File constructor. Valid values are "Windows", "Macintosh", and "Unix". + */ + readonly fs: string + + /** + * Decodes a UTF-8 encoded string as required by RFC 2396, and returns the decoded string. + * See also String.decodeURI(). + * @param uri The UTF-8 encoded string to decode. + */ + decode(uri: string): string + + /** + * Encodes a string as required by RFC 2396, and returns the encoded string. + * All special characters are encoded in UTF-8 and stored as escaped characters starting with the percent sign followed by two hexadecimal digits. For example, the string "my file" is encoded as "my%20file". + * Special characters are those with a numeric value greater than 127, except the following: / - _ . ! ~ * ' ( ) + * See also encodeURI(). + * @param name The string to encode. + */ + encode(name: string): string + + /** + * Reports whether a given encoding is available. + * @param name The encoding name. Typical values are "ASCII", "binary", or "UTF-8".For a complete list of supported encodings, see the JavaScript Tools Guide. + */ + isEncodingAvailable(name: string): boolean + + /** + * Opens a dialog so the user can select one or more files to open. + * Opens the built-in platform-specific file-browsing dialog in which a user can select an existing file or multiple files, and creates new File objects to represent the selected files. + * If the user clicks OK, returns a File object for the selected file, or an array of objects if multiple files are selected. + * If the user cancels, returns null. + * @param prompt The prompt text, displayed if the dialog allows a prompt. + * @param filter A filter that limits the types of files displayed in the dialog. In Windows,a filter expression such as "Javascript files:*.jsx;All files:*.*". In Mac OS, a filter function that takes a File instance and returns true if the file should be included in the display, false if it should not. + * @param multiSelect When true, the user can select multiple files and the return value is an array. + */ + openDialog(prompt?: string, filter?: any, multiSelect?: boolean): File + + /** + * Opens a dialog so the user can select a file name to save to. + * Opens the built-in platform-specific file-browsing dialog in which a user can select an existing file location to which to save information, and creates a new File object to represent the selected file location. + * If the user clicks OK, returns a File object for the selected file location. + * If the user cancels, returns null. + * @param prompt The prompt text, displayed if the dialog allows a prompt. + * @param filter In Windows only, a filter that limits the types of files displayed in the dialog. In Windows only,a filter expression such as "Javascript files:*.jsx;All files:*.*". Not used In Mac OS. + */ + saveDialog(prompt?: string, filter?: any): File +} +declare const File: FileConstructor + +/** + * Represents a file in the local file system in a platform-independent manner. + */ +interface File { + /** + * The full path name for the referenced file in URI notation. + */ + readonly absoluteURI: string + + /** + * If true, the object refers to a file system alias or shortcut. + */ + readonly alias: boolean + + /** + * The creation date of the referenced file, or null if the object does not refer to a file on disk. + */ + readonly created: Date + + /** + * In Mac OS, the file creator as a four-character string. In Windows or UNIX, value is "????". + */ + readonly creator: string + + /** + * The localized name of the referenced file, without the path specification. + */ + readonly displayName: string + + /** + * Gets or sets the encoding for subsequent read/write operations. + * One of the encoding constants listed in the JavaScript Tools Guide. If the value is not recognized, uses the system default encoding.A special encoder, BINARY, is used to read binary files. It stores each byte of the file as one Unicode character regardless of any encoding. When writing, the lower byte of each Unicode character is treated as a single byte to write. + */ + encoding: string + + /** + * When true, a read attempt caused the current position to be at the end of the file, or the file is not open. + */ + readonly eof: boolean + + /** + * A string containing a message describing the most recent file system error. + * Typically set by the file system, but a script can set it. Setting this value clears any error message and resets the error bit for opened files. Contains the empty string if there is no error. + */ + error: string + + /** + * If true, this object refers to a file or file-system alias that actually exists in the file system. + */ + readonly exists: boolean + + /** + * The platform-specific full path name for the referenced file. + */ + readonly fsName: string + + /** + * The full path name for the referenced file in URI notation. + */ + readonly fullName: string + + /** + * When true, the file is not shown in the platform-specific file browser. + * If the object references a file-system alias or shortcut, the flag is altered on the alias, not on the original file. + */ + hidden: boolean + + /** + * The size of the file in bytes. + * Can be set only for a file that is not open, in which case it truncates or pads the file with 0-bytes to the new length. + */ + length: number + + /** + * How line feed characters are written in the file system. + * One of the values "Windows", "Macintosh", or "Unix". + */ + lineFeed: string + + /** + * The date of the referenced file's last modification, or null if the object does not refer to a file on the disk. + */ + readonly modified: Date + + /** + * The file name portion of the absolute URI for the referenced file, without the path specification. + */ + readonly name: string + + /** + * The Folder object for the folder that contains this file. + */ + readonly parent: Folder + + /** + * The path portion of the absolute URI for the referenced file, without the file name. + */ + readonly path: string + + /** + * When true, prevents the file from being altered or deleted. + * If the referenced file is a file-system alias or shortcut, the flag is altered on the alias, not on the original file. + */ + readonly: boolean + + /** + * The path name for the object in URI notation, relative to the current folder. + */ + readonly relativeURI: string + + /** + * The file type as a four-character string. + * In Mac OS, the Mac OS file type. + * In Windows, "appl" for .EXE files, "shlb" for .DLL files and "TEXT" for any other file. + */ + readonly type: string + + /** + * Changes the path specification of the referenced file. + * @param path A string containing the new path, absolute or relative to the current folder. + */ + changePath(path: string): boolean + + /** + * Closes this open file. + * Returns true if the file was closed successfully, false if an I/O error occurred. + */ + close(): boolean + + /** + * Copies this object’s referenced file to the specified target location. + * Resolves any aliases to find the source file. If a file exists at the target location, it is overwritten. + * Returns true if the copy was successful. + * @param target A string with the URI path to the target location, or a File object that references the target location. + */ + copy(target: string): boolean + + /** + * Makes this file a file-system alias or shortcut to the specified file. + * The referenced file for this object must not yet exist on disk. Returns true if the operation was successful. + * @param path A string containing the path of the target file. + */ + createAlias(path: string): void + + /** + * Executes or opens this file using the appropriate application, as if it had been double-clicked in a file browser. + * You can use this method to run scripts, launch applications, and so on.Returns true immediately if the application launch was successful. + */ + execute(): boolean + + /** + * Retrieves and returns the path for this file, relative to the specified base path, in URI notation. + * If no base path is supplied, the URI is relative to the path of the current folder.Returns a string containing the relative URI. + * @param basePath A base path in URI notation. + */ + getRelativeURI(basePath: string): string + + /** + * Opens the referenced file for subsequent read/write operations. The method resolves any aliases to find the file. + * Returns true if the file was opened successfully.The method attempts to detect the encoding of the open file. It reads a few bytes at the current location and tries to detect the Byte Order Mark character 0xFFFE. If found, the current position is advanced behind the detected character and the encoding property is set to one of the strings UCS-2BE, UCS-2LE, UCS4-BE, UCS-4LE, or UTF-8. If the marker character is not found, it checks for zero bytes at the current location and makes an assumption about one of the above formats (except UTF-8). If everything fails, the encoding property is set to the system encoding. + * IMPORTANT: Be careful about opening a file more than once. The operating system usually permits you to do so, but if you start writing to the file using two different File objects, you can destroy your data. + * @param mode The read-write mode, a single-character string. One of these characters: r (read) Opens for reading. If the file does not exist or cannot be found, the call fails. w (write) Opens a file for writing. If the file exists, its contents are destroyed. If the file does not exist, creates a new, empty file. e (edit) Opens an existing file for reading and writing. a (append) Opens an existing file for reading and writing, and moves the current position to the end of the file. + * @param type In Mac OS, the type of a newly created file, a 4-character string. Ignored in Windows and UNIX. + * @param creator In Mac OS, the creator of a newly created file, a 4-character string. Ignored in Windows and UNIX. + */ + open(mode: string, type?: string, creator?: string): boolean + + /** + * Opens the built-in platform-specific file-browsing dialog, in which the user can select an existing file or files, and creates new File objects to represent the selected files. + * Differs from the class method openDialog() in that it presets the current folder to this File object’s parent folder and the current file to this object’s associated file. + * If the user clicks OK, returns a File or Folder object for the selected file or folder, or an array of objects. + * If the user cancels, returns null. + * @param prompt A string containing the prompt text, if the dialog allows a prompt. + * @param filter A filter that limits the types of files displayed in the dialog. In Windows,a filter expression such as "Javascript files:*.jsx;All files:*.*". In Mac OS, a filter function that takes a File instance and returns true if the file should be included in the display, false if it should not. + * @param multiSelect When true, the user can select multiple files and the return value is an array. + */ + openDlg(prompt?: string, filter?: any, multiSelect?: boolean): File + + /** + * Reads the contents of the file, starting at the current position. + * Returns a string that contains up to the specified number of characters. If a number of characters is not supplied, reads from the current position to the end of the file. If the file is encoded, multiple bytes might be read to create single Unicode characters. + * @param chars An integer specifying the number of characters to read. + */ + read(chars?: number): string + + /** + * Reads a single text character from the file at the current position. + * Line feeds are recognized as CR, LF, CRLF or LFCR pairs.If the file is encoded, multiple bytes might be read to create a single Unicode character. Returns a string that contains the character. + */ + readch(): string + + /** + * Reads a single line of text from the file at the current position. + * Line feeds are recognized as CR, LF, CRLF or LFCR pairs.. If the file is encoded, multiple bytes might be read to create single Unicode characters. Returns a string that contains the text. + */ + readln(): string + + /** + * Deletes the file associated with this object from disk immediately, without moving it to the system trash. + * Does not resolve aliases; instead, deletes the referenced alias or shortcut file itself. Returns true if the file was successfully removed. + * IMPORTANT: Cannot be undone. It is recommended that you prompt the user for permission before deleting. + */ + remove(): boolean + + /** + * Renames the associated file. + * Does not resolve aliases, but renames the referenced alias or shortcut file itself. Returns true if the file was successfully renamed. + * @param newName The new file name, with no path information. + */ + rename(newName: string): boolean + + /** + * Attempts to resolve the file-system alias or shortcut that this object refers to. + * If successful, creates and returns a new File object that points to the resolved file system element. Returns null if this object does not refer to an alias, or if the alias could not be resolved. + */ + resolve(): File + + /** + * Opens the built-in platform-specific file-browsing dialog, in which the user can select an existing file location to which to save information, and creates a new File object to represent the selected file. + * Differs from the class method saveDialog() in that it presets the current folder to this File object’s parent folder and the file to this object’s associated file. + * If the user clicks OK, returns a File object for the selected file. + * If the user cancels, returns null. + * @param prompt A string containing the prompt text, if the dialog allows a prompt. + * @param filter In Windows only, a filter that limits the types of files displayed in the dialog. In Windows only,a filter expression such as "Javascript files:*.jsx;All files:*.*". Not used In Mac OS. + */ + saveDlg(prompt?: string, filter?: any): File + + /** + * Seeks to a given position in the file. + * The new position cannot be less than 0 or greater than the current file size. Returns true if the position was changed. + * @param pos The new current position in the file as an offset in bytes from the start, current position, or end, depending on the mode. + * @param mode The seek mode. One of: 0: Seek to absolute position, where pos=0 is the first byte of the file. This is the default. 1: Seek relative to the current position. 2. Seek backward from the end of the file. + */ + seek(pos: number, mode?: number): boolean + + /** + * Retrieves the current position as a byte offset from the start of the file. + * Returns a number, the position index. + */ + tell(): number + + /** + * Creates and returns a serialized string representation of this object. + * Pass the resulting string to eval() to recreate the object. + */ + toSource(): string + + /** + * Converts this object to a string. + */ + toString(): string + + /** + * Writes the specified text to the file at the current position. + * You can supply multiple text values; the strings are concatenated to form a single string.For encoded files, writing a single Unicode character may write multiple bytes. Returns true if the write was successful.IMPORTANT: Be careful not to write to a file that is open in another application or object, as this can overwrite existing data. + * @param text A text string to be written. + */ + write(text: string): boolean + + /** + * Writes a string to the file at the current position and appends a line-feed sequence. + * You can supply multiple text values. The strings are concatenated into a single string, which is written in the file followed by one line-feed sequence, of the style specified by this object's linefeed property.For encoded files, writing a single Unicode character may write multiple bytes.Returns true if the write was successful.IMPORTANT: Be careful not to write to a file that is open in another application or object, as this can overwrite existing data. + * @param text A text string to be written. + */ + writeln(text: string): boolean +} + +interface FolderConstructor { + readonly prototype: Folder + + /** + * Creates and returns a new Folder object referring to a given file-system location. + * If the path name refers to an already existing disk file, a File object is returned instead.Returns the new Folder object. + * @param path The absolute or relative path to the folder associated with this object, specified in URI format. The value stored in the object is the absolute path.The path need not refer to an existing folder. If the path refers to an existing file, rather than a folder: The Folder() function returns a File object instead of a Folder object. The new operator returns a Folder object for a nonexisting folder with the same name. + */ + new(path?: string): Folder + (path?: string): Folder + + /** + * The folder containing the application data for all users. + * In Windows, the value of %APPDATA% (by default, C:\\Documents and Settings\\All Users\\Application Data) + * In Mac OS, /Library/Application Support + */ + readonly appData: Folder + + /** + * In Mac OS, a Folder object for the folder containing the bundle of the running application. + */ + readonly appPackage: Folder + + /** + * A Folder object for the folder containing common files for all programs installed by the user. + * In Windows, the value of %CommonProgramFiles% (by default, C:\\Program Files\\Common Files) + * In Mac OS, /Library/Application Support + */ + readonly commonFiles: Folder + + /** + * A Folder object for the current folder. + * Assign a Folder object or a string containing the new path name to set the current folder. This is a class property accessed through the Folder constructor. + */ + current: Folder + + /** + * A Folder object for the folder that contains the user’s desktop. + * In Windows, C:\\Documents and Settings\\username\\Desktop + * In Mac OS, ~/Desktop + */ + readonly desktop: Folder + + /** + * The name of the current file system. + * One of "Windows", "Macintosh", or "Unix". + */ + readonly fs: string + + /** + * A folder pointing to the user's My Documents folder. + * In Windows, C:\\Documents and Settings\\username\\My Documents + * In Mac OS,~/Documents + */ + readonly myDocuments: Folder + + /** + * A Folder object for the folder containing the executable image of the running application. + */ + readonly startup: Folder + + /** + * A Folder object for the folder containing the operating system files. + * In Windows, the value of %windir% (by default, C:\\Windows) + * In Mac OS, /System + */ + readonly system: Folder + + /** + * A Folder object for the default folder for temporary files. + */ + readonly temp: Folder + + /** + * A Folder object for the folder containing deleted items. On Windows, the trash folder is a virtual + * folder containing a database; therefore, the property value is null on Windows. + */ + readonly trash: Folder + + /** + * A Folder object for the folder containing the user's application data. + * In Windows, the value of %USERDATA% (by default, C:\\Documents and Settings\\username\\Application Data) + * In Mac OS,~/Library/Application Support. + */ + readonly userData: Folder + + /** + * Decodes a UTF-8 encoded string as required by RFC 2396, and returns the decoded string. + * See also String.decodeURI(). + * @param uri The UTF-8 string to decode. + */ + decode(uri: string): string + + /** + * Encodes a string as required by RFC 2396, and returns the encoded string. + * All special characters are encoded in UTF-8 and stored as escaped characters starting with the percent sign followed by two hexadecimal digits. For example, the string "my file" is encoded as "my%20file". + * Special characters are those with a numeric value greater than 127, except the following: / - _ . ! ~ * ' ( ) + * See also encodeURI(). + * @param name The string to encode. + */ + encode(name: string): string + + /** + * Reports whether a given encoding is available. + * @param name The encoding name. Typical values are "ASCII", "binary", or "UTF-8".For a complete list of supported encodings, see the JavaScript Tools Guide. + */ + isEncodingAvailable(name: string): boolean + + /** + * Opens the built-in platform-specific file-browsing dialog, and creates a new File or Folder object for the selected file or folder. + * Differs from the object method selectDlg() in that it does not preselect a folder. + * If the user clicks OK, returns a File or Folder object for the selected file or folder. + * If the user cancels, returns null. + * @param prompt The prompt text, if the dialog allows a prompt. + */ + selectDialog(prompt?: string): Folder +} +declare const Folder: FolderConstructor + +/** + * Represents a file-system folder or directory in a platform-independent manner. + */ +interface Folder { + /** + * The full path name for the referenced folder in URI notation. + */ + readonly absoluteURI: string + + /** + * When true, the object refers to a file system alias or shortcut. + */ + readonly alias: boolean + + /** + * The creation date of the referenced folder, or null if the object does not refer to a folder on disk. + */ + readonly created: Date + + /** + * The localized name portion of the absolute URI for the referenced folder, without the path specification. + */ + readonly displayName: string + + /** + * A message describing the most recent file system error. + * Typically set by the file system, but a script can set it. Setting this value clears any error message and resets the error bit for opened files. Contains the empty string if there is no error. + */ + error: string + + /** + * When true, this object refers to a folder that currently exists in the file system. + */ + readonly exists: boolean + + /** + * The platform-specific name of the referenced folder as a full path name. + */ + readonly fsName: string + + /** + * The full path name for the referenced folder in URI notation. . + */ + readonly fullName: string + + /** + * The date of the referenced folder's last modification, or null if the object does not refer to a folder on disk. + */ + readonly modified: Date + + /** + * The folder name portion of the absolute URI for the referenced file, without the path specification. + */ + readonly name: string + + /** + * TThe Folder object for the folder that contains this folder, or null if this object refers to the root folder of a volume. + */ + readonly parent: Folder + + /** + * The path portion of the object absolute URI for the referenced file, without the folder name. + */ + readonly path: string + + /** + * The path name for the referenced folder in URI notation, relative to the current folder. + */ + readonly relativeURI: string + + /** + * Changes the path specification of the referenced folder. + * @param path A string containing the new path, absolute or relative to the current folder. + */ + changePath(path: string): boolean + + /** + * Creates a folder at the location given by this object's path property. + * Returns true if the folder was created. + */ + create(): boolean + + /** + * Opens this folder in the platform-specific file browser (as if it had been double-clicked in the file browser). + * Returns true immediately if the folder was opened successfully. + */ + execute(): boolean + + /** + * Retrieves the contents of this folder, filtered by the supplied mask. + * Returns an array of File and Folder objects, or null if this object's referenced folder does not exist. + * @param mask A search mask for file names, specified as a string or a function. A mask string can contain question mark (?) and asterisk (*) wild cards. Default is "*", which matches all file names. Can also be the name of a function that takes a File or Folder object as its argument. It is called for each file or folder found in the search; if it returns true, the object is added to the return array. NOTE: In Windows, all aliases end with the extension .lnk. ExtendScript strips this from the file name when found, in order to preserve compatibility with other operating systems. You can search for all aliases by supplying the search mask "*.lnk", but note that such code is not portable. + */ + getFiles(mask?: any): Array + + /** + * Retrieves and returns the path for this file, relative to the specified base path, in URI notation. + * If no base path is supplied, the URI is relative to the path of the current folder.Returns a string containing the relative URI. + * @param basePath A base path in URI notation. + */ + getRelativeURI(basePath?: string): string + + /** + * Deletes the folder associated with this object from disk immediately, without moving it to the system trash. + * Folders must be empty before they can be deleted. Does not resolve aliases; instead, deletes the referenced alias or shortcut file itself. Returns true if the file was successfully removed. + * IMPORTANT: Cannot be undone. It is recommended that you prompt the user for permission before deleting. + */ + remove(): boolean + + /** + * Renames the associated folder. + * Does not resolve aliases, but renames the referenced alias or shortcut file itself. Returns true if the folder was successfully renamed. + * @param newName The new folder name, with no path information. + */ + rename(newName: string): boolean + + /** + * Attempts to resolve the file-system alias or shortcut that this object refers to. + * If successful, creates and returns a new Folder object that points to the resolved file system element. Returns null if this object does not refer to an alias, or if the alias could not be resolved. + */ + resolve(): Folder + + /** + * Opens the built-in platform-specific file-browsing dialog, and creates a new File or Folder object for the selected file or folder. + * Differs from the class method selectDialog() in that it preselects this folder. + * If the user clicks OK, returns a File or Folder object for the selected file or folder. + * If the user cancels, returns null. + * @param prompt The prompt text, if the dialog allows a prompt. + */ + selectDlg(prompt?: string): Folder + + /** + * Creates and returns a serialized string representation of this object. + * Pass the resulting string to eval() to recreate the object. + */ + toSource(): string + + /** + * Converts this object to a string. + */ + toString(): string +} + +interface SocketConstructor { + readonly prototype: Socket + + /** + * Creates a new Socket object. + */ + new(): Socket + (): Socket +} +declare const Socket: SocketConstructor + +/** + * Creates a TCP/IP connection, or establishes a TCP/IP server. + */ +interface Socket { + /** + * When true, the connection is active. + */ + readonly connected: boolean + + /** + * Sets or retrieves the name of the encoding used to transmit data. + * Typical values are "ASCII", "BINARY", or "UTF-8". + */ + encoding: string + + /** + * When true, the receive buffer is empty. + */ + readonly eof: boolean + + /** + * A message describing the most recent error. Setting this value clears any error message. + */ + error: string + + /** + * The name of the remote computer when a connection is established. + * If the connection is shut down or does not exist, the property contains the empty string. + */ + readonly host: string + + /** + * The timeout in seconds to be applied to read or write operations. + */ + timeout: number + + /** + * Terminates the open connection. + * Returns true if the connection was closed, false on I/O errors. + * Deleting the object also closes the connection, but not until JavaScript garbage-collects the object. The connection might stay open longer than you wish if you do not close it explicitly. + */ + close(): boolean + + /** + * Instructs the object to start listening for an incoming connection. + * The call to open() and the call to listen()are mutually exclusive. Call one function or the other, not both. + * @param port The TCP/IP port number to listen on. Valid port numbers are 1 to 65535. Typical values are 80 for a Web server, 23 for a Telnet server and so on. + * @param encoding The encoding to be used for the connection Typical values are "ASCII", "BINARY", or "UTF-8". + */ + listen(port: number, encoding?: string): boolean + + /** + * Opens the connection for subsequent read/write operations. + * The call to open() and the call to listen() are mutually exclusive. Call one function or the other, not both. + * @param host The server to connect to. This can be a DNS name, an IPv4 address, or an IPv6 address, followed by a colon and a port number. + * @param encoding The encoding to be used for the connection Typical values are "ASCII", "binary", or "UTF-8". + */ + open(host: string, encoding?: string): boolean + + /** + * Checks a listening object for a new incoming connection. + * If a connection request was detected, the method returns a new Socket object that wraps the new connection. Use this connection object to communicate with the remote computer. After use, close the connection and delete the JavaScript object. If no new connection request was detected, the method returns null. + */ + poll(): Socket + + /** + * Reads up to the specified number of characters from the connection. CR characters are ignored unless the encoding is set to "BINARY". + * Returns a string that contains up to the number of characters that were supposed to be read, or the number of characters read before the connection closed or timed out. + * @param count The number of characters to read. If not supplied, the connection attempts to read as many characters it can get and returns immediately. + */ + read(count?: number): string + + /** + * Reads one line of text up to the next line feed. + * Line feeds are recognized as LF or CRLF pairs. CR characters are ignored. Returns a string containing the characters. + */ + readln(): string + + /** + * Concatenates all arguments into a single string and writes that string to the connection. + * @param text Any number of string values. All arguments are concatenated to form the string to be written. CRLF sequences are converted to LFs unless the encoding is set to "BINARY". + */ + write(text: string): boolean + + /** + * Concatenates all arguments into a single string, appends a LF character, and writes that string to the connection. + * @param text Any number of string values. All arguments are concatenated to form the string to be written. CRLF sequences are converted to LFs unless the encoding is set to "BINARY". + */ + writeln(text: string): boolean +} + +/** + * Provides information about a method, a property or a method parameters. + */ +interface ReflectionInfo { + /** + * The description of method or function arguments. + */ + readonly arguments: ReflectionInfo[] + + /** + * The data type. + */ + readonly dataType: string + + /** + * The default value. + */ + readonly defaultValue: any + + /** + * The long description text. + */ + readonly description: string + + /** + * The short description text. + */ + readonly help: string + + /** + * Contains true if the class describes a collection class. + */ + readonly isCollection: boolean + + /** + * The maximum value. + */ + readonly max: number + + /** + * The minimum value. + */ + readonly min: number + + /** + * The element name. + */ + readonly name: string + + /** + * The class object that this element belongs to. + */ + readonly parent: Reflection + + /** + * Sample code, if present. + */ + readonly sampleCode: string + + /** + * A file containing sample code. May be null. + */ + readonly sampleFile: File + + /** + * The element type. + * One of unknown, readonly, readwrite, createonly, method or parameter. + */ + readonly type: string +} +declare const ReflectionInfo: ReflectionInfo + +/** + * Provides information about a class. + */ +interface Reflection { + /** + * The long description text. + */ + readonly description: string + + /** + * The short description text. + */ + readonly help: string + + /** + * An array of method descriptions. + */ + readonly methods: ReflectionInfo[] + + /** + * The class name. + */ + readonly name: string + + /** + * An array of property descriptions. + */ + readonly properties: ReflectionInfo[] + + /** + * Sample code, if present. + */ + readonly sampleCode: string + + /** + * A file containing sample code. May be null. + */ + readonly sampleFile: File + + /** + * An array of class method descriptions. + */ + readonly staticMethods: ReflectionInfo[] + + /** + * An array of class property descriptions. + */ + readonly staticProperties: ReflectionInfo[] + + /** + * Finds an element description by name. + * @param name The name of the element to find. + */ + find(name: string): ReflectionInfo + + /** + * Returns this class information as XML in OMV format. + */ + toXML(): XML +} +declare const Reflection: Reflection + +interface QNameConstructor { + readonly prototype: QName + + /** + * Creates a QName object. + * @param uri The URI, specified as a Namespace object, an existing QName object, or string. If this is a Namespace object, the URI is set to the namespace URI, and there is no local name. If this is a QName object, the URI and localName is set to those of that object. If this is a string, the URI is set to that string. + * @param name The local name. Used only if URI is given as a string. + */ + new(uri: any, name?: string): QName + (uri: any, name?: string): QName +} +declare const QName: QNameConstructor + +/** + * A qualified XML name, containing the URI and the local name. + */ +interface QName { + /** + * The local name part of the qualified name. + */ + readonly localName: string + + /** + * The URI part of the qualified name. + */ + readonly uri: string +} + +interface NamespaceConstructor { + readonly prototype: Namespace + + /** + * Creates a Namespace object. + * @param prefix The URIprefix, specified as an existing Namespace object, QName object, or string. If this is a Namespace or a QName object, the URI and prefix are set to that of the object. If this is a string, the prefix is set to that string, and the URI must be specified. + * @param uri The URI if the prefix is specified as a string. + */ + new(prefix: any, uri?: string): Namespace + (prefix: any, uri?: string): Namespace +} +declare const Namespace: NamespaceConstructor + +/** + * A XML namespace object. + */ +interface Namespace { + /** + * The named prefix. + */ + readonly prefix: string + + /** + * The URI. + */ + readonly uri: string +} + +interface XMLConstructor { + readonly prototype: XML + + /** + * Parses an XML string. Throws an error if the XML is incorrect. + * @param text The text to parse. + */ + new(text: string): XML + (text: string): XML + + /** + * Controls whether XML comments should be parsed (false) or ignored (true). + */ + ignoreComments: boolean + + /** + * Controls whether XML preprocessing instructions should be parsed (false) or ignored (true). + */ + ignoreProcessingInstructions: boolean + + /** + * Controls whether whitespace should be parsed (false) or ignored (true). + */ + ignoreWhitespace: boolean + + /** + * The number of spaces used to indent pretty-printed XML. + */ + prettyIndent: number + + /** + * When true, XML is pretty-printed when converting to a string. + */ + prettyPrinting: boolean + + /** + * Returns an object containing the default parsing and print settings for XML. + */ + defaultSettings(): object + + /** + * Sets the parsing and print setting for XML using an object returned by the settings() method. + * @param obj The object containing the settings to set. + */ + setSettings(obj: object): void + + /** + * Returns an object containing the current parsing and print settings for XML. + */ + settings(): object +} +declare const XML: XMLConstructor + +/** + * Wraps XML into an object. + */ +interface XML { + /** + * Adds a namespace declaration to the node. Returns the XML object itself. + * @param namespace The namespace to add. + */ + addNamespace(namespace: Namespace): XML + + /** + * Appends the given XML to this XML as a child. Returns the XML object itself. + * If the argument is not XML, creates a new XML element containing the argument as text. The element name of that new XML is the same as the last element in the original XML. + * @param child The child XML to add. + */ + appendChild(child: XML): XML + + /** + * Returns a list containing all attribute elements matching the given name. + * @param name The attribute name to look for. + */ + attribute(name: string): XML + + /** + * Returns a list containing all attribute elements. + */ + attributes(): XML + + /** + * Returns a list containing all children of this XML matching the given element name. + * If the argument is a number, uses the number as index into the array of children. + * @param name The name or the index of the child element. + */ + child(name: string): XML + + /** + * Returns a number representing the ordinal position of this XML object within the context of its parent. + */ + childIndex(): number + + /** + * Returns an XML object containing all the properties of this XML object in order. + */ + children(): XML + + /** + * Returns an XML object containing the properties of this XML object that represent XML comments. + */ + comments(): XML + + /** + * Checks if this XML object contains the given XML object. + * @param xml The XML to search for. + */ + contains(xml: XML): boolean + + /** + * Creates a copy of this XML object. + */ + copy(): XML + + /** + * Returns all the XML-valued descendants of this XML object with the given name. + * If the name parameter is omitted, returns all descendants of this XML object. + * @param name The name of the descendant to find. + */ + descendants(name?: string): XML + + /** + * Returns a list of XML children that are elements with a given name, or all children that are XML elements. + * @param name The element name. If not supplied, gets all children that are XML elements. + */ + elements(name?: string): XML + + /** + * Reports whether this XML object contains complex content. + * An XML object is considered to contain complex content if it represents an XML element that has child elements. XML objects representing attributes, comments, processing instructions and text nodes do not have complex content. The existence of attributes, comments, processing instructions and text nodes within an XML object is not significant in determining if it has complex content. + */ + hasComplexContent(): boolean + + /** + * Reports whether this XML object contains simple content. + * An XML object is considered to contain simple content if it represents a text node, represents an attribute node or if it represents an XML element that has no child elements. XML objects representing comments and processing instructions do not have simple content. The existence of attributes, comments, processing instructions and text nodes within an XML object is not significant in determining if it has simple content. + */ + hasSimpleContent(): boolean + + /** + * Returns an array of Namespace objects mirroring the current list of valid namespaces at this element. + * The last element of thereturned array is the default namespace. + */ + inScopeNamespaces(): Namespace[] + + /** + * Inserts the given child2 after the given child1 in this XML object and returns this XML object. + * If child1 is null, the method inserts child2 before all children of this XML object (that is, after none of them). If child1 does not exist in this XML object, the method returns without modifying this XML object. + * @param child1 The child to insert the other child after. If null, the method inserts child2 before all children of this XML object. + * @param child2 The XML to insert. + */ + insertChildAfter(child1: XML, child2: XML): void + + /** + * Inserts the given child2 before the given child1 in this XML object and returns this XML object. + * If child1 is null, the method inserts child2 after all children of this XML object (that is, before none of them). If child1 does not exist in this XML object, the method returns without modifying this XML object. + * @param child1 The child to search for. If null, the method inserts child2 after all children of this XML object. + * @param child2 The XML to insert. + */ + insertChildBefore(child1: XML, child2: XML): void + + /** + * Returns the number of elements contained in an XML list. If this XML object is not a list, returns 1. + */ + length(): number + + /** + * Returns the local name of this XML object. + * This value corresponds to the element name unless the name has a namespace prefix. For example, if the element has the name "ns:tag", the return value is "tag". + */ + localName(): string + + /** + * Returns a QName object containing the URI and the local name of the element. + */ + name(): QName + + /** + * Returns a Namespace object containing the namespace URI of the current element. + */ + namespace(): Namespace + + /** + * Returns an array containing all namespace declarations of this XML object. + */ + namespaceDeclarations(): Namespace[] + + /** + * Returns the type of this XML object as one of the strings "element", "attribute", "comment", "processing-instruction", or "text". + */ + nodeKind(): string + + /** + * Puts all text nodes in this and all descendant XML objects into a normal form by merging adjacent text nodes and eliminating empty text nodes. Returns this XML object. + */ + normalize(): XML + + /** + * Returns the parent object of this XML object. + * The root object, as returned by the XML constructor, does not have a parent and returns null. Note that the E4X standard does not define what happens if this XML object is a list containing elements with multiple parents. + */ + parent(): XML + + /** + * Inserts a given child into this object before its existing XML properties, and returns this XML object. + * @param child The XML to insert. + */ + prependChild(child: XML): XML + + /** + * Returns a list of preprocessing instructions. + * Collects processing-instructions with the given name, if supplied. Otherwise, returns an XML list containing all the children of this XML object that are processing-instructions regardless of their name. + * @param name The name of the preprocessing instruction to return. + */ + processingInstructions(name?: string): XML + + /** + * Removes the given namespace from this XML, and returns this XML. + * @param namespace The namespace to remove. + */ + removeNamespace(namespace: Namespace): XML + + /** + * Replaces the value of specified XML properties of this XML object returns this XML object. + * This method acts like the assignment operator. + * @param name The property name. Can be a numeric property name, a name for a set of XML elements, or the properties wildcard “*”. If this XML object contains no properties that match the name, the method returns without modifying this XML object. + * @param value The XML with which to replace the value of the matching property. Can be an XML object, XML list or any value that can be converted to a String with toString(). + */ + replace(name: string, value: XML): XML + + /** + * Replaces all of the XML-valued properties in this object with a new value, and returns this XML object. + * @param value The new value, which can be a single XML object or an XML list. + */ + setChildren(value: XML): XML + + /** + * Replaces the local name of this XML objectwith a string constructed from the given name + * The local name is any part behind a colon character. If there is no colon, it is the entire name. + * @param name The name to set. + */ + setLocalName(name: string): void + + /** + * Replaces the name of this XML object with the given QName object. + * @param name The fully qualified name. + */ + setName(name: QName): void + + /** + * Sets the namespace for this XML element. + * If the namespace has not been declared in the tree above this element, adds a namespace declaration. + * @param namespace The namespace to set. + */ + setNamespace(namespace: Namespace): void + + /** + * Returns an XML list containing all XML properties of this XML object that represent XML text nodes. + */ + text(): XML + + /** + * Returns the string representation of this object. + * For text and attribute nodes, this is the textual value of the node; for other elements, this is the result of calling the toXMLString() method. If this XML object is a list, concatenates the result of calling toString() on each element. + */ + toString(): string + + /** + * Returns an XML-encoded string representation of this XML object. + * Always includes the start tag, attributes and end tag of the XML object regardless of its content. It is provided for cases when the default XML to string conversion rules are not desired. Interprets the global settings XML.prettyPrint and XML.prettyIndent. + */ + toXMLString(): string + + /** + * Evaluates the given XPath expression in accordance with the W3C XPath recommendation, using this XML object as the context node. + * @param expr The XPath expression to use. + */ + xpath(expr: string): XML +} + +/** + * An XML list object. + * In this implementation, an XMLList object is synonymous to the XML object. The constructor accepts an XML list, but everything else works like theXML object. + */ +interface XMLList { } +declare const XMLList: XMLList + +interface UnitValueConstructor { + readonly prototype: UnitValue + + /** + * Creates a new UnitValue object. + */ + new(value: string | UnitValue): UnitValue + (value: string | UnitValue): UnitValue + + /** + * The base unit for all conversions. + */ + baseUnit: UnitValue +} +declare const UnitValue: UnitValueConstructor + +/** + * Represents a measurement as a combination of values and unit. + * Note that this object is not available in all applications. + */ +interface UnitValue { + /** + * The base unit. + */ + baseUnit: UnitValue + + /** + * The unit name. + */ + readonly type: string + + /** + * The numeric value. + */ + value: number + + /** + * Returns this instance as a different unit. + * @param unitName The unit name. + */ + as(unitName: string): UnitValue + + /** + * Converts this instance to a different unit. + * @param unitName The unit name. + */ + convert(unitName: string): any +} \ No newline at end of file diff --git a/shared/tsconfig.json b/shared/tsconfig.json index 169c0222..28d68ad9 100644 --- a/shared/tsconfig.json +++ b/shared/tsconfig.json @@ -2,7 +2,8 @@ "compilerOptions": { "module": "none", "strict": true, - "noLib": true, + "noLib": false, + "lib": ["ES5"], "typeRoots": [] }, "exclude": ["node_modules"]