mirror of
https://github.com/denoland/deno.git
synced 2024-12-11 01:58:05 -05:00
557 lines
21 KiB
TypeScript
557 lines
21 KiB
TypeScript
/*! *****************************************************************************
|
||
Copyright (c) Microsoft Corporation. All rights reserved.
|
||
Licensed under the Apache License, Version 2.0 (the "License"); you may not use
|
||
this file except in compliance with the License. You may obtain a copy of the
|
||
License at http://www.apache.org/licenses/LICENSE-2.0
|
||
|
||
THIS CODE IS PROVIDED ON AN *AS IS* BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
|
||
KIND, EITHER EXPRESS OR IMPLIED, INCLUDING WITHOUT LIMITATION ANY IMPLIED
|
||
WARRANTIES OR CONDITIONS OF TITLE, FITNESS FOR A PARTICULAR PURPOSE,
|
||
MERCHANTABLITY OR NON-INFRINGEMENT.
|
||
|
||
See the Apache Version 2.0 License for specific language governing permissions
|
||
and limitations under the License.
|
||
***************************************************************************** */
|
||
|
||
|
||
/// <reference no-default-lib="true"/>
|
||
|
||
interface Array<T> {
|
||
/**
|
||
* Returns the value of the first element in the array where predicate is true, and undefined
|
||
* otherwise.
|
||
* @param predicate find calls predicate once for each element of the array, in ascending
|
||
* order, until it finds one where predicate returns true. If such an element is found, find
|
||
* immediately returns that element value. Otherwise, find returns undefined.
|
||
* @param thisArg If provided, it will be used as the this value for each invocation of
|
||
* predicate. If it is not provided, undefined is used instead.
|
||
*/
|
||
find<S extends T>(predicate: (value: T, index: number, obj: T[]) => value is S, thisArg?: any): S | undefined;
|
||
find(predicate: (value: T, index: number, obj: T[]) => unknown, thisArg?: any): T | undefined;
|
||
|
||
/**
|
||
* Returns the index of the first element in the array where predicate is true, and -1
|
||
* otherwise.
|
||
* @param predicate find calls predicate once for each element of the array, in ascending
|
||
* order, until it finds one where predicate returns true. If such an element is found,
|
||
* findIndex immediately returns that element index. Otherwise, findIndex returns -1.
|
||
* @param thisArg If provided, it will be used as the this value for each invocation of
|
||
* predicate. If it is not provided, undefined is used instead.
|
||
*/
|
||
findIndex(predicate: (value: T, index: number, obj: T[]) => unknown, thisArg?: any): number;
|
||
|
||
/**
|
||
* Changes all array elements from `start` to `end` index to a static `value` and returns the modified array
|
||
* @param value value to fill array section with
|
||
* @param start index to start filling the array at. If start is negative, it is treated as
|
||
* length+start where length is the length of the array.
|
||
* @param end index to stop filling the array at. If end is negative, it is treated as
|
||
* length+end.
|
||
*/
|
||
fill(value: T, start?: number, end?: number): this;
|
||
|
||
/**
|
||
* Returns the this object after copying a section of the array identified by start and end
|
||
* to the same array starting at position target
|
||
* @param target If target is negative, it is treated as length+target where length is the
|
||
* length of the array.
|
||
* @param start If start is negative, it is treated as length+start. If end is negative, it
|
||
* is treated as length+end.
|
||
* @param end If not specified, length of the this object is used as its default value.
|
||
*/
|
||
copyWithin(target: number, start: number, end?: number): this;
|
||
}
|
||
|
||
interface ArrayConstructor {
|
||
/**
|
||
* Creates an array from an array-like object.
|
||
* @param arrayLike An array-like object to convert to an array.
|
||
*/
|
||
from<T>(arrayLike: ArrayLike<T>): T[];
|
||
|
||
/**
|
||
* Creates an array from an iterable object.
|
||
* @param arrayLike An array-like object to convert to an array.
|
||
* @param mapfn A mapping function to call on every element of the array.
|
||
* @param thisArg Value of 'this' used to invoke the mapfn.
|
||
*/
|
||
from<T, U>(arrayLike: ArrayLike<T>, mapfn: (v: T, k: number) => U, thisArg?: any): U[];
|
||
|
||
/**
|
||
* Returns a new array from a set of elements.
|
||
* @param items A set of elements to include in the new array object.
|
||
*/
|
||
of<T>(...items: T[]): T[];
|
||
}
|
||
|
||
interface DateConstructor {
|
||
new (value: number | string | Date): Date;
|
||
}
|
||
|
||
interface Function {
|
||
/**
|
||
* Returns the name of the function. Function names are read-only and can not be changed.
|
||
*/
|
||
readonly name: string;
|
||
}
|
||
|
||
interface Math {
|
||
/**
|
||
* Returns the number of leading zero bits in the 32-bit binary representation of a number.
|
||
* @param x A numeric expression.
|
||
*/
|
||
clz32(x: number): number;
|
||
|
||
/**
|
||
* Returns the result of 32-bit multiplication of two numbers.
|
||
* @param x First number
|
||
* @param y Second number
|
||
*/
|
||
imul(x: number, y: number): number;
|
||
|
||
/**
|
||
* Returns the sign of the x, indicating whether x is positive, negative or zero.
|
||
* @param x The numeric expression to test
|
||
*/
|
||
sign(x: number): number;
|
||
|
||
/**
|
||
* Returns the base 10 logarithm of a number.
|
||
* @param x A numeric expression.
|
||
*/
|
||
log10(x: number): number;
|
||
|
||
/**
|
||
* Returns the base 2 logarithm of a number.
|
||
* @param x A numeric expression.
|
||
*/
|
||
log2(x: number): number;
|
||
|
||
/**
|
||
* Returns the natural logarithm of 1 + x.
|
||
* @param x A numeric expression.
|
||
*/
|
||
log1p(x: number): number;
|
||
|
||
/**
|
||
* Returns the result of (e^x - 1), which is an implementation-dependent approximation to
|
||
* subtracting 1 from the exponential function of x (e raised to the power of x, where e
|
||
* is the base of the natural logarithms).
|
||
* @param x A numeric expression.
|
||
*/
|
||
expm1(x: number): number;
|
||
|
||
/**
|
||
* Returns the hyperbolic cosine of a number.
|
||
* @param x A numeric expression that contains an angle measured in radians.
|
||
*/
|
||
cosh(x: number): number;
|
||
|
||
/**
|
||
* Returns the hyperbolic sine of a number.
|
||
* @param x A numeric expression that contains an angle measured in radians.
|
||
*/
|
||
sinh(x: number): number;
|
||
|
||
/**
|
||
* Returns the hyperbolic tangent of a number.
|
||
* @param x A numeric expression that contains an angle measured in radians.
|
||
*/
|
||
tanh(x: number): number;
|
||
|
||
/**
|
||
* Returns the inverse hyperbolic cosine of a number.
|
||
* @param x A numeric expression that contains an angle measured in radians.
|
||
*/
|
||
acosh(x: number): number;
|
||
|
||
/**
|
||
* Returns the inverse hyperbolic sine of a number.
|
||
* @param x A numeric expression that contains an angle measured in radians.
|
||
*/
|
||
asinh(x: number): number;
|
||
|
||
/**
|
||
* Returns the inverse hyperbolic tangent of a number.
|
||
* @param x A numeric expression that contains an angle measured in radians.
|
||
*/
|
||
atanh(x: number): number;
|
||
|
||
/**
|
||
* Returns the square root of the sum of squares of its arguments.
|
||
* @param values Values to compute the square root for.
|
||
* If no arguments are passed, the result is +0.
|
||
* If there is only one argument, the result is the absolute value.
|
||
* If any argument is +Infinity or -Infinity, the result is +Infinity.
|
||
* If any argument is NaN, the result is NaN.
|
||
* If all arguments are either +0 or −0, the result is +0.
|
||
*/
|
||
hypot(...values: number[]): number;
|
||
|
||
/**
|
||
* Returns the integral part of the a numeric expression, x, removing any fractional digits.
|
||
* If x is already an integer, the result is x.
|
||
* @param x A numeric expression.
|
||
*/
|
||
trunc(x: number): number;
|
||
|
||
/**
|
||
* Returns the nearest single precision float representation of a number.
|
||
* @param x A numeric expression.
|
||
*/
|
||
fround(x: number): number;
|
||
|
||
/**
|
||
* Returns an implementation-dependent approximation to the cube root of number.
|
||
* @param x A numeric expression.
|
||
*/
|
||
cbrt(x: number): number;
|
||
}
|
||
|
||
interface NumberConstructor {
|
||
/**
|
||
* The value of Number.EPSILON is the difference between 1 and the smallest value greater than 1
|
||
* that is representable as a Number value, which is approximately:
|
||
* 2.2204460492503130808472633361816 x 10−16.
|
||
*/
|
||
readonly EPSILON: number;
|
||
|
||
/**
|
||
* Returns true if passed value is finite.
|
||
* Unlike the global isFinite, Number.isFinite doesn't forcibly convert the parameter to a
|
||
* number. Only finite values of the type number, result in true.
|
||
* @param number A numeric value.
|
||
*/
|
||
isFinite(number: unknown): boolean;
|
||
|
||
/**
|
||
* Returns true if the value passed is an integer, false otherwise.
|
||
* @param number A numeric value.
|
||
*/
|
||
isInteger(number: unknown): boolean;
|
||
|
||
/**
|
||
* Returns a Boolean value that indicates whether a value is the reserved value NaN (not a
|
||
* number). Unlike the global isNaN(), Number.isNaN() doesn't forcefully convert the parameter
|
||
* to a number. Only values of the type number, that are also NaN, result in true.
|
||
* @param number A numeric value.
|
||
*/
|
||
isNaN(number: unknown): boolean;
|
||
|
||
/**
|
||
* Returns true if the value passed is a safe integer.
|
||
* @param number A numeric value.
|
||
*/
|
||
isSafeInteger(number: unknown): boolean;
|
||
|
||
/**
|
||
* The value of the largest integer n such that n and n + 1 are both exactly representable as
|
||
* a Number value.
|
||
* The value of Number.MAX_SAFE_INTEGER is 9007199254740991 2^53 − 1.
|
||
*/
|
||
readonly MAX_SAFE_INTEGER: number;
|
||
|
||
/**
|
||
* The value of the smallest integer n such that n and n − 1 are both exactly representable as
|
||
* a Number value.
|
||
* The value of Number.MIN_SAFE_INTEGER is −9007199254740991 (−(2^53 − 1)).
|
||
*/
|
||
readonly MIN_SAFE_INTEGER: number;
|
||
|
||
/**
|
||
* Converts a string to a floating-point number.
|
||
* @param string A string that contains a floating-point number.
|
||
*/
|
||
parseFloat(string: string): number;
|
||
|
||
/**
|
||
* Converts A string to an integer.
|
||
* @param string A string to convert into a number.
|
||
* @param radix A value between 2 and 36 that specifies the base of the number in `string`.
|
||
* If this argument is not supplied, strings with a prefix of '0x' are considered hexadecimal.
|
||
* All other strings are considered decimal.
|
||
*/
|
||
parseInt(string: string, radix?: number): number;
|
||
}
|
||
|
||
interface ObjectConstructor {
|
||
/**
|
||
* Copy the values of all of the enumerable own properties from one or more source objects to a
|
||
* target object. Returns the target object.
|
||
* @param target The target object to copy to.
|
||
* @param source The source object from which to copy properties.
|
||
*/
|
||
assign<T extends {}, U>(target: T, source: U): T & U;
|
||
|
||
/**
|
||
* Copy the values of all of the enumerable own properties from one or more source objects to a
|
||
* target object. Returns the target object.
|
||
* @param target The target object to copy to.
|
||
* @param source1 The first source object from which to copy properties.
|
||
* @param source2 The second source object from which to copy properties.
|
||
*/
|
||
assign<T extends {}, U, V>(target: T, source1: U, source2: V): T & U & V;
|
||
|
||
/**
|
||
* Copy the values of all of the enumerable own properties from one or more source objects to a
|
||
* target object. Returns the target object.
|
||
* @param target The target object to copy to.
|
||
* @param source1 The first source object from which to copy properties.
|
||
* @param source2 The second source object from which to copy properties.
|
||
* @param source3 The third source object from which to copy properties.
|
||
*/
|
||
assign<T extends {}, U, V, W>(target: T, source1: U, source2: V, source3: W): T & U & V & W;
|
||
|
||
/**
|
||
* Copy the values of all of the enumerable own properties from one or more source objects to a
|
||
* target object. Returns the target object.
|
||
* @param target The target object to copy to.
|
||
* @param sources One or more source objects from which to copy properties
|
||
*/
|
||
assign(target: object, ...sources: any[]): any;
|
||
|
||
/**
|
||
* Returns an array of all symbol properties found directly on object o.
|
||
* @param o Object to retrieve the symbols from.
|
||
*/
|
||
getOwnPropertySymbols(o: any): symbol[];
|
||
|
||
/**
|
||
* Returns the names of the enumerable string properties and methods of an object.
|
||
* @param o Object that contains the properties and methods. This can be an object that you created or an existing Document Object Model (DOM) object.
|
||
*/
|
||
keys(o: {}): string[];
|
||
|
||
/**
|
||
* Returns true if the values are the same value, false otherwise.
|
||
* @param value1 The first value.
|
||
* @param value2 The second value.
|
||
*/
|
||
is(value1: any, value2: any): boolean;
|
||
|
||
/**
|
||
* Sets the prototype of a specified object o to object proto or null. Returns the object o.
|
||
* @param o The object to change its prototype.
|
||
* @param proto The value of the new prototype or null.
|
||
*/
|
||
setPrototypeOf(o: any, proto: object | null): any;
|
||
}
|
||
|
||
interface ReadonlyArray<T> {
|
||
/**
|
||
* Returns the value of the first element in the array where predicate is true, and undefined
|
||
* otherwise.
|
||
* @param predicate find calls predicate once for each element of the array, in ascending
|
||
* order, until it finds one where predicate returns true. If such an element is found, find
|
||
* immediately returns that element value. Otherwise, find returns undefined.
|
||
* @param thisArg If provided, it will be used as the this value for each invocation of
|
||
* predicate. If it is not provided, undefined is used instead.
|
||
*/
|
||
find<S extends T>(predicate: (value: T, index: number, obj: readonly T[]) => value is S, thisArg?: any): S | undefined;
|
||
find(predicate: (value: T, index: number, obj: readonly T[]) => unknown, thisArg?: any): T | undefined;
|
||
|
||
/**
|
||
* Returns the index of the first element in the array where predicate is true, and -1
|
||
* otherwise.
|
||
* @param predicate find calls predicate once for each element of the array, in ascending
|
||
* order, until it finds one where predicate returns true. If such an element is found,
|
||
* findIndex immediately returns that element index. Otherwise, findIndex returns -1.
|
||
* @param thisArg If provided, it will be used as the this value for each invocation of
|
||
* predicate. If it is not provided, undefined is used instead.
|
||
*/
|
||
findIndex(predicate: (value: T, index: number, obj: readonly T[]) => unknown, thisArg?: any): number;
|
||
}
|
||
|
||
interface RegExp {
|
||
/**
|
||
* Returns a string indicating the flags of the regular expression in question. This field is read-only.
|
||
* The characters in this string are sequenced and concatenated in the following order:
|
||
*
|
||
* - "g" for global
|
||
* - "i" for ignoreCase
|
||
* - "m" for multiline
|
||
* - "u" for unicode
|
||
* - "y" for sticky
|
||
*
|
||
* If no flags are set, the value is the empty string.
|
||
*/
|
||
readonly flags: string;
|
||
|
||
/**
|
||
* Returns a Boolean value indicating the state of the sticky flag (y) used with a regular
|
||
* expression. Default is false. Read-only.
|
||
*/
|
||
readonly sticky: boolean;
|
||
|
||
/**
|
||
* Returns a Boolean value indicating the state of the Unicode flag (u) used with a regular
|
||
* expression. Default is false. Read-only.
|
||
*/
|
||
readonly unicode: boolean;
|
||
}
|
||
|
||
interface RegExpConstructor {
|
||
new (pattern: RegExp | string, flags?: string): RegExp;
|
||
(pattern: RegExp | string, flags?: string): RegExp;
|
||
}
|
||
|
||
interface String {
|
||
/**
|
||
* Returns a nonnegative integer Number less than 1114112 (0x110000) that is the code point
|
||
* value of the UTF-16 encoded code point starting at the string element at position pos in
|
||
* the String resulting from converting this object to a String.
|
||
* If there is no element at that position, the result is undefined.
|
||
* If a valid UTF-16 surrogate pair does not begin at pos, the result is the code unit at pos.
|
||
*/
|
||
codePointAt(pos: number): number | undefined;
|
||
|
||
/**
|
||
* Returns true if searchString appears as a substring of the result of converting this
|
||
* object to a String, at one or more positions that are
|
||
* greater than or equal to position; otherwise, returns false.
|
||
* @param searchString search string
|
||
* @param position If position is undefined, 0 is assumed, so as to search all of the String.
|
||
*/
|
||
includes(searchString: string, position?: number): boolean;
|
||
|
||
/**
|
||
* Returns true if the sequence of elements of searchString converted to a String is the
|
||
* same as the corresponding elements of this object (converted to a String) starting at
|
||
* endPosition – length(this). Otherwise returns false.
|
||
*/
|
||
endsWith(searchString: string, endPosition?: number): boolean;
|
||
|
||
/**
|
||
* Returns the String value result of normalizing the string into the normalization form
|
||
* named by form as specified in Unicode Standard Annex #15, Unicode Normalization Forms.
|
||
* @param form Applicable values: "NFC", "NFD", "NFKC", or "NFKD", If not specified default
|
||
* is "NFC"
|
||
*/
|
||
normalize(form: "NFC" | "NFD" | "NFKC" | "NFKD"): string;
|
||
|
||
/**
|
||
* Returns the String value result of normalizing the string into the normalization form
|
||
* named by form as specified in Unicode Standard Annex #15, Unicode Normalization Forms.
|
||
* @param form Applicable values: "NFC", "NFD", "NFKC", or "NFKD", If not specified default
|
||
* is "NFC"
|
||
*/
|
||
normalize(form?: string): string;
|
||
|
||
/**
|
||
* Returns a String value that is made from count copies appended together. If count is 0,
|
||
* the empty string is returned.
|
||
* @param count number of copies to append
|
||
*/
|
||
repeat(count: number): string;
|
||
|
||
/**
|
||
* Returns true if the sequence of elements of searchString converted to a String is the
|
||
* same as the corresponding elements of this object (converted to a String) starting at
|
||
* position. Otherwise returns false.
|
||
*/
|
||
startsWith(searchString: string, position?: number): boolean;
|
||
|
||
/**
|
||
* Returns an `<a>` HTML anchor element and sets the name attribute to the text value
|
||
* @deprecated A legacy feature for browser compatibility
|
||
* @param name
|
||
*/
|
||
anchor(name: string): string;
|
||
|
||
/**
|
||
* Returns a `<big>` HTML element
|
||
* @deprecated A legacy feature for browser compatibility
|
||
*/
|
||
big(): string;
|
||
|
||
/**
|
||
* Returns a `<blink>` HTML element
|
||
* @deprecated A legacy feature for browser compatibility
|
||
*/
|
||
blink(): string;
|
||
|
||
/**
|
||
* Returns a `<b>` HTML element
|
||
* @deprecated A legacy feature for browser compatibility
|
||
*/
|
||
bold(): string;
|
||
|
||
/**
|
||
* Returns a `<tt>` HTML element
|
||
* @deprecated A legacy feature for browser compatibility
|
||
*/
|
||
fixed(): string;
|
||
|
||
/**
|
||
* Returns a `<font>` HTML element and sets the color attribute value
|
||
* @deprecated A legacy feature for browser compatibility
|
||
*/
|
||
fontcolor(color: string): string;
|
||
|
||
/**
|
||
* Returns a `<font>` HTML element and sets the size attribute value
|
||
* @deprecated A legacy feature for browser compatibility
|
||
*/
|
||
fontsize(size: number): string;
|
||
|
||
/**
|
||
* Returns a `<font>` HTML element and sets the size attribute value
|
||
* @deprecated A legacy feature for browser compatibility
|
||
*/
|
||
fontsize(size: string): string;
|
||
|
||
/**
|
||
* Returns an `<i>` HTML element
|
||
* @deprecated A legacy feature for browser compatibility
|
||
*/
|
||
italics(): string;
|
||
|
||
/**
|
||
* Returns an `<a>` HTML element and sets the href attribute value
|
||
* @deprecated A legacy feature for browser compatibility
|
||
*/
|
||
link(url: string): string;
|
||
|
||
/**
|
||
* Returns a `<small>` HTML element
|
||
* @deprecated A legacy feature for browser compatibility
|
||
*/
|
||
small(): string;
|
||
|
||
/**
|
||
* Returns a `<strike>` HTML element
|
||
* @deprecated A legacy feature for browser compatibility
|
||
*/
|
||
strike(): string;
|
||
|
||
/**
|
||
* Returns a `<sub>` HTML element
|
||
* @deprecated A legacy feature for browser compatibility
|
||
*/
|
||
sub(): string;
|
||
|
||
/**
|
||
* Returns a `<sup>` HTML element
|
||
* @deprecated A legacy feature for browser compatibility
|
||
*/
|
||
sup(): string;
|
||
}
|
||
|
||
interface StringConstructor {
|
||
/**
|
||
* Return the String value whose elements are, in order, the elements in the List elements.
|
||
* If length is 0, the empty string is returned.
|
||
*/
|
||
fromCodePoint(...codePoints: number[]): string;
|
||
|
||
/**
|
||
* String.raw is usually used as a tag function of a Tagged Template String. When called as
|
||
* such, the first argument will be a well formed template call site object and the rest
|
||
* parameter will contain the substitution values. It can also be called directly, for example,
|
||
* to interleave strings and values from your own tag function, and in this case the only thing
|
||
* it needs from the first argument is the raw property.
|
||
* @param template A well-formed template string call site representation.
|
||
* @param substitutions A set of substitution values.
|
||
*/
|
||
raw(template: { raw: readonly string[] | ArrayLike<string>}, ...substitutions: any[]): string;
|
||
}
|