mirror of
https://github.com/denoland/deno.git
synced 2024-12-22 23:34:47 -05:00
527 lines
16 KiB
TypeScript
527 lines
16 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"/>
|
|
|
|
/// <reference lib="es2015.symbol" />
|
|
|
|
interface SymbolConstructor {
|
|
/**
|
|
* A method that returns the default iterator for an object. Called by the semantics of the
|
|
* for-of statement.
|
|
*/
|
|
readonly iterator: unique symbol;
|
|
}
|
|
|
|
interface IteratorYieldResult<TYield> {
|
|
done?: false;
|
|
value: TYield;
|
|
}
|
|
|
|
interface IteratorReturnResult<TReturn> {
|
|
done: true;
|
|
value: TReturn;
|
|
}
|
|
|
|
type IteratorResult<T, TReturn = any> = IteratorYieldResult<T> | IteratorReturnResult<TReturn>;
|
|
|
|
interface Iterator<T, TReturn = any, TNext = any> {
|
|
// NOTE: 'next' is defined using a tuple to ensure we report the correct assignability errors in all places.
|
|
next(...[value]: [] | [TNext]): IteratorResult<T, TReturn>;
|
|
return?(value?: TReturn): IteratorResult<T, TReturn>;
|
|
throw?(e?: any): IteratorResult<T, TReturn>;
|
|
}
|
|
|
|
interface Iterable<T, TReturn = any, TNext = any> {
|
|
[Symbol.iterator](): Iterator<T, TReturn, TNext>;
|
|
}
|
|
|
|
/**
|
|
* Describes a user-defined {@link Iterator} that is also iterable.
|
|
*/
|
|
interface IterableIterator<T, TReturn = any, TNext = any> extends Iterator<T, TReturn, TNext> {
|
|
[Symbol.iterator](): IterableIterator<T, TReturn, TNext>;
|
|
}
|
|
|
|
/**
|
|
* Describes an {@link Iterator} produced by the runtime that inherits from the intrinsic `Iterator.prototype`.
|
|
*/
|
|
interface IteratorObject<T, TReturn = unknown, TNext = unknown> extends Iterator<T, TReturn, TNext> {
|
|
[Symbol.iterator](): IteratorObject<T, TReturn, TNext>;
|
|
}
|
|
|
|
/**
|
|
* Defines the `TReturn` type used for built-in iterators produced by `Array`, `Map`, `Set`, and others.
|
|
* This is `undefined` when `strictBuiltInIteratorReturn` is `true`; otherwise, this is `any`.
|
|
*/
|
|
type BuiltinIteratorReturn = intrinsic;
|
|
|
|
interface ArrayIterator<T> extends IteratorObject<T, BuiltinIteratorReturn, unknown> {
|
|
[Symbol.iterator](): ArrayIterator<T>;
|
|
}
|
|
|
|
interface Array<T> {
|
|
/** Iterator */
|
|
[Symbol.iterator](): ArrayIterator<T>;
|
|
|
|
/**
|
|
* Returns an iterable of key, value pairs for every entry in the array
|
|
*/
|
|
entries(): ArrayIterator<[number, T]>;
|
|
|
|
/**
|
|
* Returns an iterable of keys in the array
|
|
*/
|
|
keys(): ArrayIterator<number>;
|
|
|
|
/**
|
|
* Returns an iterable of values in the array
|
|
*/
|
|
values(): ArrayIterator<T>;
|
|
}
|
|
|
|
interface ArrayConstructor {
|
|
/**
|
|
* Creates an array from an iterable object.
|
|
* @param iterable An iterable object to convert to an array.
|
|
*/
|
|
from<T>(iterable: Iterable<T> | ArrayLike<T>): T[];
|
|
|
|
/**
|
|
* Creates an array from an iterable object.
|
|
* @param iterable An iterable 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>(iterable: Iterable<T> | ArrayLike<T>, mapfn: (v: T, k: number) => U, thisArg?: any): U[];
|
|
}
|
|
|
|
interface ReadonlyArray<T> {
|
|
/** Iterator of values in the array. */
|
|
[Symbol.iterator](): ArrayIterator<T>;
|
|
|
|
/**
|
|
* Returns an iterable of key, value pairs for every entry in the array
|
|
*/
|
|
entries(): ArrayIterator<[number, T]>;
|
|
|
|
/**
|
|
* Returns an iterable of keys in the array
|
|
*/
|
|
keys(): ArrayIterator<number>;
|
|
|
|
/**
|
|
* Returns an iterable of values in the array
|
|
*/
|
|
values(): ArrayIterator<T>;
|
|
}
|
|
|
|
interface IArguments {
|
|
/** Iterator */
|
|
[Symbol.iterator](): ArrayIterator<any>;
|
|
}
|
|
|
|
interface MapIterator<T> extends IteratorObject<T, BuiltinIteratorReturn, unknown> {
|
|
[Symbol.iterator](): MapIterator<T>;
|
|
}
|
|
|
|
interface Map<K, V> {
|
|
/** Returns an iterable of entries in the map. */
|
|
[Symbol.iterator](): MapIterator<[K, V]>;
|
|
|
|
/**
|
|
* Returns an iterable of key, value pairs for every entry in the map.
|
|
*/
|
|
entries(): MapIterator<[K, V]>;
|
|
|
|
/**
|
|
* Returns an iterable of keys in the map
|
|
*/
|
|
keys(): MapIterator<K>;
|
|
|
|
/**
|
|
* Returns an iterable of values in the map
|
|
*/
|
|
values(): MapIterator<V>;
|
|
}
|
|
|
|
interface ReadonlyMap<K, V> {
|
|
/** Returns an iterable of entries in the map. */
|
|
[Symbol.iterator](): MapIterator<[K, V]>;
|
|
|
|
/**
|
|
* Returns an iterable of key, value pairs for every entry in the map.
|
|
*/
|
|
entries(): MapIterator<[K, V]>;
|
|
|
|
/**
|
|
* Returns an iterable of keys in the map
|
|
*/
|
|
keys(): MapIterator<K>;
|
|
|
|
/**
|
|
* Returns an iterable of values in the map
|
|
*/
|
|
values(): MapIterator<V>;
|
|
}
|
|
|
|
interface MapConstructor {
|
|
new (): Map<any, any>;
|
|
new <K, V>(iterable?: Iterable<readonly [K, V]> | null): Map<K, V>;
|
|
}
|
|
|
|
interface WeakMap<K extends WeakKey, V> {}
|
|
|
|
interface WeakMapConstructor {
|
|
new <K extends WeakKey, V>(iterable: Iterable<readonly [K, V]>): WeakMap<K, V>;
|
|
}
|
|
|
|
interface SetIterator<T> extends IteratorObject<T, BuiltinIteratorReturn, unknown> {
|
|
[Symbol.iterator](): SetIterator<T>;
|
|
}
|
|
|
|
interface Set<T> {
|
|
/** Iterates over values in the set. */
|
|
[Symbol.iterator](): SetIterator<T>;
|
|
/**
|
|
* Returns an iterable of [v,v] pairs for every value `v` in the set.
|
|
*/
|
|
entries(): SetIterator<[T, T]>;
|
|
/**
|
|
* Despite its name, returns an iterable of the values in the set.
|
|
*/
|
|
keys(): SetIterator<T>;
|
|
|
|
/**
|
|
* Returns an iterable of values in the set.
|
|
*/
|
|
values(): SetIterator<T>;
|
|
}
|
|
|
|
interface ReadonlySet<T> {
|
|
/** Iterates over values in the set. */
|
|
[Symbol.iterator](): SetIterator<T>;
|
|
|
|
/**
|
|
* Returns an iterable of [v,v] pairs for every value `v` in the set.
|
|
*/
|
|
entries(): SetIterator<[T, T]>;
|
|
|
|
/**
|
|
* Despite its name, returns an iterable of the values in the set.
|
|
*/
|
|
keys(): SetIterator<T>;
|
|
|
|
/**
|
|
* Returns an iterable of values in the set.
|
|
*/
|
|
values(): SetIterator<T>;
|
|
}
|
|
|
|
interface SetConstructor {
|
|
new <T>(iterable?: Iterable<T> | null): Set<T>;
|
|
}
|
|
|
|
interface WeakSet<T extends WeakKey> {}
|
|
|
|
interface WeakSetConstructor {
|
|
new <T extends WeakKey = WeakKey>(iterable: Iterable<T>): WeakSet<T>;
|
|
}
|
|
|
|
interface Promise<T> {}
|
|
|
|
interface PromiseConstructor {
|
|
/**
|
|
* Creates a Promise that is resolved with an array of results when all of the provided Promises
|
|
* resolve, or rejected when any Promise is rejected.
|
|
* @param values An iterable of Promises.
|
|
* @returns A new Promise.
|
|
*/
|
|
all<T>(values: Iterable<T | PromiseLike<T>>): Promise<Awaited<T>[]>;
|
|
|
|
/**
|
|
* Creates a Promise that is resolved or rejected when any of the provided Promises are resolved
|
|
* or rejected.
|
|
* @param values An iterable of Promises.
|
|
* @returns A new Promise.
|
|
*/
|
|
race<T>(values: Iterable<T | PromiseLike<T>>): Promise<Awaited<T>>;
|
|
}
|
|
|
|
interface StringIterator<T> extends IteratorObject<T, BuiltinIteratorReturn, unknown> {
|
|
[Symbol.iterator](): StringIterator<T>;
|
|
}
|
|
|
|
interface String {
|
|
/** Iterator */
|
|
[Symbol.iterator](): StringIterator<string>;
|
|
}
|
|
|
|
interface Int8Array {
|
|
[Symbol.iterator](): ArrayIterator<number>;
|
|
/**
|
|
* Returns an array of key, value pairs for every entry in the array
|
|
*/
|
|
entries(): ArrayIterator<[number, number]>;
|
|
/**
|
|
* Returns an list of keys in the array
|
|
*/
|
|
keys(): ArrayIterator<number>;
|
|
/**
|
|
* Returns an list of values in the array
|
|
*/
|
|
values(): ArrayIterator<number>;
|
|
}
|
|
|
|
interface Int8ArrayConstructor {
|
|
new (elements: Iterable<number>): Int8Array;
|
|
|
|
/**
|
|
* Creates an array from an array-like or iterable object.
|
|
* @param arrayLike An array-like or iterable 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(arrayLike: Iterable<number>, mapfn?: (v: number, k: number) => number, thisArg?: any): Int8Array;
|
|
}
|
|
|
|
interface Uint8Array {
|
|
[Symbol.iterator](): ArrayIterator<number>;
|
|
/**
|
|
* Returns an array of key, value pairs for every entry in the array
|
|
*/
|
|
entries(): ArrayIterator<[number, number]>;
|
|
/**
|
|
* Returns an list of keys in the array
|
|
*/
|
|
keys(): ArrayIterator<number>;
|
|
/**
|
|
* Returns an list of values in the array
|
|
*/
|
|
values(): ArrayIterator<number>;
|
|
}
|
|
|
|
interface Uint8ArrayConstructor {
|
|
new (elements: Iterable<number>): Uint8Array;
|
|
|
|
/**
|
|
* Creates an array from an array-like or iterable object.
|
|
* @param arrayLike An array-like or iterable 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(arrayLike: Iterable<number>, mapfn?: (v: number, k: number) => number, thisArg?: any): Uint8Array;
|
|
}
|
|
|
|
interface Uint8ClampedArray {
|
|
[Symbol.iterator](): ArrayIterator<number>;
|
|
/**
|
|
* Returns an array of key, value pairs for every entry in the array
|
|
*/
|
|
entries(): ArrayIterator<[number, number]>;
|
|
|
|
/**
|
|
* Returns an list of keys in the array
|
|
*/
|
|
keys(): ArrayIterator<number>;
|
|
|
|
/**
|
|
* Returns an list of values in the array
|
|
*/
|
|
values(): ArrayIterator<number>;
|
|
}
|
|
|
|
interface Uint8ClampedArrayConstructor {
|
|
new (elements: Iterable<number>): Uint8ClampedArray;
|
|
|
|
/**
|
|
* Creates an array from an array-like or iterable object.
|
|
* @param arrayLike An array-like or iterable 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(arrayLike: Iterable<number>, mapfn?: (v: number, k: number) => number, thisArg?: any): Uint8ClampedArray;
|
|
}
|
|
|
|
interface Int16Array {
|
|
[Symbol.iterator](): ArrayIterator<number>;
|
|
/**
|
|
* Returns an array of key, value pairs for every entry in the array
|
|
*/
|
|
entries(): ArrayIterator<[number, number]>;
|
|
|
|
/**
|
|
* Returns an list of keys in the array
|
|
*/
|
|
keys(): ArrayIterator<number>;
|
|
|
|
/**
|
|
* Returns an list of values in the array
|
|
*/
|
|
values(): ArrayIterator<number>;
|
|
}
|
|
|
|
interface Int16ArrayConstructor {
|
|
new (elements: Iterable<number>): Int16Array;
|
|
|
|
/**
|
|
* Creates an array from an array-like or iterable object.
|
|
* @param arrayLike An array-like or iterable 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(arrayLike: Iterable<number>, mapfn?: (v: number, k: number) => number, thisArg?: any): Int16Array;
|
|
}
|
|
|
|
interface Uint16Array {
|
|
[Symbol.iterator](): ArrayIterator<number>;
|
|
/**
|
|
* Returns an array of key, value pairs for every entry in the array
|
|
*/
|
|
entries(): ArrayIterator<[number, number]>;
|
|
/**
|
|
* Returns an list of keys in the array
|
|
*/
|
|
keys(): ArrayIterator<number>;
|
|
/**
|
|
* Returns an list of values in the array
|
|
*/
|
|
values(): ArrayIterator<number>;
|
|
}
|
|
|
|
interface Uint16ArrayConstructor {
|
|
new (elements: Iterable<number>): Uint16Array;
|
|
|
|
/**
|
|
* Creates an array from an array-like or iterable object.
|
|
* @param arrayLike An array-like or iterable 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(arrayLike: Iterable<number>, mapfn?: (v: number, k: number) => number, thisArg?: any): Uint16Array;
|
|
}
|
|
|
|
interface Int32Array {
|
|
[Symbol.iterator](): ArrayIterator<number>;
|
|
/**
|
|
* Returns an array of key, value pairs for every entry in the array
|
|
*/
|
|
entries(): ArrayIterator<[number, number]>;
|
|
/**
|
|
* Returns an list of keys in the array
|
|
*/
|
|
keys(): ArrayIterator<number>;
|
|
/**
|
|
* Returns an list of values in the array
|
|
*/
|
|
values(): ArrayIterator<number>;
|
|
}
|
|
|
|
interface Int32ArrayConstructor {
|
|
new (elements: Iterable<number>): Int32Array;
|
|
|
|
/**
|
|
* Creates an array from an array-like or iterable object.
|
|
* @param arrayLike An array-like or iterable 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(arrayLike: Iterable<number>, mapfn?: (v: number, k: number) => number, thisArg?: any): Int32Array;
|
|
}
|
|
|
|
interface Uint32Array {
|
|
[Symbol.iterator](): ArrayIterator<number>;
|
|
/**
|
|
* Returns an array of key, value pairs for every entry in the array
|
|
*/
|
|
entries(): ArrayIterator<[number, number]>;
|
|
/**
|
|
* Returns an list of keys in the array
|
|
*/
|
|
keys(): ArrayIterator<number>;
|
|
/**
|
|
* Returns an list of values in the array
|
|
*/
|
|
values(): ArrayIterator<number>;
|
|
}
|
|
|
|
interface Uint32ArrayConstructor {
|
|
new (elements: Iterable<number>): Uint32Array;
|
|
|
|
/**
|
|
* Creates an array from an array-like or iterable object.
|
|
* @param arrayLike An array-like or iterable 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(arrayLike: Iterable<number>, mapfn?: (v: number, k: number) => number, thisArg?: any): Uint32Array;
|
|
}
|
|
|
|
interface Float32Array {
|
|
[Symbol.iterator](): ArrayIterator<number>;
|
|
/**
|
|
* Returns an array of key, value pairs for every entry in the array
|
|
*/
|
|
entries(): ArrayIterator<[number, number]>;
|
|
/**
|
|
* Returns an list of keys in the array
|
|
*/
|
|
keys(): ArrayIterator<number>;
|
|
/**
|
|
* Returns an list of values in the array
|
|
*/
|
|
values(): ArrayIterator<number>;
|
|
}
|
|
|
|
interface Float32ArrayConstructor {
|
|
new (elements: Iterable<number>): Float32Array;
|
|
|
|
/**
|
|
* Creates an array from an array-like or iterable object.
|
|
* @param arrayLike An array-like or iterable 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(arrayLike: Iterable<number>, mapfn?: (v: number, k: number) => number, thisArg?: any): Float32Array;
|
|
}
|
|
|
|
interface Float64Array {
|
|
[Symbol.iterator](): ArrayIterator<number>;
|
|
/**
|
|
* Returns an array of key, value pairs for every entry in the array
|
|
*/
|
|
entries(): ArrayIterator<[number, number]>;
|
|
/**
|
|
* Returns an list of keys in the array
|
|
*/
|
|
keys(): ArrayIterator<number>;
|
|
/**
|
|
* Returns an list of values in the array
|
|
*/
|
|
values(): ArrayIterator<number>;
|
|
}
|
|
|
|
interface Float64ArrayConstructor {
|
|
new (elements: Iterable<number>): Float64Array;
|
|
|
|
/**
|
|
* Creates an array from an array-like or iterable object.
|
|
* @param arrayLike An array-like or iterable 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(arrayLike: Iterable<number>, mapfn?: (v: number, k: number) => number, thisArg?: any): Float64Array;
|
|
}
|