@@ -0,0 +1 @@ | |||
token.ts |
@@ -0,0 +1,30 @@ | |||
# Papoh (Pen and Paper Online Helper) | |||
## Run Bot | |||
- Rename _token.ts to token.ts and add your token. | |||
- run `npm install` | |||
- run `npm start` | |||
this is an simple bot for mange online Pen and Paper Rounds | |||
## Commands | |||
### Admin Commands | |||
#### `papoh create [options]` | |||
Name of Master | |||
--master "<name>" or -ma "<name>" | |||
Name or Descripion of System (Optional) | |||
--system "<description>" or -sy "<description>" | |||
Name or Descripion of Setting (Optional) | |||
--setting "<description>" or -se "<description>" | |||
Some extra Notes (Optional) | |||
--note "<description>" or -no "<description>" | |||
Minum Player Count (Optional) | |||
--min <count> | |||
Maximum Player Count | |||
--max <count> | |||
example | |||
`papoh create -ma "Christian" --system "DSA 5" --setting "Fantasy" --note "Start at 8pm" --max 5` |
@@ -0,0 +1 @@ | |||
export const token = ""; |
@@ -0,0 +1,6 @@ | |||
#!/usr/bin/env node | |||
declare const chalk: any; | |||
declare const clear: any; | |||
declare const figlet: any; | |||
declare const path: any; | |||
declare const program: any; |
@@ -0,0 +1,9 @@ | |||
#!/usr/bin/env node | |||
"use strict"; | |||
var chalk = require('chalk'); | |||
var clear = require('clear'); | |||
var figlet = require('figlet'); | |||
var path = require('path'); | |||
var program = require('commander'); | |||
clear(); | |||
console.log(chalk.red(figlet.textSync('Papoh Bot', { horizontalLayout: 'full' }))); |
@@ -0,0 +1 @@ | |||
../is-ci/bin.js |
@@ -0,0 +1 @@ | |||
../nodemon/bin/nodemon.js |
@@ -0,0 +1 @@ | |||
../touch/bin/nodetouch.js |
@@ -0,0 +1 @@ | |||
../nopt/bin/nopt.js |
@@ -0,0 +1 @@ | |||
../rc/cli.js |
@@ -0,0 +1 @@ | |||
../semver/bin/semver |
@@ -0,0 +1 @@ | |||
../ts-node/dist/bin.js |
@@ -0,0 +1 @@ | |||
../ts-node/dist/bin-script.js |
@@ -0,0 +1 @@ | |||
../ts-node/dist/bin-transpile.js |
@@ -0,0 +1 @@ | |||
../ts-node/dist/bin-script-deprecated.js |
@@ -0,0 +1 @@ | |||
../typescript/bin/tsc |
@@ -0,0 +1 @@ | |||
../typescript/bin/tsserver |
@@ -0,0 +1,190 @@ | |||
Apache License | |||
Version 2.0, January 2004 | |||
http://www.apache.org/licenses/ | |||
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION | |||
1. Definitions. | |||
"License" shall mean the terms and conditions for use, reproduction, | |||
and distribution as defined by Sections 1 through 9 of this document. | |||
"Licensor" shall mean the copyright owner or entity authorized by | |||
the copyright owner that is granting the License. | |||
"Legal Entity" shall mean the union of the acting entity and all | |||
other entities that control, are controlled by, or are under common | |||
control with that entity. For the purposes of this definition, | |||
"control" means (i) the power, direct or indirect, to cause the | |||
direction or management of such entity, whether by contract or | |||
otherwise, or (ii) ownership of fifty percent (50%) or more of the | |||
outstanding shares, or (iii) beneficial ownership of such entity. | |||
"You" (or "Your") shall mean an individual or Legal Entity | |||
exercising permissions granted by this License. | |||
"Source" form shall mean the preferred form for making modifications, | |||
including but not limited to software source code, documentation | |||
source, and configuration files. | |||
"Object" form shall mean any form resulting from mechanical | |||
transformation or translation of a Source form, including but | |||
not limited to compiled object code, generated documentation, | |||
and conversions to other media types. | |||
"Work" shall mean the work of authorship, whether in Source or | |||
Object form, made available under the License, as indicated by a | |||
copyright notice that is included in or attached to the work | |||
(an example is provided in the Appendix below). | |||
"Derivative Works" shall mean any work, whether in Source or Object | |||
form, that is based on (or derived from) the Work and for which the | |||
editorial revisions, annotations, elaborations, or other modifications | |||
represent, as a whole, an original work of authorship. For the purposes | |||
of this License, Derivative Works shall not include works that remain | |||
separable from, or merely link (or bind by name) to the interfaces of, | |||
the Work and Derivative Works thereof. | |||
"Contribution" shall mean any work of authorship, including | |||
the original version of the Work and any modifications or additions | |||
to that Work or Derivative Works thereof, that is intentionally | |||
submitted to Licensor for inclusion in the Work by the copyright owner | |||
or by an individual or Legal Entity authorized to submit on behalf of | |||
the copyright owner. For the purposes of this definition, "submitted" | |||
means any form of electronic, verbal, or written communication sent | |||
to the Licensor or its representatives, including but not limited to | |||
communication on electronic mailing lists, source code control systems, | |||
and issue tracking systems that are managed by, or on behalf of, the | |||
Licensor for the purpose of discussing and improving the Work, but | |||
excluding communication that is conspicuously marked or otherwise | |||
designated in writing by the copyright owner as "Not a Contribution." | |||
"Contributor" shall mean Licensor and any individual or Legal Entity | |||
on behalf of whom a Contribution has been received by Licensor and | |||
subsequently incorporated within the Work. | |||
2. Grant of Copyright License. Subject to the terms and conditions of | |||
this License, each Contributor hereby grants to You a perpetual, | |||
worldwide, non-exclusive, no-charge, royalty-free, irrevocable | |||
copyright license to reproduce, prepare Derivative Works of, | |||
publicly display, publicly perform, sublicense, and distribute the | |||
Work and such Derivative Works in Source or Object form. | |||
3. Grant of Patent License. Subject to the terms and conditions of | |||
this License, each Contributor hereby grants to You a perpetual, | |||
worldwide, non-exclusive, no-charge, royalty-free, irrevocable | |||
(except as stated in this section) patent license to make, have made, | |||
use, offer to sell, sell, import, and otherwise transfer the Work, | |||
where such license applies only to those patent claims licensable | |||
by such Contributor that are necessarily infringed by their | |||
Contribution(s) alone or by combination of their Contribution(s) | |||
with the Work to which such Contribution(s) was submitted. If You | |||
institute patent litigation against any entity (including a | |||
cross-claim or counterclaim in a lawsuit) alleging that the Work | |||
or a Contribution incorporated within the Work constitutes direct | |||
or contributory patent infringement, then any patent licenses | |||
granted to You under this License for that Work shall terminate | |||
as of the date such litigation is filed. | |||
4. Redistribution. You may reproduce and distribute copies of the | |||
Work or Derivative Works thereof in any medium, with or without | |||
modifications, and in Source or Object form, provided that You | |||
meet the following conditions: | |||
(a) You must give any other recipients of the Work or | |||
Derivative Works a copy of this License; and | |||
(b) You must cause any modified files to carry prominent notices | |||
stating that You changed the files; and | |||
(c) You must retain, in the Source form of any Derivative Works | |||
that You distribute, all copyright, patent, trademark, and | |||
attribution notices from the Source form of the Work, | |||
excluding those notices that do not pertain to any part of | |||
the Derivative Works; and | |||
(d) If the Work includes a "NOTICE" text file as part of its | |||
distribution, then any Derivative Works that You distribute must | |||
include a readable copy of the attribution notices contained | |||
within such NOTICE file, excluding those notices that do not | |||
pertain to any part of the Derivative Works, in at least one | |||
of the following places: within a NOTICE text file distributed | |||
as part of the Derivative Works; within the Source form or | |||
documentation, if provided along with the Derivative Works; or, | |||
within a display generated by the Derivative Works, if and | |||
wherever such third-party notices normally appear. The contents | |||
of the NOTICE file are for informational purposes only and | |||
do not modify the License. You may add Your own attribution | |||
notices within Derivative Works that You distribute, alongside | |||
or as an addendum to the NOTICE text from the Work, provided | |||
that such additional attribution notices cannot be construed | |||
as modifying the License. | |||
You may add Your own copyright statement to Your modifications and | |||
may provide additional or different license terms and conditions | |||
for use, reproduction, or distribution of Your modifications, or | |||
for any such Derivative Works as a whole, provided Your use, | |||
reproduction, and distribution of the Work otherwise complies with | |||
the conditions stated in this License. | |||
5. Submission of Contributions. Unless You explicitly state otherwise, | |||
any Contribution intentionally submitted for inclusion in the Work | |||
by You to the Licensor shall be under the terms and conditions of | |||
this License, without any additional terms or conditions. | |||
Notwithstanding the above, nothing herein shall supersede or modify | |||
the terms of any separate license agreement you may have executed | |||
with Licensor regarding such Contributions. | |||
6. Trademarks. This License does not grant permission to use the trade | |||
names, trademarks, service marks, or product names of the Licensor, | |||
except as required for reasonable and customary use in describing the | |||
origin of the Work and reproducing the content of the NOTICE file. | |||
7. Disclaimer of Warranty. Unless required by applicable law or | |||
agreed to in writing, Licensor provides the Work (and each | |||
Contributor provides its Contributions) on an "AS IS" BASIS, | |||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or | |||
implied, including, without limitation, any warranties or conditions | |||
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A | |||
PARTICULAR PURPOSE. You are solely responsible for determining the | |||
appropriateness of using or redistributing the Work and assume any | |||
risks associated with Your exercise of permissions under this License. | |||
8. Limitation of Liability. In no event and under no legal theory, | |||
whether in tort (including negligence), contract, or otherwise, | |||
unless required by applicable law (such as deliberate and grossly | |||
negligent acts) or agreed to in writing, shall any Contributor be | |||
liable to You for damages, including any direct, indirect, special, | |||
incidental, or consequential damages of any character arising as a | |||
result of this License or out of the use or inability to use the | |||
Work (including but not limited to damages for loss of goodwill, | |||
work stoppage, computer failure or malfunction, or any and all | |||
other commercial damages or losses), even if such Contributor | |||
has been advised of the possibility of such damages. | |||
9. Accepting Warranty or Additional Liability. While redistributing | |||
the Work or Derivative Works thereof, You may choose to offer, | |||
and charge a fee for, acceptance of support, warranty, indemnity, | |||
or other liability obligations and/or rights consistent with this | |||
License. However, in accepting such obligations, You may act only | |||
on Your own behalf and on Your sole responsibility, not on behalf | |||
of any other Contributor, and only if You agree to indemnify, | |||
defend, and hold each Contributor harmless for any liability | |||
incurred by, or claims asserted against, such Contributor by reason | |||
of your accepting any such warranty or additional liability. | |||
END OF TERMS AND CONDITIONS | |||
Copyright 2015 - 2019 Amish Shah | |||
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 | |||
Unless required by applicable law or agreed to in writing, software | |||
distributed under the License is distributed on an "AS IS" BASIS, | |||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | |||
See the License for the specific language governing permissions and | |||
limitations under the License. |
@@ -0,0 +1,3 @@ | |||
# Collection | |||
Utility data structure used in Discord.js. |
@@ -0,0 +1,317 @@ | |||
export interface CollectionConstructor { | |||
new (): Collection<unknown, unknown>; | |||
new <K, V>(entries?: ReadonlyArray<readonly [K, V]> | null): Collection<K, V>; | |||
new <K, V>(iterable: Iterable<readonly [K, V]>): Collection<K, V>; | |||
readonly prototype: Collection<unknown, unknown>; | |||
readonly [Symbol.species]: CollectionConstructor; | |||
} | |||
/** | |||
* A Map with additional utility methods. This is used throughout discord.js rather than Arrays for anything that has | |||
* an ID, for significantly improved performance and ease-of-use. | |||
* @extends {Map} | |||
* @property {number} size - The amount of elements in this collection. | |||
*/ | |||
declare class Collection<K, V> extends Map<K, V> { | |||
private _array; | |||
private _keyArray; | |||
static readonly default: typeof Collection; | |||
['constructor']: typeof Collection; | |||
constructor(entries?: ReadonlyArray<readonly [K, V]> | null); | |||
/** | |||
* Identical to [Map.get()](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Map/get). | |||
* Gets an element with the specified key, and returns its value, or `undefined` if the element does not exist. | |||
* @param {*} key - The key to get from this collection | |||
* @returns {* | undefined} | |||
*/ | |||
get(key: K): V | undefined; | |||
/** | |||
* Identical to [Map.set()](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Map/set). | |||
* Sets a new element in the collection with the specified key and value. | |||
* @param {*} key - The key of the element to add | |||
* @param {*} value - The value of the element to add | |||
* @returns {Collection} | |||
*/ | |||
set(key: K, value: V): this; | |||
/** | |||
* Identical to [Map.has()](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Map/has). | |||
* Checks if an element exists in the collection. | |||
* @param {*} key - The key of the element to check for | |||
* @returns {boolean} `true` if the element exists, `false` if it does not exist. | |||
*/ | |||
has(key: K): boolean; | |||
/** | |||
* Identical to [Map.delete()](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Map/delete). | |||
* Deletes an element from the collection. | |||
* @param {*} key - The key to delete from the collection | |||
* @returns {boolean} `true` if the element was removed, `false` if the element does not exist. | |||
*/ | |||
delete(key: K): boolean; | |||
/** | |||
* Identical to [Map.clear()](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Map/clear). | |||
* Removes all elements from the collection. | |||
* @returns {undefined} | |||
*/ | |||
clear(): void; | |||
/** | |||
* Creates an ordered array of the values of this collection, and caches it internally. The array will only be | |||
* reconstructed if an item is added to or removed from the collection, or if you change the length of the array | |||
* itself. If you don't want this caching behavior, use `[...collection.values()]` or | |||
* `Array.from(collection.values())` instead. | |||
* @returns {Array} | |||
*/ | |||
array(): V[]; | |||
/** | |||
* Creates an ordered array of the keys of this collection, and caches it internally. The array will only be | |||
* reconstructed if an item is added to or removed from the collection, or if you change the length of the array | |||
* itself. If you don't want this caching behavior, use `[...collection.keys()]` or | |||
* `Array.from(collection.keys())` instead. | |||
* @returns {Array} | |||
*/ | |||
keyArray(): K[]; | |||
/** | |||
* Obtains the first value(s) in this collection. | |||
* @param {number} [amount] Amount of values to obtain from the beginning | |||
* @returns {*|Array<*>} A single value if no amount is provided or an array of values, starting from the end if | |||
* amount is negative | |||
*/ | |||
first(): V | undefined; | |||
first(amount: number): V[]; | |||
/** | |||
* Obtains the first key(s) in this collection. | |||
* @param {number} [amount] Amount of keys to obtain from the beginning | |||
* @returns {*|Array<*>} A single key if no amount is provided or an array of keys, starting from the end if | |||
* amount is negative | |||
*/ | |||
firstKey(): K | undefined; | |||
firstKey(amount: number): K[]; | |||
/** | |||
* Obtains the last value(s) in this collection. This relies on {@link Collection#array}, and thus the caching | |||
* mechanism applies here as well. | |||
* @param {number} [amount] Amount of values to obtain from the end | |||
* @returns {*|Array<*>} A single value if no amount is provided or an array of values, starting from the start if | |||
* amount is negative | |||
*/ | |||
last(): V | undefined; | |||
last(amount: number): V[]; | |||
/** | |||
* Obtains the last key(s) in this collection. This relies on {@link Collection#keyArray}, and thus the caching | |||
* mechanism applies here as well. | |||
* @param {number} [amount] Amount of keys to obtain from the end | |||
* @returns {*|Array<*>} A single key if no amount is provided or an array of keys, starting from the start if | |||
* amount is negative | |||
*/ | |||
lastKey(): K | undefined; | |||
lastKey(amount: number): K[]; | |||
/** | |||
* Obtains unique random value(s) from this collection. This relies on {@link Collection#array}, and thus the caching | |||
* mechanism applies here as well. | |||
* @param {number} [amount] Amount of values to obtain randomly | |||
* @returns {*|Array<*>} A single value if no amount is provided or an array of values | |||
*/ | |||
random(): V; | |||
random(amount: number): V[]; | |||
/** | |||
* Obtains unique random key(s) from this collection. This relies on {@link Collection#keyArray}, and thus the caching | |||
* mechanism applies here as well. | |||
* @param {number} [amount] Amount of keys to obtain randomly | |||
* @returns {*|Array<*>} A single key if no amount is provided or an array | |||
*/ | |||
randomKey(): K; | |||
randomKey(amount: number): K[]; | |||
/** | |||
* Searches for a single item where the given function returns a truthy value. This behaves like | |||
* [Array.find()](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/find). | |||
* <warn>All collections used in Discord.js are mapped using their `id` property, and if you want to find by id you | |||
* should use the `get` method. See | |||
* [MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Map/get) for details.</warn> | |||
* @param {Function} fn The function to test with (should return boolean) | |||
* @param {*} [thisArg] Value to use as `this` when executing function | |||
* @returns {*} | |||
* @example collection.find(user => user.username === 'Bob'); | |||
*/ | |||
find(fn: (value: V, key: K, collection: this) => boolean): V | undefined; | |||
find<T>(fn: (this: T, value: V, key: K, collection: this) => boolean, thisArg: T): V | undefined; | |||
/** | |||
* Searches for the key of a single item where the given function returns a truthy value. This behaves like | |||
* [Array.findIndex()](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/findIndex), | |||
* but returns the key rather than the positional index. | |||
* @param {Function} fn The function to test with (should return boolean) | |||
* @param {*} [thisArg] Value to use as `this` when executing function | |||
* @returns {*} | |||
* @example collection.findKey(user => user.username === 'Bob'); | |||
*/ | |||
findKey(fn: (value: V, key: K, collection: this) => boolean): K | undefined; | |||
findKey<T>(fn: (this: T, value: V, key: K, collection: this) => boolean, thisArg: T): K | undefined; | |||
/** | |||
* Removes items that satisfy the provided filter function. | |||
* @param {Function} fn Function used to test (should return a boolean) | |||
* @param {*} [thisArg] Value to use as `this` when executing function | |||
* @returns {number} The number of removed entries | |||
*/ | |||
sweep(fn: (value: V, key: K, collection: this) => boolean): number; | |||
sweep<T>(fn: (this: T, value: V, key: K, collection: this) => boolean, thisArg: T): number; | |||
/** | |||
* Identical to | |||
* [Array.filter()](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/filter), | |||
* but returns a Collection instead of an Array. | |||
* @param {Function} fn The function to test with (should return boolean) | |||
* @param {*} [thisArg] Value to use as `this` when executing function | |||
* @returns {Collection} | |||
* @example collection.filter(user => user.username === 'Bob'); | |||
*/ | |||
filter(fn: (value: V, key: K, collection: this) => boolean): this; | |||
filter<T>(fn: (this: T, value: V, key: K, collection: this) => boolean, thisArg: T): this; | |||
/** | |||
* Partitions the collection into two collections where the first collection | |||
* contains the items that passed and the second contains the items that failed. | |||
* @param {Function} fn Function used to test (should return a boolean) | |||
* @param {*} [thisArg] Value to use as `this` when executing function | |||
* @returns {Collection[]} | |||
* @example const [big, small] = collection.partition(guild => guild.memberCount > 250); | |||
*/ | |||
partition(fn: (value: V, key: K, collection: this) => boolean): [this, this]; | |||
partition<T>(fn: (this: T, value: V, key: K, collection: this) => boolean, thisArg: T): [this, this]; | |||
/** | |||
* Maps each item into a Collection, then joins the results into a single Collection. Identical in behavior to | |||
* [Array.flatMap()](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/flatMap). | |||
* @param {Function} fn Function that produces a new Collection | |||
* @param {*} [thisArg] Value to use as `this` when executing function | |||
* @returns {Collection} | |||
* @example collection.flatMap(guild => guild.members); | |||
*/ | |||
flatMap<T>(fn: (value: V, key: K, collection: this) => Collection<K, T>): Collection<K, T>; | |||
flatMap<T, This>(fn: (this: This, value: V, key: K, collection: this) => Collection<K, T>, thisArg: This): Collection<K, T>; | |||
/** | |||
* Maps each item to another value into an array. Identical in behavior to | |||
* [Array.map()](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/map). | |||
* @param {Function} fn Function that produces an element of the new array, taking three arguments | |||
* @param {*} [thisArg] Value to use as `this` when executing function | |||
* @returns {Array} | |||
* @example collection.map(user => user.tag); | |||
*/ | |||
map<T>(fn: (value: V, key: K, collection: this) => T): T[]; | |||
map<This, T>(fn: (this: This, value: V, key: K, collection: this) => T, thisArg: This): T[]; | |||
/** | |||
* Maps each item to another value into a collection. Identical in behavior to | |||
* [Array.map()](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/map). | |||
* @param {Function} fn Function that produces an element of the new collection, taking three arguments | |||
* @param {*} [thisArg] Value to use as `this` when executing function | |||
* @returns {Collection} | |||
* @example collection.mapValues(user => user.tag); | |||
*/ | |||
mapValues<T>(fn: (value: V, key: K, collection: this) => T): Collection<K, T>; | |||
mapValues<This, T>(fn: (this: This, value: V, key: K, collection: this) => T, thisArg: This): Collection<K, T>; | |||
/** | |||
* Checks if there exists an item that passes a test. Identical in behavior to | |||
* [Array.some()](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/some). | |||
* @param {Function} fn Function used to test (should return a boolean) | |||
* @param {*} [thisArg] Value to use as `this` when executing function | |||
* @returns {boolean} | |||
* @example collection.some(user => user.discriminator === '0000'); | |||
*/ | |||
some(fn: (value: V, key: K, collection: this) => boolean): boolean; | |||
some<T>(fn: (this: T, value: V, key: K, collection: this) => boolean, thisArg: T): boolean; | |||
/** | |||
* Checks if all items passes a test. Identical in behavior to | |||
* [Array.every()](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/every). | |||
* @param {Function} fn Function used to test (should return a boolean) | |||
* @param {*} [thisArg] Value to use as `this` when executing function | |||
* @returns {boolean} | |||
* @example collection.every(user => !user.bot); | |||
*/ | |||
every(fn: (value: V, key: K, collection: this) => boolean): boolean; | |||
every<T>(fn: (this: T, value: V, key: K, collection: this) => boolean, thisArg: T): boolean; | |||
/** | |||
* Applies a function to produce a single value. Identical in behavior to | |||
* [Array.reduce()](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/reduce). | |||
* @param {Function} fn Function used to reduce, taking four arguments; `accumulator`, `currentValue`, `currentKey`, | |||
* and `collection` | |||
* @param {*} [initialValue] Starting value for the accumulator | |||
* @returns {*} | |||
* @example collection.reduce((acc, guild) => acc + guild.memberCount, 0); | |||
*/ | |||
reduce<T>(fn: (accumulator: T, value: V, key: K, collection: this) => T, initialValue?: T): T; | |||
/** | |||
* Identical to | |||
* [Map.forEach()](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Map/forEach), | |||
* but returns the collection instead of undefined. | |||
* @param {Function} fn Function to execute for each element | |||
* @param {*} [thisArg] Value to use as `this` when executing function | |||
* @returns {Collection} | |||
* @example | |||
* collection | |||
* .each(user => console.log(user.username)) | |||
* .filter(user => user.bot) | |||
* .each(user => console.log(user.username)); | |||
*/ | |||
each(fn: (value: V, key: K, collection: this) => void): this; | |||
each<T>(fn: (this: T, value: V, key: K, collection: this) => void, thisArg: T): this; | |||
/** | |||
* Runs a function on the collection and returns the collection. | |||
* @param {Function} fn Function to execute | |||
* @param {*} [thisArg] Value to use as `this` when executing function | |||
* @returns {Collection} | |||
* @example | |||
* collection | |||
* .tap(coll => console.log(coll.size)) | |||
* .filter(user => user.bot) | |||
* .tap(coll => console.log(coll.size)) | |||
*/ | |||
tap(fn: (collection: this) => void): this; | |||
tap<T>(fn: (this: T, collection: this) => void, thisArg: T): this; | |||
/** | |||
* Creates an identical shallow copy of this collection. | |||
* @returns {Collection} | |||
* @example const newColl = someColl.clone(); | |||
*/ | |||
clone(): this; | |||
/** | |||
* Combines this collection with others into a new collection. None of the source collections are modified. | |||
* @param {...Collection} collections Collections to merge | |||
* @returns {Collection} | |||
* @example const newColl = someColl.concat(someOtherColl, anotherColl, ohBoyAColl); | |||
*/ | |||
concat(...collections: Collection<K, V>[]): this; | |||
/** | |||
* Checks if this collection shares identical items with another. | |||
* This is different to checking for equality using equal-signs, because | |||
* the collections may be different objects, but contain the same data. | |||
* @param {Collection} collection Collection to compare with | |||
* @returns {boolean} Whether the collections have identical contents | |||
*/ | |||
equals(collection: Collection<K, V>): boolean; | |||
/** | |||
* The sort method sorts the items of a collection in place and returns it. | |||
* The sort is not necessarily stable. The default sort order is according to string Unicode code points. | |||
* @param {Function} [compareFunction] Specifies a function that defines the sort order. | |||
* If omitted, the collection is sorted according to each character's Unicode code point value, | |||
* according to the string conversion of each element. | |||
* @returns {Collection} | |||
* @example collection.sort((userA, userB) => userA.createdTimestamp - userB.createdTimestamp); | |||
*/ | |||
sort(compareFunction?: (firstValue: V, secondValue: V, firstKey: K, secondKey: K) => number): this; | |||
/** | |||
* The intersect method returns a new structure containing items where the keys are present in both original structures. | |||
* @param {Collection} other The other Collection to filter against | |||
* @returns {Collection} | |||
*/ | |||
intersect(other: Collection<K, V>): Collection<K, V>; | |||
/** | |||
* The difference method returns a new structure containing items where the key is present in one of the original structures but not the other. | |||
* @param {Collection} other The other Collection to filter against | |||
* @returns {Collection} | |||
*/ | |||
difference(other: Collection<K, V>): Collection<K, V>; | |||
/** | |||
* The sorted method sorts the items of a collection and returns it. | |||
* The sort is not necessarily stable. The default sort order is according to string Unicode code points. | |||
* @param {Function} [compareFunction] Specifies a function that defines the sort order. | |||
* If omitted, the collection is sorted according to each character's Unicode code point value, | |||
* according to the string conversion of each element. | |||
* @returns {Collection} | |||
* @example collection.sorted((userA, userB) => userA.createdTimestamp - userB.createdTimestamp); | |||
*/ | |||
sorted(compareFunction?: (firstValue: V, secondValue: V, firstKey: K, secondKey: K) => number): this; | |||
} | |||
export { Collection }; | |||
export default Collection; |
@@ -0,0 +1,78 @@ | |||
{ | |||
"_from": "@discordjs/collection@^0.1.5", | |||
"_id": "@discordjs/collection@0.1.5", | |||
"_inBundle": false, | |||
"_integrity": "sha512-CU1q0UXQUpFNzNB7gufgoisDHP7n+T3tkqTsp3MNUkVJ5+hS3BCvME8uCXAUFlz+6T2FbTCu75A+yQ7HMKqRKw==", | |||
"_location": "/@discordjs/collection", | |||
"_phantomChildren": {}, | |||
"_requested": { | |||
"type": "range", | |||
"registry": true, | |||
"raw": "@discordjs/collection@^0.1.5", | |||
"name": "@discordjs/collection", | |||
"escapedName": "@discordjs%2fcollection", | |||
"scope": "@discordjs", | |||
"rawSpec": "^0.1.5", | |||
"saveSpec": null, | |||
"fetchSpec": "^0.1.5" | |||
}, | |||
"_requiredBy": [ | |||
"/discord.js" | |||
], | |||
"_resolved": "https://registry.npmjs.org/@discordjs/collection/-/collection-0.1.5.tgz", | |||
"_shasum": "1781c620b4c88d619bd0373a1548e5a6025e3d3a", | |||
"_spec": "@discordjs/collection@^0.1.5", | |||
"_where": "/home/cziermann/git/papoh/node_modules/discord.js", | |||
"author": { | |||
"name": "Amish Shah", | |||
"email": "amishshah.2k@gmail.com" | |||
}, | |||
"bugs": { | |||
"url": "https://github.com/discordjs/collection/issues" | |||
}, | |||
"bundleDependencies": false, | |||
"deprecated": false, | |||
"description": "Utility data structure used in Discord.js", | |||
"devDependencies": { | |||
"@babel/cli": "^7.8.4", | |||
"@babel/core": "^7.8.4", | |||
"@babel/preset-env": "^7.8.4", | |||
"@babel/preset-typescript": "^7.8.3", | |||
"@types/node": "^13.7.4", | |||
"@typescript-eslint/eslint-plugin": "^2.21.0", | |||
"@typescript-eslint/parser": "^2.21.0", | |||
"discord.js-docgen": "github:discordjs/docgen#ts-patch", | |||
"eslint": "^6.8.0", | |||
"eslint-config-marine": "^6.0.0", | |||
"jsdoc-babel": "^0.5.0", | |||
"rimraf": "^3.0.2", | |||
"typescript": "^3.8.2" | |||
}, | |||
"eslintConfig": { | |||
"extends": "marine/node" | |||
}, | |||
"homepage": "https://github.com/discordjs/collection#readme", | |||
"keywords": [ | |||
"map", | |||
"collection", | |||
"utility" | |||
], | |||
"license": "Apache-2.0", | |||
"main": "dist/index.js", | |||
"name": "@discordjs/collection", | |||
"repository": { | |||
"type": "git", | |||
"url": "git+https://github.com/discordjs/collection.git" | |||
}, | |||
"scripts": { | |||
"build": "rimraf dist/ && tsc", | |||
"docs": "docgen --jsdoc jsdoc.json --source src/*.ts src/**/*.ts --custom docs/index.yml --output docs/docs.json", | |||
"docs:test": "docgen --jsdoc jsdoc.json --source src/*.ts src/**/*.ts --custom docs/index.yml", | |||
"lint": "eslint src --ext .ts", | |||
"prebuild": "npm run lint", | |||
"pretest": "npm run build", | |||
"test": "node test/index.js" | |||
}, | |||
"types": "dist/index.d.ts", | |||
"version": "0.1.5" | |||
} |
@@ -0,0 +1,19 @@ | |||
Copyright (c) 2012 Felix Geisendörfer (felix@debuggable.com) and contributors | |||
Permission is hereby granted, free of charge, to any person obtaining a copy | |||
of this software and associated documentation files (the "Software"), to deal | |||
in the Software without restriction, including without limitation the rights | |||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | |||
copies of the Software, and to permit persons to whom the Software is | |||
furnished to do so, subject to the following conditions: | |||
The above copyright notice and this permission notice shall be included in | |||
all copies or substantial portions of the Software. | |||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | |||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | |||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | |||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | |||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | |||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN | |||
THE SOFTWARE. |
@@ -0,0 +1,353 @@ | |||
# Form-Data [](https://www.npmjs.com/package/form-data) [](https://gitter.im/form-data/form-data) | |||
A library to create readable ```"multipart/form-data"``` streams. Can be used to submit forms and file uploads to other web applications. | |||
The API of this library is inspired by the [XMLHttpRequest-2 FormData Interface][xhr2-fd]. | |||
[xhr2-fd]: http://dev.w3.org/2006/webapi/XMLHttpRequest-2/Overview.html#the-formdata-interface | |||
[](https://travis-ci.org/form-data/form-data) | |||
[](https://travis-ci.org/form-data/form-data) | |||
[](https://travis-ci.org/form-data/form-data) | |||
[](https://coveralls.io/github/form-data/form-data?branch=master) | |||
[](https://david-dm.org/form-data/form-data) | |||
## Install | |||
``` | |||
npm install --save form-data | |||
``` | |||
## Usage | |||
In this example we are constructing a form with 3 fields that contain a string, | |||
a buffer and a file stream. | |||
``` javascript | |||
var FormData = require('form-data'); | |||
var fs = require('fs'); | |||
var form = new FormData(); | |||
form.append('my_field', 'my value'); | |||
form.append('my_buffer', new Buffer(10)); | |||
form.append('my_file', fs.createReadStream('/foo/bar.jpg')); | |||
``` | |||
Also you can use http-response stream: | |||
``` javascript | |||
var FormData = require('form-data'); | |||
var http = require('http'); | |||
var form = new FormData(); | |||
http.request('http://nodejs.org/images/logo.png', function(response) { | |||
form.append('my_field', 'my value'); | |||
form.append('my_buffer', new Buffer(10)); | |||
form.append('my_logo', response); | |||
}); | |||
``` | |||
Or @mikeal's [request](https://github.com/request/request) stream: | |||
``` javascript | |||
var FormData = require('form-data'); | |||
var request = require('request'); | |||
var form = new FormData(); | |||
form.append('my_field', 'my value'); | |||
form.append('my_buffer', new Buffer(10)); | |||
form.append('my_logo', request('http://nodejs.org/images/logo.png')); | |||
``` | |||
In order to submit this form to a web application, call ```submit(url, [callback])``` method: | |||
``` javascript | |||
form.submit('http://example.org/', function(err, res) { | |||
// res – response object (http.IncomingMessage) // | |||
res.resume(); | |||
}); | |||
``` | |||
For more advanced request manipulations ```submit()``` method returns ```http.ClientRequest``` object, or you can choose from one of the alternative submission methods. | |||
### Custom options | |||
You can provide custom options, such as `maxDataSize`: | |||
``` javascript | |||
var FormData = require('form-data'); | |||
var form = new FormData({ maxDataSize: 20971520 }); | |||
form.append('my_field', 'my value'); | |||
form.append('my_buffer', /* something big */); | |||
``` | |||
List of available options could be found in [combined-stream](https://github.com/felixge/node-combined-stream/blob/master/lib/combined_stream.js#L7-L15) | |||
### Alternative submission methods | |||
You can use node's http client interface: | |||
``` javascript | |||
var http = require('http'); | |||
var request = http.request({ | |||
method: 'post', | |||
host: 'example.org', | |||
path: '/upload', | |||
headers: form.getHeaders() | |||
}); | |||
form.pipe(request); | |||
request.on('response', function(res) { | |||
console.log(res.statusCode); | |||
}); | |||
``` | |||
Or if you would prefer the `'Content-Length'` header to be set for you: | |||
``` javascript | |||
form.submit('example.org/upload', function(err, res) { | |||
console.log(res.statusCode); | |||
}); | |||
``` | |||
To use custom headers and pre-known length in parts: | |||
``` javascript | |||
var CRLF = '\r\n'; | |||
var form = new FormData(); | |||
var options = { | |||
header: CRLF + '--' + form.getBoundary() + CRLF + 'X-Custom-Header: 123' + CRLF + CRLF, | |||
knownLength: 1 | |||
}; | |||
form.append('my_buffer', buffer, options); | |||
form.submit('http://example.com/', function(err, res) { | |||
if (err) throw err; | |||
console.log('Done'); | |||
}); | |||
``` | |||
Form-Data can recognize and fetch all the required information from common types of streams (```fs.readStream```, ```http.response``` and ```mikeal's request```), for some other types of streams you'd need to provide "file"-related information manually: | |||
``` javascript | |||
someModule.stream(function(err, stdout, stderr) { | |||
if (err) throw err; | |||
var form = new FormData(); | |||
form.append('file', stdout, { | |||
filename: 'unicycle.jpg', // ... or: | |||
filepath: 'photos/toys/unicycle.jpg', | |||
contentType: 'image/jpeg', | |||
knownLength: 19806 | |||
}); | |||
form.submit('http://example.com/', function(err, res) { | |||
if (err) throw err; | |||
console.log('Done'); | |||
}); | |||
}); | |||
``` | |||
The `filepath` property overrides `filename` and may contain a relative path. This is typically used when uploading [multiple files from a directory](https://wicg.github.io/entries-api/#dom-htmlinputelement-webkitdirectory). | |||
For edge cases, like POST request to URL with query string or to pass HTTP auth credentials, object can be passed to `form.submit()` as first parameter: | |||
``` javascript | |||
form.submit({ | |||
host: 'example.com', | |||
path: '/probably.php?extra=params', | |||
auth: 'username:password' | |||
}, function(err, res) { | |||
console.log(res.statusCode); | |||
}); | |||
``` | |||
In case you need to also send custom HTTP headers with the POST request, you can use the `headers` key in first parameter of `form.submit()`: | |||
``` javascript | |||
form.submit({ | |||
host: 'example.com', | |||
path: '/surelynot.php', | |||
headers: {'x-test-header': 'test-header-value'} | |||
}, function(err, res) { | |||
console.log(res.statusCode); | |||
}); | |||
``` | |||
### Methods | |||
- [_Void_ append( **String** _field_, **Mixed** _value_ [, **Mixed** _options_] )](https://github.com/form-data/form-data#void-append-string-field-mixed-value--mixed-options-). | |||
- [_Headers_ getHeaders( [**Headers** _userHeaders_] )](https://github.com/form-data/form-data#array-getheaders-array-userheaders-) | |||
- [_String_ getBoundary()](https://github.com/form-data/form-data#string-getboundary) | |||
- [_Buffer_ getBuffer()](https://github.com/form-data/form-data#buffer-getbuffer) | |||
- [_Integer_ getLengthSync()](https://github.com/form-data/form-data#integer-getlengthsync) | |||
- [_Integer_ getLength( **function** _callback_ )](https://github.com/form-data/form-data#integer-getlength-function-callback-) | |||
- [_Boolean_ hasKnownLength()](https://github.com/form-data/form-data#boolean-hasknownlength) | |||
- [_Request_ submit( _params_, **function** _callback_ )](https://github.com/form-data/form-data#request-submit-params-function-callback-) | |||
- [_String_ toString()](https://github.com/form-data/form-data#string-tostring) | |||
#### _Void_ append( **String** _field_, **Mixed** _value_ [, **Mixed** _options_] ) | |||
Append data to the form. You can submit about any format (string, integer, boolean, buffer, etc.). However, Arrays are not supported and need to be turned into strings by the user. | |||
```javascript | |||
var form = new FormData(); | |||
form.append( 'my_string', 'my value' ); | |||
form.append( 'my_integer', 1 ); | |||
form.append( 'my_boolean', true ); | |||
form.append( 'my_buffer', new Buffer(10) ); | |||
form.append( 'my_array_as_json', JSON.stringify( ['bird','cute'] ) ) | |||
``` | |||
You may provide a string for options, or an object. | |||
```javascript | |||
// Set filename by providing a string for options | |||
form.append( 'my_file', fs.createReadStream('/foo/bar.jpg'), 'bar.jpg' ); | |||
// provide an object. | |||
form.append( 'my_file', fs.createReadStream('/foo/bar.jpg'), {filename: 'bar.jpg', contentType: 'image/jpeg', knownLength: 19806} ); | |||
``` | |||
#### _Headers_ getHeaders( [**Headers** _userHeaders_] ) | |||
This method adds the correct `content-type` header to the provided array of `userHeaders`. | |||
#### _String_ getBoundary() | |||
Return the boundary of the formData. A boundary consists of 26 `-` followed by 24 numbers | |||
for example: | |||
```javascript | |||
--------------------------515890814546601021194782 | |||
``` | |||
_Note: The boundary must be unique and may not appear in the data._ | |||
#### _Buffer_ getBuffer() | |||
Return the full formdata request package, as a Buffer. You can insert this Buffer in e.g. Axios to send multipart data. | |||
```javascript | |||
var form = new FormData(); | |||
form.append( 'my_buffer', Buffer.from([0x4a,0x42,0x20,0x52,0x6f,0x63,0x6b,0x73]) ); | |||
form.append( 'my_file', fs.readFileSync('/foo/bar.jpg') ); | |||
axios.post( 'https://example.com/path/to/api', | |||
form.getBuffer(), | |||
form.getHeaders() | |||
) | |||
``` | |||
**Note:** Because the output is of type Buffer, you can only append types that are accepted by Buffer: *string, Buffer, ArrayBuffer, Array, or Array-like Object*. A ReadStream for example will result in an error. | |||
#### _Integer_ getLengthSync() | |||
Same as `getLength` but synchronous. | |||
_Note: getLengthSync __doesn't__ calculate streams length._ | |||
#### _Integer_ getLength( **function** _callback_ ) | |||
Returns the `Content-Length` async. The callback is used to handle errors and continue once the length has been calculated | |||
```javascript | |||
this.getLength(function(err, length) { | |||
if (err) { | |||
this._error(err); | |||
return; | |||
} | |||
// add content length | |||
request.setHeader('Content-Length', length); | |||
... | |||
}.bind(this)); | |||
``` | |||
#### _Boolean_ hasKnownLength() | |||
Checks if the length of added values is known. | |||
#### _Request_ submit( _params_, **function** _callback_ ) | |||
Submit the form to a web application. | |||
```javascript | |||
var form = new FormData(); | |||
form.append( 'my_string', 'Hello World' ); | |||
form.submit( 'http://example.com/', function(err, res) { | |||
// res – response object (http.IncomingMessage) // | |||
res.resume(); | |||
} ); | |||
``` | |||
#### _String_ toString() | |||
Returns the form data as a string. Don't use this if you are sending files or buffers, use `getBuffer()` instead. | |||
### Integration with other libraries | |||
#### Request | |||
Form submission using [request](https://github.com/request/request): | |||
```javascript | |||
var formData = { | |||
my_field: 'my_value', | |||
my_file: fs.createReadStream(__dirname + '/unicycle.jpg'), | |||
}; | |||
request.post({url:'http://service.com/upload', formData: formData}, function(err, httpResponse, body) { | |||
if (err) { | |||
return console.error('upload failed:', err); | |||
} | |||
console.log('Upload successful! Server responded with:', body); | |||
}); | |||
``` | |||
For more details see [request readme](https://github.com/request/request#multipartform-data-multipart-form-uploads). | |||
#### node-fetch | |||
You can also submit a form using [node-fetch](https://github.com/bitinn/node-fetch): | |||
```javascript | |||
var form = new FormData(); | |||
form.append('a', 1); | |||
fetch('http://example.com', { method: 'POST', body: form }) | |||
.then(function(res) { | |||
return res.json(); | |||
}).then(function(json) { | |||
console.log(json); | |||
}); | |||
``` | |||
#### axios | |||
In Node.js you can post a file using [axios](https://github.com/axios/axios): | |||
```javascript | |||
const form = new FormData(); | |||
const stream = fs.createReadStream(PATH_TO_FILE); | |||
form.append('image', stream); | |||
// In Node.js environment you need to set boundary in the header field 'Content-Type' by calling method `getHeaders` | |||
const formHeaders = form.getHeaders(); | |||
axios.post('http://example.com', form, { | |||
headers: { | |||
...formHeaders, | |||
}, | |||
}) | |||
.then(response => response) | |||
.catch(error => error) | |||
``` | |||
## Notes | |||
- ```getLengthSync()``` method DOESN'T calculate length for streams, use ```knownLength``` options as workaround. | |||
- ```getLength(cb)``` will send an error as first parameter of callback if stream length cannot be calculated (e.g. send in custom streams w/o using ```knownLength```). | |||
- ```sbumit``` will not add `content-length` if form length is unknown or not calculable. | |||
- Starting version `2.x` FormData has dropped support for `node@0.10.x`. | |||
- Starting version `3.x` FormData has dropped support for `node@4.x`. | |||
## License | |||
Form-Data is released under the [MIT](License) license. |
@@ -0,0 +1,61 @@ | |||
// Definitions by: Carlos Ballesteros Velasco <https://github.com/soywiz> | |||
// Leon Yu <https://github.com/leonyu> | |||
// BendingBender <https://github.com/BendingBender> | |||
// Maple Miao <https://github.com/mapleeit> | |||
/// <reference types="node" /> | |||
import * as stream from 'stream'; | |||
import * as http from 'http'; | |||
export = FormData; | |||
// Extracted because @types/node doesn't export interfaces. | |||
interface ReadableOptions { | |||
highWaterMark?: number; | |||
encoding?: string; | |||
objectMode?: boolean; | |||
read?(this: stream.Readable, size: number): void; | |||
destroy?(this: stream.Readable, error: Error | null, callback: (error: Error | null) => void): void; | |||
autoDestroy?: boolean; | |||
} | |||
interface Options extends ReadableOptions { | |||
writable?: boolean; | |||
readable?: boolean; | |||
dataSize?: number; | |||
maxDataSize?: number; | |||
pauseStreams?: boolean; | |||
} | |||
declare class FormData extends stream.Readable { | |||
constructor(options?: Options); | |||
append(key: string, value: any, options?: FormData.AppendOptions | string): void; | |||
getHeaders(userHeaders?: FormData.Headers): FormData.Headers; | |||
submit( | |||
params: string | FormData.SubmitOptions, | |||
callback?: (error: Error | null, response: http.IncomingMessage) => void | |||
): http.ClientRequest; | |||
getBuffer(): Buffer; | |||
getBoundary(): string; | |||
getLength(callback: (err: Error | null, length: number) => void): void; | |||
getLengthSync(): number; | |||
hasKnownLength(): boolean; | |||
} | |||
declare namespace FormData { | |||
interface Headers { | |||
[key: string]: any; | |||
} | |||
interface AppendOptions { | |||
header?: string | Headers; | |||
knownLength?: number; | |||
filename?: string; | |||
filepath?: string; | |||
contentType?: string; | |||
} | |||
interface SubmitOptions extends http.RequestOptions { | |||
protocol?: 'https:' | 'http:'; | |||
} | |||
} |
@@ -0,0 +1,2 @@ | |||
/* eslint-env browser */ | |||
module.exports = typeof self == 'object' ? self.FormData : window.FormData; |
@@ -0,0 +1,497 @@ | |||
var CombinedStream = require('combined-stream'); | |||
var util = require('util'); | |||
var path = require('path'); | |||
var http = require('http'); | |||
var https = require('https'); | |||
var parseUrl = require('url').parse; | |||
var fs = require('fs'); | |||
var Stream = require('stream').Stream; | |||
var mime = require('mime-types'); | |||
var asynckit = require('asynckit'); | |||
var populate = require('./populate.js'); | |||
// Public API | |||
module.exports = FormData; | |||
// make it a Stream | |||
util.inherits(FormData, CombinedStream); | |||
/** | |||
* Create readable "multipart/form-data" streams. | |||
* Can be used to submit forms | |||
* and file uploads to other web applications. | |||
* | |||
* @constructor | |||
* @param {Object} options - Properties to be added/overriden for FormData and CombinedStream | |||
*/ | |||
function FormData(options) { | |||
if (!(this instanceof FormData)) { | |||
return new FormData(options); | |||
} | |||
this._overheadLength = 0; | |||
this._valueLength = 0; | |||
this._valuesToMeasure = []; | |||
CombinedStream.call(this); | |||
options = options || {}; | |||
for (var option in options) { | |||
this[option] = options[option]; | |||
} | |||
} | |||
FormData.LINE_BREAK = '\r\n'; | |||
FormData.DEFAULT_CONTENT_TYPE = 'application/octet-stream'; | |||
FormData.prototype.append = function(field, value, options) { | |||
options = options || {}; | |||
// allow filename as single option | |||
if (typeof options == 'string') { | |||
options = {filename: options}; | |||
} | |||
var append = CombinedStream.prototype.append.bind(this); | |||
// all that streamy business can't handle numbers | |||
if (typeof value == 'number') { | |||
value = '' + value; | |||
} | |||
// https://github.com/felixge/node-form-data/issues/38 | |||
if (util.isArray(value)) { | |||
// Please convert your array into string | |||
// the way web server expects it | |||
this._error(new Error('Arrays are not supported.')); | |||
return; | |||
} | |||
var header = this._multiPartHeader(field, value, options); | |||
var footer = this._multiPartFooter(); | |||
append(header); | |||
append(value); | |||
append(footer); | |||
// pass along options.knownLength | |||
this._trackLength(header, value, options); | |||
}; | |||
FormData.prototype._trackLength = function(header, value, options) { | |||
var valueLength = 0; | |||
// used w/ getLengthSync(), when length is known. | |||
// e.g. for streaming directly from a remote server, | |||
// w/ a known file a size, and not wanting to wait for | |||
// incoming file to finish to get its size. | |||
if (options.knownLength != null) { | |||
valueLength += +options.knownLength; | |||
} else if (Buffer.isBuffer(value)) { | |||
valueLength = value.length; | |||
} else if (typeof value === 'string') { | |||
valueLength = Buffer.byteLength(value); | |||
} | |||
this._valueLength += valueLength; | |||
// @check why add CRLF? does this account for custom/multiple CRLFs? | |||
this._overheadLength += | |||
Buffer.byteLength(header) + | |||
FormData.LINE_BREAK.length; | |||
// empty or either doesn't have path or not an http response or not a stream | |||
if (!value || ( !value.path && !(value.readable && value.hasOwnProperty('httpVersion')) && !(value instanceof Stream))) { | |||
return; | |||
} | |||
// no need to bother with the length | |||
if (!options.knownLength) { | |||
this._valuesToMeasure.push(value); | |||
} | |||
}; | |||
FormData.prototype._lengthRetriever = function(value, callback) { | |||
if (value.hasOwnProperty('fd')) { | |||
// take read range into a account | |||
// `end` = Infinity –> read file till the end | |||
// | |||
// TODO: Looks like there is bug in Node fs.createReadStream | |||
// it doesn't respect `end` options without `start` options | |||
// Fix it when node fixes it. | |||
// https://github.com/joyent/node/issues/7819 | |||
if (value.end != undefined && value.end != Infinity && value.start != undefined) { | |||
// when end specified | |||
// no need to calculate range | |||
// inclusive, starts with 0 | |||
callback(null, value.end + 1 - (value.start ? value.start : 0)); | |||
// not that fast snoopy | |||
} else { | |||
// still need to fetch file size from fs | |||
fs.stat(value.path, function(err, stat) { | |||
var fileSize; | |||
if (err) { | |||
callback(err); | |||
return; | |||
} | |||
// update final size based on the range options | |||
fileSize = stat.size - (value.start ? value.start : 0); | |||
callback(null, fileSize); | |||
}); | |||
} | |||
// or http response | |||
} else if (value.hasOwnProperty('httpVersion')) { | |||
callback(null, +value.headers['content-length']); | |||
// or request stream http://github.com/mikeal/request | |||
} else if (value.hasOwnProperty('httpModule')) { | |||
// wait till response come back | |||
value.on('response', function(response) { | |||
value.pause(); | |||
callback(null, +response.headers['content-length']); | |||
}); | |||
value.resume(); | |||
// something else | |||
} else { | |||
callback('Unknown stream'); | |||
} | |||
}; | |||
FormData.prototype._multiPartHeader = function(field, value, options) { | |||
// custom header specified (as string)? | |||
// it becomes responsible for boundary | |||
// (e.g. to handle extra CRLFs on .NET servers) | |||
if (typeof options.header == 'string') { | |||
return options.header; | |||
} | |||
var contentDisposition = this._getContentDisposition(value, options); | |||
var contentType = this._getContentType(value, options); | |||
var contents = ''; | |||
var headers = { | |||
// add custom disposition as third element or keep it two elements if not | |||
'Content-Disposition': ['form-data', 'name="' + field + '"'].concat(contentDisposition || []), | |||
// if no content type. allow it to be empty array | |||
'Content-Type': [].concat(contentType || []) | |||
}; | |||
// allow custom headers. | |||
if (typeof options.header == 'object') { | |||
populate(headers, options.header); | |||
} | |||
var header; | |||
for (var prop in headers) { | |||
if (!headers.hasOwnProperty(prop)) continue; | |||
header = headers[prop]; | |||
// skip nullish headers. | |||
if (header == null) { | |||
continue; | |||
} | |||
// convert all headers to arrays. | |||
if (!Array.isArray(header)) { | |||
header = [header]; | |||
} | |||
// add non-empty headers. | |||
if (header.length) { | |||
contents += prop + ': ' + header.join('; ') + FormData.LINE_BREAK; | |||
} | |||
} | |||
return '--' + this.getBoundary() + FormData.LINE_BREAK + contents + FormData.LINE_BREAK; | |||
}; | |||
FormData.prototype._getContentDisposition = function(value, options) { | |||
var filename | |||
, contentDisposition | |||
; | |||
if (typeof options.filepath === 'string') { | |||
// custom filepath for relative paths | |||
filename = path.normalize(options.filepath).replace(/\\/g, '/'); | |||
} else if (options.filename || value.name || value.path) { | |||
// custom filename take precedence | |||
// formidable and the browser add a name property | |||
// fs- and request- streams have path property | |||
filename = path.basename(options.filename || value.name || value.path); | |||
} else if (value.readable && value.hasOwnProperty('httpVersion')) { | |||
// or try http response | |||
filename = path.basename(value.client._httpMessage.path || ''); | |||
} | |||
if (filename) { | |||
contentDisposition = 'filename="' + filename + '"'; | |||
} | |||
return contentDisposition; | |||
}; | |||
FormData.prototype._getContentType = function(value, options) { | |||
// use custom content-type above all | |||
var contentType = options.contentType; | |||
// or try `name` from formidable, browser | |||
if (!contentType && value.name) { | |||
contentType = mime.lookup(value.name); | |||
} | |||
// or try `path` from fs-, request- streams | |||
if (!contentType && value.path) { | |||
contentType = mime.lookup(value.path); | |||
} | |||
// or if it's http-reponse | |||
if (!contentType && value.readable && value.hasOwnProperty('httpVersion')) { | |||
contentType = value.headers['content-type']; | |||
} | |||
// or guess it from the filepath or filename | |||
if (!contentType && (options.filepath || options.filename)) { | |||
contentType = mime.lookup(options.filepath || options.filename); | |||
} | |||
// fallback to the default content type if `value` is not simple value | |||
if (!contentType && typeof value == 'object') { | |||
contentType = FormData.DEFAULT_CONTENT_TYPE; | |||
} | |||
return contentType; | |||
}; | |||
FormData.prototype._multiPartFooter = function() { | |||
return function(next) { | |||
var footer = FormData.LINE_BREAK; | |||
var lastPart = (this._streams.length === 0); | |||
if (lastPart) { | |||
footer += this._lastBoundary(); | |||
} | |||
next(footer); | |||
}.bind(this); | |||
}; | |||
FormData.prototype._lastBoundary = function() { | |||
return '--' + this.getBoundary() + '--' + FormData.LINE_BREAK; | |||
}; | |||
FormData.prototype.getHeaders = function(userHeaders) { | |||
var header; | |||
var formHeaders = { | |||
'content-type': 'multipart/form-data; boundary=' + this.getBoundary() | |||
}; | |||
for (header in userHeaders) { | |||
if (userHeaders.hasOwnProperty(header)) { | |||
formHeaders[header.toLowerCase()] = userHeaders[header]; | |||
} | |||
} | |||
return formHeaders; | |||
}; | |||
FormData.prototype.getBoundary = function() { | |||
if (!this._boundary) { | |||
this._generateBoundary(); | |||
} | |||
return this._boundary; | |||
}; | |||
FormData.prototype.getBuffer = function() { | |||
var dataBuffer = new Buffer.alloc( 0 ); | |||
var boundary = this.getBoundary(); | |||
// Create the form content. Add Line breaks to the end of data. | |||
for (var i = 0, len = this._streams.length; i < len; i++) { | |||
if (typeof this._streams[i] !== 'function') { | |||
// Add content to the buffer. | |||
if(Buffer.isBuffer(this._streams[i])) { | |||
dataBuffer = Buffer.concat( [dataBuffer, this._streams[i]]); | |||
}else { | |||
dataBuffer = Buffer.concat( [dataBuffer, Buffer.from(this._streams[i])]); | |||
} | |||
// Add break after content. | |||
if (typeof this._streams[i] !== 'string' || this._streams[i].substring( 2, boundary.length + 2 ) !== boundary) { | |||
dataBuffer = Buffer.concat( [dataBuffer, Buffer.from(FormData.LINE_BREAK)] ); | |||
} | |||
} | |||
} | |||
// Add the footer and return the Buffer object. | |||
return Buffer.concat( [dataBuffer, Buffer.from(this._lastBoundary())] ); | |||
}; | |||
FormData.prototype._generateBoundary = function() { | |||
// This generates a 50 character boundary similar to those used by Firefox. | |||
// They are optimized for boyer-moore parsing. | |||
var boundary = '--------------------------'; | |||
for (var i = 0; i < 24; i++) { | |||
boundary += Math.floor(Math.random() * 10).toString(16); | |||
} | |||
this._boundary = boundary; | |||
}; | |||
// Note: getLengthSync DOESN'T calculate streams length | |||
// As workaround one can calculate file size manually | |||
// and add it as knownLength option | |||
FormData.prototype.getLengthSync = function() { | |||
var knownLength = this._overheadLength + this._valueLength; | |||
// Don't get confused, there are 3 "internal" streams for each keyval pair | |||
// so it basically checks if there is any value added to the form | |||
if (this._streams.length) { | |||
knownLength += this._lastBoundary().length; | |||
} | |||
// https://github.com/form-data/form-data/issues/40 | |||
if (!this.hasKnownLength()) { | |||
// Some async length retrievers are present | |||
// therefore synchronous length calculation is false. | |||
// Please use getLength(callback) to get proper length | |||
this._error(new Error('Cannot calculate proper length in synchronous way.')); | |||
} | |||
return knownLength; | |||
}; | |||
// Public API to check if length of added values is known | |||
// https://github.com/form-data/form-data/issues/196 | |||
// https://github.com/form-data/form-data/issues/262 | |||
FormData.prototype.hasKnownLength = function() { | |||
var hasKnownLength = true; | |||
if (this._valuesToMeasure.length) { | |||
hasKnownLength = false; | |||
} | |||
return hasKnownLength; | |||
}; | |||
FormData.prototype.getLength = function(cb) { | |||
var knownLength = this._overheadLength + this._valueLength; | |||
if (this._streams.length) { | |||
knownLength += this._lastBoundary().length; | |||
} | |||
if (!this._valuesToMeasure.length) { | |||
process.nextTick(cb.bind(this, null, knownLength)); | |||
return; | |||
} | |||
asynckit.parallel(this._valuesToMeasure, this._lengthRetriever, function(err, values) { | |||
if (err) { | |||
cb(err); | |||
return; | |||
} | |||
values.forEach(function(length) { | |||
knownLength += length; | |||
}); | |||
cb(null, knownLength); | |||
}); | |||
}; | |||
FormData.prototype.submit = function(params, cb) { | |||
var request | |||
, options | |||
, defaults = {method: 'post'} | |||
; | |||
// parse provided url if it's string | |||
// or treat it as options object | |||
if (typeof params == 'string') { | |||
params = parseUrl(params); | |||
options = populate({ | |||
port: params.port, | |||
path: params.pathname, | |||
host: params.hostname, | |||
protocol: params.protocol | |||
}, defaults); | |||
// use custom params | |||
} else { | |||
options = populate(params, defaults); | |||
// if no port provided use default one | |||
if (!options.port) { | |||
options.port = options.protocol == 'https:' ? 443 : 80; | |||
} | |||
} | |||
// put that good code in getHeaders to some use | |||
options.headers = this.getHeaders(params.headers); | |||
// https if specified, fallback to http in any other case | |||
if (options.protocol == 'https:') { | |||
request = https.request(options); | |||
} else { | |||
request = http.request(options); | |||
} | |||
// get content length and fire away | |||
this.getLength(function(err, length) { | |||
if (err && err !== 'Unknown stream') { | |||
this._error(err); | |||
return; | |||
} | |||
// add content length | |||
if (length) { | |||
request.setHeader('Content-Length', length); | |||
} | |||
this.pipe(request); | |||
if (cb) { | |||
var onResponse; | |||
var callback = function (error, responce) { | |||
request.removeListener('error', callback); | |||
request.removeListener('response', onResponse); | |||
return cb.call(this, error, responce); | |||
}; | |||
onResponse = callback.bind(this, null); | |||
request.on('error', callback); | |||
request.on('response', onResponse); | |||
} | |||
}.bind(this)); | |||
return request; | |||
}; | |||
FormData.prototype._error = function(err) { | |||
if (!this.error) { | |||
this.error = err; | |||
this.pause(); | |||
this.emit('error', err); | |||
} | |||
}; | |||
FormData.prototype.toString = function () { | |||
return '[object FormData]'; | |||
}; |
@@ -0,0 +1,10 @@ | |||
// populates missing values | |||
module.exports = function(dst, src) { | |||
Object.keys(src).forEach(function(prop) | |||
{ | |||
dst[prop] = dst[prop] || src[prop]; | |||
}); | |||
return dst; | |||
}; |
@@ -0,0 +1,98 @@ | |||
{ | |||
"_from": "@discordjs/form-data@^3.0.1", | |||
"_id": "@discordjs/form-data@3.0.1", | |||
"_inBundle": false, | |||
"_integrity": "sha512-ZfFsbgEXW71Rw/6EtBdrP5VxBJy4dthyC0tpQKGKmYFImlmmrykO14Za+BiIVduwjte0jXEBlhSKf0MWbFp9Eg==", | |||
"_location": "/@discordjs/form-data", | |||
"_phantomChildren": {}, | |||
"_requested": { | |||
"type": "range", | |||
"registry": true, | |||
"raw": "@discordjs/form-data@^3.0.1", | |||
"name": "@discordjs/form-data", | |||
"escapedName": "@discordjs%2fform-data", | |||
"scope": "@discordjs", | |||
"rawSpec": "^3.0.1", | |||
"saveSpec": null, | |||
"fetchSpec": "^3.0.1" | |||
}, | |||
"_requiredBy": [ | |||
"/discord.js" | |||
], | |||
"_resolved": "https://registry.npmjs.org/@discordjs/form-data/-/form-data-3.0.1.tgz", | |||
"_shasum": "5c9e6be992e2e57d0dfa0e39979a850225fb4697", | |||
"_spec": "@discordjs/form-data@^3.0.1", | |||
"_where": "/home/cziermann/git/papoh/node_modules/discord.js", | |||
"author": { | |||
"name": "Felix Geisendörfer", | |||
"email": "felix@debuggable.com", | |||
"url": "http://debuggable.com/" | |||
}, | |||
"browser": "./lib/browser", | |||
"bugs": { | |||
"url": "https://github.com/form-data/form-data/issues" | |||
}, | |||
"bundleDependencies": false, | |||
"dependencies": { | |||
"asynckit": "^0.4.0", | |||
"combined-stream": "^1.0.8", | |||
"mime-types": "^2.1.12" | |||
}, | |||
"deprecated": false, | |||
"description": "A library to create readable \"multipart/form-data\" streams. Can be used to submit forms and file uploads to other web applications.", | |||
"devDependencies": { | |||
"@types/node": "^12.0.10", | |||
"browserify": "^13.1.1", | |||
"browserify-istanbul": "^2.0.0", | |||
"coveralls": "^3.0.4", | |||
"cross-spawn": "^6.0.5", | |||
"eslint": "^6.0.1", | |||
"fake": "^0.2.2", | |||
"far": "^0.0.7", | |||
"formidable": "^1.0.17", | |||
"in-publish": "^2.0.0", | |||
"is-node-modern": "^1.0.0", | |||
"istanbul": "^0.4.5", | |||
"obake": "^0.1.2", | |||
"pkgfiles": "^2.3.0", | |||
"pre-commit": "^1.1.3", | |||
"puppeteer": "^1.19.0", | |||
"request": "^2.88.0", | |||
"rimraf": "^2.7.1", | |||
"tape": "^4.6.2", | |||
"typescript": "^3.5.2" | |||
}, | |||
"engines": { | |||
"node": ">= 6" | |||
}, | |||
"homepage": "https://github.com/form-data/form-data#readme", | |||
"license": "MIT", | |||
"main": "./lib/form_data", | |||
"name": "@discordjs/form-data", | |||
"pre-commit": [ | |||
"lint", | |||
"ci-test", | |||
"check" | |||
], | |||
"repository": { | |||
"type": "git", | |||
"url": "git://github.com/form-data/form-data.git" | |||
}, | |||
"scripts": { | |||
"browser": "browserify -t browserify-istanbul test/run-browser.js | obake --coverage", | |||
"check": "istanbul check-coverage coverage/coverage*.json", | |||
"ci-lint": "is-node-modern 8 && npm run lint || is-node-not-modern 8", | |||
"ci-test": "npm run test && npm run browser && npm run report", | |||
"debug": "verbose=1 ./test/run.js", | |||
"files": "pkgfiles --sort=name", | |||
"get-version": "node -e \"console.log(require('./package.json').version)\"", | |||
"lint": "eslint lib/*.js test/*.js test/integration/*.js", | |||
"posttest": "istanbul report lcov text", | |||
"predebug": "rimraf coverage test/tmp", | |||
"pretest": "rimraf coverage test/tmp", | |||
"report": "istanbul report lcov text", | |||
"test": "istanbul cover test/run.js" | |||
}, | |||
"typings": "./index.d.ts", | |||
"version": "3.0.1" | |||
} |
@@ -0,0 +1,132 @@ | |||
/// <reference types="node" /> | |||
/// <reference lib="es2016" /> | |||
/// <reference lib="es2017.sharedmemory" /> | |||
/// <reference lib="esnext.asynciterable" /> | |||
/// <reference lib="dom" /> | |||
declare type TypedArray = Int8Array | Uint8Array | Uint8ClampedArray | Int16Array | Uint16Array | Int32Array | Uint32Array | Float32Array | Float64Array; | |||
declare type Primitive = null | undefined | string | number | boolean | Symbol; | |||
export interface ArrayLike { | |||
length: number; | |||
} | |||
export interface Class<T = unknown> { | |||
new (...args: any[]): T; | |||
} | |||
declare type DomElement = object & { | |||
nodeType: 1; | |||
nodeName: string; | |||
}; | |||
declare type NodeStream = object & { | |||
pipe: Function; | |||
}; | |||
export declare const enum TypeName { | |||
null = "null", | |||
boolean = "boolean", | |||
undefined = "undefined", | |||
string = "string", | |||
number = "number", | |||
symbol = "symbol", | |||
Function = "Function", | |||
GeneratorFunction = "GeneratorFunction", | |||
AsyncFunction = "AsyncFunction", | |||
Observable = "Observable", | |||
Array = "Array", | |||
Buffer = "Buffer", | |||
Object = "Object", | |||
RegExp = "RegExp", | |||
Date = "Date", | |||
Error = "Error", | |||
Map = "Map", | |||
Set = "Set", | |||
WeakMap = "WeakMap", | |||
WeakSet = "WeakSet", | |||
Int8Array = "Int8Array", | |||
Uint8Array = "Uint8Array", | |||
Uint8ClampedArray = "Uint8ClampedArray", | |||
Int16Array = "Int16Array", | |||
Uint16Array = "Uint16Array", | |||
Int32Array = "Int32Array", | |||
Uint32Array = "Uint32Array", | |||
Float32Array = "Float32Array", | |||
Float64Array = "Float64Array", | |||
ArrayBuffer = "ArrayBuffer", | |||
SharedArrayBuffer = "SharedArrayBuffer", | |||
DataView = "DataView", | |||
Promise = "Promise", | |||
URL = "URL" | |||
} | |||
declare function is(value: unknown): TypeName; | |||
declare namespace is { | |||
const undefined: (value: unknown) => value is undefined; | |||
const string: (value: unknown) => value is string; | |||
const number: (value: unknown) => value is number; | |||
const function_: (value: unknown) => value is Function; | |||
const null_: (value: unknown) => value is null; | |||
const class_: (value: unknown) => value is Class<unknown>; | |||
const boolean: (value: unknown) => value is boolean; | |||
const symbol: (value: unknown) => value is Symbol; | |||
const numericString: (value: unknown) => boolean; | |||
const array: (arg: any) => arg is any[]; | |||
const buffer: (input: unknown) => input is Buffer; | |||
const nullOrUndefined: (value: unknown) => value is null | undefined; | |||
const object: (value: unknown) => value is object; | |||
const iterable: (value: unknown) => value is IterableIterator<unknown>; | |||
const asyncIterable: (value: unknown) => value is AsyncIterableIterator<unknown>; | |||
const generator: (value: unknown) => value is Generator; | |||
const nativePromise: (value: unknown) => value is Promise<unknown>; | |||
const promise: (value: unknown) => value is Promise<unknown>; | |||
const generatorFunction: (value: unknown) => value is GeneratorFunction; | |||
const asyncFunction: (value: unknown) => value is Function; | |||
const boundFunction: (value: unknown) => value is Function; | |||
const regExp: (value: unknown) => value is RegExp; | |||
const date: (value: unknown) => value is Date; | |||
const error: (value: unknown) => value is Error; | |||
const map: (value: unknown) => value is Map<unknown, unknown>; | |||
const set: (value: unknown) => value is Set<unknown>; | |||
const weakMap: (value: unknown) => value is WeakMap<object, unknown>; | |||
const weakSet: (value: unknown) => value is WeakSet<object>; | |||
const int8Array: (value: unknown) => value is Int8Array; | |||
const uint8Array: (value: unknown) => value is Uint8Array; | |||
const uint8ClampedArray: (value: unknown) => value is Uint8ClampedArray; | |||
const int16Array: (value: unknown) => value is Int16Array; | |||
const uint16Array: (value: unknown) => value is Uint16Array; | |||
const int32Array: (value: unknown) => value is Int32Array; | |||
const uint32Array: (value: unknown) => value is Uint32Array; | |||
const float32Array: (value: unknown) => value is Float32Array; | |||
const float64Array: (value: unknown) => value is Float64Array; | |||
const arrayBuffer: (value: unknown) => value is ArrayBuffer; | |||
const sharedArrayBuffer: (value: unknown) => value is SharedArrayBuffer; | |||
const dataView: (value: unknown) => value is DataView; | |||
const directInstanceOf: <T>(instance: unknown, klass: Class<T>) => instance is T; | |||
const urlInstance: (value: unknown) => value is URL; | |||
const urlString: (value: unknown) => boolean; | |||
const truthy: (value: unknown) => boolean; | |||
const falsy: (value: unknown) => boolean; | |||
const nan: (value: unknown) => boolean; | |||
const primitive: (value: unknown) => value is Primitive; | |||
const integer: (value: unknown) => value is number; | |||
const safeInteger: (value: unknown) => value is number; | |||
const plainObject: (value: unknown) => boolean; | |||
const typedArray: (value: unknown) => value is TypedArray; | |||
const arrayLike: (value: unknown) => value is ArrayLike; | |||
const inRange: (value: number, range: number | number[]) => boolean; | |||
const domElement: (value: unknown) => value is DomElement; | |||
const observable: (value: unknown) => boolean; | |||
const nodeStream: (value: unknown) => value is NodeStream; | |||
const infinite: (value: unknown) => boolean; | |||
const even: (value: number) => boolean; | |||
const odd: (value: number) => boolean; | |||
const emptyArray: (value: unknown) => boolean; | |||
const nonEmptyArray: (value: unknown) => boolean; | |||
const emptyString: (value: unknown) => boolean; | |||
const nonEmptyString: (value: unknown) => boolean; | |||
const emptyStringOrWhitespace: (value: unknown) => boolean; | |||
const emptyObject: (value: unknown) => boolean; | |||
const nonEmptyObject: (value: unknown) => boolean; | |||
const emptySet: (value: unknown) => boolean; | |||
const nonEmptySet: (value: unknown) => boolean; | |||
const emptyMap: (value: unknown) => boolean; | |||
const nonEmptyMap: (value: unknown) => boolean; | |||
const any: (predicate: unknown, ...values: unknown[]) => boolean; | |||
const all: (predicate: unknown, ...values: unknown[]) => boolean; | |||
} | |||
export default is; |
@@ -0,0 +1,245 @@ | |||
"use strict"; | |||
/// <reference lib="es2016"/> | |||
/// <reference lib="es2017.sharedmemory"/> | |||
/// <reference lib="esnext.asynciterable"/> | |||
/// <reference lib="dom"/> | |||
Object.defineProperty(exports, "__esModule", { value: true }); | |||
// TODO: Use the `URL` global when targeting Node.js 10 | |||
// tslint:disable-next-line | |||
const URLGlobal = typeof URL === 'undefined' ? require('url').URL : URL; | |||
const toString = Object.prototype.toString; | |||
const isOfType = (type) => (value) => typeof value === type; | |||
const isBuffer = (input) => !is.nullOrUndefined(input) && !is.nullOrUndefined(input.constructor) && is.function_(input.constructor.isBuffer) && input.constructor.isBuffer(input); | |||
const getObjectType = (value) => { | |||
const objectName = toString.call(value).slice(8, -1); | |||
if (objectName) { | |||
return objectName; | |||
} | |||
return null; | |||
}; | |||
const isObjectOfType = (type) => (value) => getObjectType(value) === type; | |||
function is(value) { | |||
switch (value) { | |||
case null: | |||
return "null" /* null */; | |||
case true: | |||
case false: | |||
return "boolean" /* boolean */; | |||
default: | |||
} | |||
switch (typeof value) { | |||
case 'undefined': | |||
return "undefined" /* undefined */; | |||
case 'string': | |||
return "string" /* string */; | |||
case 'number': | |||
return "number" /* number */; | |||
case 'symbol': | |||
return "symbol" /* symbol */; | |||
default: | |||
} | |||
if (is.function_(value)) { | |||
return "Function" /* Function */; | |||
} | |||
if (is.observable(value)) { | |||
return "Observable" /* Observable */; | |||
} | |||
if (Array.isArray(value)) { | |||
return "Array" /* Array */; | |||
} | |||
if (isBuffer(value)) { | |||
return "Buffer" /* Buffer */; | |||
} | |||
const tagType = getObjectType(value); | |||
if (tagType) { | |||
return tagType; | |||
} | |||
if (value instanceof String || value instanceof Boolean || value instanceof Number) { | |||
throw new TypeError('Please don\'t use object wrappers for primitive types'); | |||
} | |||
return "Object" /* Object */; | |||
} | |||
(function (is) { | |||
// tslint:disable-next-line:strict-type-predicates | |||
const isObject = (value) => typeof value === 'object'; | |||
// tslint:disable:variable-name | |||
is.undefined = isOfType('undefined'); | |||
is.string = isOfType('string'); | |||
is.number = isOfType('number'); | |||
is.function_ = isOfType('function'); | |||
// tslint:disable-next-line:strict-type-predicates | |||
is.null_ = (value) => value === null; | |||
is.class_ = (value) => is.function_(value) && value.toString().startsWith('class '); | |||
is.boolean = (value) => value === true || value === false; | |||
is.symbol = isOfType('symbol'); | |||
// tslint:enable:variable-name | |||
is.numericString = (value) => is.string(value) && value.length > 0 && !Number.isNaN(Number(value)); | |||
is.array = Array.isArray; | |||
is.buffer = isBuffer; | |||
is.nullOrUndefined = (value) => is.null_(value) || is.undefined(value); | |||
is.object = (value) => !is.nullOrUndefined(value) && (is.function_(value) || isObject(value)); | |||
is.iterable = (value) => !is.nullOrUndefined(value) && is.function_(value[Symbol.iterator]); | |||
is.asyncIterable = (value) => !is.nullOrUndefined(value) && is.function_(value[Symbol.asyncIterator]); | |||
is.generator = (value) => is.iterable(value) && is.function_(value.next) && is.function_(value.throw); | |||
is.nativePromise = (value) => isObjectOfType("Promise" /* Promise */)(value); | |||
const hasPromiseAPI = (value) => !is.null_(value) && | |||
isObject(value) && | |||
is.function_(value.then) && | |||
is.function_(value.catch); | |||
is.promise = (value) => is.nativePromise(value) || hasPromiseAPI(value); | |||
is.generatorFunction = isObjectOfType("GeneratorFunction" /* GeneratorFunction */); | |||
is.asyncFunction = isObjectOfType("AsyncFunction" /* AsyncFunction */); | |||
is.boundFunction = (value) => is.function_(value) && !value.hasOwnProperty('prototype'); | |||
is.regExp = isObjectOfType("RegExp" /* RegExp */); | |||
is.date = isObjectOfType("Date" /* Date */); | |||
is.error = isObjectOfType("Error" /* Error */); | |||
is.map = (value) => isObjectOfType("Map" /* Map */)(value); | |||
is.set = (value) => isObjectOfType("Set" /* Set */)(value); | |||
is.weakMap = (value) => isObjectOfType("WeakMap" /* WeakMap */)(value); | |||
is.weakSet = (value) => isObjectOfType("WeakSet" /* WeakSet */)(value); | |||
is.int8Array = isObjectOfType("Int8Array" /* Int8Array */); | |||
is.uint8Array = isObjectOfType("Uint8Array" /* Uint8Array */); | |||
is.uint8ClampedArray = isObjectOfType("Uint8ClampedArray" /* Uint8ClampedArray */); | |||
is.int16Array = isObjectOfType("Int16Array" /* Int16Array */); | |||
is.uint16Array = isObjectOfType("Uint16Array" /* Uint16Array */); | |||
is.int32Array = isObjectOfType("Int32Array" /* Int32Array */); | |||
is.uint32Array = isObjectOfType("Uint32Array" /* Uint32Array */); | |||
is.float32Array = isObjectOfType("Float32Array" /* Float32Array */); | |||
is.float64Array = isObjectOfType("Float64Array" /* Float64Array */); | |||
is.arrayBuffer = isObjectOfType("ArrayBuffer" /* ArrayBuffer */); | |||
is.sharedArrayBuffer = isObjectOfType("SharedArrayBuffer" /* SharedArrayBuffer */); | |||
is.dataView = isObjectOfType("DataView" /* DataView */); | |||
is.directInstanceOf = (instance, klass) => Object.getPrototypeOf(instance) === klass.prototype; | |||
is.urlInstance = (value) => isObjectOfType("URL" /* URL */)(value); | |||
is.urlString = (value) => { | |||
if (!is.string(value)) { | |||
return false; | |||
} | |||
try { | |||
new URLGlobal(value); // tslint:disable-line no-unused-expression | |||
return true; | |||
} | |||
catch (_a) { | |||
return false; | |||
} | |||
}; | |||
is.truthy = (value) => Boolean(value); | |||
is.falsy = (value) => !value; | |||
is.nan = (value) => Number.isNaN(value); | |||
const primitiveTypes = new Set([ | |||
'undefined', | |||
'string', | |||
'number', | |||
'boolean', | |||
'symbol' | |||
]); | |||
is.primitive = (value) => is.null_(value) || primitiveTypes.has(typeof value); | |||
is.integer = (value) => Number.isInteger(value); | |||
is.safeInteger = (value) => Number.isSafeInteger(value); | |||
is.plainObject = (value) => { | |||
// From: https://github.com/sindresorhus/is-plain-obj/blob/master/index.js | |||
let prototype; | |||
return getObjectType(value) === "Object" /* Object */ && | |||
(prototype = Object.getPrototypeOf(value), prototype === null || // tslint:disable-line:ban-comma-operator | |||
prototype === Object.getPrototypeOf({})); | |||
}; | |||
const typedArrayTypes = new Set([ | |||
"Int8Array" /* Int8Array */, | |||
"Uint8Array" /* Uint8Array */, | |||
"Uint8ClampedArray" /* Uint8ClampedArray */, | |||
"Int16Array" /* Int16Array */, | |||
"Uint16Array" /* Uint16Array */, | |||
"Int32Array" /* Int32Array */, | |||
"Uint32Array" /* Uint32Array */, | |||
"Float32Array" /* Float32Array */, | |||
"Float64Array" /* Float64Array */ | |||
]); | |||
is.typedArray = (value) => { | |||
const objectType = getObjectType(value); | |||
if (objectType === null) { | |||
return false; | |||
} | |||
return typedArrayTypes.has(objectType); | |||
}; | |||
const isValidLength = (value) => is.safeInteger(value) && value > -1; | |||
is.arrayLike = (value) => !is.nullOrUndefined(value) && !is.function_(value) && isValidLength(value.length); | |||
is.inRange = (value, range) => { | |||
if (is.number(range)) { | |||
return value >= Math.min(0, range) && value <= Math.max(range, 0); | |||
} | |||
if (is.array(range) && range.length === 2) { | |||
return value >= Math.min(...range) && value <= Math.max(...range); | |||
} | |||
throw new TypeError(`Invalid range: ${JSON.stringify(range)}`); | |||
}; | |||
const NODE_TYPE_ELEMENT = 1; | |||
const DOM_PROPERTIES_TO_CHECK = [ | |||
'innerHTML', | |||
'ownerDocument', | |||
'style', | |||
'attributes', | |||
'nodeValue' | |||
]; | |||
is.domElement = (value) => is.object(value) && value.nodeType === NODE_TYPE_ELEMENT && is.string(value.nodeName) && | |||
!is.plainObject(value) && DOM_PROPERTIES_TO_CHECK.every(property => property in value); | |||
is.observable = (value) => { | |||
if (!value) { | |||
return false; | |||
} | |||
if (value[Symbol.observable] && value === value[Symbol.observable]()) { | |||
return true; | |||
} | |||
if (value['@@observable'] && value === value['@@observable']()) { | |||
return true; | |||
} | |||
return false; | |||
}; | |||
is.nodeStream = (value) => !is.nullOrUndefined(value) && isObject(value) && is.function_(value.pipe) && !is.observable(value); | |||
is.infinite = (value) => value === Infinity || value === -Infinity; | |||
const isAbsoluteMod2 = (rem) => (value) => is.integer(value) && Math.abs(value % 2) === rem; | |||
is.even = isAbsoluteMod2(0); | |||
is.odd = isAbsoluteMod2(1); | |||
const isWhiteSpaceString = (value) => is.string(value) && /\S/.test(value) === false; | |||
is.emptyArray = (value) => is.array(value) && value.length === 0; | |||
is.nonEmptyArray = (value) => is.array(value) && value.length > 0; | |||
is.emptyString = (value) => is.string(value) && value.length === 0; | |||
is.nonEmptyString = (value) => is.string(value) && value.length > 0; | |||
is.emptyStringOrWhitespace = (value) => is.emptyString(value) || isWhiteSpaceString(value); | |||
is.emptyObject = (value) => is.object(value) && !is.map(value) && !is.set(value) && Object.keys(value).length === 0; | |||
is.nonEmptyObject = (value) => is.object(value) && !is.map(value) && !is.set(value) && Object.keys(value).length > 0; | |||
is.emptySet = (value) => is.set(value) && value.size === 0; | |||
is.nonEmptySet = (value) => is.set(value) && value.size > 0; | |||
is.emptyMap = (value) => is.map(value) && value.size === 0; | |||
is.nonEmptyMap = (value) => is.map(value) && value.size > 0; | |||
const predicateOnArray = (method, predicate, values) => { | |||
if (is.function_(predicate) === false) { | |||
throw new TypeError(`Invalid predicate: ${JSON.stringify(predicate)}`); | |||
} | |||
if (values.length === 0) { | |||
throw new TypeError('Invalid number of values'); | |||
} | |||
return method.call(values, predicate); | |||
}; | |||
// tslint:disable variable-name | |||
is.any = (predicate, ...values) => predicateOnArray(Array.prototype.some, predicate, values); | |||
is.all = (predicate, ...values) => predicateOnArray(Array.prototype.every, predicate, values); | |||
// tslint:enable variable-name | |||
})(is || (is = {})); | |||
// Some few keywords are reserved, but we'll populate them for Node.js users | |||
// See https://github.com/Microsoft/TypeScript/issues/2536 | |||
Object.defineProperties(is, { | |||
class: { | |||
value: is.class_ | |||
}, | |||
function: { | |||
value: is.function_ | |||
}, | |||
null: { | |||
value: is.null_ | |||
} | |||
}); | |||
exports.default = is; | |||
// For CommonJS default export support | |||
module.exports = is; | |||
module.exports.default = is; | |||
//# sourceMappingURL=index.js.map |
@@ -0,0 +1,9 @@ | |||
MIT License | |||
Copyright (c) Sindre Sorhus <sindresorhus@gmail.com> (sindresorhus.com) | |||
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: | |||
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. | |||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
@@ -0,0 +1,96 @@ | |||
{ | |||
"_from": "@sindresorhus/is@^0.14.0", | |||
"_id": "@sindresorhus/is@0.14.0", | |||
"_inBundle": false, | |||
"_integrity": "sha512-9NET910DNaIPngYnLLPeg+Ogzqsi9uM4mSboU5y6p8S5DzMTVEsJZrawi+BoDNUVBa2DhJqQYUFvMDfgU062LQ==", | |||
"_location": "/@sindresorhus/is", | |||
"_phantomChildren": {}, | |||
"_requested": { | |||
"type": "range", | |||
"registry": true, | |||
"raw": "@sindresorhus/is@^0.14.0", | |||
"name": "@sindresorhus/is", | |||
"escapedName": "@sindresorhus%2fis", | |||
"scope": "@sindresorhus", | |||
"rawSpec": "^0.14.0", | |||
"saveSpec": null, | |||
"fetchSpec": "^0.14.0" | |||
}, | |||
"_requiredBy": [ | |||
"/got" | |||
], | |||
"_resolved": "https://registry.npmjs.org/@sindresorhus/is/-/is-0.14.0.tgz", | |||
"_shasum": "9fb3a3cf3132328151f353de4632e01e52102bea", | |||
"_spec": "@sindresorhus/is@^0.14.0", | |||
"_where": "/home/cziermann/git/papoh/node_modules/got", | |||
"author": { | |||
"name": "Sindre Sorhus", | |||
"email": "sindresorhus@gmail.com", | |||
"url": "sindresorhus.com" | |||
}, | |||
"bugs": { | |||
"url": "https://github.com/sindresorhus/is/issues" | |||
}, | |||
"bundleDependencies": false, | |||
"deprecated": false, | |||
"description": "Type check values: `is.string('🦄') //=> true`", | |||
"devDependencies": { | |||
"@sindresorhus/tsconfig": "^0.1.0", | |||
"@types/jsdom": "^11.12.0", | |||
"@types/node": "^10.12.10", | |||
"@types/tempy": "^0.2.0", | |||
"@types/zen-observable": "^0.8.0", | |||
"ava": "^0.25.0", | |||
"del-cli": "^1.1.0", | |||
"jsdom": "^11.6.2", | |||
"rxjs": "^6.3.3", | |||
"tempy": "^0.2.1", | |||
"tslint": "^5.9.1", | |||
"tslint-xo": "^0.10.0", | |||
"typescript": "^3.2.1", | |||
"zen-observable": "^0.8.8" | |||
}, | |||
"engines": { | |||
"node": ">=6" | |||
}, | |||
"files": [ | |||
"dist" | |||
], | |||
"homepage": "https://github.com/sindresorhus/is#readme", | |||
"keywords": [ | |||
"type", | |||
"types", | |||
"is", | |||
"check", | |||
"checking", | |||
"validate", | |||
"validation", | |||
"utility", | |||
"util", | |||
"typeof", | |||
"instanceof", | |||
"object", | |||
"assert", | |||
"assertion", | |||
"test", | |||
"kind", | |||
"primitive", | |||
"verify", | |||
"compare" | |||
], | |||
"license": "MIT", | |||
"main": "dist/index.js", | |||
"name": "@sindresorhus/is", | |||
"repository": { | |||
"type": "git", | |||
"url": "git+https://github.com/sindresorhus/is.git" | |||
}, | |||
"scripts": { | |||
"build": "del dist && tsc", | |||
"lint": "tslint --format stylish --project .", | |||
"prepublish": "npm run build && del dist/tests", | |||
"test": "npm run lint && npm run build && ava dist/tests" | |||
}, | |||
"types": "dist/index.d.ts", | |||
"version": "0.14.0" | |||
} |
@@ -0,0 +1,451 @@ | |||
# is [](https://travis-ci.org/sindresorhus/is) | |||
> Type check values: `is.string('🦄') //=> true` | |||
<img src="header.gif" width="182" align="right"> | |||
## Install | |||
``` | |||
$ npm install @sindresorhus/is | |||
``` | |||
## Usage | |||
```js | |||
const is = require('@sindresorhus/is'); | |||
is('🦄'); | |||
//=> 'string' | |||
is(new Map()); | |||
//=> 'Map' | |||
is.number(6); | |||
//=> true | |||
``` | |||
When using `is` together with TypeScript, [type guards](http://www.typescriptlang.org/docs/handbook/advanced-types.html#type-guards-and-differentiating-types) are being used to infer the correct type inside if-else statements. | |||
```ts | |||
import is from '@sindresorhus/is'; | |||
const padLeft = (value: string, padding: string | number) => { | |||
if (is.number(padding)) { | |||
// `padding` is typed as `number` | |||
return Array(padding + 1).join(' ') + value; | |||
} | |||
if (is.string(padding)) { | |||
// `padding` is typed as `string` | |||
return padding + value; | |||
} | |||
throw new TypeError(`Expected 'padding' to be of type 'string' or 'number', got '${is(padding)}'.`); | |||
} | |||
padLeft('🦄', 3); | |||
//=> ' 🦄' | |||
padLeft('🦄', '🌈'); | |||
//=> '🌈🦄' | |||
``` | |||
## API | |||
### is(value) | |||
Returns the type of `value`. | |||
Primitives are lowercase and object types are camelcase. | |||
Example: | |||
- `'undefined'` | |||
- `'null'` | |||
- `'string'` | |||
- `'symbol'` | |||
- `'Array'` | |||
- `'Function'` | |||
- `'Object'` | |||
Note: It will throw an error if you try to feed it object-wrapped primitives, as that's a bad practice. For example `new String('foo')`. | |||
### is.{method} | |||
All the below methods accept a value and returns a boolean for whether the value is of the desired type. | |||
#### Primitives | |||
##### .undefined(value) | |||
##### .null(value) | |||
##### .string(value) | |||
##### .number(value) | |||
##### .boolean(value) | |||
##### .symbol(value) | |||
#### Built-in types | |||
##### .array(value) | |||
##### .function(value) | |||
##### .buffer(value) | |||
##### .object(value) | |||
Keep in mind that [functions are objects too](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Functions). | |||
##### .numericString(value) | |||
Returns `true` for a string that represents a number. For example, `'42'` and `'-8'`. | |||
Note: `'NaN'` returns `false`, but `'Infinity'` and `'-Infinity'` return `true`. | |||
##### .regExp(value) | |||
##### .date(value) | |||
##### .error(value) | |||
##### .nativePromise(value) | |||
##### .promise(value) | |||
Returns `true` for any object with a `.then()` and `.catch()` method. Prefer this one over `.nativePromise()` as you usually want to allow userland promise implementations too. | |||
##### .generator(value) | |||
Returns `true` for any object that implements its own `.next()` and `.throw()` methods and has a function definition for `Symbol.iterator`. | |||
##### .generatorFunction(value) | |||
##### .asyncFunction(value) | |||
Returns `true` for any `async` function that can be called with the `await` operator. | |||
```js | |||
is.asyncFunction(async () => {}); | |||
// => true | |||
is.asyncFunction(() => {}); | |||
// => false | |||
``` | |||
##### .boundFunction(value) | |||
Returns `true` for any `bound` function. | |||
```js | |||
is.boundFunction(() => {}); | |||
// => true | |||
is.boundFunction(function () {}.bind(null)); | |||
// => true | |||
is.boundFunction(function () {}); | |||
// => false | |||
``` | |||
##### .map(value) | |||
##### .set(value) | |||
##### .weakMap(value) | |||
##### .weakSet(value) | |||
#### Typed arrays | |||
##### .int8Array(value) | |||
##### .uint8Array(value) | |||
##### .uint8ClampedArray(value) | |||
##### .int16Array(value) | |||
##### .uint16Array(value) | |||
##### .int32Array(value) | |||
##### .uint32Array(value) | |||
##### .float32Array(value) | |||
##### .float64Array(value) | |||
#### Structured data | |||
##### .arrayBuffer(value) | |||
##### .sharedArrayBuffer(value) | |||
##### .dataView(value) | |||
#### Emptiness | |||
##### .emptyString(value) | |||
Returns `true` if the value is a `string` and the `.length` is 0. | |||
##### .nonEmptyString(value) | |||
Returns `true` if the value is a `string` and the `.length` is more than 0. | |||
##### .emptyStringOrWhitespace(value) | |||
Returns `true` if `is.emptyString(value)` or if it's a `string` that is all whitespace. | |||
##### .emptyArray(value) | |||
Returns `true` if the value is an `Array` and the `.length` is 0. | |||
##### .nonEmptyArray(value) | |||
Returns `true` if the value is an `Array` and the `.length` is more than 0. | |||
##### .emptyObject(value) | |||
Returns `true` if the value is an `Object` and `Object.keys(value).length` is 0. | |||
Please note that `Object.keys` returns only own enumerable properties. Hence something like this can happen: | |||
```js | |||
const object1 = {}; | |||
Object.defineProperty(object1, 'property1', { | |||
value: 42, | |||
writable: true, | |||
enumerable: false, | |||
configurable: true | |||
}); | |||
is.emptyObject(object1); | |||
// => true | |||
``` | |||
##### .nonEmptyObject(value) | |||
Returns `true` if the value is an `Object` and `Object.keys(value).length` is more than 0. | |||
##### .emptySet(value) | |||
Returns `true` if the value is a `Set` and the `.size` is 0. | |||
##### .nonEmptySet(Value) | |||
Returns `true` if the value is a `Set` and the `.size` is more than 0. | |||
##### .emptyMap(value) | |||
Returns `true` if the value is a `Map` and the `.size` is 0. | |||
##### .nonEmptyMap(value) | |||
Returns `true` if the value is a `Map` and the `.size` is more than 0. | |||
#### Miscellaneous | |||
##### .directInstanceOf(value, class) | |||
Returns `true` if `value` is a direct instance of `class`. | |||
```js | |||
is.directInstanceOf(new Error(), Error); | |||
//=> true | |||
class UnicornError extends Error {} | |||
is.directInstanceOf(new UnicornError(), Error); | |||
//=> false | |||
``` | |||
##### .urlInstance(value) | |||
Returns `true` if `value` is an instance of the [`URL` class](https://developer.mozilla.org/en-US/docs/Web/API/URL). | |||
```js | |||
const url = new URL('https://example.com'); | |||
is.urlInstance(url); | |||
//=> true | |||
``` | |||
### .url(value) | |||
Returns `true` if `value` is a URL string. | |||
Note: this only does basic checking using the [`URL` class](https://developer.mozilla.org/en-US/docs/Web/API/URL) constructor. | |||
```js | |||
const url = 'https://example.com'; | |||
is.url(url); | |||
//=> true | |||
is.url(new URL(url)); | |||
//=> false | |||
``` | |||
##### .truthy(value) | |||
Returns `true` for all values that evaluate to true in a boolean context: | |||
```js | |||
is.truthy('🦄'); | |||
//=> true | |||
is.truthy(undefined); | |||
//=> false | |||
``` | |||
##### .falsy(value) | |||
Returns `true` if `value` is one of: `false`, `0`, `''`, `null`, `undefined`, `NaN`. | |||
##### .nan(value) | |||
##### .nullOrUndefined(value) | |||
##### .primitive(value) | |||
JavaScript primitives are as follows: `null`, `undefined`, `string`, `number`, `boolean`, `symbol`. | |||
##### .integer(value) | |||
##### .safeInteger(value) | |||
Returns `true` if `value` is a [safe integer](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number/isSafeInteger). | |||
##### .plainObject(value) | |||
An object is plain if it's created by either `{}`, `new Object()`, or `Object.create(null)`. | |||
##### .iterable(value) | |||
##### .asyncIterable(value) | |||
##### .class(value) | |||
Returns `true` for instances created by a class. | |||
##### .typedArray(value) | |||
##### .arrayLike(value) | |||
A `value` is array-like if it is not a function and has a `value.length` that is a safe integer greater than or equal to 0. | |||
```js | |||
is.arrayLike(document.forms); | |||
//=> true | |||
function foo() { | |||
is.arrayLike(arguments); | |||
//=> true | |||
} | |||
foo(); | |||
``` | |||
##### .inRange(value, range) | |||
Check if `value` (number) is in the given `range`. The range is an array of two values, lower bound and upper bound, in no specific order. | |||
```js | |||
is.inRange(3, [0, 5]); | |||
is.inRange(3, [5, 0]); | |||
is.inRange(0, [-2, 2]); | |||
``` | |||
##### .inRange(value, upperBound) | |||
Check if `value` (number) is in the range of `0` to `upperBound`. | |||
```js | |||
is.inRange(3, 10); | |||
``` | |||
##### .domElement(value) | |||
Returns `true` if `value` is a DOM Element. | |||
##### .nodeStream(value) | |||
Returns `true` if `value` is a Node.js [stream](https://nodejs.org/api/stream.html). | |||
```js | |||
const fs = require('fs'); | |||
is.nodeStream(fs.createReadStream('unicorn.png')); | |||
//=> true | |||
``` | |||
##### .observable(value) | |||
Returns `true` if `value` is an `Observable`. | |||
```js | |||
const {Observable} = require('rxjs'); | |||
is.observable(new Observable()); | |||
//=> true | |||
``` | |||
##### .infinite(value) | |||
Check if `value` is `Infinity` or `-Infinity`. | |||
##### .even(value) | |||
Returns `true` if `value` is an even integer. | |||
##### .odd(value) | |||
Returns `true` if `value` is an odd integer. | |||
##### .any(predicate, ...values) | |||
Returns `true` if **any** of the input `values` returns true in the `predicate`: | |||
```js | |||
is.any(is.string, {}, true, '🦄'); | |||
//=> true | |||
is.any(is.boolean, 'unicorns', [], new Map()); | |||
//=> false | |||
``` | |||
##### .all(predicate, ...values) | |||
Returns `true` if **all** of the input `values` returns true in the `predicate`: | |||
```js | |||
is.all(is.object, {}, new Map(), new Set()); | |||
//=> true | |||
is.all(is.string, '🦄', [], 'unicorns'); | |||
//=> false | |||
``` | |||
## FAQ | |||
### Why yet another type checking module? | |||
There are hundreds of type checking modules on npm, unfortunately, I couldn't find any that fit my needs: | |||
- Includes both type methods and ability to get the type | |||
- Types of primitives returned as lowercase and object types as camelcase | |||
- Covers all built-ins | |||
- Unsurprising behavior | |||
- Well-maintained | |||
- Comprehensive test suite | |||
For the ones I found, pick 3 of these. | |||
The most common mistakes I noticed in these modules was using `instanceof` for type checking, forgetting that functions are objects, and omitting `symbol` as a primitive. | |||
## Related | |||
- [ow](https://github.com/sindresorhus/ow) - Function argument validation for humans | |||
- [is-stream](https://github.com/sindresorhus/is-stream) - Check if something is a Node.js stream | |||
- [is-observable](https://github.com/sindresorhus/is-observable) - Check if a value is an Observable | |||
- [file-type](https://github.com/sindresorhus/file-type) - Detect the file type of a Buffer/Uint8Array | |||
- [is-ip](https://github.com/sindresorhus/is-ip) - Check if a string is an IP address | |||
- [is-array-sorted](https://github.com/sindresorhus/is-array-sorted) - Check if an Array is sorted | |||
- [is-error-constructor](https://github.com/sindresorhus/is-error-constructor) - Check if a value is an error constructor | |||
- [is-empty-iterable](https://github.com/sindresorhus/is-empty-iterable) - Check if an Iterable is empty | |||
- [is-blob](https://github.com/sindresorhus/is-blob) - Check if a value is a Blob - File-like object of immutable, raw data | |||
- [has-emoji](https://github.com/sindresorhus/has-emoji) - Check whether a string has any emoji | |||
## Created by | |||
- [Sindre Sorhus](https://github.com/sindresorhus) | |||
- [Giora Guttsait](https://github.com/gioragutt) | |||
- [Brandon Smith](https://github.com/brandon93s) | |||
## License | |||
MIT |
@@ -0,0 +1,21 @@ | |||
MIT License | |||
Copyright (c) 2018 Szymon Marczak | |||
Permission is hereby granted, free of charge, to any person obtaining a copy | |||
of this software and associated documentation files (the "Software"), to deal | |||
in the Software without restriction, including without limitation the rights | |||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | |||
copies of the Software, and to permit persons to whom the Software is | |||
furnished to do so, subject to the following conditions: | |||
The above copyright notice and this permission notice shall be included in all | |||
copies or substantial portions of the Software. | |||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | |||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | |||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | |||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | |||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | |||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | |||
SOFTWARE. |
@@ -0,0 +1,70 @@ | |||
# http-timer | |||
> Timings for HTTP requests | |||
[](https://travis-ci.org/szmarczak/http-timer) | |||
[](https://coveralls.io/github/szmarczak/http-timer?branch=master) | |||
[](https://packagephobia.now.sh/result?p=@szmarczak/http-timer) | |||
Inspired by the [`request` package](https://github.com/request/request). | |||
## Usage | |||
```js | |||
'use strict'; | |||
const https = require('https'); | |||
const timer = require('@szmarczak/http-timer'); | |||
const request = https.get('https://httpbin.org/anything'); | |||
const timings = timer(request); | |||
request.on('response', response => { | |||
response.on('data', () => {}); // Consume the data somehow | |||
response.on('end', () => { | |||
console.log(timings); | |||
}); | |||
}); | |||
// { start: 1535708511443, | |||
// socket: 1535708511444, | |||
// lookup: 1535708511444, | |||
// connect: 1535708511582, | |||
// upload: 1535708511887, | |||
// response: 1535708512037, | |||
// end: 1535708512040, | |||
// phases: | |||
// { wait: 1, | |||
// dns: 0, | |||
// tcp: 138, | |||
// request: 305, | |||
// firstByte: 150, | |||
// download: 3, | |||
// total: 597 } } | |||
``` | |||
## API | |||
### timer(request) | |||
Returns: `Object` | |||
- `start` - Time when the request started. | |||
- `socket` - Time when a socket was assigned to the request. | |||
- `lookup` - Time when the DNS lookup finished. | |||
- `connect` - Time when the socket successfully connected. | |||
- `upload` - Time when the request finished uploading. | |||
- `response` - Time when the request fired the `response` event. | |||
- `end` - Time when the response fired the `end` event. | |||
- `error` - Time when the request fired the `error` event. | |||
- `phases` | |||
- `wait` - `timings.socket - timings.start` | |||
- `dns` - `timings.lookup - timings.socket` | |||
- `tcp` - `timings.connect - timings.lookup` | |||
- `request` - `timings.upload - timings.connect` | |||
- `firstByte` - `timings.response - timings.upload` | |||
- `download` - `timings.end - timings.response` | |||
- `total` - `timings.end - timings.start` or `timings.error - timings.start` | |||
**Note**: The time is a `number` representing the milliseconds elapsed since the UNIX epoch. | |||
## License | |||
MIT |
@@ -0,0 +1,75 @@ | |||
{ | |||
"_from": "@szmarczak/http-timer@^1.1.2", | |||
"_id": "@szmarczak/http-timer@1.1.2", | |||
"_inBundle": false, | |||
"_integrity": "sha512-XIB2XbzHTN6ieIjfIMV9hlVcfPU26s2vafYWQcZHWXHOxiaRZYEDKEwdl129Zyg50+foYV2jCgtrqSA6qNuNSA==", | |||
"_location": "/@szmarczak/http-timer", | |||
"_phantomChildren": {}, | |||
"_requested": { | |||
"type": "range", | |||
"registry": true, | |||
"raw": "@szmarczak/http-timer@^1.1.2", | |||
"name": "@szmarczak/http-timer", | |||
"escapedName": "@szmarczak%2fhttp-timer", | |||
"scope": "@szmarczak", | |||
"rawSpec": "^1.1.2", | |||
"saveSpec": null, | |||
"fetchSpec": "^1.1.2" | |||
}, | |||
"_requiredBy": [ | |||
"/got" | |||
], | |||
"_resolved": "https://registry.npmjs.org/@szmarczak/http-timer/-/http-timer-1.1.2.tgz", | |||
"_shasum": "b1665e2c461a2cd92f4c1bbf50d5454de0d4b421", | |||
"_spec": "@szmarczak/http-timer@^1.1.2", | |||
"_where": "/home/cziermann/git/papoh/node_modules/got", | |||
"author": { | |||
"name": "Szymon Marczak" | |||
}, | |||
"bugs": { | |||
"url": "https://github.com/szmarczak/http-timer/issues" | |||
}, | |||
"bundleDependencies": false, | |||
"dependencies": { | |||
"defer-to-connect": "^1.0.1" | |||
}, | |||
"deprecated": false, | |||
"description": "Timings for HTTP requests", | |||
"devDependencies": { | |||
"ava": "^0.25.0", | |||
"coveralls": "^3.0.2", | |||
"nyc": "^12.0.2", | |||
"p-event": "^2.1.0", | |||
"xo": "^0.22.0" | |||
}, | |||
"engines": { | |||
"node": ">=6" | |||
}, | |||
"files": [ | |||
"source" | |||
], | |||
"homepage": "https://github.com/szmarczak/http-timer#readme", | |||
"keywords": [ | |||
"http", | |||
"https", | |||
"timer", | |||
"timings" | |||
], | |||
"license": "MIT", | |||
"main": "source", | |||
"name": "@szmarczak/http-timer", | |||
"repository": { | |||
"type": "git", | |||
"url": "git+https://github.com/szmarczak/http-timer.git" | |||
}, | |||
"scripts": { | |||
"coveralls": "nyc report --reporter=text-lcov | coveralls", | |||
"test": "xo && nyc ava" | |||
}, | |||
"version": "1.1.2", | |||
"xo": { | |||
"rules": { | |||
"unicorn/filename-case": "camelCase" | |||
} | |||
} | |||
} |
@@ -0,0 +1,99 @@ | |||
'use strict'; | |||
const deferToConnect = require('defer-to-connect'); | |||
module.exports = request => { | |||
const timings = { | |||
start: Date.now(), | |||
socket: null, | |||
lookup: null, | |||
connect: null, | |||
upload: null, | |||
response: null, | |||
end: null, | |||
error: null, | |||
phases: { | |||
wait: null, | |||
dns: null, | |||
tcp: null, | |||
request: null, | |||
firstByte: null, | |||
download: null, | |||
total: null | |||
} | |||
}; | |||
const handleError = origin => { | |||
const emit = origin.emit.bind(origin); | |||
origin.emit = (event, ...args) => { | |||
// Catches the `error` event | |||
if (event === 'error') { | |||
timings.error = Date.now(); | |||
timings.phases.total = timings.error - timings.start; | |||
origin.emit = emit; | |||
} | |||
// Saves the original behavior | |||
return emit(event, ...args); | |||
}; | |||
}; | |||
let uploadFinished = false; | |||
const onUpload = () => { | |||
timings.upload = Date.now(); | |||
timings.phases.request = timings.upload - timings.connect; | |||
}; | |||
handleError(request); | |||
request.once('socket', socket => { | |||
timings.socket = Date.now(); | |||
timings.phases.wait = timings.socket - timings.start; | |||
const lookupListener = () => { | |||
timings.lookup = Date.now(); | |||
timings.phases.dns = timings.lookup - timings.socket; | |||
}; | |||
socket.once('lookup', lookupListener); | |||
deferToConnect(socket, () => { | |||
timings.connect = Date.now(); | |||
if (timings.lookup === null) { | |||
socket.removeListener('lookup', lookupListener); | |||
timings.lookup = timings.connect; | |||
timings.phases.dns = timings.lookup - timings.socket; | |||
} | |||
timings.phases.tcp = timings.connect - timings.lookup; | |||
if (uploadFinished && !timings.upload) { | |||
onUpload(); | |||
} | |||
}); | |||
}); | |||
request.once('finish', () => { | |||
uploadFinished = true; | |||
if (timings.connect) { | |||
onUpload(); | |||
} | |||
}); | |||
request.once('response', response => { | |||
timings.response = Date.now(); | |||
timings.phases.firstByte = timings.response - timings.upload; | |||
handleError(response); | |||
response.once('end', () => { | |||
timings.end = Date.now(); | |||
timings.phases.download = timings.end - timings.response; | |||
timings.phases.total = timings.end - timings.start; | |||
}); | |||
}); | |||
return timings; | |||
}; |
@@ -0,0 +1,21 @@ | |||
MIT License | |||
Copyright (c) Microsoft Corporation. All rights reserved. | |||
Permission is hereby granted, free of charge, to any person obtaining a copy | |||
of this software and associated documentation files (the "Software"), to deal | |||
in the Software without restriction, including without limitation the rights | |||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | |||
copies of the Software, and to permit persons to whom the Software is | |||
furnished to do so, subject to the following conditions: | |||
The above copyright notice and this permission notice shall be included in all | |||
copies or substantial portions of the Software. | |||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | |||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | |||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | |||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | |||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | |||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | |||
SOFTWARE |
@@ -0,0 +1,16 @@ | |||
# Installation | |||
> `npm install --save @types/color-name` | |||
# Summary | |||
This package contains type definitions for color-name ( https://github.com/colorjs/color-name ). | |||
# Details | |||
Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/color-name | |||
Additional Details | |||
* Last updated: Wed, 13 Feb 2019 16:16:48 GMT | |||
* Dependencies: none | |||
* Global values: none | |||
# Credits | |||
These definitions were written by Junyoung Clare Jang <https://github.com/Ailrun>. |
@@ -0,0 +1,161 @@ | |||
// Type definitions for color-name 1.1 | |||
// Project: https://github.com/colorjs/color-name | |||
// Definitions by: Junyoung Clare Jang <https://github.com/Ailrun> | |||
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped | |||
/** | |||
* Tuple of Red, Green, and Blue | |||
* @example | |||
* // Red = 55, Green = 70, Blue = 0 | |||
* const rgb: RGB = [55, 70, 0]; | |||
*/ | |||
export type RGB = [number, number, number]; | |||
export const aliceblue: RGB; | |||
export const antiquewhite: RGB; | |||
export const aqua: RGB; | |||
export const aquamarine: RGB; | |||
export const azure: RGB; | |||
export const beige: RGB; | |||
export const bisque: RGB; | |||
export const black: RGB; | |||
export const blanchedalmond: RGB; | |||
export const blue: RGB; | |||
export const blueviolet: RGB; | |||
export const brown: RGB; | |||
export const burlywood: RGB; | |||
export const cadetblue: RGB; | |||
export const chartreuse: RGB; | |||
export const chocolate: RGB; | |||
export const coral: RGB; | |||
export const cornflowerblue: RGB; | |||
export const cornsilk: RGB; | |||
export const crimson: RGB; | |||
export const cyan: RGB; | |||
export const darkblue: RGB; | |||
export const darkcyan: RGB; | |||
export const darkgoldenrod: RGB; | |||
export const darkgray: RGB; | |||
export const darkgreen: RGB; | |||
export const darkgrey: RGB; | |||
export const darkkhaki: RGB; | |||
export const darkmagenta: RGB; | |||
export const darkolivegreen: RGB; | |||
export const darkorange: RGB; | |||
export const darkorchid: RGB; | |||
export const darkred: RGB; | |||
export const darksalmon: RGB; | |||
export const darkseagreen: RGB; | |||
export const darkslateblue: RGB; | |||
export const darkslategray: RGB; | |||
export const darkslategrey: RGB; | |||
export const darkturquoise: RGB; | |||
export const darkviolet: RGB; | |||
export const deeppink: RGB; | |||
export const deepskyblue: RGB; | |||
export const dimgray: RGB; | |||
export const dimgrey: RGB; | |||
export const dodgerblue: RGB; | |||
export const firebrick: RGB; | |||
export const floralwhite: RGB; | |||
export const forestgreen: RGB; | |||
export const fuchsia: RGB; | |||
export const gainsboro: RGB; | |||
export const ghostwhite: RGB; | |||
export const gold: RGB; | |||
export const goldenrod: RGB; | |||
export const gray: RGB; | |||
export const green: RGB; | |||
export const greenyellow: RGB; | |||
export const grey: RGB; | |||
export const honeydew: RGB; | |||
export const hotpink: RGB; | |||
export const indianred: RGB; | |||
export const indigo: RGB; | |||
export const ivory: RGB; | |||
export const khaki: RGB; | |||
export const lavender: RGB; | |||
export const lavenderblush: RGB; | |||
export const lawngreen: RGB; | |||
export const lemonchiffon: RGB; | |||
export const lightblue: RGB; | |||
export const lightcoral: RGB; | |||
export const lightcyan: RGB; | |||
export const lightgoldenrodyellow: RGB; | |||
export const lightgray: RGB; | |||
export const lightgreen: RGB; | |||
export const lightgrey: RGB; | |||
export const lightpink: RGB; | |||
export const lightsalmon: RGB; | |||
export const lightseagreen: RGB; | |||
export const lightskyblue: RGB; | |||
export const lightslategray: RGB; | |||
export const lightslategrey: RGB; | |||
export const lightsteelblue: RGB; | |||
export const lightyellow: RGB; | |||
export const lime: RGB; | |||
export const limegreen: RGB; | |||
export const linen: RGB; | |||
export const magenta: RGB; | |||
export const maroon: RGB; | |||
export const mediumaquamarine: RGB; | |||
export const mediumblue: RGB; | |||
export const mediumorchid: RGB; | |||
export const mediumpurple: RGB; | |||
export const mediumseagreen: RGB; | |||
export const mediumslateblue: RGB; | |||
export const mediumspringgreen: RGB; | |||
export const mediumturquoise: RGB; | |||
export const mediumvioletred: RGB; | |||
export const midnightblue: RGB; | |||
export const mintcream: RGB; | |||
export const mistyrose: RGB; | |||
export const moccasin: RGB; | |||
export const navajowhite: RGB; | |||
export const navy: RGB; | |||
export const oldlace: RGB; | |||
export const olive: RGB; | |||
export const olivedrab: RGB; | |||
export const orange: RGB; | |||
export const orangered: RGB; | |||
export const orchid: RGB; | |||
export const palegoldenrod: RGB; | |||
export const palegreen: RGB; | |||
export const paleturquoise: RGB; | |||
export const palevioletred: RGB; | |||
export const papayawhip: RGB; | |||
export const peachpuff: RGB; | |||
export const peru: RGB; | |||
export const pink: RGB; | |||
export const plum: RGB; | |||
export const powderblue: RGB; | |||
export const purple: RGB; | |||
export const rebeccapurple: RGB; | |||
export const red: RGB; | |||
export const rosybrown: RGB; | |||
export const royalblue: RGB; | |||
export const saddlebrown: RGB; | |||
export const salmon: RGB; | |||
export const sandybrown: RGB; | |||
export const seagreen: RGB; | |||
export const seashell: RGB; | |||
export const sienna: RGB; | |||
export const silver: RGB; | |||
export const skyblue: RGB; | |||
export const slateblue: RGB; | |||
export const slategray: RGB; | |||
export const slategrey: RGB; | |||
export const snow: RGB; | |||
export const springgreen: RGB; | |||
export const steelblue: RGB; | |||
export const tan: RGB; | |||
export const teal: RGB; | |||
export const thistle: RGB; | |||
export const tomato: RGB; | |||
export const turquoise: RGB; | |||
export const violet: RGB; | |||
export const wheat: RGB; | |||
export const white: RGB; | |||
export const whitesmoke: RGB; | |||
export const yellow: RGB; | |||
export const yellowgreen: RGB; |
@@ -0,0 +1,52 @@ | |||
{ | |||
"_from": "@types/color-name@^1.1.1", | |||
"_id": "@types/color-name@1.1.1", | |||
"_inBundle": false, | |||
"_integrity": "sha512-rr+OQyAjxze7GgWrSaJwydHStIhHq2lvY3BOC2Mj7KnzI7XK0Uw1TOOdI9lDoajEbSWLiYgoo4f1R51erQfhPQ==", | |||
"_location": "/@types/color-name", | |||
"_phantomChildren": {}, | |||
"_requested": { | |||
"type": "range", | |||
"registry": true, | |||
"raw": "@types/color-name@^1.1.1", | |||
"name": "@types/color-name", | |||
"escapedName": "@types%2fcolor-name", | |||
"scope": "@types", | |||
"rawSpec": "^1.1.1", | |||
"saveSpec": null, | |||
"fetchSpec": "^1.1.1" | |||
}, | |||
"_requiredBy": [ | |||
"/ansi-styles" | |||
], | |||
"_resolved": "https://registry.npmjs.org/@types/color-name/-/color-name-1.1.1.tgz", | |||
"_shasum": "1c1261bbeaa10a8055bbc5d8ab84b7b2afc846a0", | |||
"_spec": "@types/color-name@^1.1.1", | |||
"_where": "/home/cziermann/git/papoh/node_modules/ansi-styles", | |||
"bugs": { | |||
"url": "https://github.com/DefinitelyTyped/DefinitelyTyped/issues" | |||
}, | |||
"bundleDependencies": false, | |||
"contributors": [ | |||
{ | |||
"name": "Junyoung Clare Jang", | |||
"url": "https://github.com/Ailrun" | |||
} | |||
], | |||
"dependencies": {}, | |||
"deprecated": false, | |||
"description": "TypeScript definitions for color-name", | |||
"homepage": "https://github.com/DefinitelyTyped/DefinitelyTyped#readme", | |||
"license": "MIT", | |||
"main": "", | |||
"name": "@types/color-name", | |||
"repository": { | |||
"type": "git", | |||
"url": "git+https://github.com/DefinitelyTyped/DefinitelyTyped.git" | |||
}, | |||
"scripts": {}, | |||
"typeScriptVersion": "2.0", | |||
"types": "index", | |||
"typesPublisherContentHash": "e22c6881e2dcf766e32142cbb82d9acf9c08258bdf0da8e76c8a448d1be44ac7", | |||
"version": "1.1.1" | |||
} |
@@ -0,0 +1,21 @@ | |||
MIT License | |||
Copyright (c) Microsoft Corporation. | |||
Permission is hereby granted, free of charge, to any person obtaining a copy | |||
of this software and associated documentation files (the "Software"), to deal | |||
in the Software without restriction, including without limitation the rights | |||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | |||
copies of the Software, and to permit persons to whom the Software is | |||
furnished to do so, subject to the following conditions: | |||
The above copyright notice and this permission notice shall be included in all | |||
copies or substantial portions of the Software. | |||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | |||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | |||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | |||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | |||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | |||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | |||
SOFTWARE |
@@ -0,0 +1,16 @@ | |||
# Installation | |||
> `npm install --save @types/node` | |||
# Summary | |||
This package contains type definitions for Node.js (http://nodejs.org/). | |||
# Details | |||
Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/node. | |||
### Additional Details | |||
* Last updated: Thu, 21 May 2020 20:08:41 GMT | |||
* Dependencies: none | |||
* Global values: `Buffer`, `Symbol`, `__dirname`, `__filename`, `clearImmediate`, `clearInterval`, `clearTimeout`, `console`, `exports`, `global`, `module`, `process`, `queueMicrotask`, `require`, `setImmediate`, `setInterval`, `setTimeout` | |||
# Credits | |||
These definitions were written by [Microsoft TypeScript](https://github.com/Microsoft), [DefinitelyTyped](https://github.com/DefinitelyTyped), [Alberto Schiabel](https://github.com/jkomyno), [Alexander T.](https://github.com/a-tarasyuk), [Alvis HT Tang](https://github.com/alvis), [Andrew Makarov](https://github.com/r3nya), [Benjamin Toueg](https://github.com/btoueg), [Bruno Scheufler](https://github.com/brunoscheufler), [Chigozirim C.](https://github.com/smac89), [David Junger](https://github.com/touffy), [Deividas Bakanas](https://github.com/DeividasBakanas), [Eugene Y. Q. Shen](https://github.com/eyqs), [Flarna](https://github.com/Flarna), [Hannes Magnusson](https://github.com/Hannes-Magnusson-CK), [Hoàng Văn Khải](https://github.com/KSXGitHub), [Huw](https://github.com/hoo29), [Kelvin Jin](https://github.com/kjin), [Klaus Meinhardt](https://github.com/ajafff), [Lishude](https://github.com/islishude), [Mariusz Wiktorczyk](https://github.com/mwiktorczyk), [Mohsen Azimi](https://github.com/mohsen1), [Nicolas Even](https://github.com/n-e), [Nicolas Voigt](https://github.com/octo-sniffle), [Nikita Galkin](https://github.com/galkin), [Parambir Singh](https://github.com/parambirs), [Sebastian Silbermann](https://github.com/eps1lon), [Simon Schick](https://github.com/SimonSchick), [Thomas den Hollander](https://github.com/ThomasdenH), [Wilco Bakker](https://github.com/WilcoBakker), [wwwy3y3](https://github.com/wwwy3y3), [Samuel Ainsworth](https://github.com/samuela), [Kyle Uehlein](https://github.com/kuehlein), [Jordi Oliveras Rovira](https://github.com/j-oliveras), [Thanik Bhongbhibhat](https://github.com/bhongy), [Marcin Kopacz](https://github.com/chyzwar), [Trivikram Kamat](https://github.com/trivikr), [Minh Son Nguyen](https://github.com/nguymin4), [Junxiao Shi](https://github.com/yoursunny), [Ilia Baryshnikov](https://github.com/qwelias), [ExE Boss](https://github.com/ExE-Boss), [Surasak Chaisurin](https://github.com/Ryan-Willpower), [Piotr Błażejewicz](https://github.com/peterblazejewicz), [Anna Henningsen](https://github.com/addaleax), and [Jason Kwok](https://github.com/JasonHK). |
@@ -0,0 +1,57 @@ | |||
declare module "assert" { | |||
function assert(value: any, message?: string | Error): void; | |||
namespace assert { | |||
class AssertionError implements Error { | |||
name: string; | |||
message: string; | |||
actual: any; | |||
expected: any; | |||
operator: string; | |||
generatedMessage: boolean; | |||
code: 'ERR_ASSERTION'; | |||
constructor(options?: { | |||
message?: string; actual?: any; expected?: any; | |||
operator?: string; stackStartFn?: Function | |||
}); | |||
} | |||
type AssertPredicate = RegExp | (new() => object) | ((thrown: any) => boolean) | object | Error; | |||
function fail(message?: string | Error): never; | |||
/** @deprecated since v10.0.0 - use fail([message]) or other assert functions instead. */ | |||
function fail(actual: any, expected: any, message?: string | Error, operator?: string, stackStartFn?: Function): never; | |||
function ok(value: any, message?: string | Error): void; | |||
/** @deprecated since v9.9.0 - use strictEqual() instead. */ | |||
function equal(actual: any, expected: any, message?: string | Error): void; | |||
/** @deprecated since v9.9.0 - use notStrictEqual() instead. */ | |||
function notEqual(actual: any, expected: any, message?: string | Error): void; | |||
/** @deprecated since v9.9.0 - use deepStrictEqual() instead. */ | |||
function deepEqual(actual: any, expected: any, message?: string | Error): void; | |||
/** @deprecated since v9.9.0 - use notDeepStrictEqual() instead. */ | |||
function notDeepEqual(actual: any, expected: any, message?: string | Error): void; | |||
function strictEqual(actual: any, expected: any, message?: string | Error): void; | |||
function notStrictEqual(actual: any, expected: any, message?: string | Error): void; | |||
function deepStrictEqual(actual: any, expected: any, message?: string | Error): void; | |||
function notDeepStrictEqual(actual: any, expected: any, message?: string | Error): void; | |||
function throws(block: () => any, message?: string | Error): void; | |||
function throws(block: () => any, error: AssertPredicate, message?: string | Error): void; | |||
function doesNotThrow(block: () => any, message?: string | Error): void; | |||
function doesNotThrow(block: () => any, error: RegExp | Function, message?: string | Error): void; | |||
function ifError(value: any): void; | |||
function rejects(block: (() => Promise<any>) | Promise<any>, message?: string | Error): Promise<void>; | |||
function rejects(block: (() => Promise<any>) | Promise<any>, error: AssertPredicate, message?: string | Error): Promise<void>; | |||
function doesNotReject(block: (() => Promise<any>) | Promise<any>, message?: string | Error): Promise<void>; | |||
function doesNotReject(block: (() => Promise<any>) | Promise<any>, error: RegExp | Function, message?: string | Error): Promise<void>; | |||
function match(value: string, regExp: RegExp, message?: string | Error): void; | |||
function doesNotMatch(value: string, regExp: RegExp, message?: string | Error): void; | |||
const strict: typeof assert; | |||
} | |||
export = assert; | |||
} |
@@ -0,0 +1,219 @@ | |||
/** | |||
* Async Hooks module: https://nodejs.org/api/async_hooks.html | |||
*/ | |||
declare module "async_hooks" { | |||
/** | |||
* Returns the asyncId of the current execution context. | |||
*/ | |||
function executionAsyncId(): number; | |||
/** | |||
* The resource representing the current execution. | |||
* Useful to store data within the resource. | |||
* | |||
* Resource objects returned by `executionAsyncResource()` are most often internal | |||
* Node.js handle objects with undocumented APIs. Using any functions or properties | |||
* on the object is likely to crash your application and should be avoided. | |||
* | |||
* Using `executionAsyncResource()` in the top-level execution context will | |||
* return an empty object as there is no handle or request object to use, | |||
* but having an object representing the top-level can be helpful. | |||
*/ | |||
function executionAsyncResource(): object; | |||
/** | |||
* Returns the ID of the resource responsible for calling the callback that is currently being executed. | |||
*/ | |||
function triggerAsyncId(): number; | |||
interface HookCallbacks { | |||
/** | |||
* Called when a class is constructed that has the possibility to emit an asynchronous event. | |||
* @param asyncId a unique ID for the async resource | |||
* @param type the type of the async resource | |||
* @param triggerAsyncId the unique ID of the async resource in whose execution context this async resource was created | |||
* @param resource reference to the resource representing the async operation, needs to be released during destroy | |||
*/ | |||
init?(asyncId: number, type: string, triggerAsyncId: number, resource: object): void; | |||
/** | |||
* When an asynchronous operation is initiated or completes a callback is called to notify the user. | |||
* The before callback is called just before said callback is executed. | |||
* @param asyncId the unique identifier assigned to the resource about to execute the callback. | |||
*/ | |||
before?(asyncId: number): void; | |||
/** | |||
* Called immediately after the callback specified in before is completed. | |||
* @param asyncId the unique identifier assigned to the resource which has executed the callback. | |||
*/ | |||
after?(asyncId: number): void; | |||
/** | |||
* Called when a promise has resolve() called. This may not be in the same execution id | |||
* as the promise itself. | |||
* @param asyncId the unique id for the promise that was resolve()d. | |||
*/ | |||
promiseResolve?(asyncId: number): void; | |||
/** | |||
* Called after the resource corresponding to asyncId is destroyed | |||
* @param asyncId a unique ID for the async resource | |||
*/ | |||
destroy?(asyncId: number): void; | |||
} | |||
interface AsyncHook { | |||
/** | |||
* Enable the callbacks for a given AsyncHook instance. If no callbacks are provided enabling is a noop. | |||
*/ | |||
enable(): this; | |||
/** | |||
* Disable the callbacks for a given AsyncHook instance from the global pool of AsyncHook callbacks to be executed. Once a hook has been disabled it will not be called again until enabled. | |||
*/ | |||
disable(): this; | |||
} | |||
/** | |||
* Registers functions to be called for different lifetime events of each async operation. | |||
* @param options the callbacks to register | |||
* @return an AsyncHooks instance used for disabling and enabling hooks | |||
*/ | |||
function createHook(options: HookCallbacks): AsyncHook; | |||
interface AsyncResourceOptions { | |||
/** | |||
* The ID of the execution context that created this async event. | |||
* Default: `executionAsyncId()` | |||
*/ | |||
triggerAsyncId?: number; | |||
/** | |||
* Disables automatic `emitDestroy` when the object is garbage collected. | |||
* This usually does not need to be set (even if `emitDestroy` is called | |||
* manually), unless the resource's `asyncId` is retrieved and the | |||
* sensitive API's `emitDestroy` is called with it. | |||
* Default: `false` | |||
*/ | |||
requireManualDestroy?: boolean; | |||
} | |||
/** | |||
* The class AsyncResource was designed to be extended by the embedder's async resources. | |||
* Using this users can easily trigger the lifetime events of their own resources. | |||
*/ | |||
class AsyncResource { | |||
/** | |||
* AsyncResource() is meant to be extended. Instantiating a | |||
* new AsyncResource() also triggers init. If triggerAsyncId is omitted then | |||
* async_hook.executionAsyncId() is used. | |||
* @param type The type of async event. | |||
* @param triggerAsyncId The ID of the execution context that created | |||
* this async event (default: `executionAsyncId()`), or an | |||
* AsyncResourceOptions object (since 9.3) | |||
*/ | |||
constructor(type: string, triggerAsyncId?: number|AsyncResourceOptions); | |||
/** | |||
* Call the provided function with the provided arguments in the | |||
* execution context of the async resource. This will establish the | |||
* context, trigger the AsyncHooks before callbacks, call the function, | |||
* trigger the AsyncHooks after callbacks, and then restore the original | |||
* execution context. | |||
* @param fn The function to call in the execution context of this | |||
* async resource. | |||
* @param thisArg The receiver to be used for the function call. | |||
* @param args Optional arguments to pass to the function. | |||
*/ | |||
runInAsyncScope<This, Result>(fn: (this: This, ...args: any[]) => Result, thisArg?: This, ...args: any[]): Result; | |||
/** | |||
* Call AsyncHooks destroy callbacks. | |||
*/ | |||
emitDestroy(): void; | |||
/** | |||
* @return the unique ID assigned to this AsyncResource instance. | |||
*/ | |||
asyncId(): number; | |||
/** | |||
* @return the trigger ID for this AsyncResource instance. | |||
*/ | |||
triggerAsyncId(): number; | |||
} | |||
/** | |||
* When having multiple instances of `AsyncLocalStorage`, they are independent | |||
* from each other. It is safe to instantiate this class multiple times. | |||
*/ | |||
class AsyncLocalStorage<T> { | |||
/** | |||
* This method disables the instance of `AsyncLocalStorage`. All subsequent calls | |||
* to `asyncLocalStorage.getStore()` will return `undefined` until | |||
* `asyncLocalStorage.run()` or `asyncLocalStorage.runSyncAndReturn()` | |||
* is called again. | |||
* | |||
* When calling `asyncLocalStorage.disable()`, all current contexts linked to the | |||
* instance will be exited. | |||
* | |||
* Calling `asyncLocalStorage.disable()` is required before the | |||
* `asyncLocalStorage` can be garbage collected. This does not apply to stores | |||
* provided by the `asyncLocalStorage`, as those objects are garbage collected | |||
* along with the corresponding async resources. | |||
* | |||
* This method is to be used when the `asyncLocalStorage` is not in use anymore | |||
* in the current process. | |||
*/ | |||
disable(): void; | |||
/** | |||
* This method returns the current store. | |||
* If this method is called outside of an asynchronous context initialized by | |||
* calling `asyncLocalStorage.run` or `asyncLocalStorage.runAndReturn`, it will | |||
* return `undefined`. | |||
*/ | |||
getStore(): T | undefined; | |||
/** | |||
* Calling `asyncLocalStorage.run(callback)` will create a new asynchronous | |||
* context. | |||
* Within the callback function and the asynchronous operations from the callback, | |||
* `asyncLocalStorage.getStore()` will return an instance of `Map` known as | |||
* "the store". This store will be persistent through the following | |||
* asynchronous calls. | |||
* | |||
* The callback will be ran asynchronously. Optionally, arguments can be passed | |||
* to the function. They will be passed to the callback function. | |||
* | |||
* If an error is thrown by the callback function, it will not be caught by | |||
* a `try/catch` block as the callback is ran in a new asynchronous resource. | |||
* Also, the stacktrace will be impacted by the asynchronous call. | |||
*/ | |||
// TODO: Apply generic vararg once available | |||
run(store: T, callback: (...args: any[]) => void, ...args: any[]): void; | |||
/** | |||
* Calling `asyncLocalStorage.exit(callback)` will create a new asynchronous | |||
* context. | |||
* Within the callback function and the asynchronous operations from the callback, | |||
* `asyncLocalStorage.getStore()` will return `undefined`. | |||
* | |||
* The callback will be ran asynchronously. Optionally, arguments can be passed | |||
* to the function. They will be passed to the callback function. | |||
* | |||
* If an error is thrown by the callback function, it will not be caught by | |||
* a `try/catch` block as the callback is ran in a new asynchronous resource. | |||
* Also, the stacktrace will be impacted by the asynchronous call. | |||
*/ | |||
exit(callback: (...args: any[]) => void, ...args: any[]): void; | |||
/** | |||
* Calling `asyncLocalStorage.enterWith(store)` will transition into the context | |||
* for the remainder of the current synchronous execution and will persist | |||
* through any following asynchronous calls. | |||
*/ | |||
enterWith(store: T): void; | |||
} | |||
} |
@@ -0,0 +1,41 @@ | |||
// base definnitions for all NodeJS modules that are not specific to any version of TypeScript | |||
/// <reference path="globals.d.ts" /> | |||
/// <reference path="async_hooks.d.ts" /> | |||
/// <reference path="buffer.d.ts" /> | |||
/// <reference path="child_process.d.ts" /> | |||
/// <reference path="cluster.d.ts" /> | |||
/// <reference path="console.d.ts" /> | |||
/// <reference path="constants.d.ts" /> | |||
/// <reference path="crypto.d.ts" /> | |||
/// <reference path="dgram.d.ts" /> | |||
/// <reference path="dns.d.ts" /> | |||
/// <reference path="domain.d.ts" /> | |||
/// <reference path="events.d.ts" /> | |||
/// <reference path="fs.d.ts" /> | |||
/// <reference path="fs/promises.d.ts" /> | |||
/// <reference path="http.d.ts" /> | |||
/// <reference path="http2.d.ts" /> | |||
/// <reference path="https.d.ts" /> | |||
/// <reference path="inspector.d.ts" /> | |||
/// <reference path="module.d.ts" /> | |||
/// <reference path="net.d.ts" /> | |||
/// <reference path="os.d.ts" /> | |||
/// <reference path="path.d.ts" /> | |||
/// <reference path="perf_hooks.d.ts" /> | |||
/// <reference path="process.d.ts" /> | |||
/// <reference path="punycode.d.ts" /> | |||
/// <reference path="querystring.d.ts" /> | |||
/// <reference path="readline.d.ts" /> | |||
/// <reference path="repl.d.ts" /> | |||
/// <reference path="stream.d.ts" /> | |||
/// <reference path="string_decoder.d.ts" /> | |||
/// <reference path="timers.d.ts" /> | |||
/// <reference path="tls.d.ts" /> | |||
/// <reference path="trace_events.d.ts" /> | |||
/// <reference path="tty.d.ts" /> | |||
/// <reference path="url.d.ts" /> | |||
/// <reference path="util.d.ts" /> | |||
/// <reference path="v8.d.ts" /> | |||
/// <reference path="vm.d.ts" /> | |||
/// <reference path="worker_threads.d.ts" /> | |||
/// <reference path="zlib.d.ts" /> |
@@ -0,0 +1,22 @@ | |||
declare module "buffer" { | |||
export const INSPECT_MAX_BYTES: number; | |||
export const kMaxLength: number; | |||
export const kStringMaxLength: number; | |||
export const constants: { | |||
MAX_LENGTH: number; | |||
MAX_STRING_LENGTH: number; | |||
}; | |||
const BuffType: typeof Buffer; | |||
export type TranscodeEncoding = "ascii" | "utf8" | "utf16le" | "ucs2" | "latin1" | "binary"; | |||
export function transcode(source: Uint8Array, fromEnc: TranscodeEncoding, toEnc: TranscodeEncoding): Buffer; | |||
export const SlowBuffer: { | |||
/** @deprecated since v6.0.0, use Buffer.allocUnsafeSlow() */ | |||
new(size: number): Buffer; | |||
prototype: Buffer; | |||
}; | |||
export { BuffType as Buffer }; | |||
} |
@@ -0,0 +1,504 @@ | |||
declare module "child_process" { | |||
import { BaseEncodingOptions } from 'fs'; | |||
import * as events from "events"; | |||
import * as net from "net"; | |||
import { Writable, Readable, Stream, Pipe } from "stream"; | |||
type Serializable = string | object | number | boolean; | |||
type SendHandle = net.Socket | net.Server; | |||
interface ChildProcess extends events.EventEmitter { | |||
stdin: Writable | null; | |||
stdout: Readable | null; | |||
stderr: Readable | null; | |||
readonly channel?: Pipe | null; | |||
readonly stdio: [ | |||
Writable | null, // stdin | |||
Readable | null, // stdout | |||
Readable | null, // stderr | |||
Readable | Writable | null | undefined, // extra | |||
Readable | Writable | null | undefined // extra | |||
]; | |||
readonly killed: boolean; | |||
readonly pid: number; | |||
readonly connected: boolean; | |||
readonly exitCode: number | null; | |||
readonly signalCode: number | null; | |||
readonly spawnargs: string[]; | |||
readonly spawnfile: string; | |||
kill(signal?: NodeJS.Signals | number): boolean; | |||
send(message: Serializable, callback?: (error: Error | null) => void): boolean; | |||
send(message: Serializable, sendHandle?: SendHandle, callback?: (error: Error | null) => void): boolean; | |||
send(message: Serializable, sendHandle?: SendHandle, options?: MessageOptions, callback?: (error: Error | null) => void): boolean; | |||
disconnect(): void; | |||
unref(): void; | |||
ref(): void; | |||
/** | |||
* events.EventEmitter | |||
* 1. close | |||
* 2. disconnect | |||
* 3. error | |||
* 4. exit | |||
* 5. message | |||
*/ | |||
addListener(event: string, listener: (...args: any[]) => void): this; | |||
addListener(event: "close", listener: (code: number, signal: NodeJS.Signals) => void): this; | |||
addListener(event: "disconnect", listener: () => void): this; | |||
addListener(event: "error", listener: (err: Error) => void): this; | |||
addListener(event: "exit", listener: (code: number | null, signal: NodeJS.Signals | null) => void): this; | |||
addListener(event: "message", listener: (message: Serializable, sendHandle: SendHandle) => void): this; | |||
emit(event: string | symbol, ...args: any[]): boolean; | |||
emit(event: "close", code: number, signal: NodeJS.Signals): boolean; | |||
emit(event: "disconnect"): boolean; | |||
emit(event: "error", err: Error): boolean; | |||
emit(event: "exit", code: number | null, signal: NodeJS.Signals | null): boolean; | |||
emit(event: "message", message: Serializable, sendHandle: SendHandle): boolean; | |||
on(event: string, listener: (...args: any[]) => void): this; | |||
on(event: "close", listener: (code: number, signal: NodeJS.Signals) => void): this; | |||
on(event: "disconnect", listener: () => void): this; | |||
on(event: "error", listener: (err: Error) => void): this; | |||
on(event: "exit", listener: (code: number | null, signal: NodeJS.Signals | null) => void): this; | |||
on(event: "message", listener: (message: Serializable, sendHandle: SendHandle) => void): this; | |||
once(event: string, listener: (...args: any[]) => void): this; | |||
once(event: "close", listener: (code: number, signal: NodeJS.Signals) => void): this; | |||
once(event: "disconnect", listener: () => void): this; | |||
once(event: "error", listener: (err: Error) => void): this; | |||
once(event: "exit", listener: (code: number | null, signal: NodeJS.Signals | null) => void): this; | |||
once(event: "message", listener: (message: Serializable, sendHandle: SendHandle) => void): this; | |||
prependListener(event: string, listener: (...args: any[]) => void): this; | |||
prependListener(event: "close", listener: (code: number, signal: NodeJS.Signals) => void): this; | |||
prependListener(event: "disconnect", listener: () => void): this; | |||
prependListener(event: "error", listener: (err: Error) => void): this; | |||
prependListener(event: "exit", listener: (code: number | null, signal: NodeJS.Signals | null) => void): this; | |||
prependListener(event: "message", listener: (message: Serializable, sendHandle: SendHandle) => void): this; | |||
prependOnceListener(event: string, listener: (...args: any[]) => void): this; | |||
prependOnceListener(event: "close", listener: (code: number, signal: NodeJS.Signals) => void): this; | |||
prependOnceListener(event: "disconnect", listener: () => void): this; | |||
prependOnceListener(event: "error", listener: (err: Error) => void): this; | |||
prependOnceListener(event: "exit", listener: (code: number | null, signal: NodeJS.Signals | null) => void): this; | |||
prependOnceListener(event: "message", listener: (message: Serializable, sendHandle: SendHandle) => void): this; | |||
} | |||
// return this object when stdio option is undefined or not specified | |||
interface ChildProcessWithoutNullStreams extends ChildProcess { | |||
stdin: Writable; | |||
stdout: Readable; | |||
stderr: Readable; | |||
readonly stdio: [ | |||
Writable, // stdin | |||
Readable, // stdout | |||
Readable, // stderr | |||
Readable | Writable | null | undefined, // extra, no modification | |||
Readable | Writable | null | undefined // extra, no modification | |||
]; | |||
} | |||
// return this object when stdio option is a tuple of 3 | |||
interface ChildProcessByStdio< | |||
I extends null | Writable, | |||
O extends null | Readable, | |||
E extends null | Readable, | |||
> extends ChildProcess { | |||
stdin: I; | |||
stdout: O; | |||
stderr: E; | |||
readonly stdio: [ | |||
I, | |||
O, | |||
E, | |||
Readable | Writable | null | undefined, // extra, no modification | |||
Readable | Writable | null | undefined // extra, no modification | |||
]; | |||
} | |||
interface MessageOptions { | |||
keepOpen?: boolean; | |||
} | |||
type StdioOptions = "pipe" | "ignore" | "inherit" | Array<("pipe" | "ipc" | "ignore" | "inherit" | Stream | number | null | undefined)>; | |||
type SerializationType = 'json' | 'advanced'; | |||
interface MessagingOptions { | |||
/** | |||
* Specify the kind of serialization used for sending messages between processes. | |||
* @default 'json' | |||
*/ | |||
serialization?: SerializationType; | |||
} | |||
interface ProcessEnvOptions { | |||
uid?: number; | |||
gid?: number; | |||
cwd?: string; | |||
env?: NodeJS.ProcessEnv; | |||
} | |||
interface CommonOptions extends ProcessEnvOptions { | |||
/** | |||
* @default true | |||
*/ | |||
windowsHide?: boolean; | |||
/** | |||
* @default 0 | |||
*/ | |||
timeout?: number; | |||
} | |||
interface CommonSpawnOptions extends CommonOptions, MessagingOptions { | |||
argv0?: string; | |||
stdio?: StdioOptions; | |||
shell?: boolean | string; | |||
windowsVerbatimArguments?: boolean; | |||
} | |||
interface SpawnOptions extends CommonSpawnOptions { | |||
detached?: boolean; | |||
} | |||
interface SpawnOptionsWithoutStdio extends SpawnOptions { | |||
stdio?: 'pipe' | Array<null | undefined | 'pipe'>; | |||
} | |||
type StdioNull = 'inherit' | 'ignore' | Stream; | |||
type StdioPipe = undefined | null | 'pipe'; | |||
interface SpawnOptionsWithStdioTuple< | |||
Stdin extends StdioNull | StdioPipe, | |||
Stdout extends StdioNull | StdioPipe, | |||
Stderr extends StdioNull | StdioPipe, | |||
> extends SpawnOptions { | |||
stdio: [Stdin, Stdout, Stderr]; | |||
} | |||
// overloads of spawn without 'args' | |||
function spawn(command: string, options?: SpawnOptionsWithoutStdio): ChildProcessWithoutNullStreams; | |||
function spawn( | |||
command: string, | |||
options: SpawnOptionsWithStdioTuple<StdioPipe, StdioPipe, StdioPipe>, | |||
): ChildProcessByStdio<Writable, Readable, Readable>; | |||
function spawn( | |||
command: string, | |||
options: SpawnOptionsWithStdioTuple<StdioPipe, StdioPipe, StdioNull>, | |||
): ChildProcessByStdio<Writable, Readable, null>; | |||
function spawn( | |||
command: string, | |||
options: SpawnOptionsWithStdioTuple<StdioPipe, StdioNull, StdioPipe>, | |||
): ChildProcessByStdio<Writable, null, Readable>; | |||
function spawn( | |||
command: string, | |||
options: SpawnOptionsWithStdioTuple<StdioNull, StdioPipe, StdioPipe>, | |||
): ChildProcessByStdio<null, Readable, Readable>; | |||
function spawn( | |||
command: string, | |||
options: SpawnOptionsWithStdioTuple<StdioPipe, StdioNull, StdioNull>, | |||
): ChildProcessByStdio<Writable, null, null>; | |||
function spawn( | |||
command: string, | |||
options: SpawnOptionsWithStdioTuple<StdioNull, StdioPipe, StdioNull>, | |||
): ChildProcessByStdio<null, Readable, null>; | |||
function spawn( | |||
command: string, | |||
options: SpawnOptionsWithStdioTuple<StdioNull, StdioNull, StdioPipe>, | |||
): ChildProcessByStdio<null, null, Readable>; | |||
function spawn( | |||
command: string, | |||
options: SpawnOptionsWithStdioTuple<StdioNull, StdioNull, StdioNull>, | |||
): ChildProcessByStdio<null, null, null>; | |||
function spawn(command: string, options: SpawnOptions): ChildProcess; | |||
// overloads of spawn with 'args' | |||
function spawn(command: string, args?: ReadonlyArray<string>, options?: SpawnOptionsWithoutStdio): ChildProcessWithoutNullStreams; | |||
function spawn( | |||
command: string, | |||
args: ReadonlyArray<string>, | |||
options: SpawnOptionsWithStdioTuple<StdioPipe, StdioPipe, StdioPipe>, | |||
): ChildProcessByStdio<Writable, Readable, Readable>; | |||
function spawn( | |||
command: string, | |||
args: ReadonlyArray<string>, | |||
options: SpawnOptionsWithStdioTuple<StdioPipe, StdioPipe, StdioNull>, | |||
): ChildProcessByStdio<Writable, Readable, null>; | |||
function spawn( | |||
command: string, | |||
args: ReadonlyArray<string>, | |||
options: SpawnOptionsWithStdioTuple<StdioPipe, StdioNull, StdioPipe>, | |||
): ChildProcessByStdio<Writable, null, Readable>; | |||
function spawn( | |||
command: string, | |||
args: ReadonlyArray<string>, | |||
options: SpawnOptionsWithStdioTuple<StdioNull, StdioPipe, StdioPipe>, | |||
): ChildProcessByStdio<null, Readable, Readable>; | |||
function spawn( | |||
command: string, | |||
args: ReadonlyArray<string>, | |||
options: SpawnOptionsWithStdioTuple<StdioPipe, StdioNull, StdioNull>, | |||
): ChildProcessByStdio<Writable, null, null>; | |||
function spawn( | |||
command: string, | |||
args: ReadonlyArray<string>, | |||
options: SpawnOptionsWithStdioTuple<StdioNull, StdioPipe, StdioNull>, | |||
): ChildProcessByStdio<null, Readable, null>; | |||
function spawn( | |||
command: string, | |||
args: ReadonlyArray<string>, | |||
options: SpawnOptionsWithStdioTuple<StdioNull, StdioNull, StdioPipe>, | |||
): ChildProcessByStdio<null, null, Readable>; | |||
function spawn( | |||
command: string, | |||
args: ReadonlyArray<string>, | |||
options: SpawnOptionsWithStdioTuple<StdioNull, StdioNull, StdioNull>, | |||
): ChildProcessByStdio<null, null, null>; | |||
function spawn(command: string, args: ReadonlyArray<string>, options: SpawnOptions): ChildProcess; | |||
interface ExecOptions extends CommonOptions { | |||
shell?: string; | |||
maxBuffer?: number; | |||
killSignal?: NodeJS.Signals | number; | |||
} | |||
interface ExecOptionsWithStringEncoding extends ExecOptions { | |||
encoding: BufferEncoding; | |||
} | |||
interface ExecOptionsWithBufferEncoding extends ExecOptions { | |||
encoding: BufferEncoding | null; // specify `null`. | |||
} | |||
interface ExecException extends Error { | |||
cmd?: string; | |||
killed?: boolean; | |||
code?: number; | |||
signal?: NodeJS.Signals; | |||
} | |||
// no `options` definitely means stdout/stderr are `string`. | |||
function exec(command: string, callback?: (error: ExecException | null, stdout: string, stderr: string) => void): ChildProcess; | |||
// `options` with `"buffer"` or `null` for `encoding` means stdout/stderr are definitely `Buffer`. | |||
function exec(command: string, options: { encoding: "buffer" | null } & ExecOptions, callback?: (error: ExecException | null, stdout: Buffer, stderr: Buffer) => void): ChildProcess; | |||
// `options` with well known `encoding` means stdout/stderr are definitely `string`. | |||
function exec(command: string, options: { encoding: BufferEncoding } & ExecOptions, callback?: (error: ExecException | null, stdout: string, stderr: string) => void): ChildProcess; | |||
// `options` with an `encoding` whose type is `string` means stdout/stderr could either be `Buffer` or `string`. | |||
// There is no guarantee the `encoding` is unknown as `string` is a superset of `BufferEncoding`. | |||
function exec( | |||
command: string, | |||
options: { encoding: BufferEncoding } & ExecOptions, | |||
callback?: (error: ExecException | null, stdout: string | Buffer, stderr: string | Buffer) => void, | |||
): ChildProcess; | |||
// `options` without an `encoding` means stdout/stderr are definitely `string`. | |||
function exec(command: string, options: ExecOptions, callback?: (error: ExecException | null, stdout: string, stderr: string) => void): ChildProcess; | |||
// fallback if nothing else matches. Worst case is always `string | Buffer`. | |||
function exec( | |||
command: string, | |||
options: (BaseEncodingOptions & ExecOptions) | undefined | null, | |||
callback?: (error: ExecException | null, stdout: string | Buffer, stderr: string | Buffer) => void, | |||
): ChildProcess; | |||
interface PromiseWithChild<T> extends Promise<T> { | |||
child: ChildProcess; | |||
} | |||
// NOTE: This namespace provides design-time support for util.promisify. Exported members do not exist at runtime. | |||
namespace exec { | |||
function __promisify__(command: string): PromiseWithChild<{ stdout: string, stderr: string }>; | |||
function __promisify__(command: string, options: { encoding: "buffer" | null } & ExecOptions): PromiseWithChild<{ stdout: Buffer, stderr: Buffer }>; | |||
function __promisify__(command: string, options: { encoding: BufferEncoding } & ExecOptions): PromiseWithChild<{ stdout: string, stderr: string }>; | |||
function __promisify__(command: string, options: ExecOptions): PromiseWithChild<{ stdout: string, stderr: string }>; | |||
function __promisify__(command: string, options?: (BaseEncodingOptions & ExecOptions) | null): PromiseWithChild<{ stdout: string | Buffer, stderr: string | Buffer }>; | |||
} | |||
interface ExecFileOptions extends CommonOptions { | |||
maxBuffer?: number; | |||
killSignal?: NodeJS.Signals | number; | |||
windowsVerbatimArguments?: boolean; | |||
shell?: boolean | string; | |||
} | |||
interface ExecFileOptionsWithStringEncoding extends ExecFileOptions { | |||
encoding: BufferEncoding; | |||
} | |||
interface ExecFileOptionsWithBufferEncoding extends ExecFileOptions { | |||
encoding: 'buffer' | null; | |||
} | |||
interface ExecFileOptionsWithOtherEncoding extends ExecFileOptions { | |||
encoding: BufferEncoding; | |||
} | |||
function execFile(file: string): ChildProcess; | |||
function execFile(file: string, options: (BaseEncodingOptions & ExecFileOptions) | undefined | null): ChildProcess; | |||
function execFile(file: string, args?: ReadonlyArray<string> | null): ChildProcess; | |||
function execFile(file: string, args: ReadonlyArray<string> | undefined | null, options: (BaseEncodingOptions & ExecFileOptions) | undefined | null): ChildProcess; | |||
// no `options` definitely means stdout/stderr are `string`. | |||
function execFile(file: string, callback: (error: ExecException | null, stdout: string, stderr: string) => void): ChildProcess; | |||
function execFile(file: string, args: ReadonlyArray<string> | undefined | null, callback: (error: ExecException | null, stdout: string, stderr: string) => void): ChildProcess; | |||
// `options` with `"buffer"` or `null` for `encoding` means stdout/stderr are definitely `Buffer`. | |||
function execFile(file: string, options: ExecFileOptionsWithBufferEncoding, callback: (error: ExecException | null, stdout: Buffer, stderr: Buffer) => void): ChildProcess; | |||
function execFile( | |||
file: string, | |||
args: ReadonlyArray<string> | undefined | null, | |||
options: ExecFileOptionsWithBufferEncoding, | |||
callback: (error: ExecException | null, stdout: Buffer, stderr: Buffer) => void, | |||
): ChildProcess; | |||
// `options` with well known `encoding` means stdout/stderr are definitely `string`. | |||
function execFile(file: string, options: ExecFileOptionsWithStringEncoding, callback: (error: ExecException | null, stdout: string, stderr: string) => void): ChildProcess; | |||
function execFile( | |||
file: string, | |||
args: ReadonlyArray<string> | undefined | null, | |||
options: ExecFileOptionsWithStringEncoding, | |||
callback: (error: ExecException | null, stdout: string, stderr: string) => void, | |||
): ChildProcess; | |||
// `options` with an `encoding` whose type is `string` means stdout/stderr could either be `Buffer` or `string`. | |||
// There is no guarantee the `encoding` is unknown as `string` is a superset of `BufferEncoding`. | |||
function execFile( | |||
file: string, | |||
options: ExecFileOptionsWithOtherEncoding, | |||
callback: (error: ExecException | null, stdout: string | Buffer, stderr: string | Buffer) => void, | |||
): ChildProcess; | |||
function execFile( | |||
file: string, | |||
args: ReadonlyArray<string> | undefined | null, | |||
options: ExecFileOptionsWithOtherEncoding, | |||
callback: (error: ExecException | null, stdout: string | Buffer, stderr: string | Buffer) => void, | |||
): ChildProcess; | |||
// `options` without an `encoding` means stdout/stderr are definitely `string`. | |||
function execFile(file: string, options: ExecFileOptions, callback: (error: ExecException | null, stdout: string, stderr: string) => void): ChildProcess; | |||
function execFile( | |||
file: string, | |||
args: ReadonlyArray<string> | undefined | null, | |||
options: ExecFileOptions, | |||
callback: (error: ExecException | null, stdout: string, stderr: string) => void | |||
): ChildProcess; | |||
// fallback if nothing else matches. Worst case is always `string | Buffer`. | |||
function execFile( | |||
file: string, | |||
options: (BaseEncodingOptions & ExecFileOptions) | undefined | null, | |||
callback: ((error: ExecException | null, stdout: string | Buffer, stderr: string | Buffer) => void) | undefined | null, | |||
): ChildProcess; | |||
function execFile( | |||
file: string, | |||
args: ReadonlyArray<string> | undefined | null, | |||
options: (BaseEncodingOptions & ExecFileOptions) | undefined | null, | |||
callback: ((error: ExecException | null, stdout: string | Buffer, stderr: string | Buffer) => void) | undefined | null, | |||
): ChildProcess; | |||
// NOTE: This namespace provides design-time support for util.promisify. Exported members do not exist at runtime. | |||
namespace execFile { | |||
function __promisify__(file: string): PromiseWithChild<{ stdout: string, stderr: string }>; | |||
function __promisify__(file: string, args: string[] | undefined | null): PromiseWithChild<{ stdout: string, stderr: string }>; | |||
function __promisify__(file: string, options: ExecFileOptionsWithBufferEncoding): PromiseWithChild<{ stdout: Buffer, stderr: Buffer }>; | |||
function __promisify__(file: string, args: string[] | undefined | null, options: ExecFileOptionsWithBufferEncoding): PromiseWithChild<{ stdout: Buffer, stderr: Buffer }>; | |||
function __promisify__(file: string, options: ExecFileOptionsWithStringEncoding): PromiseWithChild<{ stdout: string, stderr: string }>; | |||
function __promisify__(file: string, args: string[] | undefined | null, options: ExecFileOptionsWithStringEncoding): PromiseWithChild<{ stdout: string, stderr: string }>; | |||
function __promisify__(file: string, options: ExecFileOptionsWithOtherEncoding): PromiseWithChild<{ stdout: string | Buffer, stderr: string | Buffer }>; | |||
function __promisify__(file: string, args: string[] | undefined | null, options: ExecFileOptionsWithOtherEncoding): PromiseWithChild<{ stdout: string | Buffer, stderr: string | Buffer }>; | |||
function __promisify__(file: string, options: ExecFileOptions): PromiseWithChild<{ stdout: string, stderr: string }>; | |||
function __promisify__(file: string, args: string[] | undefined | null, options: ExecFileOptions): PromiseWithChild<{ stdout: string, stderr: string }>; | |||
function __promisify__(file: string, options: (BaseEncodingOptions & ExecFileOptions) | undefined | null): PromiseWithChild<{ stdout: string | Buffer, stderr: string | Buffer }>; | |||
function __promisify__( | |||
file: string, | |||
args: string[] | undefined | null, | |||
options: (BaseEncodingOptions & ExecFileOptions) | undefined | null, | |||
): PromiseWithChild<{ stdout: string | Buffer, stderr: string | Buffer }>; | |||
} | |||
interface ForkOptions extends ProcessEnvOptions, MessagingOptions { | |||
execPath?: string; | |||
execArgv?: string[]; | |||
silent?: boolean; | |||
stdio?: StdioOptions; | |||
detached?: boolean; | |||
windowsVerbatimArguments?: boolean; | |||
} | |||
function fork(modulePath: string, args?: ReadonlyArray<string>, options?: ForkOptions): ChildProcess; | |||
interface SpawnSyncOptions extends CommonSpawnOptions { | |||
input?: string | NodeJS.ArrayBufferView; | |||
killSignal?: NodeJS.Signals | number; | |||
maxBuffer?: number; | |||
encoding?: BufferEncoding; | |||
} | |||
interface SpawnSyncOptionsWithStringEncoding extends SpawnSyncOptions { | |||
encoding: BufferEncoding; | |||
} | |||
interface SpawnSyncOptionsWithBufferEncoding extends SpawnSyncOptions { | |||
encoding: BufferEncoding; // specify `null`. | |||
} | |||
interface SpawnSyncReturns<T> { | |||
pid: number; | |||
output: string[]; | |||
stdout: T; | |||
stderr: T; | |||
status: number | null; | |||
signal: NodeJS.Signals | null; | |||
error?: Error; | |||
} | |||
function spawnSync(command: string): SpawnSyncReturns<Buffer>; | |||
function spawnSync(command: string, options?: SpawnSyncOptionsWithStringEncoding): SpawnSyncReturns<string>; | |||
function spawnSync(command: string, options?: SpawnSyncOptionsWithBufferEncoding): SpawnSyncReturns<Buffer>; | |||
function spawnSync(command: string, options?: SpawnSyncOptions): SpawnSyncReturns<Buffer>; | |||
function spawnSync(command: string, args?: ReadonlyArray<string>, options?: SpawnSyncOptionsWithStringEncoding): SpawnSyncReturns<string>; | |||
function spawnSync(command: string, args?: ReadonlyArray<string>, options?: SpawnSyncOptionsWithBufferEncoding): SpawnSyncReturns<Buffer>; | |||
function spawnSync(command: string, args?: ReadonlyArray<string>, options?: SpawnSyncOptions): SpawnSyncReturns<Buffer>; | |||
interface ExecSyncOptions extends CommonOptions { | |||
input?: string | Uint8Array; | |||
stdio?: StdioOptions; | |||
shell?: string; | |||
killSignal?: NodeJS.Signals | number; | |||
maxBuffer?: number; | |||
encoding?: BufferEncoding; | |||
} | |||
interface ExecSyncOptionsWithStringEncoding extends ExecSyncOptions { | |||
encoding: BufferEncoding; | |||
} | |||
interface ExecSyncOptionsWithBufferEncoding extends ExecSyncOptions { | |||
encoding: BufferEncoding; // specify `null`. | |||
} | |||
function execSync(command: string): Buffer; | |||
function execSync(command: string, options?: ExecSyncOptionsWithStringEncoding): string; | |||
function execSync(command: string, options?: ExecSyncOptionsWithBufferEncoding): Buffer; | |||
function execSync(command: string, options?: ExecSyncOptions): Buffer; | |||
interface ExecFileSyncOptions extends CommonOptions { | |||
input?: string | NodeJS.ArrayBufferView; | |||
stdio?: StdioOptions; | |||
killSignal?: NodeJS.Signals | number; | |||
maxBuffer?: number; | |||
encoding?: BufferEncoding; | |||
shell?: boolean | string; | |||
} | |||
interface ExecFileSyncOptionsWithStringEncoding extends ExecFileSyncOptions { | |||
encoding: BufferEncoding; | |||
} | |||
interface ExecFileSyncOptionsWithBufferEncoding extends ExecFileSyncOptions { | |||
encoding: BufferEncoding; // specify `null`. | |||
} | |||
function execFileSync(command: string): Buffer; | |||
function execFileSync(command: string, options?: ExecFileSyncOptionsWithStringEncoding): string; | |||
function execFileSync(command: string, options?: ExecFileSyncOptionsWithBufferEncoding): Buffer; | |||
function execFileSync(command: string, options?: ExecFileSyncOptions): Buffer; | |||
function execFileSync(command: string, args?: ReadonlyArray<string>, options?: ExecFileSyncOptionsWithStringEncoding): string; | |||
function execFileSync(command: string, args?: ReadonlyArray<string>, options?: ExecFileSyncOptionsWithBufferEncoding): Buffer; | |||
function execFileSync(command: string, args?: ReadonlyArray<string>, options?: ExecFileSyncOptions): Buffer; | |||
} |
@@ -0,0 +1,262 @@ | |||
declare module "cluster" { | |||
import * as child from "child_process"; | |||
import * as events from "events"; | |||
import * as net from "net"; | |||
// interfaces | |||
interface ClusterSettings { | |||
execArgv?: string[]; // default: process.execArgv | |||
exec?: string; | |||
args?: string[]; | |||
silent?: boolean; | |||
stdio?: any[]; | |||
uid?: number; | |||
gid?: number; | |||
inspectPort?: number | (() => number); | |||
} | |||
interface Address { | |||
address: string; | |||
port: number; | |||
addressType: number | "udp4" | "udp6"; // 4, 6, -1, "udp4", "udp6" | |||
} | |||
class Worker extends events.EventEmitter { | |||
id: number; | |||
process: child.ChildProcess; | |||
send(message: child.Serializable, sendHandle?: child.SendHandle, callback?: (error: Error | null) => void): boolean; | |||
kill(signal?: string): void; | |||
destroy(signal?: string): void; | |||
disconnect(): void; | |||
isConnected(): boolean; | |||
isDead(): boolean; | |||
exitedAfterDisconnect: boolean; | |||
/** | |||
* events.EventEmitter | |||
* 1. disconnect | |||
* 2. error | |||
* 3. exit | |||
* 4. listening | |||
* 5. message | |||
* 6. online | |||
*/ | |||
addListener(event: string, listener: (...args: any[]) => void): this; | |||
addListener(event: "disconnect", listener: () => void): this; | |||
addListener(event: "error", listener: (error: Error) => void): this; | |||
addListener(event: "exit", listener: (code: number, signal: string) => void): this; | |||
addListener(event: "listening", listener: (address: Address) => void): this; | |||
addListener(event: "message", listener: (message: any, handle: net.Socket | net.Server) => void): this; // the handle is a net.Socket or net.Server object, or undefined. | |||
addListener(event: "online", listener: () => void): this; | |||
emit(event: string | symbol, ...args: any[]): boolean; | |||
emit(event: "disconnect"): boolean; | |||
emit(event: "error", error: Error): boolean; | |||
emit(event: "exit", code: number, signal: string): boolean; | |||
emit(event: "listening", address: Address): boolean; | |||
emit(event: "message", message: any, handle: net.Socket | net.Server): boolean; | |||
emit(event: "online"): boolean; | |||
on(event: string, listener: (...args: any[]) => void): this; | |||
on(event: "disconnect", listener: () => void): this; | |||
on(event: "error", listener: (error: Error) => void): this; | |||
on(event: "exit", listener: (code: number, signal: string) => void): this; | |||
on(event: "listening", listener: (address: Address) => void): this; | |||
on(event: "message", listener: (message: any, handle: net.Socket | net.Server) => void): this; // the handle is a net.Socket or net.Server object, or undefined. | |||
on(event: "online", listener: () => void): this; | |||
once(event: string, listener: (...args: any[]) => void): this; | |||
once(event: "disconnect", listener: () => void): this; | |||
once(event: "error", listener: (error: Error) => void): this; | |||
once(event: "exit", listener: (code: number, signal: string) => void): this; | |||
once(event: "listening", listener: (address: Address) => void): this; | |||
once(event: "message", listener: (message: any, handle: net.Socket | net.Server) => void): this; // the handle is a net.Socket or net.Server object, or undefined. | |||
once(event: "online", listener: () => void): this; | |||
prependListener(event: string, listener: (...args: any[]) => void): this; | |||
prependListener(event: "disconnect", listener: () => void): this; | |||
prependListener(event: "error", listener: (error: Error) => void): this; | |||
prependListener(event: "exit", listener: (code: number, signal: string) => void): this; | |||
prependListener(event: "listening", listener: (address: Address) => void): this; | |||
prependListener(event: "message", listener: (message: any, handle: net.Socket | net.Server) => void): this; // the handle is a net.Socket or net.Server object, or undefined. | |||
prependListener(event: "online", listener: () => void): this; | |||
prependOnceListener(event: string, listener: (...args: any[]) => void): this; | |||
prependOnceListener(event: "disconnect", listener: () => void): this; | |||
prependOnceListener(event: "error", listener: (error: Error) => void): this; | |||
prependOnceListener(event: "exit", listener: (code: number, signal: string) => void): this; | |||
prependOnceListener(event: "listening", listener: (address: Address) => void): this; | |||
prependOnceListener(event: "message", listener: (message: any, handle: net.Socket | net.Server) => void): this; // the handle is a net.Socket or net.Server object, or undefined. | |||
prependOnceListener(event: "online", listener: () => void): this; | |||
} | |||
interface Cluster extends events.EventEmitter { | |||
Worker: Worker; | |||
disconnect(callback?: () => void): void; | |||
fork(env?: any): Worker; | |||
isMaster: boolean; | |||
isWorker: boolean; | |||
schedulingPolicy: number; | |||
settings: ClusterSettings; | |||
setupMaster(settings?: ClusterSettings): void; | |||
worker?: Worker; | |||
workers?: NodeJS.Dict<Worker>; | |||
readonly SCHED_NONE: number; | |||
readonly SCHED_RR: number; | |||
/** | |||
* events.EventEmitter | |||
* 1. disconnect | |||
* 2. exit | |||
* 3. fork | |||
* 4. listening | |||
* 5. message | |||
* 6. online | |||
* 7. setup | |||
*/ | |||
addListener(event: string, listener: (...args: any[]) => void): this; | |||
addListener(event: "disconnect", listener: (worker: Worker) => void): this; | |||
addListener(event: "exit", listener: (worker: Worker, code: number, signal: string) => void): this; | |||
addListener(event: "fork", listener: (worker: Worker) => void): this; | |||
addListener(event: "listening", listener: (worker: Worker, address: Address) => void): this; | |||
addListener(event: "message", listener: (worker: Worker, message: any, handle: net.Socket | net.Server) => void): this; // the handle is a net.Socket or net.Server object, or undefined. | |||
addListener(event: "online", listener: (worker: Worker) => void): this; | |||
addListener(event: "setup", listener: (settings: ClusterSettings) => void): this; | |||
emit(event: string | symbol, ...args: any[]): boolean; | |||
emit(event: "disconnect", worker: Worker): boolean; | |||
emit(event: "exit", worker: Worker, code: number, signal: string): boolean; | |||
emit(event: "fork", worker: Worker): boolean; | |||
emit(event: "listening", worker: Worker, address: Address): boolean; | |||
emit(event: "message", worker: Worker, message: any, handle: net.Socket | net.Server): boolean; | |||
emit(event: "online", worker: Worker): boolean; | |||
emit(event: "setup", settings: ClusterSettings): boolean; | |||
on(event: string, listener: (...args: any[]) => void): this; | |||
on(event: "disconnect", listener: (worker: Worker) => void): this; | |||
on(event: "exit", listener: (worker: Worker, code: number, signal: string) => void): this; | |||
on(event: "fork", listener: (worker: Worker) => void): this; | |||
on(event: "listening", listener: (worker: Worker, address: Address) => void): this; | |||
on(event: "message", listener: (worker: Worker, message: any, handle: net.Socket | net.Server) => void): this; // the handle is a net.Socket or net.Server object, or undefined. | |||
on(event: "online", listener: (worker: Worker) => void): this; | |||
on(event: "setup", listener: (settings: ClusterSettings) => void): this; | |||
once(event: string, listener: (...args: any[]) => void): this; | |||
once(event: "disconnect", listener: (worker: Worker) => void): this; | |||
once(event: "exit", listener: (worker: Worker, code: number, signal: string) => void): this; | |||
once(event: "fork", listener: (worker: Worker) => void): this; | |||
once(event: "listening", listener: (worker: Worker, address: Address) => void): this; | |||
once(event: "message", listener: (worker: Worker, message: any, handle: net.Socket | net.Server) => void): this; // the handle is a net.Socket or net.Server object, or undefined. | |||
once(event: "online", listener: (worker: Worker) => void): this; | |||
once(event: "setup", listener: (settings: ClusterSettings) => void): this; | |||
prependListener(event: string, listener: (...args: any[]) => void): this; | |||
prependListener(event: "disconnect", listener: (worker: Worker) => void): this; | |||
prependListener(event: "exit", listener: (worker: Worker, code: number, signal: string) => void): this; | |||
prependListener(event: "fork", listener: (worker: Worker) => void): this; | |||
prependListener(event: "listening", listener: (worker: Worker, address: Address) => void): this; | |||
prependListener(event: "message", listener: (worker: Worker, message: any, handle: net.Socket | net.Server) => void): this; // the handle is a net.Socket or net.Server object, or undefined. | |||
prependListener(event: "online", listener: (worker: Worker) => void): this; | |||
prependListener(event: "setup", listener: (settings: ClusterSettings) => void): this; | |||
prependOnceListener(event: string, listener: (...args: any[]) => void): this; | |||
prependOnceListener(event: "disconnect", listener: (worker: Worker) => void): this; | |||
prependOnceListener(event: "exit", listener: (worker: Worker, code: number, signal: string) => void): this; | |||
prependOnceListener(event: "fork", listener: (worker: Worker) => void): this; | |||
prependOnceListener(event: "listening", listener: (worker: Worker, address: Address) => void): this; | |||
// the handle is a net.Socket or net.Server object, or undefined. | |||
prependOnceListener(event: "message", listener: (worker: Worker, message: any, handle: net.Socket | net.Server) => void): this; | |||
prependOnceListener(event: "online", listener: (worker: Worker) => void): this; | |||
prependOnceListener(event: "setup", listener: (settings: ClusterSettings) => void): this; | |||
} | |||
const SCHED_NONE: number; | |||
const SCHED_RR: number; | |||
function disconnect(callback?: () => void): void; | |||
function fork(env?: any): Worker; | |||
const isMaster: boolean; | |||
const isWorker: boolean; | |||
let schedulingPolicy: number; | |||
const settings: ClusterSettings; | |||
function setupMaster(settings?: ClusterSettings): void; | |||
const worker: Worker; | |||
const workers: NodeJS.Dict<Worker>; | |||
/** | |||
* events.EventEmitter | |||
* 1. disconnect | |||
* 2. exit | |||
* 3. fork | |||
* 4. listening | |||
* 5. message | |||
* 6. online | |||
* 7. setup | |||
*/ | |||
function addListener(event: string, listener: (...args: any[]) => void): Cluster; | |||
function addListener(event: "disconnect", listener: (worker: Worker) => void): Cluster; | |||
function addListener(event: "exit", listener: (worker: Worker, code: number, signal: string) => void): Cluster; | |||
function addListener(event: "fork", listener: (worker: Worker) => void): Cluster; | |||
function addListener(event: "listening", listener: (worker: Worker, address: Address) => void): Cluster; | |||
// the handle is a net.Socket or net.Server object, or undefined. | |||
function addListener(event: "message", listener: (worker: Worker, message: any, handle: net.Socket | net.Server) => void): Cluster; | |||
function addListener(event: "online", listener: (worker: Worker) => void): Cluster; | |||
function addListener(event: "setup", listener: (settings: ClusterSettings) => void): Cluster; | |||
function emit(event: string | symbol, ...args: any[]): boolean; | |||
function emit(event: "disconnect", worker: Worker): boolean; | |||
function emit(event: "exit", worker: Worker, code: number, signal: string): boolean; | |||
function emit(event: "fork", worker: Worker): boolean; | |||
function emit(event: "listening", worker: Worker, address: Address): boolean; | |||
function emit(event: "message", worker: Worker, message: any, handle: net.Socket | net.Server): boolean; | |||
function emit(event: "online", worker: Worker): boolean; | |||
function emit(event: "setup", settings: ClusterSettings): boolean; | |||
function on(event: string, listener: (...args: any[]) => void): Cluster; | |||
function on(event: "disconnect", listener: (worker: Worker) => void): Cluster; | |||
function on(event: "exit", listener: (worker: Worker, code: number, signal: string) => void): Cluster; | |||
function on(event: "fork", listener: (worker: Worker) => void): Cluster; | |||
function on(event: "listening", listener: (worker: Worker, address: Address) => void): Cluster; | |||
function on(event: "message", listener: (worker: Worker, message: any, handle: net.Socket | net.Server) => void): Cluster; // the handle is a net.Socket or net.Server object, or undefined. | |||
function on(event: "online", listener: (worker: Worker) => void): Cluster; | |||
function on(event: "setup", listener: (settings: ClusterSettings) => void): Cluster; | |||
function once(event: string, listener: (...args: any[]) => void): Cluster; | |||
function once(event: "disconnect", listener: (worker: Worker) => void): Cluster; | |||
function once(event: "exit", listener: (worker: Worker, code: number, signal: string) => void): Cluster; | |||
function once(event: "fork", listener: (worker: Worker) => void): Cluster; | |||
function once(event: "listening", listener: (worker: Worker, address: Address) => void): Cluster; | |||
function once(event: "message", listener: (worker: Worker, message: any, handle: net.Socket | net.Server) => void): Cluster; // the handle is a net.Socket or net.Server object, or undefined. | |||
function once(event: "online", listener: (worker: Worker) => void): Cluster; | |||
function once(event: "setup", listener: (settings: ClusterSettings) => void): Cluster; | |||
function removeListener(event: string, listener: (...args: any[]) => void): Cluster; | |||
function removeAllListeners(event?: string): Cluster; | |||
function setMaxListeners(n: number): Cluster; | |||
function getMaxListeners(): number; | |||
function listeners(event: string): Function[]; | |||
function listenerCount(type: string): number; | |||
function prependListener(event: string, listener: (...args: any[]) => void): Cluster; | |||
function prependListener(event: "disconnect", listener: (worker: Worker) => void): Cluster; | |||
function prependListener(event: "exit", listener: (worker: Worker, code: number, signal: string) => void): Cluster; | |||
function prependListener(event: "fork", listener: (worker: Worker) => void): Cluster; | |||
function prependListener(event: "listening", listener: (worker: Worker, address: Address) => void): Cluster; | |||
// the handle is a net.Socket or net.Server object, or undefined. | |||
function prependListener(event: "message", listener: (worker: Worker, message: any, handle: net.Socket | net.Server) => void): Cluster; | |||
function prependListener(event: "online", listener: (worker: Worker) => void): Cluster; | |||
function prependListener(event: "setup", listener: (settings: ClusterSettings) => void): Cluster; | |||
function prependOnceListener(event: string, listener: (...args: any[]) => void): Cluster; | |||
function prependOnceListener(event: "disconnect", listener: (worker: Worker) => void): Cluster; | |||
function prependOnceListener(event: "exit", listener: (worker: Worker, code: number, signal: string) => void): Cluster; | |||
function prependOnceListener(event: "fork", listener: (worker: Worker) => void): Cluster; | |||
function prependOnceListener(event: "listening", listener: (worker: Worker, address: Address) => void): Cluster; | |||
// the handle is a net.Socket or net.Server object, or undefined. | |||
function prependOnceListener(event: "message", listener: (worker: Worker, message: any, handle: net.Socket | net.Server) => void): Cluster; | |||
function prependOnceListener(event: "online", listener: (worker: Worker) => void): Cluster; | |||
function prependOnceListener(event: "setup", listener: (settings: ClusterSettings) => void): Cluster; | |||
function eventNames(): string[]; | |||
} |
@@ -0,0 +1,3 @@ | |||
declare module "console" { | |||
export = console; | |||
} |
@@ -0,0 +1,8 @@ | |||
/** @deprecated since v6.3.0 - use constants property exposed by the relevant module instead. */ | |||
declare module "constants" { | |||
import { constants as osConstants, SignalConstants } from 'os'; | |||
import { constants as cryptoConstants } from 'crypto'; | |||
import { constants as fsConstants } from 'fs'; | |||
const exp: typeof osConstants.errno & typeof osConstants.priority & SignalConstants & typeof cryptoConstants & typeof fsConstants; | |||
export = exp; | |||
} |
@@ -0,0 +1,615 @@ | |||
declare module "crypto" { | |||
import * as stream from "stream"; | |||
interface Certificate { | |||
exportChallenge(spkac: BinaryLike): Buffer; | |||
exportPublicKey(spkac: BinaryLike): Buffer; | |||
verifySpkac(spkac: NodeJS.ArrayBufferView): boolean; | |||
} | |||
const Certificate: { | |||
new(): Certificate; | |||
(): Certificate; | |||
}; | |||
namespace constants { // https://nodejs.org/dist/latest-v10.x/docs/api/crypto.html#crypto_crypto_constants | |||
const OPENSSL_VERSION_NUMBER: number; | |||
/** Applies multiple bug workarounds within OpenSSL. See https://www.openssl.org/docs/man1.0.2/ssl/SSL_CTX_set_options.html for detail. */ | |||
const SSL_OP_ALL: number; | |||
/** Allows legacy insecure renegotiation between OpenSSL and unpatched clients or servers. See https://www.openssl.org/docs/man1.0.2/ssl/SSL_CTX_set_options.html. */ | |||
const SSL_OP_ALLOW_UNSAFE_LEGACY_RENEGOTIATION: number; | |||
/** Attempts to use the server's preferences instead of the client's when selecting a cipher. See https://www.openssl.org/docs/man1.0.2/ssl/SSL_CTX_set_options.html. */ | |||
const SSL_OP_CIPHER_SERVER_PREFERENCE: number; | |||
/** Instructs OpenSSL to use Cisco's "speshul" version of DTLS_BAD_VER. */ | |||
const SSL_OP_CISCO_ANYCONNECT: number; | |||
/** Instructs OpenSSL to turn on cookie exchange. */ | |||
const SSL_OP_COOKIE_EXCHANGE: number; | |||
/** Instructs OpenSSL to add server-hello extension from an early version of the cryptopro draft. */ | |||
const SSL_OP_CRYPTOPRO_TLSEXT_BUG: number; | |||
/** Instructs OpenSSL to disable a SSL 3.0/TLS 1.0 vulnerability workaround added in OpenSSL 0.9.6d. */ | |||
const SSL_OP_DONT_INSERT_EMPTY_FRAGMENTS: number; | |||
/** Instructs OpenSSL to always use the tmp_rsa key when performing RSA operations. */ | |||
const SSL_OP_EPHEMERAL_RSA: number; | |||
/** Allows initial connection to servers that do not support RI. */ | |||
const SSL_OP_LEGACY_SERVER_CONNECT: number; | |||
const SSL_OP_MICROSOFT_BIG_SSLV3_BUFFER: number; | |||
const SSL_OP_MICROSOFT_SESS_ID_BUG: number; | |||
/** Instructs OpenSSL to disable the workaround for a man-in-the-middle protocol-version vulnerability in the SSL 2.0 server implementation. */ | |||
const SSL_OP_MSIE_SSLV2_RSA_PADDING: number; | |||
const SSL_OP_NETSCAPE_CA_DN_BUG: number; | |||
const SSL_OP_NETSCAPE_CHALLENGE_BUG: number; | |||
const SSL_OP_NETSCAPE_DEMO_CIPHER_CHANGE_BUG: number; | |||
const SSL_OP_NETSCAPE_REUSE_CIPHER_CHANGE_BUG: number; | |||
/** Instructs OpenSSL to disable support for SSL/TLS compression. */ | |||
const SSL_OP_NO_COMPRESSION: number; | |||
const SSL_OP_NO_QUERY_MTU: number; | |||
/** Instructs OpenSSL to always start a new session when performing renegotiation. */ | |||
const SSL_OP_NO_SESSION_RESUMPTION_ON_RENEGOTIATION: number; | |||
const SSL_OP_NO_SSLv2: number; | |||
const SSL_OP_NO_SSLv3: number; | |||
const SSL_OP_NO_TICKET: number; | |||
const SSL_OP_NO_TLSv1: number; | |||
const SSL_OP_NO_TLSv1_1: number; | |||
const SSL_OP_NO_TLSv1_2: number; | |||
const SSL_OP_PKCS1_CHECK_1: number; | |||
const SSL_OP_PKCS1_CHECK_2: number; | |||
/** Instructs OpenSSL to always create a new key when using temporary/ephemeral DH parameters. */ | |||
const SSL_OP_SINGLE_DH_USE: number; | |||
/** Instructs OpenSSL to always create a new key when using temporary/ephemeral ECDH parameters. */ | |||
const SSL_OP_SINGLE_ECDH_USE: number; | |||
const SSL_OP_SSLEAY_080_CLIENT_DH_BUG: number; | |||
const SSL_OP_SSLREF2_REUSE_CERT_TYPE_BUG: number; | |||
const SSL_OP_TLS_BLOCK_PADDING_BUG: number; | |||
const SSL_OP_TLS_D5_BUG: number; | |||
/** Instructs OpenSSL to disable version rollback attack detection. */ | |||
const SSL_OP_TLS_ROLLBACK_BUG: number; | |||
const ENGINE_METHOD_RSA: number; | |||
const ENGINE_METHOD_DSA: number; | |||
const ENGINE_METHOD_DH: number; | |||
const ENGINE_METHOD_RAND: number; | |||
const ENGINE_METHOD_EC: number; | |||
const ENGINE_METHOD_CIPHERS: number; | |||
const ENGINE_METHOD_DIGESTS: number; | |||
const ENGINE_METHOD_PKEY_METHS: number; | |||
const ENGINE_METHOD_PKEY_ASN1_METHS: number; | |||
const ENGINE_METHOD_ALL: number; | |||
const ENGINE_METHOD_NONE: number; | |||
const DH_CHECK_P_NOT_SAFE_PRIME: number; | |||
const DH_CHECK_P_NOT_PRIME: number; | |||
const DH_UNABLE_TO_CHECK_GENERATOR: number; | |||
const DH_NOT_SUITABLE_GENERATOR: number; | |||
const ALPN_ENABLED: number; | |||
const RSA_PKCS1_PADDING: number; | |||
const RSA_SSLV23_PADDING: number; | |||
const RSA_NO_PADDING: number; | |||
const RSA_PKCS1_OAEP_PADDING: number; | |||
const RSA_X931_PADDING: number; | |||
const RSA_PKCS1_PSS_PADDING: number; | |||
/** Sets the salt length for RSA_PKCS1_PSS_PADDING to the digest size when signing or verifying. */ | |||
const RSA_PSS_SALTLEN_DIGEST: number; | |||
/** Sets the salt length for RSA_PKCS1_PSS_PADDING to the maximum permissible value when signing data. */ | |||
const RSA_PSS_SALTLEN_MAX_SIGN: number; | |||
/** Causes the salt length for RSA_PKCS1_PSS_PADDING to be determined automatically when verifying a signature. */ | |||
const RSA_PSS_SALTLEN_AUTO: number; | |||
const POINT_CONVERSION_COMPRESSED: number; | |||
const POINT_CONVERSION_UNCOMPRESSED: number; | |||
const POINT_CONVERSION_HYBRID: number; | |||
/** Specifies the built-in default cipher list used by Node.js (colon-separated values). */ | |||
const defaultCoreCipherList: string; | |||
/** Specifies the active default cipher list used by the current Node.js process (colon-separated values). */ | |||
const defaultCipherList: string; | |||
} | |||
interface HashOptions extends stream.TransformOptions { | |||
/** | |||
* For XOF hash functions such as `shake256`, the | |||
* outputLength option can be used to specify the desired output length in bytes. | |||
*/ | |||
outputLength?: number; | |||
} | |||
/** @deprecated since v10.0.0 */ | |||
const fips: boolean; | |||
function createHash(algorithm: string, options?: HashOptions): Hash; | |||
function createHmac(algorithm: string, key: BinaryLike | KeyObject, options?: stream.TransformOptions): Hmac; | |||
type Utf8AsciiLatin1Encoding = "utf8" | "ascii" | "latin1"; | |||
type HexBase64Latin1Encoding = "latin1" | "hex" | "base64"; | |||
type Utf8AsciiBinaryEncoding = "utf8" | "ascii" | "binary"; | |||
type HexBase64BinaryEncoding = "binary" | "base64" | "hex"; | |||
type ECDHKeyFormat = "compressed" | "uncompressed" | "hybrid"; | |||
class Hash extends stream.Transform { | |||
private constructor(); | |||
copy(): Hash; | |||
update(data: BinaryLike): Hash; | |||
update(data: string, input_encoding: Utf8AsciiLatin1Encoding): Hash; | |||
digest(): Buffer; | |||
digest(encoding: HexBase64Latin1Encoding): string; | |||
} | |||
class Hmac extends stream.Transform { | |||
private constructor(); | |||
update(data: BinaryLike): Hmac; | |||
update(data: string, input_encoding: Utf8AsciiLatin1Encoding): Hmac; | |||
digest(): Buffer; | |||
digest(encoding: HexBase64Latin1Encoding): string; | |||
} | |||
type KeyObjectType = 'secret' | 'public' | 'private'; | |||
interface KeyExportOptions<T extends KeyFormat> { | |||
type: 'pkcs1' | 'spki' | 'pkcs8' | 'sec1'; | |||
format: T; | |||
cipher?: string; | |||
passphrase?: string | Buffer; | |||
} | |||
class KeyObject { | |||
private constructor(); | |||
asymmetricKeyType?: KeyType; | |||
/** | |||
* For asymmetric keys, this property represents the size of the embedded key in | |||
* bytes. This property is `undefined` for symmetric keys. | |||
*/ | |||
asymmetricKeySize?: number; | |||
export(options: KeyExportOptions<'pem'>): string | Buffer; | |||
export(options?: KeyExportOptions<'der'>): Buffer; | |||
symmetricKeySize?: number; | |||
type: KeyObjectType; | |||
} | |||
type CipherCCMTypes = 'aes-128-ccm' | 'aes-192-ccm' | 'aes-256-ccm' | 'chacha20-poly1305'; | |||
type CipherGCMTypes = 'aes-128-gcm' | 'aes-192-gcm' | 'aes-256-gcm'; | |||
type BinaryLike = string | NodeJS.ArrayBufferView; | |||
type CipherKey = BinaryLike | KeyObject; | |||
interface CipherCCMOptions extends stream.TransformOptions { | |||
authTagLength: number; | |||
} | |||
interface CipherGCMOptions extends stream.TransformOptions { | |||
authTagLength?: number; | |||
} | |||
/** @deprecated since v10.0.0 use createCipheriv() */ | |||
function createCipher(algorithm: CipherCCMTypes, password: BinaryLike, options: CipherCCMOptions): CipherCCM; | |||
/** @deprecated since v10.0.0 use createCipheriv() */ | |||
function createCipher(algorithm: CipherGCMTypes, password: BinaryLike, options?: CipherGCMOptions): CipherGCM; | |||
/** @deprecated since v10.0.0 use createCipheriv() */ | |||
function createCipher(algorithm: string, password: BinaryLike, options?: stream.TransformOptions): Cipher; | |||
function createCipheriv( | |||
algorithm: CipherCCMTypes, | |||
key: CipherKey, | |||
iv: BinaryLike | null, | |||
options: CipherCCMOptions | |||
): CipherCCM; | |||
function createCipheriv( | |||
algorithm: CipherGCMTypes, | |||
key: CipherKey, | |||
iv: BinaryLike | null, | |||
options?: CipherGCMOptions | |||
): CipherGCM; | |||
function createCipheriv( | |||
algorithm: string, key: CipherKey, iv: BinaryLike | null, options?: stream.TransformOptions | |||
): Cipher; | |||
class Cipher extends stream.Transform { | |||
private constructor(); | |||
update(data: BinaryLike): Buffer; | |||
update(data: string, input_encoding: Utf8AsciiBinaryEncoding): Buffer; | |||
update(data: NodeJS.ArrayBufferView, input_encoding: undefined, output_encoding: HexBase64BinaryEncoding): string; | |||
update(data: string, input_encoding: Utf8AsciiBinaryEncoding | undefined, output_encoding: HexBase64BinaryEncoding): string; | |||
final(): Buffer; | |||
final(output_encoding: BufferEncoding): string; | |||
setAutoPadding(auto_padding?: boolean): this; | |||
// getAuthTag(): Buffer; | |||
// setAAD(buffer: Buffer): this; // docs only say buffer | |||
} | |||
interface CipherCCM extends Cipher { | |||
setAAD(buffer: Buffer, options: { plaintextLength: number }): this; | |||
getAuthTag(): Buffer; | |||
} | |||
interface CipherGCM extends Cipher { | |||
setAAD(buffer: Buffer, options?: { plaintextLength: number }): this; | |||
getAuthTag(): Buffer; | |||
} | |||
/** @deprecated since v10.0.0 use createDecipheriv() */ | |||
function createDecipher(algorithm: CipherCCMTypes, password: BinaryLike, options: CipherCCMOptions): DecipherCCM; | |||
/** @deprecated since v10.0.0 use createDecipheriv() */ | |||
function createDecipher(algorithm: CipherGCMTypes, password: BinaryLike, options?: CipherGCMOptions): DecipherGCM; | |||
/** @deprecated since v10.0.0 use createDecipheriv() */ | |||
function createDecipher(algorithm: string, password: BinaryLike, options?: stream.TransformOptions): Decipher; | |||
function createDecipheriv( | |||
algorithm: CipherCCMTypes, | |||
key: CipherKey, | |||
iv: BinaryLike | null, | |||
options: CipherCCMOptions, | |||
): DecipherCCM; | |||
function createDecipheriv( | |||
algorithm: CipherGCMTypes, | |||
key: CipherKey, | |||
iv: BinaryLike | null, | |||
options?: CipherGCMOptions, | |||
): DecipherGCM; | |||
function createDecipheriv(algorithm: string, key: CipherKey, iv: BinaryLike | null, options?: stream.TransformOptions): Decipher; | |||
class Decipher extends stream.Transform { | |||
private constructor(); | |||
update(data: NodeJS.ArrayBufferView): Buffer; | |||
update(data: string, input_encoding: HexBase64BinaryEncoding): Buffer; | |||
update(data: NodeJS.ArrayBufferView, input_encoding: HexBase64BinaryEncoding | undefined, output_encoding: Utf8AsciiBinaryEncoding): string; | |||
update(data: string, input_encoding: HexBase64BinaryEncoding | undefined, output_encoding: Utf8AsciiBinaryEncoding): string; | |||
final(): Buffer; | |||
final(output_encoding: BufferEncoding): string; | |||
setAutoPadding(auto_padding?: boolean): this; | |||
// setAuthTag(tag: NodeJS.ArrayBufferView): this; | |||
// setAAD(buffer: NodeJS.ArrayBufferView): this; | |||
} | |||
interface DecipherCCM extends Decipher { | |||
setAuthTag(buffer: NodeJS.ArrayBufferView): this; | |||
setAAD(buffer: NodeJS.ArrayBufferView, options: { plaintextLength: number }): this; | |||
} | |||
interface DecipherGCM extends Decipher { | |||
setAuthTag(buffer: NodeJS.ArrayBufferView): this; | |||
setAAD(buffer: NodeJS.ArrayBufferView, options?: { plaintextLength: number }): this; | |||
} | |||
interface PrivateKeyInput { | |||
key: string | Buffer; | |||
format?: KeyFormat; | |||
type?: 'pkcs1' | 'pkcs8' | 'sec1'; | |||
passphrase?: string | Buffer; | |||
} | |||
interface PublicKeyInput { | |||
key: string | Buffer; | |||
format?: KeyFormat; | |||
type?: 'pkcs1' | 'spki'; | |||
} | |||
function createPrivateKey(key: PrivateKeyInput | string | Buffer): KeyObject; | |||
function createPublicKey(key: PublicKeyInput | string | Buffer | KeyObject): KeyObject; | |||
function createSecretKey(key: Buffer): KeyObject; | |||
function createSign(algorithm: string, options?: stream.WritableOptions): Signer; | |||
interface SigningOptions { | |||
/** | |||
* @See crypto.constants.RSA_PKCS1_PADDING | |||
*/ | |||
padding?: number; | |||
saltLength?: number; | |||
} | |||
interface SignPrivateKeyInput extends PrivateKeyInput, SigningOptions { | |||
} | |||
type KeyLike = string | Buffer | KeyObject; | |||
class Signer extends stream.Writable { | |||
private constructor(); | |||
update(data: BinaryLike): Signer; | |||
update(data: string, input_encoding: Utf8AsciiLatin1Encoding): Signer; | |||
sign(private_key: SignPrivateKeyInput | KeyLike): Buffer; | |||
sign(private_key: SignPrivateKeyInput | KeyLike, output_format: HexBase64Latin1Encoding): string; | |||
} | |||
function createVerify(algorithm: string, options?: stream.WritableOptions): Verify; | |||
class Verify extends stream.Writable { | |||
private constructor(); | |||
update(data: BinaryLike): Verify; | |||
update(data: string, input_encoding: Utf8AsciiLatin1Encoding): Verify; | |||
verify(object: object | KeyLike, signature: NodeJS.ArrayBufferView): boolean; | |||
verify(object: object | KeyLike, signature: string, signature_format?: HexBase64Latin1Encoding): boolean; | |||
// https://nodejs.org/api/crypto.html#crypto_verifier_verify_object_signature_signature_format | |||
// The signature field accepts a TypedArray type, but it is only available starting ES2017 | |||
} | |||
function createDiffieHellman(prime_length: number, generator?: number | NodeJS.ArrayBufferView): DiffieHellman; | |||
function createDiffieHellman(prime: NodeJS.ArrayBufferView): DiffieHellman; | |||
function createDiffieHellman(prime: string, prime_encoding: HexBase64Latin1Encoding): DiffieHellman; | |||
function createDiffieHellman(prime: string, prime_encoding: HexBase64Latin1Encoding, generator: number | NodeJS.ArrayBufferView): DiffieHellman; | |||
function createDiffieHellman(prime: string, prime_encoding: HexBase64Latin1Encoding, generator: string, generator_encoding: HexBase64Latin1Encoding): DiffieHellman; | |||
class DiffieHellman { | |||
private constructor(); | |||
generateKeys(): Buffer; | |||
generateKeys(encoding: HexBase64Latin1Encoding): string; | |||
computeSecret(other_public_key: NodeJS.ArrayBufferView): Buffer; | |||
computeSecret(other_public_key: string, input_encoding: HexBase64Latin1Encoding): Buffer; | |||
computeSecret(other_public_key: NodeJS.ArrayBufferView, output_encoding: HexBase64Latin1Encoding): string; | |||
computeSecret(other_public_key: string, input_encoding: HexBase64Latin1Encoding, output_encoding: HexBase64Latin1Encoding): string; | |||
getPrime(): Buffer; | |||
getPrime(encoding: HexBase64Latin1Encoding): string; | |||
getGenerator(): Buffer; | |||
getGenerator(encoding: HexBase64Latin1Encoding): string; | |||
getPublicKey(): Buffer; | |||
getPublicKey(encoding: HexBase64Latin1Encoding): string; | |||
getPrivateKey(): Buffer; | |||
getPrivateKey(encoding: HexBase64Latin1Encoding): string; | |||
setPublicKey(public_key: NodeJS.ArrayBufferView): void; | |||
setPublicKey(public_key: string, encoding: BufferEncoding): void; | |||
setPrivateKey(private_key: NodeJS.ArrayBufferView): void; | |||
setPrivateKey(private_key: string, encoding: BufferEncoding): void; | |||
verifyError: number; | |||
} | |||
function getDiffieHellman(group_name: string): DiffieHellman; | |||
function pbkdf2( | |||
password: BinaryLike, | |||
salt: BinaryLike, | |||
iterations: number, | |||
keylen: number, | |||
digest: string, | |||
callback: (err: Error | null, derivedKey: Buffer) => any, | |||
): void; | |||
function pbkdf2Sync(password: BinaryLike, salt: BinaryLike, iterations: number, keylen: number, digest: string): Buffer; | |||
function randomBytes(size: number): Buffer; | |||
function randomBytes(size: number, callback: (err: Error | null, buf: Buffer) => void): void; | |||
function pseudoRandomBytes(size: number): Buffer; | |||
function pseudoRandomBytes(size: number, callback: (err: Error | null, buf: Buffer) => void): void; | |||
function randomFillSync<T extends NodeJS.ArrayBufferView>(buffer: T, offset?: number, size?: number): T; | |||
function randomFill<T extends NodeJS.ArrayBufferView>(buffer: T, callback: (err: Error | null, buf: T) => void): void; | |||
function randomFill<T extends NodeJS.ArrayBufferView>(buffer: T, offset: number, callback: (err: Error | null, buf: T) => void): void; | |||
function randomFill<T extends NodeJS.ArrayBufferView>(buffer: T, offset: number, size: number, callback: (err: Error | null, buf: T) => void): void; | |||
interface ScryptOptions { | |||
N?: number; | |||
r?: number; | |||
p?: number; | |||
maxmem?: number; | |||
} | |||
function scrypt( | |||
password: BinaryLike, | |||
salt: BinaryLike, | |||
keylen: number, callback: (err: Error | null, derivedKey: Buffer) => void, | |||
): void; | |||
function scrypt( | |||
password: BinaryLike, | |||
salt: BinaryLike, | |||
keylen: number, | |||
options: ScryptOptions, | |||
callback: (err: Error | null, derivedKey: Buffer) => void, | |||
): void; | |||
function scryptSync(password: BinaryLike, salt: BinaryLike, keylen: number, options?: ScryptOptions): Buffer; | |||
interface RsaPublicKey { | |||
key: KeyLike; | |||
padding?: number; | |||
} | |||
interface RsaPrivateKey { | |||
key: KeyLike; | |||
passphrase?: string; | |||
/** | |||
* @default 'sha1' | |||
*/ | |||
oaepHash?: string; | |||
oaepLabel?: NodeJS.TypedArray; | |||
padding?: number; | |||
} | |||
function publicEncrypt(key: RsaPublicKey | RsaPrivateKey | KeyLike, buffer: NodeJS.ArrayBufferView): Buffer; | |||
function publicDecrypt(key: RsaPublicKey | RsaPrivateKey | KeyLike, buffer: NodeJS.ArrayBufferView): Buffer; | |||
function privateDecrypt(private_key: RsaPrivateKey | KeyLike, buffer: NodeJS.ArrayBufferView): Buffer; | |||
function privateEncrypt(private_key: RsaPrivateKey | KeyLike, buffer: NodeJS.ArrayBufferView): Buffer; | |||
function getCiphers(): string[]; | |||
function getCurves(): string[]; | |||
function getHashes(): string[]; | |||
class ECDH { | |||
private constructor(); | |||
static convertKey( | |||
key: BinaryLike, | |||
curve: string, | |||
inputEncoding?: HexBase64Latin1Encoding, | |||
outputEncoding?: "latin1" | "hex" | "base64", | |||
format?: "uncompressed" | "compressed" | "hybrid", | |||
): Buffer | string; | |||
generateKeys(): Buffer; | |||
generateKeys(encoding: HexBase64Latin1Encoding, format?: ECDHKeyFormat): string; | |||
computeSecret(other_public_key: NodeJS.ArrayBufferView): Buffer; | |||
computeSecret(other_public_key: string, input_encoding: HexBase64Latin1Encoding): Buffer; | |||
computeSecret(other_public_key: NodeJS.ArrayBufferView, output_encoding: HexBase64Latin1Encoding): string; | |||
computeSecret(other_public_key: string, input_encoding: HexBase64Latin1Encoding, output_encoding: HexBase64Latin1Encoding): string; | |||
getPrivateKey(): Buffer; | |||
getPrivateKey(encoding: HexBase64Latin1Encoding): string; | |||
getPublicKey(): Buffer; | |||
getPublicKey(encoding: HexBase64Latin1Encoding, format?: ECDHKeyFormat): string; | |||
setPrivateKey(private_key: NodeJS.ArrayBufferView): void; | |||
setPrivateKey(private_key: string, encoding: HexBase64Latin1Encoding): void; | |||
} | |||
function createECDH(curve_name: string): ECDH; | |||
function timingSafeEqual(a: NodeJS.ArrayBufferView, b: NodeJS.ArrayBufferView): boolean; | |||
/** @deprecated since v10.0.0 */ | |||
const DEFAULT_ENCODING: BufferEncoding; | |||
type KeyType = 'rsa' | 'dsa' | 'ec'; | |||
type KeyFormat = 'pem' | 'der'; | |||
interface BasePrivateKeyEncodingOptions<T extends KeyFormat> { | |||
format: T; | |||
cipher?: string; | |||
passphrase?: string; | |||
} | |||
interface KeyPairKeyObjectResult { | |||
publicKey: KeyObject; | |||
privateKey: KeyObject; | |||
} | |||
interface ECKeyPairKeyObjectOptions { | |||
/** | |||
* Name of the curve to use. | |||
*/ | |||
namedCurve: string; | |||
} | |||
interface RSAKeyPairKeyObjectOptions { | |||
/** | |||
* Key size in bits | |||
*/ | |||
modulusLength: number; | |||
/** | |||
* @default 0x10001 | |||
*/ | |||
publicExponent?: number; | |||
} | |||
interface DSAKeyPairKeyObjectOptions { | |||
/** | |||
* Key size in bits | |||
*/ | |||
modulusLength: number; | |||
/** | |||
* Size of q in bits | |||
*/ | |||
divisorLength: number; | |||
} | |||
interface RSAKeyPairOptions<PubF extends KeyFormat, PrivF extends KeyFormat> { | |||
/** | |||
* Key size in bits | |||
*/ | |||
modulusLength: number; | |||
/** | |||
* @default 0x10001 | |||
*/ | |||
publicExponent?: number; | |||
publicKeyEncoding: { | |||
type: 'pkcs1' | 'spki'; | |||
format: PubF; | |||
}; | |||
privateKeyEncoding: BasePrivateKeyEncodingOptions<PrivF> & { | |||
type: 'pkcs1' | 'pkcs8'; | |||
}; | |||
} | |||
interface DSAKeyPairOptions<PubF extends KeyFormat, PrivF extends KeyFormat> { | |||
/** | |||
* Key size in bits | |||
*/ | |||
modulusLength: number; | |||
/** | |||
* Size of q in bits | |||
*/ | |||
divisorLength: number; | |||
publicKeyEncoding: { | |||
type: 'spki'; | |||
format: PubF; | |||
}; | |||
privateKeyEncoding: BasePrivateKeyEncodingOptions<PrivF> & { | |||
type: 'pkcs8'; | |||
}; | |||
} | |||
interface ECKeyPairOptions<PubF extends KeyFormat, PrivF extends KeyFormat> { | |||
/** | |||
* Name of the curve to use. | |||
*/ | |||
namedCurve: string; | |||
publicKeyEncoding: { | |||
type: 'pkcs1' | 'spki'; | |||
format: PubF; | |||
}; | |||
privateKeyEncoding: BasePrivateKeyEncodingOptions<PrivF> & { | |||
type: 'sec1' | 'pkcs8'; | |||
}; | |||
} | |||
interface KeyPairSyncResult<T1 extends string | Buffer, T2 extends string | Buffer> { | |||
publicKey: T1; | |||
privateKey: T2; | |||
} | |||
function generateKeyPairSync(type: 'rsa', options: RSAKeyPairOptions<'pem', 'pem'>): KeyPairSyncResult<string, string>; | |||
function generateKeyPairSync(type: 'rsa', options: RSAKeyPairOptions<'pem', 'der'>): KeyPairSyncResult<string, Buffer>; | |||
function generateKeyPairSync(type: 'rsa', options: RSAKeyPairOptions<'der', 'pem'>): KeyPairSyncResult<Buffer, string>; | |||
function generateKeyPairSync(type: 'rsa', options: RSAKeyPairOptions<'der', 'der'>): KeyPairSyncResult<Buffer, Buffer>; | |||
function generateKeyPairSync(type: 'rsa', options: RSAKeyPairKeyObjectOptions): KeyPairKeyObjectResult; | |||
function generateKeyPairSync(type: 'dsa', options: DSAKeyPairOptions<'pem', 'pem'>): KeyPairSyncResult<string, string>; | |||
function generateKeyPairSync(type: 'dsa', options: DSAKeyPairOptions<'pem', 'der'>): KeyPairSyncResult<string, Buffer>; | |||
function generateKeyPairSync(type: 'dsa', options: DSAKeyPairOptions<'der', 'pem'>): KeyPairSyncResult<Buffer, string>; | |||
function generateKeyPairSync(type: 'dsa', options: DSAKeyPairOptions<'der', 'der'>): KeyPairSyncResult<Buffer, Buffer>; | |||
function generateKeyPairSync(type: 'dsa', options: DSAKeyPairKeyObjectOptions): KeyPairKeyObjectResult; | |||
function generateKeyPairSync(type: 'ec', options: ECKeyPairOptions<'pem', 'pem'>): KeyPairSyncResult<string, string>; | |||
function generateKeyPairSync(type: 'ec', options: ECKeyPairOptions<'pem', 'der'>): KeyPairSyncResult<string, Buffer>; | |||
function generateKeyPairSync(type: 'ec', options: ECKeyPairOptions<'der', 'pem'>): KeyPairSyncResult<Buffer, string>; | |||
function generateKeyPairSync(type: 'ec', options: ECKeyPairOptions<'der', 'der'>): KeyPairSyncResult<Buffer, Buffer>; | |||
function generateKeyPairSync(type: 'ec', options: ECKeyPairKeyObjectOptions): KeyPairKeyObjectResult; | |||
function generateKeyPair(type: 'rsa', options: RSAKeyPairOptions<'pem', 'pem'>, callback: (err: Error | null, publicKey: string, privateKey: string) => void): void; | |||
function generateKeyPair(type: 'rsa', options: RSAKeyPairOptions<'pem', 'der'>, callback: (err: Error | null, publicKey: string, privateKey: Buffer) => void): void; | |||
function generateKeyPair(type: 'rsa', options: RSAKeyPairOptions<'der', 'pem'>, callback: (err: Error | null, publicKey: Buffer, privateKey: string) => void): void; | |||
function generateKeyPair(type: 'rsa', options: RSAKeyPairOptions<'der', 'der'>, callback: (err: Error | null, publicKey: Buffer, privateKey: Buffer) => void): void; | |||
function generateKeyPair(type: 'rsa', options: RSAKeyPairKeyObjectOptions, callback: (err: Error | null, publicKey: KeyObject, privateKey: KeyObject) => void): void; | |||
function generateKeyPair(type: 'dsa', options: DSAKeyPairOptions<'pem', 'pem'>, callback: (err: Error | null, publicKey: string, privateKey: string) => void): void; | |||
function generateKeyPair(type: 'dsa', options: DSAKeyPairOptions<'pem', 'der'>, callback: (err: Error | null, publicKey: string, privateKey: Buffer) => void): void; | |||
function generateKeyPair(type: 'dsa', options: DSAKeyPairOptions<'der', 'pem'>, callback: (err: Error | null, publicKey: Buffer, privateKey: string) => void): void; | |||
function generateKeyPair(type: 'dsa', options: DSAKeyPairOptions<'der', 'der'>, callback: (err: Error | null, publicKey: Buffer, privateKey: Buffer) => void): void; | |||
function generateKeyPair(type: 'dsa', options: DSAKeyPairKeyObjectOptions, callback: (err: Error | null, publicKey: KeyObject, privateKey: KeyObject) => void): void; | |||
function generateKeyPair(type: 'ec', options: ECKeyPairOptions<'pem', 'pem'>, callback: (err: Error | null, publicKey: string, privateKey: string) => void): void; | |||
function generateKeyPair(type: 'ec', options: ECKeyPairOptions<'pem', 'der'>, callback: (err: Error | null, publicKey: string, privateKey: Buffer) => void): void; | |||
function generateKeyPair(type: 'ec', options: ECKeyPairOptions<'der', 'pem'>, callback: (err: Error | null, publicKey: Buffer, privateKey: string) => void): void; | |||
function generateKeyPair(type: 'ec', options: ECKeyPairOptions<'der', 'der'>, callback: (err: Error | null, publicKey: Buffer, privateKey: Buffer) => void): void; | |||
function generateKeyPair(type: 'ec', options: ECKeyPairKeyObjectOptions, callback: (err: Error | null, publicKey: KeyObject, privateKey: KeyObject) => void): void; | |||
namespace generateKeyPair { | |||
function __promisify__(type: "rsa", options: RSAKeyPairOptions<'pem', 'pem'>): Promise<{ publicKey: string, privateKey: string }>; | |||
function __promisify__(type: "rsa", options: RSAKeyPairOptions<'pem', 'der'>): Promise<{ publicKey: string, privateKey: Buffer }>; | |||
function __promisify__(type: "rsa", options: RSAKeyPairOptions<'der', 'pem'>): Promise<{ publicKey: Buffer, privateKey: string }>; | |||
function __promisify__(type: "rsa", options: RSAKeyPairOptions<'der', 'der'>): Promise<{ publicKey: Buffer, privateKey: Buffer }>; | |||
function __promisify__(type: "rsa", options: RSAKeyPairKeyObjectOptions): Promise<KeyPairKeyObjectResult>; | |||
function __promisify__(type: "dsa", options: DSAKeyPairOptions<'pem', 'pem'>): Promise<{ publicKey: string, privateKey: string }>; | |||
function __promisify__(type: "dsa", options: DSAKeyPairOptions<'pem', 'der'>): Promise<{ publicKey: string, privateKey: Buffer }>; | |||
function __promisify__(type: "dsa", options: DSAKeyPairOptions<'der', 'pem'>): Promise<{ publicKey: Buffer, privateKey: string }>; | |||
function __promisify__(type: "dsa", options: DSAKeyPairOptions<'der', 'der'>): Promise<{ publicKey: Buffer, privateKey: Buffer }>; | |||
function __promisify__(type: "dsa", options: DSAKeyPairKeyObjectOptions): Promise<KeyPairKeyObjectResult>; | |||
function __promisify__(type: "ec", options: ECKeyPairOptions<'pem', 'pem'>): Promise<{ publicKey: string, privateKey: string }>; | |||
function __promisify__(type: "ec", options: ECKeyPairOptions<'pem', 'der'>): Promise<{ publicKey: string, privateKey: Buffer }>; | |||
function __promisify__(type: "ec", options: ECKeyPairOptions<'der', 'pem'>): Promise<{ publicKey: Buffer, privateKey: string }>; | |||
function __promisify__(type: "ec", options: ECKeyPairOptions<'der', 'der'>): Promise<{ publicKey: Buffer, privateKey: Buffer }>; | |||
function __promisify__(type: "ec", options: ECKeyPairKeyObjectOptions): Promise<KeyPairKeyObjectResult>; | |||
} | |||
/** | |||
* Calculates and returns the signature for `data` using the given private key and | |||
* algorithm. If `algorithm` is `null` or `undefined`, then the algorithm is | |||
* dependent upon the key type (especially Ed25519 and Ed448). | |||
* | |||
* If `key` is not a [`KeyObject`][], this function behaves as if `key` had been | |||
* passed to [`crypto.createPrivateKey()`][]. | |||
*/ | |||
function sign(algorithm: string | null | undefined, data: NodeJS.ArrayBufferView, key: KeyLike | SignPrivateKeyInput): Buffer; | |||
interface VerifyKeyWithOptions extends KeyObject, SigningOptions { | |||
} | |||
/** | |||
* Calculates and returns the signature for `data` using the given private key and | |||
* algorithm. If `algorithm` is `null` or `undefined`, then the algorithm is | |||
* dependent upon the key type (especially Ed25519 and Ed448). | |||
* | |||
* If `key` is not a [`KeyObject`][], this function behaves as if `key` had been | |||
* passed to [`crypto.createPublicKey()`][]. | |||
*/ | |||
function verify(algorithm: string | null | undefined, data: NodeJS.ArrayBufferView, key: KeyLike | VerifyKeyWithOptions, signature: NodeJS.ArrayBufferView): boolean; | |||
} |
@@ -0,0 +1,141 @@ | |||
declare module "dgram" { | |||
import { AddressInfo } from "net"; | |||
import * as dns from "dns"; | |||
import * as events from "events"; | |||
interface RemoteInfo { | |||
address: string; | |||
family: 'IPv4' | 'IPv6'; | |||
port: number; | |||
size: number; | |||
} | |||
interface BindOptions { | |||
port?: number; | |||
address?: string; | |||
exclusive?: boolean; | |||
fd?: number; | |||
} | |||
type SocketType = "udp4" | "udp6"; | |||
interface SocketOptions { | |||
type: SocketType; | |||
reuseAddr?: boolean; | |||
/** | |||
* @default false | |||
*/ | |||
ipv6Only?: boolean; | |||
recvBufferSize?: number; | |||
sendBufferSize?: number; | |||
lookup?: (hostname: string, options: dns.LookupOneOptions, callback: (err: NodeJS.ErrnoException | null, address: string, family: number) => void) => void; | |||
} | |||
function createSocket(type: SocketType, callback?: (msg: Buffer, rinfo: RemoteInfo) => void): Socket; | |||
function createSocket(options: SocketOptions, callback?: (msg: Buffer, rinfo: RemoteInfo) => void): Socket; | |||
class Socket extends events.EventEmitter { | |||
addMembership(multicastAddress: string, multicastInterface?: string): void; | |||
address(): AddressInfo; | |||
bind(port?: number, address?: string, callback?: () => void): void; | |||
bind(port?: number, callback?: () => void): void; | |||
bind(callback?: () => void): void; | |||
bind(options: BindOptions, callback?: () => void): void; | |||
close(callback?: () => void): void; | |||
connect(port: number, address?: string, callback?: () => void): void; | |||
connect(port: number, callback: () => void): void; | |||
disconnect(): void; | |||
dropMembership(multicastAddress: string, multicastInterface?: string): void; | |||
getRecvBufferSize(): number; | |||
getSendBufferSize(): number; | |||
ref(): this; | |||
remoteAddress(): AddressInfo; | |||
send(msg: string | Uint8Array | any[], port?: number, address?: string, callback?: (error: Error | null, bytes: number) => void): void; | |||
send(msg: string | Uint8Array | any[], port?: number, callback?: (error: Error | null, bytes: number) => void): void; | |||
send(msg: string | Uint8Array | any[], callback?: (error: Error | null, bytes: number) => void): void; | |||
send(msg: string | Uint8Array, offset: number, length: number, port?: number, address?: string, callback?: (error: Error | null, bytes: number) => void): void; | |||
send(msg: string | Uint8Array, offset: number, length: number, port?: number, callback?: (error: Error | null, bytes: number) => void): void; | |||
send(msg: string | Uint8Array, offset: number, length: number, callback?: (error: Error | null, bytes: number) => void): void; | |||
setBroadcast(flag: boolean): void; | |||
setMulticastInterface(multicastInterface: string): void; | |||
setMulticastLoopback(flag: boolean): void; | |||
setMulticastTTL(ttl: number): void; | |||
setRecvBufferSize(size: number): void; | |||
setSendBufferSize(size: number): void; | |||
setTTL(ttl: number): void; | |||
unref(): this; | |||
/** | |||
* Tells the kernel to join a source-specific multicast channel at the given | |||
* `sourceAddress` and `groupAddress`, using the `multicastInterface` with the | |||
* `IP_ADD_SOURCE_MEMBERSHIP` socket option. | |||
* If the `multicastInterface` argument | |||
* is not specified, the operating system will choose one interface and will add | |||
* membership to it. | |||
* To add membership to every available interface, call | |||
* `socket.addSourceSpecificMembership()` multiple times, once per interface. | |||
*/ | |||
addSourceSpecificMembership(sourceAddress: string, groupAddress: string, multicastInterface?: string): void; | |||
/** | |||
* Instructs the kernel to leave a source-specific multicast channel at the given | |||
* `sourceAddress` and `groupAddress` using the `IP_DROP_SOURCE_MEMBERSHIP` | |||
* socket option. This method is automatically called by the kernel when the | |||
* socket is closed or the process terminates, so most apps will never have | |||
* reason to call this. | |||
* | |||
* If `multicastInterface` is not specified, the operating system will attempt to | |||
* drop membership on all valid interfaces. | |||
*/ | |||
dropSourceSpecificMembership(sourceAddress: string, groupAddress: string, multicastInterface?: string): void; | |||
/** | |||
* events.EventEmitter | |||
* 1. close | |||
* 2. connect | |||
* 3. error | |||
* 4. listening | |||
* 5. message | |||
*/ | |||
addListener(event: string, listener: (...args: any[]) => void): this; | |||
addListener(event: "close", listener: () => void): this; | |||
addListener(event: "connect", listener: () => void): this; | |||
addListener(event: "error", listener: (err: Error) => void): this; | |||
addListener(event: "listening", listener: () => void): this; | |||
addListener(event: "message", listener: (msg: Buffer, rinfo: RemoteInfo) => void): this; | |||
emit(event: string | symbol, ...args: any[]): boolean; | |||
emit(event: "close"): boolean; | |||
emit(event: "connect"): boolean; | |||
emit(event: "error", err: Error): boolean; | |||
emit(event: "listening"): boolean; | |||
emit(event: "message", msg: Buffer, rinfo: RemoteInfo): boolean; | |||
on(event: string, listener: (...args: any[]) => void): this; | |||
on(event: "close", listener: () => void): this; | |||
on(event: "connect", listener: () => void): this; | |||
on(event: "error", listener: (err: Error) => void): this; | |||
on(event: "listening", listener: () => void): this; | |||
on(event: "message", listener: (msg: Buffer, rinfo: RemoteInfo) => void): this; | |||
once(event: string, listener: (...args: any[]) => void): this; | |||
once(event: "close", listener: () => void): this; | |||
once(event: "connect", listener: () => void): this; | |||
once(event: "error", listener: (err: Error) => void): this; | |||
once(event: "listening", listener: () => void): this; | |||
once(event: "message", listener: (msg: Buffer, rinfo: RemoteInfo) => void): this; | |||
prependListener(event: string, listener: (...args: any[]) => void): this; | |||
prependListener(event: "close", listener: () => void): this; | |||
prependListener(event: "connect", listener: () => void): this; | |||
prependListener(event: "error", listener: (err: Error) => void): this; | |||
prependListener(event: "listening", listener: () => void): this; | |||
prependListener(event: "message", listener: (msg: Buffer, rinfo: RemoteInfo) => void): this; | |||
prependOnceListener(event: string, listener: (...args: any[]) => void): this; | |||
prependOnceListener(event: "close", listener: () => void): this; | |||
prependOnceListener(event: "connect", listener: () => void): this; | |||
prependOnceListener(event: "error", listener: (err: Error) => void): this; | |||
prependOnceListener(event: "listening", listener: () => void): this; | |||
prependOnceListener(event: "message", listener: (msg: Buffer, rinfo: RemoteInfo) => void): this; | |||
} | |||
} |
@@ -0,0 +1,371 @@ | |||
declare module "dns" { | |||
// Supported getaddrinfo flags. | |||
const ADDRCONFIG: number; | |||
const V4MAPPED: number; | |||
/** | |||
* If `dns.V4MAPPED` is specified, return resolved IPv6 addresses as | |||
* well as IPv4 mapped IPv6 addresses. | |||
*/ | |||
const ALL: number; | |||
interface LookupOptions { | |||
family?: number; | |||
hints?: number; | |||
all?: boolean; | |||
verbatim?: boolean; | |||
} | |||
interface LookupOneOptions extends LookupOptions { | |||
all?: false; | |||
} | |||
interface LookupAllOptions extends LookupOptions { | |||
all: true; | |||
} | |||
interface LookupAddress { | |||
address: string; | |||
family: number; | |||
} | |||
function lookup(hostname: string, family: number, callback: (err: NodeJS.ErrnoException | null, address: string, family: number) => void): void; | |||
function lookup(hostname: string, options: LookupOneOptions, callback: (err: NodeJS.ErrnoException | null, address: string, family: number) => void): void; | |||
function lookup(hostname: string, options: LookupAllOptions, callback: (err: NodeJS.ErrnoException | null, addresses: LookupAddress[]) => void): void; | |||
function lookup(hostname: string, options: LookupOptions, callback: (err: NodeJS.ErrnoException | null, address: string | LookupAddress[], family: number) => void): void; | |||
function lookup(hostname: string, callback: (err: NodeJS.ErrnoException | null, address: string, family: number) => void): void; | |||
// NOTE: This namespace provides design-time support for util.promisify. Exported members do not exist at runtime. | |||
namespace lookup { | |||
function __promisify__(hostname: string, options: LookupAllOptions): Promise<LookupAddress[]>; | |||
function __promisify__(hostname: string, options?: LookupOneOptions | number): Promise<LookupAddress>; | |||
function __promisify__(hostname: string, options: LookupOptions): Promise<LookupAddress | LookupAddress[]>; | |||
} | |||
function lookupService(address: string, port: number, callback: (err: NodeJS.ErrnoException | null, hostname: string, service: string) => void): void; | |||
namespace lookupService { | |||
function __promisify__(address: string, port: number): Promise<{ hostname: string, service: string }>; | |||
} | |||
interface ResolveOptions { | |||
ttl: boolean; | |||
} | |||
interface ResolveWithTtlOptions extends ResolveOptions { | |||
ttl: true; | |||
} | |||
interface RecordWithTtl { | |||
address: string; | |||
ttl: number; | |||
} | |||
/** @deprecated Use AnyARecord or AnyAaaaRecord instead. */ | |||
type AnyRecordWithTtl = AnyARecord | AnyAaaaRecord; | |||
interface AnyARecord extends RecordWithTtl { | |||
type: "A"; | |||
} | |||
interface AnyAaaaRecord extends RecordWithTtl { | |||
type: "AAAA"; | |||
} | |||
interface MxRecord { | |||
priority: number; | |||
exchange: string; | |||
} | |||
interface AnyMxRecord extends MxRecord { | |||
type: "MX"; | |||
} | |||
interface NaptrRecord { | |||
flags: string; | |||
service: string; | |||
regexp: string; | |||
replacement: string; | |||
order: number; | |||
preference: number; | |||
} | |||
interface AnyNaptrRecord extends NaptrRecord { | |||
type: "NAPTR"; | |||
} | |||
interface SoaRecord { | |||
nsname: string; | |||
hostmaster: string; | |||
serial: number; | |||
refresh: number; | |||
retry: number; | |||
expire: number; | |||
minttl: number; | |||
} | |||
interface AnySoaRecord extends SoaRecord { | |||
type: "SOA"; | |||
} | |||
interface SrvRecord { | |||
priority: number; | |||
weight: number; | |||
port: number; | |||
name: string; | |||
} | |||
interface AnySrvRecord extends SrvRecord { | |||
type: "SRV"; | |||
} | |||
interface AnyTxtRecord { | |||
type: "TXT"; | |||
entries: string[]; | |||
} | |||
interface AnyNsRecord { | |||
type: "NS"; | |||
value: string; | |||
} | |||
interface AnyPtrRecord { | |||
type: "PTR"; | |||
value: string; | |||
} | |||
interface AnyCnameRecord { | |||
type: "CNAME"; | |||
value: string; | |||
} | |||
type AnyRecord = AnyARecord | | |||
AnyAaaaRecord | | |||
AnyCnameRecord | | |||
AnyMxRecord | | |||
AnyNaptrRecord | | |||
AnyNsRecord | | |||
AnyPtrRecord | | |||
AnySoaRecord | | |||
AnySrvRecord | | |||
AnyTxtRecord; | |||
function resolve(hostname: string, callback: (err: NodeJS.ErrnoException | null, addresses: string[]) => void): void; | |||
function resolve(hostname: string, rrtype: "A", callback: (err: NodeJS.ErrnoException | null, addresses: string[]) => void): void; | |||
function resolve(hostname: string, rrtype: "AAAA", callback: (err: NodeJS.ErrnoException | null, addresses: string[]) => void): void; | |||
function resolve(hostname: string, rrtype: "ANY", callback: (err: NodeJS.ErrnoException | null, addresses: AnyRecord[]) => void): void; | |||
function resolve(hostname: string, rrtype: "CNAME", callback: (err: NodeJS.ErrnoException | null, addresses: string[]) => void): void; | |||
function resolve(hostname: string, rrtype: "MX", callback: (err: NodeJS.ErrnoException | null, addresses: MxRecord[]) => void): void; | |||
function resolve(hostname: string, rrtype: "NAPTR", callback: (err: NodeJS.ErrnoException | null, addresses: NaptrRecord[]) => void): void; | |||
function resolve(hostname: string, rrtype: "NS", callback: (err: NodeJS.ErrnoException | null, addresses: string[]) => void): void; | |||
function resolve(hostname: string, rrtype: "PTR", callback: (err: NodeJS.ErrnoException | null, addresses: string[]) => void): void; | |||
function resolve(hostname: string, rrtype: "SOA", callback: (err: NodeJS.ErrnoException | null, addresses: SoaRecord) => void): void; | |||
function resolve(hostname: string, rrtype: "SRV", callback: (err: NodeJS.ErrnoException | null, addresses: SrvRecord[]) => void): void; | |||
function resolve(hostname: string, rrtype: "TXT", callback: (err: NodeJS.ErrnoException | null, addresses: string[][]) => void): void; | |||
function resolve( | |||
hostname: string, | |||
rrtype: string, | |||
callback: (err: NodeJS.ErrnoException | null, addresses: string[] | MxRecord[] | NaptrRecord[] | SoaRecord | SrvRecord[] | string[][] | AnyRecord[]) => void, | |||
): void; | |||
// NOTE: This namespace provides design-time support for util.promisify. Exported members do not exist at runtime. | |||
namespace resolve { | |||
function __promisify__(hostname: string, rrtype?: "A" | "AAAA" | "CNAME" | "NS" | "PTR"): Promise<string[]>; | |||
function __promisify__(hostname: string, rrtype: "ANY"): Promise<AnyRecord[]>; | |||
function __promisify__(hostname: string, rrtype: "MX"): Promise<MxRecord[]>; | |||
function __promisify__(hostname: string, rrtype: "NAPTR"): Promise<NaptrRecord[]>; | |||
function __promisify__(hostname: string, rrtype: "SOA"): Promise<SoaRecord>; | |||
function __promisify__(hostname: string, rrtype: "SRV"): Promise<SrvRecord[]>; | |||
function __promisify__(hostname: string, rrtype: "TXT"): Promise<string[][]>; | |||
function __promisify__(hostname: string, rrtype: string): Promise<string[] | MxRecord[] | NaptrRecord[] | SoaRecord | SrvRecord[] | string[][] | AnyRecord[]>; | |||
} | |||
function resolve4(hostname: string, callback: (err: NodeJS.ErrnoException | null, addresses: string[]) => void): void; | |||
function resolve4(hostname: string, options: ResolveWithTtlOptions, callback: (err: NodeJS.ErrnoException | null, addresses: RecordWithTtl[]) => void): void; | |||
function resolve4(hostname: string, options: ResolveOptions, callback: (err: NodeJS.ErrnoException | null, addresses: string[] | RecordWithTtl[]) => void): void; | |||
// NOTE: This namespace provides design-time support for util.promisify. Exported members do not exist at runtime. | |||
namespace resolve4 { | |||
function __promisify__(hostname: string): Promise<string[]>; | |||
function __promisify__(hostname: string, options: ResolveWithTtlOptions): Promise<RecordWithTtl[]>; | |||
function __promisify__(hostname: string, options?: ResolveOptions): Promise<string[] | RecordWithTtl[]>; | |||
} | |||
function resolve6(hostname: string, callback: (err: NodeJS.ErrnoException | null, addresses: string[]) => void): void; | |||
function resolve6(hostname: string, options: ResolveWithTtlOptions, callback: (err: NodeJS.ErrnoException | null, addresses: RecordWithTtl[]) => void): void; | |||
function resolve6(hostname: string, options: ResolveOptions, callback: (err: NodeJS.ErrnoException | null, addresses: string[] | RecordWithTtl[]) => void): void; | |||
// NOTE: This namespace provides design-time support for util.promisify. Exported members do not exist at runtime. | |||
namespace resolve6 { | |||
function __promisify__(hostname: string): Promise<string[]>; | |||
function __promisify__(hostname: string, options: ResolveWithTtlOptions): Promise<RecordWithTtl[]>; | |||
function __promisify__(hostname: string, options?: ResolveOptions): Promise<string[] | RecordWithTtl[]>; | |||
} | |||
function resolveCname(hostname: string, callback: (err: NodeJS.ErrnoException | null, addresses: string[]) => void): void; | |||
namespace resolveCname { | |||
function __promisify__(hostname: string): Promise<string[]>; | |||
} | |||
function resolveMx(hostname: string, callback: (err: NodeJS.ErrnoException | null, addresses: MxRecord[]) => void): void; | |||
namespace resolveMx { | |||
function __promisify__(hostname: string): Promise<MxRecord[]>; | |||
} | |||
function resolveNaptr(hostname: string, callback: (err: NodeJS.ErrnoException | null, addresses: NaptrRecord[]) => void): void; | |||
namespace resolveNaptr { | |||
function __promisify__(hostname: string): Promise<NaptrRecord[]>; | |||
} | |||
function resolveNs(hostname: string, callback: (err: NodeJS.ErrnoException | null, addresses: string[]) => void): void; | |||
namespace resolveNs { | |||
function __promisify__(hostname: string): Promise<string[]>; | |||
} | |||
function resolvePtr(hostname: string, callback: (err: NodeJS.ErrnoException | null, addresses: string[]) => void): void; | |||
namespace resolvePtr { | |||
function __promisify__(hostname: string): Promise<string[]>; | |||
} | |||
function resolveSoa(hostname: string, callback: (err: NodeJS.ErrnoException | null, address: SoaRecord) => void): void; | |||
namespace resolveSoa { | |||
function __promisify__(hostname: string): Promise<SoaRecord>; | |||
} | |||
function resolveSrv(hostname: string, callback: (err: NodeJS.ErrnoException | null, addresses: SrvRecord[]) => void): void; | |||
namespace resolveSrv { | |||
function __promisify__(hostname: string): Promise<SrvRecord[]>; | |||
} | |||
function resolveTxt(hostname: string, callback: (err: NodeJS.ErrnoException | null, addresses: string[][]) => void): void; | |||
namespace resolveTxt { | |||
function __promisify__(hostname: string): Promise<string[][]>; | |||
} | |||
function resolveAny(hostname: string, callback: (err: NodeJS.ErrnoException | null, addresses: AnyRecord[]) => void): void; | |||
namespace resolveAny { | |||
function __promisify__(hostname: string): Promise<AnyRecord[]>; | |||
} | |||
function reverse(ip: string, callback: (err: NodeJS.ErrnoException | null, hostnames: string[]) => void): void; | |||
function setServers(servers: ReadonlyArray<string>): void; | |||
function getServers(): string[]; | |||
// Error codes | |||
const NODATA: string; | |||
const FORMERR: string; | |||
const SERVFAIL: string; | |||
const NOTFOUND: string; | |||
const NOTIMP: string; | |||
const REFUSED: string; | |||
const BADQUERY: string; | |||
const BADNAME: string; | |||
const BADFAMILY: string; | |||
const BADRESP: string; | |||
const CONNREFUSED: string; | |||
const TIMEOUT: string; | |||
const EOF: string; | |||
const FILE: string; | |||
const NOMEM: string; | |||
const DESTRUCTION: string; | |||
const BADSTR: string; | |||
const BADFLAGS: string; | |||
const NONAME: string; | |||
const BADHINTS: string; | |||
const NOTINITIALIZED: string; | |||
const LOADIPHLPAPI: string; | |||
const ADDRGETNETWORKPARAMS: string; | |||
const CANCELLED: string; | |||
class Resolver { | |||
getServers: typeof getServers; | |||
setServers: typeof setServers; | |||
resolve: typeof resolve; | |||
resolve4: typeof resolve4; | |||
resolve6: typeof resolve6; | |||
resolveAny: typeof resolveAny; | |||
resolveCname: typeof resolveCname; | |||
resolveMx: typeof resolveMx; | |||
resolveNaptr: typeof resolveNaptr; | |||
resolveNs: typeof resolveNs; | |||
resolvePtr: typeof resolvePtr; | |||
resolveSoa: typeof resolveSoa; | |||
resolveSrv: typeof resolveSrv; | |||
resolveTxt: typeof resolveTxt; | |||
reverse: typeof reverse; | |||
cancel(): void; | |||
} | |||
namespace promises { | |||
function getServers(): string[]; | |||
function lookup(hostname: string, family: number): Promise<LookupAddress>; | |||
function lookup(hostname: string, options: LookupOneOptions): Promise<LookupAddress>; | |||
function lookup(hostname: string, options: LookupAllOptions): Promise<LookupAddress[]>; | |||
function lookup(hostname: string, options: LookupOptions): Promise<LookupAddress | LookupAddress[]>; | |||
function lookup(hostname: string): Promise<LookupAddress>; | |||
function lookupService(address: string, port: number): Promise<{ hostname: string, service: string }>; | |||
function resolve(hostname: string): Promise<string[]>; | |||
function resolve(hostname: string, rrtype: "A"): Promise<string[]>; | |||
function resolve(hostname: string, rrtype: "AAAA"): Promise<string[]>; | |||
function resolve(hostname: string, rrtype: "ANY"): Promise<AnyRecord[]>; | |||
function resolve(hostname: string, rrtype: "CNAME"): Promise<string[]>; | |||
function resolve(hostname: string, rrtype: "MX"): Promise<MxRecord[]>; | |||
function resolve(hostname: string, rrtype: "NAPTR"): Promise<NaptrRecord[]>; | |||
function resolve(hostname: string, rrtype: "NS"): Promise<string[]>; | |||
function resolve(hostname: string, rrtype: "PTR"): Promise<string[]>; | |||
function resolve(hostname: string, rrtype: "SOA"): Promise<SoaRecord>; | |||
function resolve(hostname: string, rrtype: "SRV"): Promise<SrvRecord[]>; | |||
function resolve(hostname: string, rrtype: "TXT"): Promise<string[][]>; | |||
function resolve(hostname: string, rrtype: string): Promise<string[] | MxRecord[] | NaptrRecord[] | SoaRecord | SrvRecord[] | string[][] | AnyRecord[]>; | |||
function resolve4(hostname: string): Promise<string[]>; | |||
function resolve4(hostname: string, options: ResolveWithTtlOptions): Promise<RecordWithTtl[]>; | |||
function resolve4(hostname: string, options: ResolveOptions): Promise<string[] | RecordWithTtl[]>; | |||
function resolve6(hostname: string): Promise<string[]>; | |||
function resolve6(hostname: string, options: ResolveWithTtlOptions): Promise<RecordWithTtl[]>; | |||
function resolve6(hostname: string, options: ResolveOptions): Promise<string[] | RecordWithTtl[]>; | |||
function resolveAny(hostname: string): Promise<AnyRecord[]>; | |||
function resolveCname(hostname: string): Promise<string[]>; | |||
function resolveMx(hostname: string): Promise<MxRecord[]>; | |||
function resolveNaptr(hostname: string): Promise<NaptrRecord[]>; | |||
function resolveNs(hostname: string): Promise<string[]>; | |||
function resolvePtr(hostname: string): Promise<string[]>; | |||
function resolveSoa(hostname: string): Promise<SoaRecord>; | |||
function resolveSrv(hostname: string): Promise<SrvRecord[]>; | |||
function resolveTxt(hostname: string): Promise<string[][]>; | |||
function reverse(ip: string): Promise<string[]>; | |||
function setServers(servers: ReadonlyArray<string>): void; | |||
class Resolver { | |||
getServers: typeof getServers; | |||
resolve: typeof resolve; | |||
resolve4: typeof resolve4; | |||
resolve6: typeof resolve6; | |||
resolveAny: typeof resolveAny; | |||
resolveCname: typeof resolveCname; | |||
resolveMx: typeof resolveMx; | |||
resolveNaptr: typeof resolveNaptr; | |||
resolveNs: typeof resolveNs; | |||
resolvePtr: typeof resolvePtr; | |||
resolveSoa: typeof resolveSoa; | |||
resolveSrv: typeof resolveSrv; | |||
resolveTxt: typeof resolveTxt; | |||
reverse: typeof reverse; | |||
setServers: typeof setServers; | |||
} | |||
} | |||
} |
@@ -0,0 +1,16 @@ | |||
declare module "domain" { | |||
import { EventEmitter } from "events"; | |||
class Domain extends EventEmitter implements NodeJS.Domain { | |||
run<T>(fn: (...args: any[]) => T, ...args: any[]): T; | |||
add(emitter: EventEmitter | NodeJS.Timer): void; | |||
remove(emitter: EventEmitter | NodeJS.Timer): void; | |||
bind<T extends Function>(cb: T): T; | |||
intercept<T extends Function>(cb: T): T; | |||
members: Array<EventEmitter | NodeJS.Timer>; | |||
enter(): void; | |||
exit(): void; | |||
} | |||
function create(): Domain; | |||
} |
@@ -0,0 +1,60 @@ | |||
declare module "events" { | |||
interface EventEmitterOptions { | |||
/** | |||
* Enables automatic capturing of promise rejection. | |||
*/ | |||
captureRejections?: boolean; | |||
} | |||
interface NodeEventTarget { | |||
once(event: string | symbol, listener: (...args: any[]) => void): this; | |||
} | |||
interface DOMEventTarget { | |||
addEventListener(event: string, listener: (...args: any[]) => void, opts?: { once: boolean }): any; | |||
} | |||
namespace EventEmitter { | |||
function once(emitter: NodeEventTarget, event: string | symbol): Promise<any[]>; | |||
function once(emitter: DOMEventTarget, event: string): Promise<any[]>; | |||
function on(emitter: EventEmitter, event: string): AsyncIterableIterator<any>; | |||
const captureRejectionSymbol: unique symbol; | |||
/** | |||
* This symbol shall be used to install a listener for only monitoring `'error'` | |||
* events. Listeners installed using this symbol are called before the regular | |||
* `'error'` listeners are called. | |||
* | |||
* Installing a listener using this symbol does not change the behavior once an | |||
* `'error'` event is emitted, therefore the process will still crash if no | |||
* regular `'error'` listener is installed. | |||
*/ | |||
const errorMonitor: unique symbol; | |||
/** | |||
* Sets or gets the default captureRejection value for all emitters. | |||
*/ | |||
let captureRejections: boolean; | |||
interface EventEmitter extends NodeJS.EventEmitter { | |||
} | |||
class EventEmitter { | |||
constructor(options?: EventEmitterOptions); | |||
/** @deprecated since v4.0.0 */ | |||
static listenerCount(emitter: EventEmitter, event: string | symbol): number; | |||
static defaultMaxListeners: number; | |||
/** | |||
* This symbol shall be used to install a listener for only monitoring `'error'` | |||
* events. Listeners installed using this symbol are called before the regular | |||
* `'error'` listeners are called. | |||
* | |||
* Installing a listener using this symbol does not change the behavior once an | |||
* `'error'` event is emitted, therefore the process will still crash if no | |||
* regular `'error'` listener is installed. | |||
*/ | |||
static readonly errorMonitor: unique symbol; | |||
} | |||
} | |||
export = EventEmitter; | |||
} |
@@ -0,0 +1,539 @@ | |||
declare module 'fs/promises' { | |||
import { | |||
Stats, | |||
WriteVResult, | |||
ReadVResult, | |||
PathLike, | |||
RmDirAsyncOptions, | |||
MakeDirectoryOptions, | |||
Dirent, | |||
OpenDirOptions, | |||
Dir, | |||
BaseEncodingOptions, | |||
BufferEncodingOption, | |||
OpenMode, | |||
Mode, | |||
} from 'fs'; | |||
interface FileHandle { | |||
/** | |||
* Gets the file descriptor for this file handle. | |||
*/ | |||
readonly fd: number; | |||
/** | |||
* Asynchronously append data to a file, creating the file if it does not exist. The underlying file will _not_ be closed automatically. | |||
* The `FileHandle` must have been opened for appending. | |||
* @param data The data to write. If something other than a `Buffer` or `Uint8Array` is provided, the value is coerced to a string. | |||
* @param options Either the encoding for the file, or an object optionally specifying the encoding, file mode, and flag. | |||
* If `encoding` is not supplied, the default of `'utf8'` is used. | |||
* If `mode` is not supplied, the default of `0o666` is used. | |||
* If `mode` is a string, it is parsed as an octal integer. | |||
* If `flag` is not supplied, the default of `'a'` is used. | |||
*/ | |||
appendFile(data: string | Uint8Array, options?: BaseEncodingOptions & { mode?: Mode, flag?: OpenMode } | BufferEncoding | null): Promise<void>; | |||
/** | |||
* Asynchronous fchown(2) - Change ownership of a file. | |||
*/ | |||
chown(uid: number, gid: number): Promise<void>; | |||
/** | |||
* Asynchronous fchmod(2) - Change permissions of a file. | |||
* @param mode A file mode. If a string is passed, it is parsed as an octal integer. | |||
*/ | |||
chmod(mode: Mode): Promise<void>; | |||
/** | |||
* Asynchronous fdatasync(2) - synchronize a file's in-core state with storage device. | |||
*/ | |||
datasync(): Promise<void>; | |||
/** | |||
* Asynchronous fsync(2) - synchronize a file's in-core state with the underlying storage device. | |||
*/ | |||
sync(): Promise<void>; | |||
/** | |||
* Asynchronously reads data from the file. | |||
* The `FileHandle` must have been opened for reading. | |||
* @param buffer The buffer that the data will be written to. | |||
* @param offset The offset in the buffer at which to start writing. | |||
* @param length The number of bytes to read. | |||
* @param position The offset from the beginning of the file from which data should be read. If `null`, data will be read from the current position. | |||
*/ | |||
read<TBuffer extends Uint8Array>(buffer: TBuffer, offset?: number | null, length?: number | null, position?: number | null): Promise<{ bytesRead: number, buffer: TBuffer }>; | |||
/** | |||
* Asynchronously reads the entire contents of a file. The underlying file will _not_ be closed automatically. | |||
* The `FileHandle` must have been opened for reading. | |||
* @param options An object that may contain an optional flag. | |||
* If a flag is not provided, it defaults to `'r'`. | |||
*/ | |||
readFile(options?: { encoding?: null, flag?: OpenMode } | null): Promise<Buffer>; | |||
/** | |||
* Asynchronously reads the entire contents of a file. The underlying file will _not_ be closed automatically. | |||
* The `FileHandle` must have been opened for reading. | |||
* @param options An object that may contain an optional flag. | |||
* If a flag is not provided, it defaults to `'r'`. | |||
*/ | |||
readFile(options: { encoding: BufferEncoding, flag?: OpenMode } | BufferEncoding): Promise<string>; | |||
/** | |||
* Asynchronously reads the entire contents of a file. The underlying file will _not_ be closed automatically. | |||
* The `FileHandle` must have been opened for reading. | |||
* @param options An object that may contain an optional flag. | |||
* If a flag is not provided, it defaults to `'r'`. | |||
*/ | |||
readFile(options?: BaseEncodingOptions & { flag?: OpenMode } | BufferEncoding | null): Promise<string | Buffer>; | |||
/** | |||
* Asynchronous fstat(2) - Get file status. | |||
*/ | |||
stat(): Promise<Stats>; | |||
/** | |||
* Asynchronous ftruncate(2) - Truncate a file to a specified length. | |||
* @param len If not specified, defaults to `0`. | |||
*/ | |||
truncate(len?: number): Promise<void>; | |||
/** | |||
* Asynchronously change file timestamps of the file. | |||
* @param atime The last access time. If a string is provided, it will be coerced to number. | |||
* @param mtime The last modified time. If a string is provided, it will be coerced to number. | |||
*/ | |||
utimes(atime: string | number | Date, mtime: string | number | Date): Promise<void>; | |||
/** | |||
* Asynchronously writes `buffer` to the file. | |||
* The `FileHandle` must have been opened for writing. | |||
* @param buffer The buffer that the data will be written to. | |||
* @param offset The part of the buffer to be written. If not supplied, defaults to `0`. | |||
* @param length The number of bytes to write. If not supplied, defaults to `buffer.length - offset`. | |||
* @param position The offset from the beginning of the file where this data should be written. If not supplied, defaults to the current position. | |||
*/ | |||
write<TBuffer extends Uint8Array>(buffer: TBuffer, offset?: number | null, length?: number | null, position?: number | null): Promise<{ bytesWritten: number, buffer: TBuffer }>; | |||
/** | |||
* Asynchronously writes `string` to the file. | |||
* The `FileHandle` must have been opened for writing. | |||
* It is unsafe to call `write()` multiple times on the same file without waiting for the `Promise` | |||
* to be resolved (or rejected). For this scenario, `fs.createWriteStream` is strongly recommended. | |||
* @param string A string to write. | |||
* @param position The offset from the beginning of the file where this data should be written. If not supplied, defaults to the current position. | |||
* @param encoding The expected string encoding. | |||
*/ | |||
write(data: string | Uint8Array, position?: number | null, encoding?: BufferEncoding | null): Promise<{ bytesWritten: number, buffer: string }>; | |||
/** | |||
* Asynchronously writes data to a file, replacing the file if it already exists. The underlying file will _not_ be closed automatically. | |||
* The `FileHandle` must have been opened for writing. | |||
* It is unsafe to call `writeFile()` multiple times on the same file without waiting for the `Promise` to be resolved (or rejected). | |||
* @param data The data to write. If something other than a `Buffer` or `Uint8Array` is provided, the value is coerced to a string. | |||
* @param options Either the encoding for the file, or an object optionally specifying the encoding, file mode, and flag. | |||
* If `encoding` is not supplied, the default of `'utf8'` is used. | |||
* If `mode` is not supplied, the default of `0o666` is used. | |||
* If `mode` is a string, it is parsed as an octal integer. | |||
* If `flag` is not supplied, the default of `'w'` is used. | |||
*/ | |||
writeFile(data: string | Uint8Array, options?: BaseEncodingOptions & { mode?: Mode, flag?: OpenMode } | BufferEncoding | null): Promise<void>; | |||
/** | |||
* See `fs.writev` promisified version. | |||
*/ | |||
writev(buffers: NodeJS.ArrayBufferView[], position?: number): Promise<WriteVResult>; | |||
/** | |||
* See `fs.readv` promisified version. | |||
*/ | |||
readv(buffers: NodeJS.ArrayBufferView[], position?: number): Promise<ReadVResult>; | |||
/** | |||
* Asynchronous close(2) - close a `FileHandle`. | |||
*/ | |||
close(): Promise<void>; | |||
} | |||
/** | |||
* Asynchronously tests a user's permissions for the file specified by path. | |||
* @param path A path to a file or directory. If a URL is provided, it must use the `file:` protocol. | |||
* URL support is _experimental_. | |||
*/ | |||
function access(path: PathLike, mode?: number): Promise<void>; | |||
/** | |||
* Asynchronously copies `src` to `dest`. By default, `dest` is overwritten if it already exists. | |||
* Node.js makes no guarantees about the atomicity of the copy operation. | |||
* If an error occurs after the destination file has been opened for writing, Node.js will attempt | |||
* to remove the destination. | |||
* @param src A path to the source file. | |||
* @param dest A path to the destination file. | |||
* @param flags An optional integer that specifies the behavior of the copy operation. The only | |||
* supported flag is `fs.constants.COPYFILE_EXCL`, which causes the copy operation to fail if | |||
* `dest` already exists. | |||
*/ | |||
function copyFile(src: PathLike, dest: PathLike, flags?: number): Promise<void>; | |||
/** | |||
* Asynchronous open(2) - open and possibly create a file. | |||
* @param path A path to a file. If a URL is provided, it must use the `file:` protocol. | |||
* @param mode A file mode. If a string is passed, it is parsed as an octal integer. If not | |||
* supplied, defaults to `0o666`. | |||
*/ | |||
function open(path: PathLike, flags: string | number, mode?: Mode): Promise<FileHandle>; | |||
/** | |||
* Asynchronously reads data from the file referenced by the supplied `FileHandle`. | |||
* @param handle A `FileHandle`. | |||
* @param buffer The buffer that the data will be written to. | |||
* @param offset The offset in the buffer at which to start writing. | |||
* @param length The number of bytes to read. | |||
* @param position The offset from the beginning of the file from which data should be read. If | |||
* `null`, data will be read from the current position. | |||
*/ | |||
function read<TBuffer extends Uint8Array>( | |||
handle: FileHandle, | |||
buffer: TBuffer, | |||
offset?: number | null, | |||
length?: number | null, | |||
position?: number | null, | |||
): Promise<{ bytesRead: number, buffer: TBuffer }>; | |||
/** | |||
* Asynchronously writes `buffer` to the file referenced by the supplied `FileHandle`. | |||
* It is unsafe to call `fsPromises.write()` multiple times on the same file without waiting for the `Promise` | |||
* to be resolved (or rejected). For this scenario, `fs.createWriteStream` is strongly recommended. | |||
* @param handle A `FileHandle`. | |||
* @param buffer The buffer that the data will be written to. | |||
* @param offset The part of the buffer to be written. If not supplied, defaults to `0`. | |||
* @param length The number of bytes to write. If not supplied, defaults to `buffer.length - offset`. | |||
* @param position The offset from the beginning of the file where this data should be written. If not supplied, defaults to the current position. | |||
*/ | |||
function write<TBuffer extends Uint8Array>( | |||
handle: FileHandle, | |||
buffer: TBuffer, | |||
offset?: number | null, | |||
length?: number | null, position?: number | null): Promise<{ bytesWritten: number, buffer: TBuffer }>; | |||
/** | |||
* Asynchronously writes `string` to the file referenced by the supplied `FileHandle`. | |||
* It is unsafe to call `fsPromises.write()` multiple times on the same file without waiting for the `Promise` | |||
* to be resolved (or rejected). For this scenario, `fs.createWriteStream` is strongly recommended. | |||
* @param handle A `FileHandle`. | |||
* @param string A string to write. | |||
* @param position The offset from the beginning of the file where this data should be written. If not supplied, defaults to the current position. | |||
* @param encoding The expected string encoding. | |||
*/ | |||
function write(handle: FileHandle, string: string, position?: number | null, encoding?: BufferEncoding | null): Promise<{ bytesWritten: number, buffer: string }>; | |||
/** | |||
* Asynchronous rename(2) - Change the name or location of a file or directory. | |||
* @param oldPath A path to a file. If a URL is provided, it must use the `file:` protocol. | |||
* URL support is _experimental_. | |||
* @param newPath A path to a file. If a URL is provided, it must use the `file:` protocol. | |||
* URL support is _experimental_. | |||
*/ | |||
function rename(oldPath: PathLike, newPath: PathLike): Promise<void>; | |||
/** | |||
* Asynchronous truncate(2) - Truncate a file to a specified length. | |||
* @param path A path to a file. If a URL is provided, it must use the `file:` protocol. | |||
* @param len If not specified, defaults to `0`. | |||
*/ | |||
function truncate(path: PathLike, len?: number): Promise<void>; | |||
/** | |||
* Asynchronous ftruncate(2) - Truncate a file to a specified length. | |||
* @param handle A `FileHandle`. | |||
* @param len If not specified, defaults to `0`. | |||
*/ | |||
function ftruncate(handle: FileHandle, len?: number): Promise<void>; | |||
/** | |||
* Asynchronous rmdir(2) - delete a directory. | |||
* @param path A path to a file. If a URL is provided, it must use the `file:` protocol. | |||
*/ | |||
function rmdir(path: PathLike, options?: RmDirAsyncOptions): Promise<void>; | |||
/** | |||
* Asynchronous fdatasync(2) - synchronize a file's in-core state with storage device. | |||
* @param handle A `FileHandle`. | |||
*/ | |||
function fdatasync(handle: FileHandle): Promise<void>; | |||
/** | |||
* Asynchronous fsync(2) - synchronize a file's in-core state with the underlying storage device. | |||
* @param handle A `FileHandle`. | |||
*/ | |||
function fsync(handle: FileHandle): Promise<void>; | |||
/** | |||
* Asynchronous mkdir(2) - create a directory. | |||
* @param path A path to a file. If a URL is provided, it must use the `file:` protocol. | |||
* @param options Either the file mode, or an object optionally specifying the file mode and whether parent folders | |||
* should be created. If a string is passed, it is parsed as an octal integer. If not specified, defaults to `0o777`. | |||
*/ | |||
function mkdir(path: PathLike, options: MakeDirectoryOptions & { recursive: true; }): Promise<string>; | |||
/** | |||
* Asynchronous mkdir(2) - create a directory. | |||
* @param path A path to a file. If a URL is provided, it must use the `file:` protocol. | |||
* @param options Either the file mode, or an object optionally specifying the file mode and whether parent folders | |||
* should be created. If a string is passed, it is parsed as an octal integer. If not specified, defaults to `0o777`. | |||
*/ | |||
function mkdir(path: PathLike, options?: Mode | (MakeDirectoryOptions & { recursive?: false; }) | null): Promise<void>; | |||
/** | |||
* Asynchronous mkdir(2) - create a directory. | |||
* @param path A path to a file. If a URL is provided, it must use the `file:` protocol. | |||
* @param options Either the file mode, or an object optionally specifying the file mode and whether parent folders | |||
* should be created. If a string is passed, it is parsed as an octal integer. If not specified, defaults to `0o777`. | |||
*/ | |||
function mkdir(path: PathLike, options?: Mode | MakeDirectoryOptions | null): Promise<string | undefined>; | |||
/** | |||
* Asynchronous readdir(3) - read a directory. | |||
* @param path A path to a file. If a URL is provided, it must use the `file:` protocol. | |||
* @param options The encoding (or an object specifying the encoding), used as the encoding of the result. If not provided, `'utf8'` is used. | |||
*/ | |||
function readdir(path: PathLike, options?: BaseEncodingOptions & { withFileTypes?: false } | BufferEncoding | null): Promise<string[]>; | |||
/** | |||
* Asynchronous readdir(3) - read a directory. | |||
* @param path A path to a file. If a URL is provided, it must use the `file:` protocol. | |||
* @param options The encoding (or an object specifying the encoding), used as the encoding of the result. If not provided, `'utf8'` is used. | |||
*/ | |||
function readdir(path: PathLike, options: { encoding: "buffer"; withFileTypes?: false } | "buffer"): Promise<Buffer[]>; | |||
/** | |||
* Asynchronous readdir(3) - read a directory. | |||
* @param path A path to a file. If a URL is provided, it must use the `file:` protocol. | |||
* @param options The encoding (or an object specifying the encoding), used as the encoding of the result. If not provided, `'utf8'` is used. | |||
*/ | |||
function readdir(path: PathLike, options?: BaseEncodingOptions & { withFileTypes?: false } | BufferEncoding | null): Promise<string[] | Buffer[]>; | |||
/** | |||
* Asynchronous readdir(3) - read a directory. | |||
* @param path A path to a file. If a URL is provided, it must use the `file:` protocol. | |||
* @param options If called with `withFileTypes: true` the result data will be an array of Dirent. | |||
*/ | |||
function readdir(path: PathLike, options: BaseEncodingOptions & { withFileTypes: true }): Promise<Dirent[]>; | |||
/** | |||
* Asynchronous readlink(2) - read value of a symbolic link. | |||
* @param path A path to a file. If a URL is provided, it must use the `file:` protocol. | |||
* @param options The encoding (or an object specifying the encoding), used as the encoding of the result. If not provided, `'utf8'` is used. | |||
*/ | |||
function readlink(path: PathLike, options?: BaseEncodingOptions | BufferEncoding | null): Promise<string>; | |||
/** | |||
* Asynchronous readlink(2) - read value of a symbolic link. | |||
* @param path A path to a file. If a URL is provided, it must use the `file:` protocol. | |||
* @param options The encoding (or an object specifying the encoding), used as the encoding of the result. If not provided, `'utf8'` is used. | |||
*/ | |||
function readlink(path: PathLike, options: BufferEncodingOption): Promise<Buffer>; | |||
/** | |||
* Asynchronous readlink(2) - read value of a symbolic link. | |||
* @param path A path to a file. If a URL is provided, it must use the `file:` protocol. | |||
* @param options The encoding (or an object specifying the encoding), used as the encoding of the result. If not provided, `'utf8'` is used. | |||
*/ | |||
function readlink(path: PathLike, options?: BaseEncodingOptions | string | null): Promise<string | Buffer>; | |||
/** | |||
* Asynchronous symlink(2) - Create a new symbolic link to an existing file. | |||
* @param target A path to an existing file. If a URL is provided, it must use the `file:` protocol. | |||
* @param path A path to the new symlink. If a URL is provided, it must use the `file:` protocol. | |||
* @param type May be set to `'dir'`, `'file'`, or `'junction'` (default is `'file'`) and is only available on Windows (ignored on other platforms). | |||
* When using `'junction'`, the `target` argument will automatically be normalized to an absolute path. | |||
*/ | |||
function symlink(target: PathLike, path: PathLike, type?: string | null): Promise<void>; | |||
/** | |||
* Asynchronous fstat(2) - Get file status. | |||
* @param handle A `FileHandle`. | |||
*/ | |||
function fstat(handle: FileHandle): Promise<Stats>; | |||
/** | |||
* Asynchronous lstat(2) - Get file status. Does not dereference symbolic links. | |||
* @param path A path to a file. If a URL is provided, it must use the `file:` protocol. | |||
*/ | |||
function lstat(path: PathLike): Promise<Stats>; | |||
/** | |||
* Asynchronous stat(2) - Get file status. | |||
* @param path A path to a file. If a URL is provided, it must use the `file:` protocol. | |||
*/ | |||
function stat(path: PathLike): Promise<Stats>; | |||
/** | |||
* Asynchronous link(2) - Create a new link (also known as a hard link) to an existing file. | |||
* @param existingPath A path to a file. If a URL is provided, it must use the `file:` protocol. | |||
* @param newPath A path to a file. If a URL is provided, it must use the `file:` protocol. | |||
*/ | |||
function link(existingPath: PathLike, newPath: PathLike): Promise<void>; | |||
/** | |||
* Asynchronous unlink(2) - delete a name and possibly the file it refers to. | |||
* @param path A path to a file. If a URL is provided, it must use the `file:` protocol. | |||
*/ | |||
function unlink(path: PathLike): Promise<void>; | |||
/** | |||
* Asynchronous fchmod(2) - Change permissions of a file. | |||
* @param handle A `FileHandle`. | |||
* @param mode A file mode. If a string is passed, it is parsed as an octal integer. | |||
*/ | |||
function fchmod(handle: FileHandle, mode: Mode): Promise<void>; | |||
/** | |||
* Asynchronous chmod(2) - Change permissions of a file. | |||
* @param path A path to a file. If a URL is provided, it must use the `file:` protocol. | |||
* @param mode A file mode. If a string is passed, it is parsed as an octal integer. | |||
*/ | |||
function chmod(path: PathLike, mode: Mode): Promise<void>; | |||
/** | |||
* Asynchronous lchmod(2) - Change permissions of a file. Does not dereference symbolic links. | |||
* @param path A path to a file. If a URL is provided, it must use the `file:` protocol. | |||
* @param mode A file mode. If a string is passed, it is parsed as an octal integer. | |||
*/ | |||
function lchmod(path: PathLike, mode: Mode): Promise<void>; | |||
/** | |||
* Asynchronous lchown(2) - Change ownership of a file. Does not dereference symbolic links. | |||
* @param path A path to a file. If a URL is provided, it must use the `file:` protocol. | |||
*/ | |||
function lchown(path: PathLike, uid: number, gid: number): Promise<void>; | |||
/** | |||
* Asynchronous fchown(2) - Change ownership of a file. | |||
* @param handle A `FileHandle`. | |||
*/ | |||
function fchown(handle: FileHandle, uid: number, gid: number): Promise<void>; | |||
/** | |||
* Asynchronous chown(2) - Change ownership of a file. | |||
* @param path A path to a file. If a URL is provided, it must use the `file:` protocol. | |||
*/ | |||
function chown(path: PathLike, uid: number, gid: number): Promise<void>; | |||
/** | |||
* Asynchronously change file timestamps of the file referenced by the supplied path. | |||
* @param path A path to a file. If a URL is provided, it must use the `file:` protocol. | |||
* @param atime The last access time. If a string is provided, it will be coerced to number. | |||
* @param mtime The last modified time. If a string is provided, it will be coerced to number. | |||
*/ | |||
function utimes(path: PathLike, atime: string | number | Date, mtime: string | number | Date): Promise<void>; | |||
/** | |||
* Asynchronously change file timestamps of the file referenced by the supplied `FileHandle`. | |||
* @param handle A `FileHandle`. | |||
* @param atime The last access time. If a string is provided, it will be coerced to number. | |||
* @param mtime The last modified time. If a string is provided, it will be coerced to number. | |||
*/ | |||
function futimes(handle: FileHandle, atime: string | number | Date, mtime: string | number | Date): Promise<void>; | |||
/** | |||
* Asynchronous realpath(3) - return the canonicalized absolute pathname. | |||
* @param path A path to a file. If a URL is provided, it must use the `file:` protocol. | |||
* @param options The encoding (or an object specifying the encoding), used as the encoding of the result. If not provided, `'utf8'` is used. | |||
*/ | |||
function realpath(path: PathLike, options?: BaseEncodingOptions | BufferEncoding | null): Promise<string>; | |||
/** | |||
* Asynchronous realpath(3) - return the canonicalized absolute pathname. | |||
* @param path A path to a file. If a URL is provided, it must use the `file:` protocol. | |||
* @param options The encoding (or an object specifying the encoding), used as the encoding of the result. If not provided, `'utf8'` is used. | |||
*/ | |||
function realpath(path: PathLike, options: BufferEncodingOption): Promise<Buffer>; | |||
/** | |||
* Asynchronous realpath(3) - return the canonicalized absolute pathname. | |||
* @param path A path to a file. If a URL is provided, it must use the `file:` protocol. | |||
* @param options The encoding (or an object specifying the encoding), used as the encoding of the result. If not provided, `'utf8'` is used. | |||
*/ | |||
function realpath(path: PathLike, options?: BaseEncodingOptions | BufferEncoding | null): Promise<string | Buffer>; | |||
/** | |||
* Asynchronously creates a unique temporary directory. | |||
* Generates six random characters to be appended behind a required `prefix` to create a unique temporary directory. | |||
* @param options The encoding (or an object specifying the encoding), used as the encoding of the result. If not provided, `'utf8'` is used. | |||
*/ | |||
function mkdtemp(prefix: string, options?: BaseEncodingOptions | BufferEncoding | null): Promise<string>; | |||
/** | |||
* Asynchronously creates a unique temporary directory. | |||
* Generates six random characters to be appended behind a required `prefix` to create a unique temporary directory. | |||
* @param options The encoding (or an object specifying the encoding), used as the encoding of the result. If not provided, `'utf8'` is used. | |||
*/ | |||
function mkdtemp(prefix: string, options: BufferEncodingOption): Promise<Buffer>; | |||
/** | |||
* Asynchronously creates a unique temporary directory. | |||
* Generates six random characters to be appended behind a required `prefix` to create a unique temporary directory. | |||
* @param options The encoding (or an object specifying the encoding), used as the encoding of the result. If not provided, `'utf8'` is used. | |||
*/ | |||
function mkdtemp(prefix: string, options?: BaseEncodingOptions | BufferEncoding | null): Promise<string | Buffer>; | |||
/** | |||
* Asynchronously writes data to a file, replacing the file if it already exists. | |||
* It is unsafe to call `fsPromises.writeFile()` multiple times on the same file without waiting for the `Promise` to be resolved (or rejected). | |||
* @param path A path to a file. If a URL is provided, it must use the `file:` protocol. | |||
* URL support is _experimental_. | |||
* If a `FileHandle` is provided, the underlying file will _not_ be closed automatically. | |||
* @param data The data to write. If something other than a `Buffer` or `Uint8Array` is provided, the value is coerced to a string. | |||
* @param options Either the encoding for the file, or an object optionally specifying the encoding, file mode, and flag. | |||
* If `encoding` is not supplied, the default of `'utf8'` is used. | |||
* If `mode` is not supplied, the default of `0o666` is used. | |||
* If `mode` is a string, it is parsed as an octal integer. | |||
* If `flag` is not supplied, the default of `'w'` is used. | |||
*/ | |||
function writeFile(path: PathLike | FileHandle, data: string | Uint8Array, options?: BaseEncodingOptions & { mode?: Mode, flag?: OpenMode } | BufferEncoding | null): Promise<void>; | |||
/** | |||
* Asynchronously append data to a file, creating the file if it does not exist. | |||
* @param file A path to a file. If a URL is provided, it must use the `file:` protocol. | |||
* URL support is _experimental_. | |||
* If a `FileHandle` is provided, the underlying file will _not_ be closed automatically. | |||
* @param data The data to write. If something other than a `Buffer` or `Uint8Array` is provided, the value is coerced to a string. | |||
* @param options Either the encoding for the file, or an object optionally specifying the encoding, file mode, and flag. | |||
* If `encoding` is not supplied, the default of `'utf8'` is used. | |||
* If `mode` is not supplied, the default of `0o666` is used. | |||
* If `mode` is a string, it is parsed as an octal integer. | |||
* If `flag` is not supplied, the default of `'a'` is used. | |||
*/ | |||
function appendFile(path: PathLike | FileHandle, data: string | Uint8Array, options?: BaseEncodingOptions & { mode?: Mode, flag?: OpenMode } | BufferEncoding | null): Promise<void>; | |||
/** | |||
* Asynchronously reads the entire contents of a file. | |||
* @param path A path to a file. If a URL is provided, it must use the `file:` protocol. | |||
* If a `FileHandle` is provided, the underlying file will _not_ be closed automatically. | |||
* @param options An object that may contain an optional flag. | |||
* If a flag is not provided, it defaults to `'r'`. | |||
*/ | |||
function readFile(path: PathLike | FileHandle, options?: { encoding?: null, flag?: OpenMode } | null): Promise<Buffer>; | |||
/** | |||
* Asynchronously reads the entire contents of a file. | |||
* @param path A path to a file. If a URL is provided, it must use the `file:` protocol. | |||
* If a `FileHandle` is provided, the underlying file will _not_ be closed automatically. | |||
* @param options An object that may contain an optional flag. | |||
* If a flag is not provided, it defaults to `'r'`. | |||
*/ | |||
function readFile(path: PathLike | FileHandle, options: { encoding: BufferEncoding, flag?: OpenMode } | BufferEncoding): Promise<string>; | |||
/** | |||
* Asynchronously reads the entire contents of a file. | |||
* @param path A path to a file. If a URL is provided, it must use the `file:` protocol. | |||
* If a `FileHandle` is provided, the underlying file will _not_ be closed automatically. | |||
* @param options An object that may contain an optional flag. | |||
* If a flag is not provided, it defaults to `'r'`. | |||
*/ | |||
function readFile(path: PathLike | FileHandle, options?: BaseEncodingOptions & { flag?: OpenMode } | BufferEncoding | null): Promise<string | Buffer>; | |||
function opendir(path: string, options?: OpenDirOptions): Promise<Dir>; | |||
} |
@@ -0,0 +1 @@ | |||
declare var global: NodeJS.Global; |
@@ -0,0 +1,397 @@ | |||
declare module "http" { | |||
import * as events from "events"; | |||
import * as stream from "stream"; | |||
import { URL } from "url"; | |||
import { Socket, Server as NetServer } from "net"; | |||
// incoming headers will never contain number | |||
interface IncomingHttpHeaders extends NodeJS.Dict<string | string[]> { | |||
'accept'?: string; | |||
'accept-language'?: string; | |||
'accept-patch'?: string; | |||
'accept-ranges'?: string; | |||
'access-control-allow-credentials'?: string; | |||
'access-control-allow-headers'?: string; | |||
'access-control-allow-methods'?: string; | |||
'access-control-allow-origin'?: string; | |||
'access-control-expose-headers'?: string; | |||
'access-control-max-age'?: string; | |||
'age'?: string; | |||
'allow'?: string; | |||
'alt-svc'?: string; | |||
'authorization'?: string; | |||
'cache-control'?: string; | |||
'connection'?: string; | |||
'content-disposition'?: string; | |||
'content-encoding'?: string; | |||
'content-language'?: string; | |||
'content-length'?: string; | |||
'content-location'?: string; | |||
'content-range'?: string; | |||
'content-type'?: string; | |||
'cookie'?: string; | |||
'date'?: string; | |||
'expect'?: string; | |||
'expires'?: string; | |||
'forwarded'?: string; | |||
'from'?: string; | |||
'host'?: string; | |||
'if-match'?: string; | |||
'if-modified-since'?: string; | |||
'if-none-match'?: string; | |||
'if-unmodified-since'?: string; | |||
'last-modified'?: string; | |||
'location'?: string; | |||
'pragma'?: string; | |||
'proxy-authenticate'?: string; | |||
'proxy-authorization'?: string; | |||
'public-key-pins'?: string; | |||
'range'?: string; | |||
'referer'?: string; | |||
'retry-after'?: string; | |||
'set-cookie'?: string[]; | |||
'strict-transport-security'?: string; | |||
'tk'?: string; | |||
'trailer'?: string; | |||
'transfer-encoding'?: string; | |||
'upgrade'?: string; | |||
'user-agent'?: string; | |||
'vary'?: string; | |||
'via'?: string; | |||
'warning'?: string; | |||
'www-authenticate'?: string; | |||
} | |||
// outgoing headers allows numbers (as they are converted internally to strings) | |||
interface OutgoingHttpHeaders extends NodeJS.Dict<number | string | string[]> { | |||
} | |||
interface ClientRequestArgs { | |||
protocol?: string | null; | |||
host?: string | null; | |||
hostname?: string | null; | |||
family?: number; | |||
port?: number | string | null; | |||
defaultPort?: number | string; | |||
localAddress?: string; | |||
socketPath?: string; | |||
/** | |||
* @default 8192 | |||
*/ | |||
maxHeaderSize?: number; | |||
method?: string; | |||
path?: string | null; | |||
headers?: OutgoingHttpHeaders; | |||
auth?: string | null; | |||
agent?: Agent | boolean; | |||
_defaultAgent?: Agent; | |||
timeout?: number; | |||
setHost?: boolean; | |||
// https://github.com/nodejs/node/blob/master/lib/_http_client.js#L278 | |||
createConnection?: (options: ClientRequestArgs, oncreate: (err: Error, socket: Socket) => void) => Socket; | |||
} | |||
interface ServerOptions { | |||
IncomingMessage?: typeof IncomingMessage; | |||
ServerResponse?: typeof ServerResponse; | |||
/** | |||
* Optionally overrides the value of | |||
* [`--max-http-header-size`][] for requests received by this server, i.e. | |||
* the maximum length of request headers in bytes. | |||
* @default 8192 | |||
*/ | |||
maxHeaderSize?: number; | |||
/** | |||
* Use an insecure HTTP parser that accepts invalid HTTP headers when true. | |||
* Using the insecure parser should be avoided. | |||
* See --insecure-http-parser for more information. | |||
* @default false | |||
*/ | |||
insecureHTTPParser?: boolean; | |||
} | |||
type RequestListener = (req: IncomingMessage, res: ServerResponse) => void; | |||
interface HttpBase { | |||
setTimeout(msecs?: number, callback?: () => void): this; | |||
setTimeout(callback: () => void): this; | |||
/** | |||
* Limits maximum incoming headers count. If set to 0, no limit will be applied. | |||
* @default 2000 | |||
* {@link https://nodejs.org/api/http.html#http_server_maxheaderscount} | |||
*/ | |||
maxHeadersCount: number | null; | |||
timeout: number; | |||
/** | |||
* Limit the amount of time the parser will wait to receive the complete HTTP headers. | |||
* @default 60000 | |||
* {@link https://nodejs.org/api/http.html#http_server_headerstimeout} | |||
*/ | |||
headersTimeout: number; | |||
keepAliveTimeout: number; | |||
} | |||
interface Server extends HttpBase {} | |||
class Server extends NetServer { | |||
constructor(requestListener?: RequestListener); | |||
constructor(options: ServerOptions, requestListener?: RequestListener); | |||
} | |||
// https://github.com/nodejs/node/blob/master/lib/_http_outgoing.js | |||
class OutgoingMessage extends stream.Writable { | |||
upgrading: boolean; | |||
chunkedEncoding: boolean; | |||
shouldKeepAlive: boolean; | |||
useChunkedEncodingByDefault: boolean; | |||
sendDate: boolean; | |||
/** | |||
* @deprecated Use `writableEnded` instead. | |||
*/ | |||
finished: boolean; | |||
headersSent: boolean; | |||
/** | |||
* @deprecate Use `socket` instead. | |||
*/ | |||
connection: Socket; | |||
socket: Socket; | |||
constructor(); | |||
setTimeout(msecs: number, callback?: () => void): this; | |||
setHeader(name: string, value: number | string | string[]): void; | |||
getHeader(name: string): number | string | string[] | undefined; | |||
getHeaders(): OutgoingHttpHeaders; | |||
getHeaderNames(): string[]; | |||
hasHeader(name: string): boolean; | |||
removeHeader(name: string): void; | |||
addTrailers(headers: OutgoingHttpHeaders | Array<[string, string]>): void; | |||
flushHeaders(): void; | |||
} | |||
// https://github.com/nodejs/node/blob/master/lib/_http_server.js#L108-L256 | |||
class ServerResponse extends OutgoingMessage { | |||
statusCode: number; | |||
statusMessage: string; | |||
constructor(req: IncomingMessage); | |||
assignSocket(socket: Socket): void; | |||
detachSocket(socket: Socket): void; | |||
// https://github.com/nodejs/node/blob/master/test/parallel/test-http-write-callbacks.js#L53 | |||
// no args in writeContinue callback | |||
writeContinue(callback?: () => void): void; | |||
writeHead(statusCode: number, reasonPhrase?: string, headers?: OutgoingHttpHeaders): this; | |||
writeHead(statusCode: number, headers?: OutgoingHttpHeaders): this; | |||
writeProcessing(): void; | |||
} | |||
interface InformationEvent { | |||
statusCode: number; | |||
statusMessage: string; | |||
httpVersion: string; | |||
httpVersionMajor: number; | |||
httpVersionMinor: number; | |||
headers: IncomingHttpHeaders; | |||
rawHeaders: string[]; | |||
} | |||
// https://github.com/nodejs/node/blob/master/lib/_http_client.js#L77 | |||
class ClientRequest extends OutgoingMessage { | |||
connection: Socket; | |||
socket: Socket; | |||
aborted: number; | |||
constructor(url: string | URL | ClientRequestArgs, cb?: (res: IncomingMessage) => void); | |||
method: string; | |||
path: string; | |||
abort(): void; | |||
onSocket(socket: Socket): void; | |||
setTimeout(timeout: number, callback?: () => void): this; | |||
setNoDelay(noDelay?: boolean): void; | |||
setSocketKeepAlive(enable?: boolean, initialDelay?: number): void; | |||
addListener(event: 'abort', listener: () => void): this; | |||
addListener(event: 'connect', listener: (response: IncomingMessage, socket: Socket, head: Buffer) => void): this; | |||
addListener(event: 'continue', listener: () => void): this; | |||
addListener(event: 'information', listener: (info: InformationEvent) => void): this; | |||
addListener(event: 'response', listener: (response: IncomingMessage) => void): this; | |||
addListener(event: 'socket', listener: (socket: Socket) => void): this; | |||
addListener(event: 'timeout', listener: () => void): this; | |||
addListener(event: 'upgrade', listener: (response: IncomingMessage, socket: Socket, head: Buffer) => void): this; | |||
addListener(event: 'close', listener: () => void): this; | |||
addListener(event: 'drain', listener: () => void): this; | |||
addListener(event: 'error', listener: (err: Error) => void): this; | |||
addListener(event: 'finish', listener: () => void): this; | |||
addListener(event: 'pipe', listener: (src: stream.Readable) => void): this; | |||
addListener(event: 'unpipe', listener: (src: stream.Readable) => void): this; | |||
addListener(event: string | symbol, listener: (...args: any[]) => void): this; | |||
on(event: 'abort', listener: () => void): this; | |||
on(event: 'connect', listener: (response: IncomingMessage, socket: Socket, head: Buffer) => void): this; | |||
on(event: 'continue', listener: () => void): this; | |||
on(event: 'information', listener: (info: InformationEvent) => void): this; | |||
on(event: 'response', listener: (response: IncomingMessage) => void): this; | |||
on(event: 'socket', listener: (socket: Socket) => void): this; | |||
on(event: 'timeout', listener: () => void): this; | |||
on(event: 'upgrade', listener: (response: IncomingMessage, socket: Socket, head: Buffer) => void): this; | |||
on(event: 'close', listener: () => void): this; | |||
on(event: 'drain', listener: () => void): this; | |||
on(event: 'error', listener: (err: Error) => void): this; | |||
on(event: 'finish', listener: () => void): this; | |||
on(event: 'pipe', listener: (src: stream.Readable) => void): this; | |||
on(event: 'unpipe', listener: (src: stream.Readable) => void): this; | |||
on(event: string | symbol, listener: (...args: any[]) => void): this; | |||
once(event: 'abort', listener: () => void): this; | |||
once(event: 'connect', listener: (response: IncomingMessage, socket: Socket, head: Buffer) => void): this; | |||
once(event: 'continue', listener: () => void): this; | |||
once(event: 'information', listener: (info: InformationEvent) => void): this; | |||
once(event: 'response', listener: (response: IncomingMessage) => void): this; | |||
once(event: 'socket', listener: (socket: Socket) => void): this; | |||
once(event: 'timeout', listener: () => void): this; | |||
once(event: 'upgrade', listener: (response: IncomingMessage, socket: Socket, head: Buffer) => void): this; | |||
once(event: 'close', listener: () => void): this; | |||
once(event: 'drain', listener: () => void): this; | |||
once(event: 'error', listener: (err: Error) => void): this; | |||
once(event: 'finish', listener: () => void): this; | |||
once(event: 'pipe', listener: (src: stream.Readable) => void): this; | |||
once(event: 'unpipe', listener: (src: stream.Readable) => void): this; | |||
once(event: string | symbol, listener: (...args: any[]) => void): this; | |||
prependListener(event: 'abort', listener: () => void): this; | |||
prependListener(event: 'connect', listener: (response: IncomingMessage, socket: Socket, head: Buffer) => void): this; | |||
prependListener(event: 'continue', listener: () => void): this; | |||
prependListener(event: 'information', listener: (info: InformationEvent) => void): this; | |||
prependListener(event: 'response', listener: (response: IncomingMessage) => void): this; | |||
prependListener(event: 'socket', listener: (socket: Socket) => void): this; | |||
prependListener(event: 'timeout', listener: () => void): this; | |||
prependListener(event: 'upgrade', listener: (response: IncomingMessage, socket: Socket, head: Buffer) => void): this; | |||
prependListener(event: 'close', listener: () => void): this; | |||
prependListener(event: 'drain', listener: () => void): this; | |||
prependListener(event: 'error', listener: (err: Error) => void): this; | |||
prependListener(event: 'finish', listener: () => void): this; | |||
prependListener(event: 'pipe', listener: (src: stream.Readable) => void): this; | |||
prependListener(event: 'unpipe', listener: (src: stream.Readable) => void): this; | |||
prependListener(event: string | symbol, listener: (...args: any[]) => void): this; | |||
prependOnceListener(event: 'abort', listener: () => void): this; | |||
prependOnceListener(event: 'connect', listener: (response: IncomingMessage, socket: Socket, head: Buffer) => void): this; | |||
prependOnceListener(event: 'continue', listener: () => void): this; | |||
prependOnceListener(event: 'information', listener: (info: InformationEvent) => void): this; | |||
prependOnceListener(event: 'response', listener: (response: IncomingMessage) => void): this; | |||
prependOnceListener(event: 'socket', listener: (socket: Socket) => void): this; | |||
prependOnceListener(event: 'timeout', listener: () => void): this; | |||
prependOnceListener(event: 'upgrade', listener: (response: IncomingMessage, socket: Socket, head: Buffer) => void): this; | |||
prependOnceListener(event: 'close', listener: () => void): this; | |||
prependOnceListener(event: 'drain', listener: () => void): this; | |||
prependOnceListener(event: 'error', listener: (err: Error) => void): this; | |||
prependOnceListener(event: 'finish', listener: () => void): this; | |||
prependOnceListener(event: 'pipe', listener: (src: stream.Readable) => void): this; | |||
prependOnceListener(event: 'unpipe', listener: (src: stream.Readable) => void): this; | |||
prependOnceListener(event: string | symbol, listener: (...args: any[]) => void): this; | |||
} | |||
class IncomingMessage extends stream.Readable { | |||
constructor(socket: Socket); | |||
aborted: boolean; | |||
httpVersion: string; | |||
httpVersionMajor: number; | |||
httpVersionMinor: number; | |||
complete: boolean; | |||
/** | |||
* @deprecate Use `socket` instead. | |||
*/ | |||
connection: Socket; | |||
socket: Socket; | |||
headers: IncomingHttpHeaders; | |||
rawHeaders: string[]; | |||
trailers: NodeJS.Dict<string>; | |||
rawTrailers: string[]; | |||
setTimeout(msecs: number, callback?: () => void): this; | |||
/** | |||
* Only valid for request obtained from http.Server. | |||
*/ | |||
method?: string; | |||
/** | |||
* Only valid for request obtained from http.Server. | |||
*/ | |||
url?: string; | |||
/** | |||
* Only valid for response obtained from http.ClientRequest. | |||
*/ | |||
statusCode?: number; | |||
/** | |||
* Only valid for response obtained from http.ClientRequest. | |||
*/ | |||
statusMessage?: string; | |||
destroy(error?: Error): void; | |||
} | |||
interface AgentOptions { | |||
/** | |||
* Keep sockets around in a pool to be used by other requests in the future. Default = false | |||
*/ | |||
keepAlive?: boolean; | |||
/** | |||
* When using HTTP KeepAlive, how often to send TCP KeepAlive packets over sockets being kept alive. Default = 1000. | |||
* Only relevant if keepAlive is set to true. | |||
*/ | |||
keepAliveMsecs?: number; | |||
/** | |||
* Maximum number of sockets to allow per host. Default for Node 0.10 is 5, default for Node 0.12 is Infinity | |||
*/ | |||
maxSockets?: number; | |||
/** | |||
* Maximum number of sockets to leave open in a free state. Only relevant if keepAlive is set to true. Default = 256. | |||
*/ | |||
maxFreeSockets?: number; | |||
/** | |||
* Socket timeout in milliseconds. This will set the timeout after the socket is connected. | |||
*/ | |||
timeout?: number; | |||
} | |||
class Agent { | |||
maxFreeSockets: number; | |||
maxSockets: number; | |||
readonly sockets: NodeJS.ReadOnlyDict<Socket[]>; | |||
readonly requests: NodeJS.ReadOnlyDict<IncomingMessage[]>; | |||
constructor(opts?: AgentOptions); | |||
/** | |||
* Destroy any sockets that are currently in use by the agent. | |||
* It is usually not necessary to do this. However, if you are using an agent with KeepAlive enabled, | |||
* then it is best to explicitly shut down the agent when you know that it will no longer be used. Otherwise, | |||
* sockets may hang open for quite a long time before the server terminates them. | |||
*/ | |||
destroy(): void; | |||
} | |||
const METHODS: string[]; | |||
const STATUS_CODES: { | |||
[errorCode: number]: string | undefined; | |||
[errorCode: string]: string | undefined; | |||
}; | |||
function createServer(requestListener?: RequestListener): Server; | |||
function createServer(options: ServerOptions, requestListener?: RequestListener): Server; | |||
// although RequestOptions are passed as ClientRequestArgs to ClientRequest directly, | |||
// create interface RequestOptions would make the naming more clear to developers | |||
interface RequestOptions extends ClientRequestArgs { } | |||
function request(options: RequestOptions | string | URL, callback?: (res: IncomingMessage) => void): ClientRequest; | |||
function request(url: string | URL, options: RequestOptions, callback?: (res: IncomingMessage) => void): ClientRequest; | |||
function get(options: RequestOptions | string | URL, callback?: (res: IncomingMessage) => void): ClientRequest; | |||
function get(url: string | URL, options: RequestOptions, callback?: (res: IncomingMessage) => void): ClientRequest; | |||
let globalAgent: Agent; | |||
/** | |||
* Read-only property specifying the maximum allowed size of HTTP headers in bytes. | |||
* Defaults to 16KB. Configurable using the [`--max-http-header-size`][] CLI option. | |||
*/ | |||
const maxHeaderSize: number; | |||
} |
@@ -0,0 +1,948 @@ | |||
declare module "http2" { | |||
import * as events from "events"; | |||
import * as fs from "fs"; | |||
import * as net from "net"; | |||
import * as stream from "stream"; | |||
import * as tls from "tls"; | |||
import * as url from "url"; | |||
import { IncomingHttpHeaders as Http1IncomingHttpHeaders, OutgoingHttpHeaders, IncomingMessage, ServerResponse } from "http"; | |||
export { OutgoingHttpHeaders } from "http"; | |||
export interface IncomingHttpStatusHeader { | |||
":status"?: number; | |||
} | |||
export interface IncomingHttpHeaders extends Http1IncomingHttpHeaders { | |||
":path"?: string; | |||
":method"?: string; | |||
":authority"?: string; | |||
":scheme"?: string; | |||
} | |||
// Http2Stream | |||
export interface StreamPriorityOptions { | |||
exclusive?: boolean; | |||
parent?: number; | |||
weight?: number; | |||
silent?: boolean; | |||
} | |||
export interface StreamState { | |||
localWindowSize?: number; | |||
state?: number; | |||
localClose?: number; | |||
remoteClose?: number; | |||
sumDependencyWeight?: number; | |||
weight?: number; | |||
} | |||
export interface ServerStreamResponseOptions { | |||
endStream?: boolean; | |||
waitForTrailers?: boolean; | |||
} | |||
export interface StatOptions { | |||
offset: number; | |||
length: number; | |||
} | |||
export interface ServerStreamFileResponseOptions { | |||
statCheck?(stats: fs.Stats, headers: OutgoingHttpHeaders, statOptions: StatOptions): void | boolean; | |||
waitForTrailers?: boolean; | |||
offset?: number; | |||
length?: number; | |||
} | |||
export interface ServerStreamFileResponseOptionsWithError extends ServerStreamFileResponseOptions { | |||
onError?(err: NodeJS.ErrnoException): void; | |||
} | |||
export interface Http2Stream extends stream.Duplex { | |||
readonly aborted: boolean; | |||
readonly bufferSize: number; | |||
readonly closed: boolean; | |||
readonly destroyed: boolean; | |||
/** | |||
* Set the true if the END_STREAM flag was set in the request or response HEADERS frame received, | |||
* indicating that no additional data should be received and the readable side of the Http2Stream will be closed. | |||
*/ | |||
readonly endAfterHeaders: boolean; | |||
readonly id?: number; | |||
readonly pending: boolean; | |||
readonly rstCode: number; | |||
readonly sentHeaders: OutgoingHttpHeaders; | |||
readonly sentInfoHeaders?: OutgoingHttpHeaders[]; | |||
readonly sentTrailers?: OutgoingHttpHeaders; | |||
readonly session: Http2Session; | |||
readonly state: StreamState; | |||
close(code?: number, callback?: () => void): void; | |||
priority(options: StreamPriorityOptions): void; | |||
setTimeout(msecs: number, callback?: () => void): void; | |||
sendTrailers(headers: OutgoingHttpHeaders): void; | |||
addListener(event: "aborted", listener: () => void): this; | |||
addListener(event: "close", listener: () => void): this; | |||
addListener(event: "data", listener: (chunk: Buffer | string) => void): this; | |||
addListener(event: "drain", listener: () => void): this; | |||
addListener(event: "end", listener: () => void): this; | |||
addListener(event: "error", listener: (err: Error) => void): this; | |||
addListener(event: "finish", listener: () => void): this; | |||
addListener(event: "frameError", listener: (frameType: number, errorCode: number) => void): this; | |||
addListener(event: "pipe", listener: (src: stream.Readable) => void): this; | |||
addListener(event: "unpipe", listener: (src: stream.Readable) => void): this; | |||
addListener(event: "streamClosed", listener: (code: number) => void): this; | |||
addListener(event: "timeout", listener: () => void): this; | |||
addListener(event: "trailers", listener: (trailers: IncomingHttpHeaders, flags: number) => void): this; | |||
addListener(event: "wantTrailers", listener: () => void): this; | |||
addListener(event: string | symbol, listener: (...args: any[]) => void): this; | |||
emit(event: "aborted"): boolean; | |||
emit(event: "close"): boolean; | |||
emit(event: "data", chunk: Buffer | string): boolean; | |||
emit(event: "drain"): boolean; | |||
emit(event: "end"): boolean; | |||
emit(event: "error", err: Error): boolean; | |||
emit(event: "finish"): boolean; | |||
emit(event: "frameError", frameType: number, errorCode: number): boolean; | |||
emit(event: "pipe", src: stream.Readable): boolean; | |||
emit(event: "unpipe", src: stream.Readable): boolean; | |||
emit(event: "streamClosed", code: number): boolean; | |||
emit(event: "timeout"): boolean; | |||
emit(event: "trailers", trailers: IncomingHttpHeaders, flags: number): boolean; | |||
emit(event: "wantTrailers"): boolean; | |||
emit(event: string | symbol, ...args: any[]): boolean; | |||
on(event: "aborted", listener: () => void): this; | |||
on(event: "close", listener: () => void): this; | |||
on(event: "data", listener: (chunk: Buffer | string) => void): this; | |||
on(event: "drain", listener: () => void): this; | |||
on(event: "end", listener: () => void): this; | |||
on(event: "error", listener: (err: Error) => void): this; | |||
on(event: "finish", listener: () => void): this; | |||
on(event: "frameError", listener: (frameType: number, errorCode: number) => void): this; | |||
on(event: "pipe", listener: (src: stream.Readable) => void): this; | |||
on(event: "unpipe", listener: (src: stream.Readable) => void): this; | |||
on(event: "streamClosed", listener: (code: number) => void): this; | |||
on(event: "timeout", listener: () => void): this; | |||
on(event: "trailers", listener: (trailers: IncomingHttpHeaders, flags: number) => void): this; | |||
on(event: "wantTrailers", listener: () => void): this; | |||
on(event: string | symbol, listener: (...args: any[]) => void): this; | |||
once(event: "aborted", listener: () => void): this; | |||
once(event: "close", listener: () => void): this; | |||
once(event: "data", listener: (chunk: Buffer | string) => void): this; | |||
once(event: "drain", listener: () => void): this; | |||
once(event: "end", listener: () => void): this; | |||
once(event: "error", listener: (err: Error) => void): this; | |||
once(event: "finish", listener: () => void): this; | |||
once(event: "frameError", listener: (frameType: number, errorCode: number) => void): this; | |||
once(event: "pipe", listener: (src: stream.Readable) => void): this; | |||
once(event: "unpipe", listener: (src: stream.Readable) => void): this; | |||
once(event: "streamClosed", listener: (code: number) => void): this; | |||
once(event: "timeout", listener: () => void): this; | |||
once(event: "trailers", listener: (trailers: IncomingHttpHeaders, flags: number) => void): this; | |||
once(event: "wantTrailers", listener: () => void): this; | |||
once(event: string | symbol, listener: (...args: any[]) => void): this; | |||
prependListener(event: "aborted", listener: () => void): this; | |||
prependListener(event: "close", listener: () => void): this; | |||
prependListener(event: "data", listener: (chunk: Buffer | string) => void): this; | |||
prependListener(event: "drain", listener: () => void): this; | |||
prependListener(event: "end", listener: () => void): this; | |||
prependListener(event: "error", listener: (err: Error) => void): this; | |||
prependListener(event: "finish", listener: () => void): this; | |||
prependListener(event: "frameError", listener: (frameType: number, errorCode: number) => void): this; | |||
prependListener(event: "pipe", listener: (src: stream.Readable) => void): this; | |||
prependListener(event: "unpipe", listener: (src: stream.Readable) => void): this; | |||
prependListener(event: "streamClosed", listener: (code: number) => void): this; | |||
prependListener(event: "timeout", listener: () => void): this; | |||
prependListener(event: "trailers", listener: (trailers: IncomingHttpHeaders, flags: number) => void): this; | |||
prependListener(event: "wantTrailers", listener: () => void): this; | |||
prependListener(event: string | symbol, listener: (...args: any[]) => void): this; | |||
prependOnceListener(event: "aborted", listener: () => void): this; | |||
prependOnceListener(event: "close", listener: () => void): this; | |||
prependOnceListener(event: "data", listener: (chunk: Buffer | string) => void): this; | |||
prependOnceListener(event: "drain", listener: () => void): this; | |||
prependOnceListener(event: "end", listener: () => void): this; | |||
prependOnceListener(event: "error", listener: (err: Error) => void): this; | |||
prependOnceListener(event: "finish", listener: () => void): this; | |||
prependOnceListener(event: "frameError", listener: (frameType: number, errorCode: number) => void): this; | |||
prependOnceListener(event: "pipe", listener: (src: stream.Readable) => void): this; | |||
prependOnceListener(event: "unpipe", listener: (src: stream.Readable) => void): this; | |||
prependOnceListener(event: "streamClosed", listener: (code: number) => void): this; | |||
prependOnceListener(event: "timeout", listener: () => void): this; | |||
prependOnceListener(event: "trailers", listener: (trailers: IncomingHttpHeaders, flags: number) => void): this; | |||
prependOnceListener(event: "wantTrailers", listener: () => void): this; | |||
prependOnceListener(event: string | symbol, listener: (...args: any[]) => void): this; | |||
} | |||
export interface ClientHttp2Stream extends Http2Stream { | |||
addListener(event: "continue", listener: () => {}): this; | |||
addListener(event: "headers", listener: (headers: IncomingHttpHeaders & IncomingHttpStatusHeader, flags: number) => void): this; | |||
addListener(event: "push", listener: (headers: IncomingHttpHeaders, flags: number) => void): this; | |||
addListener(event: "response", listener: (headers: IncomingHttpHeaders & IncomingHttpStatusHeader, flags: number) => void): this; | |||
addListener(event: string | symbol, listener: (...args: any[]) => void): this; | |||
emit(event: "continue"): boolean; | |||
emit(event: "headers", headers: IncomingHttpHeaders & IncomingHttpStatusHeader, flags: number): boolean; | |||
emit(event: "push", headers: IncomingHttpHeaders, flags: number): boolean; | |||
emit(event: "response", headers: IncomingHttpHeaders & IncomingHttpStatusHeader, flags: number): boolean; | |||
emit(event: string | symbol, ...args: any[]): boolean; | |||
on(event: "continue", listener: () => {}): this; | |||
on(event: "headers", listener: (headers: IncomingHttpHeaders & IncomingHttpStatusHeader, flags: number) => void): this; | |||
on(event: "push", listener: (headers: IncomingHttpHeaders, flags: number) => void): this; | |||
on(event: "response", listener: (headers: IncomingHttpHeaders & IncomingHttpStatusHeader, flags: number) => void): this; | |||
on(event: string | symbol, listener: (...args: any[]) => void): this; | |||
once(event: "continue", listener: () => {}): this; | |||
once(event: "headers", listener: (headers: IncomingHttpHeaders & IncomingHttpStatusHeader, flags: number) => void): this; | |||
once(event: "push", listener: (headers: IncomingHttpHeaders, flags: number) => void): this; | |||
once(event: "response", listener: (headers: IncomingHttpHeaders & IncomingHttpStatusHeader, flags: number) => void): this; | |||
once(event: string | symbol, listener: (...args: any[]) => void): this; | |||
prependListener(event: "continue", listener: () => {}): this; | |||
prependListener(event: "headers", listener: (headers: IncomingHttpHeaders & IncomingHttpStatusHeader, flags: number) => void): this; | |||
prependListener(event: "push", listener: (headers: IncomingHttpHeaders, flags: number) => void): this; | |||
prependListener(event: "response", listener: (headers: IncomingHttpHeaders & IncomingHttpStatusHeader, flags: number) => void): this; | |||
prependListener(event: string | symbol, listener: (...args: any[]) => void): this; | |||
prependOnceListener(event: "continue", listener: () => {}): this; | |||
prependOnceListener(event: "headers", listener: (headers: IncomingHttpHeaders & IncomingHttpStatusHeader, flags: number) => void): this; | |||
prependOnceListener(event: "push", listener: (headers: IncomingHttpHeaders, flags: number) => void): this; | |||
prependOnceListener(event: "response", listener: (headers: IncomingHttpHeaders & IncomingHttpStatusHeader, flags: number) => void): this; | |||
prependOnceListener(event: string | symbol, listener: (...args: any[]) => void): this; | |||
} | |||
export interface ServerHttp2Stream extends Http2Stream { | |||
readonly headersSent: boolean; | |||
readonly pushAllowed: boolean; | |||
additionalHeaders(headers: OutgoingHttpHeaders): void; | |||
pushStream(headers: OutgoingHttpHeaders, callback?: (err: Error | null, pushStream: ServerHttp2Stream, headers: OutgoingHttpHeaders) => void): void; | |||
pushStream(headers: OutgoingHttpHeaders, options?: StreamPriorityOptions, callback?: (err: Error | null, pushStream: ServerHttp2Stream, headers: OutgoingHttpHeaders) => void): void; | |||
respond(headers?: OutgoingHttpHeaders, options?: ServerStreamResponseOptions): void; | |||
respondWithFD(fd: number | fs.promises.FileHandle, headers?: OutgoingHttpHeaders, options?: ServerStreamFileResponseOptions): void; | |||
respondWithFile(path: string, headers?: OutgoingHttpHeaders, options?: ServerStreamFileResponseOptionsWithError): void; | |||
} | |||
// Http2Session | |||
export interface Settings { | |||
headerTableSize?: number; | |||
enablePush?: boolean; | |||
initialWindowSize?: number; | |||
maxFrameSize?: number; | |||
maxConcurrentStreams?: number; | |||
maxHeaderListSize?: number; | |||
enableConnectProtocol?: boolean; | |||
} | |||
export interface ClientSessionRequestOptions { | |||
endStream?: boolean; | |||
exclusive?: boolean; | |||
parent?: number; | |||
weight?: number; | |||
waitForTrailers?: boolean; | |||
} | |||
export interface SessionState { | |||
effectiveLocalWindowSize?: number; | |||
effectiveRecvDataLength?: number; | |||
nextStreamID?: number; | |||
localWindowSize?: number; | |||
lastProcStreamID?: number; | |||
remoteWindowSize?: number; | |||
outboundQueueSize?: number; | |||
deflateDynamicTableSize?: number; | |||
inflateDynamicTableSize?: number; | |||
} | |||
export interface Http2Session extends events.EventEmitter { | |||
readonly alpnProtocol?: string; | |||
readonly closed: boolean; | |||
readonly connecting: boolean; | |||
readonly destroyed: boolean; | |||
readonly encrypted?: boolean; | |||
readonly localSettings: Settings; | |||
readonly originSet?: string[]; | |||
readonly pendingSettingsAck: boolean; | |||
readonly remoteSettings: Settings; | |||
readonly socket: net.Socket | tls.TLSSocket; | |||
readonly state: SessionState; | |||
readonly type: number; | |||
close(callback?: () => void): void; | |||
destroy(error?: Error, code?: number): void; | |||
goaway(code?: number, lastStreamID?: number, opaqueData?: NodeJS.ArrayBufferView): void; | |||
ping(callback: (err: Error | null, duration: number, payload: Buffer) => void): boolean; | |||
ping(payload: NodeJS.ArrayBufferView, callback: (err: Error | null, duration: number, payload: Buffer) => void): boolean; | |||
ref(): void; | |||
setTimeout(msecs: number, callback?: () => void): void; | |||
settings(settings: Settings): void; | |||
unref(): void; | |||
addListener(event: "close", listener: () => void): this; | |||
addListener(event: "error", listener: (err: Error) => void): this; | |||
addListener(event: "frameError", listener: (frameType: number, errorCode: number, streamID: number) => void): this; | |||
addListener(event: "goaway", listener: (errorCode: number, lastStreamID: number, opaqueData: Buffer) => void): this; | |||
addListener(event: "localSettings", listener: (settings: Settings) => void): this; | |||
addListener(event: "ping", listener: () => void): this; | |||
addListener(event: "remoteSettings", listener: (settings: Settings) => void): this; | |||
addListener(event: "timeout", listener: () => void): this; | |||
addListener(event: string | symbol, listener: (...args: any[]) => void): this; | |||
emit(event: "close"): boolean; | |||
emit(event: "error", err: Error): boolean; | |||
emit(event: "frameError", frameType: number, errorCode: number, streamID: number): boolean; | |||
emit(event: "goaway", errorCode: number, lastStreamID: number, opaqueData: Buffer): boolean; | |||
emit(event: "localSettings", settings: Settings): boolean; | |||
emit(event: "ping"): boolean; | |||
emit(event: "remoteSettings", settings: Settings): boolean; | |||
emit(event: "timeout"): boolean; | |||
emit(event: string | symbol, ...args: any[]): boolean; | |||
on(event: "close", listener: () => void): this; | |||
on(event: "error", listener: (err: Error) => void): this; | |||
on(event: "frameError", listener: (frameType: number, errorCode: number, streamID: number) => void): this; | |||
on(event: "goaway", listener: (errorCode: number, lastStreamID: number, opaqueData: Buffer) => void): this; | |||
on(event: "localSettings", listener: (settings: Settings) => void): this; | |||
on(event: "ping", listener: () => void): this; | |||
on(event: "remoteSettings", listener: (settings: Settings) => void): this; | |||
on(event: "timeout", listener: () => void): this; | |||
on(event: string | symbol, listener: (...args: any[]) => void): this; | |||
once(event: "close", listener: () => void): this; | |||
once(event: "error", listener: (err: Error) => void): this; | |||
once(event: "frameError", listener: (frameType: number, errorCode: number, streamID: number) => void): this; | |||
once(event: "goaway", listener: (errorCode: number, lastStreamID: number, opaqueData: Buffer) => void): this; | |||
once(event: "localSettings", listener: (settings: Settings) => void): this; | |||
once(event: "ping", listener: () => void): this; | |||
once(event: "remoteSettings", listener: (settings: Settings) => void): this; | |||
once(event: "timeout", listener: () => void): this; | |||
once(event: string | symbol, listener: (...args: any[]) => void): this; | |||
prependListener(event: "close", listener: () => void): this; | |||
prependListener(event: "error", listener: (err: Error) => void): this; | |||
prependListener(event: "frameError", listener: (frameType: number, errorCode: number, streamID: number) => void): this; | |||
prependListener(event: "goaway", listener: (errorCode: number, lastStreamID: number, opaqueData: Buffer) => void): this; | |||
prependListener(event: "localSettings", listener: (settings: Settings) => void): this; | |||
prependListener(event: "ping", listener: () => void): this; | |||
prependListener(event: "remoteSettings", listener: (settings: Settings) => void): this; | |||
prependListener(event: "timeout", listener: () => void): this; | |||
prependListener(event: string | symbol, listener: (...args: any[]) => void): this; | |||
prependOnceListener(event: "close", listener: () => void): this; | |||
prependOnceListener(event: "error", listener: (err: Error) => void): this; | |||
prependOnceListener(event: "frameError", listener: (frameType: number, errorCode: number, streamID: number) => void): this; | |||
prependOnceListener(event: "goaway", listener: (errorCode: number, lastStreamID: number, opaqueData: Buffer) => void): this; | |||
prependOnceListener(event: "localSettings", listener: (settings: Settings) => void): this; | |||
prependOnceListener(event: "ping", listener: () => void): this; | |||
prependOnceListener(event: "remoteSettings", listener: (settings: Settings) => void): this; | |||
prependOnceListener(event: "timeout", listener: () => void): this; | |||
prependOnceListener(event: string | symbol, listener: (...args: any[]) => void): this; | |||
} | |||
export interface ClientHttp2Session extends Http2Session { | |||
request(headers?: OutgoingHttpHeaders, options?: ClientSessionRequestOptions): ClientHttp2Stream; | |||
addListener(event: "altsvc", listener: (alt: string, origin: string, stream: number) => void): this; | |||
addListener(event: "origin", listener: (origins: string[]) => void): this; | |||
addListener(event: "connect", listener: (session: ClientHttp2Session, socket: net.Socket | tls.TLSSocket) => void): this; | |||
addListener(event: "stream", listener: (stream: ClientHttp2Stream, headers: IncomingHttpHeaders & IncomingHttpStatusHeader, flags: number) => void): this; | |||
addListener(event: string | symbol, listener: (...args: any[]) => void): this; | |||
emit(event: "altsvc", alt: string, origin: string, stream: number): boolean; | |||
emit(event: "origin", origins: string[]): boolean; | |||
emit(event: "connect", session: ClientHttp2Session, socket: net.Socket | tls.TLSSocket): boolean; | |||
emit(event: "stream", stream: ClientHttp2Stream, headers: IncomingHttpHeaders & IncomingHttpStatusHeader, flags: number): boolean; | |||
emit(event: string | symbol, ...args: any[]): boolean; | |||
on(event: "altsvc", listener: (alt: string, origin: string, stream: number) => void): this; | |||
on(event: "origin", listener: (origins: string[]) => void): this; | |||
on(event: "connect", listener: (session: ClientHttp2Session, socket: net.Socket | tls.TLSSocket) => void): this; | |||
on(event: "stream", listener: (stream: ClientHttp2Stream, headers: IncomingHttpHeaders & IncomingHttpStatusHeader, flags: number) => void): this; | |||
on(event: string | symbol, listener: (...args: any[]) => void): this; | |||
once(event: "altsvc", listener: (alt: string, origin: string, stream: number) => void): this; | |||
once(event: "origin", listener: (origins: string[]) => void): this; | |||
once(event: "connect", listener: (session: ClientHttp2Session, socket: net.Socket | tls.TLSSocket) => void): this; | |||
once(event: "stream", listener: (stream: ClientHttp2Stream, headers: IncomingHttpHeaders & IncomingHttpStatusHeader, flags: number) => void): this; | |||
once(event: string | symbol, listener: (...args: any[]) => void): this; | |||
prependListener(event: "altsvc", listener: (alt: string, origin: string, stream: number) => void): this; | |||
prependListener(event: "origin", listener: (origins: string[]) => void): this; | |||
prependListener(event: "connect", listener: (session: ClientHttp2Session, socket: net.Socket | tls.TLSSocket) => void): this; | |||
prependListener(event: "stream", listener: (stream: ClientHttp2Stream, headers: IncomingHttpHeaders & IncomingHttpStatusHeader, flags: number) => void): this; | |||
prependListener(event: string | symbol, listener: (...args: any[]) => void): this; | |||
prependOnceListener(event: "altsvc", listener: (alt: string, origin: string, stream: number) => void): this; | |||
prependOnceListener(event: "origin", listener: (origins: string[]) => void): this; | |||
prependOnceListener(event: "connect", listener: (session: ClientHttp2Session, socket: net.Socket | tls.TLSSocket) => void): this; | |||
prependOnceListener(event: "stream", listener: (stream: ClientHttp2Stream, headers: IncomingHttpHeaders & IncomingHttpStatusHeader, flags: number) => void): this; | |||
prependOnceListener(event: string | symbol, listener: (...args: any[]) => void): this; | |||
} | |||
export interface AlternativeServiceOptions { | |||
origin: number | string | url.URL; | |||
} | |||
export interface ServerHttp2Session extends Http2Session { | |||
readonly server: Http2Server | Http2SecureServer; | |||
altsvc(alt: string, originOrStream: number | string | url.URL | AlternativeServiceOptions): void; | |||
origin(...args: Array<string | url.URL | { origin: string }>): void; | |||
addListener(event: "connect", listener: (session: ServerHttp2Session, socket: net.Socket | tls.TLSSocket) => void): this; | |||
addListener(event: "stream", listener: (stream: ServerHttp2Stream, headers: IncomingHttpHeaders, flags: number) => void): this; | |||
addListener(event: string | symbol, listener: (...args: any[]) => void): this; | |||
emit(event: "connect", session: ServerHttp2Session, socket: net.Socket | tls.TLSSocket): boolean; | |||
emit(event: "stream", stream: ServerHttp2Stream, headers: IncomingHttpHeaders, flags: number): boolean; | |||
emit(event: string | symbol, ...args: any[]): boolean; | |||
on(event: "connect", listener: (session: ServerHttp2Session, socket: net.Socket | tls.TLSSocket) => void): this; | |||
on(event: "stream", listener: (stream: ServerHttp2Stream, headers: IncomingHttpHeaders, flags: number) => void): this; | |||
on(event: string | symbol, listener: (...args: any[]) => void): this; | |||
once(event: "connect", listener: (session: ServerHttp2Session, socket: net.Socket | tls.TLSSocket) => void): this; | |||
once(event: "stream", listener: (stream: ServerHttp2Stream, headers: IncomingHttpHeaders, flags: number) => void): this; | |||
once(event: string | symbol, listener: (...args: any[]) => void): this; | |||
prependListener(event: "connect", listener: (session: ServerHttp2Session, socket: net.Socket | tls.TLSSocket) => void): this; | |||
prependListener(event: "stream", listener: (stream: ServerHttp2Stream, headers: IncomingHttpHeaders, flags: number) => void): this; | |||
prependListener(event: string | symbol, listener: (...args: any[]) => void): this; | |||
prependOnceListener(event: "connect", listener: (session: ServerHttp2Session, socket: net.Socket | tls.TLSSocket) => void): this; | |||
prependOnceListener(event: "stream", listener: (stream: ServerHttp2Stream, headers: IncomingHttpHeaders, flags: number) => void): this; | |||
prependOnceListener(event: string | symbol, listener: (...args: any[]) => void): this; | |||
} | |||
// Http2Server | |||
export interface SessionOptions { | |||
maxDeflateDynamicTableSize?: number; | |||
maxSessionMemory?: number; | |||
maxHeaderListPairs?: number; | |||
maxOutstandingPings?: number; | |||
maxSendHeaderBlockLength?: number; | |||
paddingStrategy?: number; | |||
peerMaxConcurrentStreams?: number; | |||
settings?: Settings; | |||
selectPadding?(frameLen: number, maxFrameLen: number): number; | |||
createConnection?(authority: url.URL, option: SessionOptions): stream.Duplex; | |||
} | |||
export interface ClientSessionOptions extends SessionOptions { | |||
maxReservedRemoteStreams?: number; | |||
createConnection?: (authority: url.URL, option: SessionOptions) => stream.Duplex; | |||
protocol?: 'http:' | 'https:'; | |||
} | |||
export interface ServerSessionOptions extends SessionOptions { | |||
Http1IncomingMessage?: typeof IncomingMessage; | |||
Http1ServerResponse?: typeof ServerResponse; | |||
Http2ServerRequest?: typeof Http2ServerRequest; | |||
Http2ServerResponse?: typeof Http2ServerResponse; | |||
} | |||
export interface SecureClientSessionOptions extends ClientSessionOptions, tls.ConnectionOptions { } | |||
export interface SecureServerSessionOptions extends ServerSessionOptions, tls.TlsOptions { } | |||
export interface ServerOptions extends ServerSessionOptions { } | |||
export interface SecureServerOptions extends SecureServerSessionOptions { | |||
allowHTTP1?: boolean; | |||
origins?: string[]; | |||
} | |||
export interface Http2Server extends net.Server { | |||
addListener(event: "checkContinue", listener: (request: Http2ServerRequest, response: Http2ServerResponse) => void): this; | |||
addListener(event: "request", listener: (request: Http2ServerRequest, response: Http2ServerResponse) => void): this; | |||
addListener(event: "session", listener: (session: ServerHttp2Session) => void): this; | |||
addListener(event: "sessionError", listener: (err: Error) => void): this; | |||
addListener(event: "stream", listener: (stream: ServerHttp2Stream, headers: IncomingHttpHeaders, flags: number) => void): this; | |||
addListener(event: "timeout", listener: () => void): this; | |||
addListener(event: string | symbol, listener: (...args: any[]) => void): this; | |||
emit(event: "checkContinue", request: Http2ServerRequest, response: Http2ServerResponse): boolean; | |||
emit(event: "request", request: Http2ServerRequest, response: Http2ServerResponse): boolean; | |||
emit(event: "session", session: ServerHttp2Session): boolean; | |||
emit(event: "sessionError", err: Error): boolean; | |||
emit(event: "stream", stream: ServerHttp2Stream, headers: IncomingHttpHeaders, flags: number): boolean; | |||
emit(event: "timeout"): boolean; | |||
emit(event: string | symbol, ...args: any[]): boolean; | |||
on(event: "checkContinue", listener: (request: Http2ServerRequest, response: Http2ServerResponse) => void): this; | |||
on(event: "request", listener: (request: Http2ServerRequest, response: Http2ServerResponse) => void): this; | |||
on(event: "session", listener: (session: ServerHttp2Session) => void): this; | |||
on(event: "sessionError", listener: (err: Error) => void): this; | |||
on(event: "stream", listener: (stream: ServerHttp2Stream, headers: IncomingHttpHeaders, flags: number) => void): this; | |||
on(event: "timeout", listener: () => void): this; | |||
on(event: string | symbol, listener: (...args: any[]) => void): this; | |||
once(event: "checkContinue", listener: (request: Http2ServerRequest, response: Http2ServerResponse) => void): this; | |||
once(event: "request", listener: (request: Http2ServerRequest, response: Http2ServerResponse) => void): this; | |||
once(event: "session", listener: (session: ServerHttp2Session) => void): this; | |||
once(event: "sessionError", listener: (err: Error) => void): this; | |||
once(event: "stream", listener: (stream: ServerHttp2Stream, headers: IncomingHttpHeaders, flags: number) => void): this; | |||
once(event: "timeout", listener: () => void): this; | |||
once(event: string | symbol, listener: (...args: any[]) => void): this; | |||
prependListener(event: "checkContinue", listener: (request: Http2ServerRequest, response: Http2ServerResponse) => void): this; | |||
prependListener(event: "request", listener: (request: Http2ServerRequest, response: Http2ServerResponse) => void): this; | |||
prependListener(event: "session", listener: (session: ServerHttp2Session) => void): this; | |||
prependListener(event: "sessionError", listener: (err: Error) => void): this; | |||
prependListener(event: "stream", listener: (stream: ServerHttp2Stream, headers: IncomingHttpHeaders, flags: number) => void): this; | |||
prependListener(event: "timeout", listener: () => void): this; | |||
prependListener(event: string | symbol, listener: (...args: any[]) => void): this; | |||
prependOnceListener(event: "checkContinue", listener: (request: Http2ServerRequest, response: Http2ServerResponse) => void): this; | |||
prependOnceListener(event: "request", listener: (request: Http2ServerRequest, response: Http2ServerResponse) => void): this; | |||
prependOnceListener(event: "session", listener: (session: ServerHttp2Session) => void): this; | |||
prependOnceListener(event: "sessionError", listener: (err: Error) => void): this; | |||
prependOnceListener(event: "stream", listener: (stream: ServerHttp2Stream, headers: IncomingHttpHeaders, flags: number) => void): this; | |||
prependOnceListener(event: "timeout", listener: () => void): this; | |||
prependOnceListener(event: string | symbol, listener: (...args: any[]) => void): this; | |||
setTimeout(msec?: number, callback?: () => void): this; | |||
} | |||
export interface Http2SecureServer extends tls.Server { | |||
addListener(event: "checkContinue", listener: (request: Http2ServerRequest, response: Http2ServerResponse) => void): this; | |||
addListener(event: "request", listener: (request: Http2ServerRequest, response: Http2ServerResponse) => void): this; | |||
addListener(event: "session", listener: (session: ServerHttp2Session) => void): this; | |||
addListener(event: "sessionError", listener: (err: Error) => void): this; | |||
addListener(event: "stream", listener: (stream: ServerHttp2Stream, headers: IncomingHttpHeaders, flags: number) => void): this; | |||
addListener(event: "timeout", listener: () => void): this; | |||
addListener(event: "unknownProtocol", listener: (socket: tls.TLSSocket) => void): this; | |||
addListener(event: string | symbol, listener: (...args: any[]) => void): this; | |||
emit(event: "checkContinue", request: Http2ServerRequest, response: Http2ServerResponse): boolean; | |||
emit(event: "request", request: Http2ServerRequest, response: Http2ServerResponse): boolean; | |||
emit(event: "session", session: ServerHttp2Session): boolean; | |||
emit(event: "sessionError", err: Error): boolean; | |||
emit(event: "stream", stream: ServerHttp2Stream, headers: IncomingHttpHeaders, flags: number): boolean; | |||
emit(event: "timeout"): boolean; | |||
emit(event: "unknownProtocol", socket: tls.TLSSocket): boolean; | |||
emit(event: string | symbol, ...args: any[]): boolean; | |||
on(event: "checkContinue", listener: (request: Http2ServerRequest, response: Http2ServerResponse) => void): this; | |||
on(event: "request", listener: (request: Http2ServerRequest, response: Http2ServerResponse) => void): this; | |||
on(event: "session", listener: (session: ServerHttp2Session) => void): this; | |||
on(event: "sessionError", listener: (err: Error) => void): this; | |||
on(event: "stream", listener: (stream: ServerHttp2Stream, headers: IncomingHttpHeaders, flags: number) => void): this; | |||
on(event: "timeout", listener: () => void): this; | |||
on(event: "unknownProtocol", listener: (socket: tls.TLSSocket) => void): this; | |||
on(event: string | symbol, listener: (...args: any[]) => void): this; | |||
once(event: "checkContinue", listener: (request: Http2ServerRequest, response: Http2ServerResponse) => void): this; | |||
once(event: "request", listener: (request: Http2ServerRequest, response: Http2ServerResponse) => void): this; | |||
once(event: "session", listener: (session: ServerHttp2Session) => void): this; | |||
once(event: "sessionError", listener: (err: Error) => void): this; | |||
once(event: "stream", listener: (stream: ServerHttp2Stream, headers: IncomingHttpHeaders, flags: number) => void): this; | |||
once(event: "timeout", listener: () => void): this; | |||
once(event: "unknownProtocol", listener: (socket: tls.TLSSocket) => void): this; | |||
once(event: string | symbol, listener: (...args: any[]) => void): this; | |||
prependListener(event: "checkContinue", listener: (request: Http2ServerRequest, response: Http2ServerResponse) => void): this; | |||
prependListener(event: "request", listener: (request: Http2ServerRequest, response: Http2ServerResponse) => void): this; | |||
prependListener(event: "session", listener: (session: ServerHttp2Session) => void): this; | |||
prependListener(event: "sessionError", listener: (err: Error) => void): this; | |||
prependListener(event: "stream", listener: (stream: ServerHttp2Stream, headers: IncomingHttpHeaders, flags: number) => void): this; | |||
prependListener(event: "timeout", listener: () => void): this; | |||
prependListener(event: "unknownProtocol", listener: (socket: tls.TLSSocket) => void): this; | |||
prependListener(event: string | symbol, listener: (...args: any[]) => void): this; | |||
prependOnceListener(event: "checkContinue", listener: (request: Http2ServerRequest, response: Http2ServerResponse) => void): this; | |||
prependOnceListener(event: "request", listener: (request: Http2ServerRequest, response: Http2ServerResponse) => void): this; | |||
prependOnceListener(event: "session", listener: (session: ServerHttp2Session) => void): this; | |||
prependOnceListener(event: "sessionError", listener: (err: Error) => void): this; | |||
prependOnceListener(event: "stream", listener: (stream: ServerHttp2Stream, headers: IncomingHttpHeaders, flags: number) => void): this; | |||
prependOnceListener(event: "timeout", listener: () => void): this; | |||
prependOnceListener(event: "unknownProtocol", listener: (socket: tls.TLSSocket) => void): this; | |||
prependOnceListener(event: string | symbol, listener: (...args: any[]) => void): this; | |||
setTimeout(msec?: number, callback?: () => void): this; | |||
} | |||
export class Http2ServerRequest extends stream.Readable { | |||
constructor(stream: ServerHttp2Stream, headers: IncomingHttpHeaders, options: stream.ReadableOptions, rawHeaders: string[]); | |||
readonly aborted: boolean; | |||
readonly authority: string; | |||
readonly headers: IncomingHttpHeaders; | |||
readonly httpVersion: string; | |||
readonly method: string; | |||
readonly rawHeaders: string[]; | |||
readonly rawTrailers: string[]; | |||
readonly scheme: string; | |||
readonly socket: net.Socket | tls.TLSSocket; | |||
readonly stream: ServerHttp2Stream; | |||
readonly trailers: IncomingHttpHeaders; | |||
readonly url: string; | |||
setTimeout(msecs: number, callback?: () => void): void; | |||
read(size?: number): Buffer | string | null; | |||
addListener(event: "aborted", listener: (hadError: boolean, code: number) => void): this; | |||
addListener(event: "close", listener: () => void): this; | |||
addListener(event: "data", listener: (chunk: Buffer | string) => void): this; | |||
addListener(event: "end", listener: () => void): this; | |||
addListener(event: "readable", listener: () => void): this; | |||
addListener(event: "error", listener: (err: Error) => void): this; | |||
addListener(event: string | symbol, listener: (...args: any[]) => void): this; | |||
emit(event: "aborted", hadError: boolean, code: number): boolean; | |||
emit(event: "close"): boolean; | |||
emit(event: "data", chunk: Buffer | string): boolean; | |||
emit(event: "end"): boolean; | |||
emit(event: "readable"): boolean; | |||
emit(event: "error", err: Error): boolean; | |||
emit(event: string | symbol, ...args: any[]): boolean; | |||
on(event: "aborted", listener: (hadError: boolean, code: number) => void): this; | |||
on(event: "close", listener: () => void): this; | |||
on(event: "data", listener: (chunk: Buffer | string) => void): this; | |||
on(event: "end", listener: () => void): this; | |||
on(event: "readable", listener: () => void): this; | |||
on(event: "error", listener: (err: Error) => void): this; | |||
on(event: string | symbol, listener: (...args: any[]) => void): this; | |||
once(event: "aborted", listener: (hadError: boolean, code: number) => void): this; | |||
once(event: "close", listener: () => void): this; | |||
once(event: "data", listener: (chunk: Buffer | string) => void): this; | |||
once(event: "end", listener: () => void): this; | |||
once(event: "readable", listener: () => void): this; | |||
once(event: "error", listener: (err: Error) => void): this; | |||
once(event: string | symbol, listener: (...args: any[]) => void): this; | |||
prependListener(event: "aborted", listener: (hadError: boolean, code: number) => void): this; | |||
prependListener(event: "close", listener: () => void): this; | |||
prependListener(event: "data", listener: (chunk: Buffer | string) => void): this; | |||
prependListener(event: "end", listener: () => void): this; | |||
prependListener(event: "readable", listener: () => void): this; | |||
prependListener(event: "error", listener: (err: Error) => void): this; | |||
prependListener(event: string | symbol, listener: (...args: any[]) => void): this; | |||
prependOnceListener(event: "aborted", listener: (hadError: boolean, code: number) => void): this; | |||
prependOnceListener(event: "close", listener: () => void): this; | |||
prependOnceListener(event: "data", listener: (chunk: Buffer | string) => void): this; | |||
prependOnceListener(event: "end", listener: () => void): this; | |||
prependOnceListener(event: "readable", listener: () => void): this; | |||
prependOnceListener(event: "error", listener: (err: Error) => void): this; | |||
prependOnceListener(event: string | symbol, listener: (...args: any[]) => void): this; | |||
} | |||
export class Http2ServerResponse extends stream.Stream { | |||
constructor(stream: ServerHttp2Stream); | |||
readonly connection: net.Socket | tls.TLSSocket; | |||
readonly finished: boolean; | |||
readonly headersSent: boolean; | |||
readonly socket: net.Socket | tls.TLSSocket; | |||
readonly stream: ServerHttp2Stream; | |||
sendDate: boolean; | |||
statusCode: number; | |||
statusMessage: ''; | |||
addTrailers(trailers: OutgoingHttpHeaders): void; | |||
end(callback?: () => void): void; | |||
end(data: string | Uint8Array, callback?: () => void): void; | |||
end(data: string | Uint8Array, encoding: BufferEncoding, callback?: () => void): void; | |||
getHeader(name: string): string; | |||
getHeaderNames(): string[]; | |||
getHeaders(): OutgoingHttpHeaders; | |||
hasHeader(name: string): boolean; | |||
removeHeader(name: string): void; | |||
setHeader(name: string, value: number | string | string[]): void; | |||
setTimeout(msecs: number, callback?: () => void): void; | |||
write(chunk: string | Uint8Array, callback?: (err: Error) => void): boolean; | |||
write(chunk: string | Uint8Array, encoding: BufferEncoding, callback?: (err: Error) => void): boolean; | |||
writeContinue(): void; | |||
writeHead(statusCode: number, headers?: OutgoingHttpHeaders): this; | |||
writeHead(statusCode: number, statusMessage: string, headers?: OutgoingHttpHeaders): this; | |||
createPushResponse(headers: OutgoingHttpHeaders, callback: (err: Error | null, res: Http2ServerResponse) => void): void; | |||
addListener(event: "close", listener: () => void): this; | |||
addListener(event: "drain", listener: () => void): this; | |||
addListener(event: "error", listener: (error: Error) => void): this; | |||
addListener(event: "finish", listener: () => void): this; | |||
addListener(event: "pipe", listener: (src: stream.Readable) => void): this; | |||
addListener(event: "unpipe", listener: (src: stream.Readable) => void): this; | |||
addListener(event: string | symbol, listener: (...args: any[]) => void): this; | |||
emit(event: "close"): boolean; | |||
emit(event: "drain"): boolean; | |||
emit(event: "error", error: Error): boolean; | |||
emit(event: "finish"): boolean; | |||
emit(event: "pipe", src: stream.Readable): boolean; | |||
emit(event: "unpipe", src: stream.Readable): boolean; | |||
emit(event: string | symbol, ...args: any[]): boolean; | |||
on(event: "close", listener: () => void): this; | |||
on(event: "drain", listener: () => void): this; | |||
on(event: "error", listener: (error: Error) => void): this; | |||
on(event: "finish", listener: () => void): this; | |||
on(event: "pipe", listener: (src: stream.Readable) => void): this; | |||
on(event: "unpipe", listener: (src: stream.Readable) => void): this; | |||
on(event: string | symbol, listener: (...args: any[]) => void): this; | |||
once(event: "close", listener: () => void): this; | |||
once(event: "drain", listener: () => void): this; | |||
once(event: "error", listener: (error: Error) => void): this; | |||
once(event: "finish", listener: () => void): this; | |||
once(event: "pipe", listener: (src: stream.Readable) => void): this; | |||
once(event: "unpipe", listener: (src: stream.Readable) => void): this; | |||
once(event: string | symbol, listener: (...args: any[]) => void): this; | |||
prependListener(event: "close", listener: () => void): this; | |||
prependListener(event: "drain", listener: () => void): this; | |||
prependListener(event: "error", listener: (error: Error) => void): this; | |||
prependListener(event: "finish", listener: () => void): this; | |||
prependListener(event: "pipe", listener: (src: stream.Readable) => void): this; | |||
prependListener(event: "unpipe", listener: (src: stream.Readable) => void): this; | |||
prependListener(event: string | symbol, listener: (...args: any[]) => void): this; | |||
prependOnceListener(event: "close", listener: () => void): this; | |||
prependOnceListener(event: "drain", listener: () => void): this; | |||
prependOnceListener(event: "error", listener: (error: Error) => void): this; | |||
prependOnceListener(event: "finish", listener: () => void): this; | |||
prependOnceListener(event: "pipe", listener: (src: stream.Readable) => void): this; | |||
prependOnceListener(event: "unpipe", listener: (src: stream.Readable) => void): this; | |||
prependOnceListener(event: string | symbol, listener: (...args: any[]) => void): this; | |||
} | |||
// Public API | |||
export namespace constants { | |||
const NGHTTP2_SESSION_SERVER: number; | |||
const NGHTTP2_SESSION_CLIENT: number; | |||
const NGHTTP2_STREAM_STATE_IDLE: number; | |||
const NGHTTP2_STREAM_STATE_OPEN: number; | |||
const NGHTTP2_STREAM_STATE_RESERVED_LOCAL: number; | |||
const NGHTTP2_STREAM_STATE_RESERVED_REMOTE: number; | |||
const NGHTTP2_STREAM_STATE_HALF_CLOSED_LOCAL: number; | |||
const NGHTTP2_STREAM_STATE_HALF_CLOSED_REMOTE: number; | |||
const NGHTTP2_STREAM_STATE_CLOSED: number; | |||
const NGHTTP2_NO_ERROR: number; | |||
const NGHTTP2_PROTOCOL_ERROR: number; | |||
const NGHTTP2_INTERNAL_ERROR: number; | |||
const NGHTTP2_FLOW_CONTROL_ERROR: number; | |||
const NGHTTP2_SETTINGS_TIMEOUT: number; | |||
const NGHTTP2_STREAM_CLOSED: number; | |||
const NGHTTP2_FRAME_SIZE_ERROR: number; | |||
const NGHTTP2_REFUSED_STREAM: number; | |||
const NGHTTP2_CANCEL: number; | |||
const NGHTTP2_COMPRESSION_ERROR: number; | |||
const NGHTTP2_CONNECT_ERROR: number; | |||
const NGHTTP2_ENHANCE_YOUR_CALM: number; | |||
const NGHTTP2_INADEQUATE_SECURITY: number; | |||
const NGHTTP2_HTTP_1_1_REQUIRED: number; | |||
const NGHTTP2_ERR_FRAME_SIZE_ERROR: number; | |||
const NGHTTP2_FLAG_NONE: number; | |||
const NGHTTP2_FLAG_END_STREAM: number; | |||
const NGHTTP2_FLAG_END_HEADERS: number; | |||
const NGHTTP2_FLAG_ACK: number; | |||
const NGHTTP2_FLAG_PADDED: number; | |||
const NGHTTP2_FLAG_PRIORITY: number; | |||
const DEFAULT_SETTINGS_HEADER_TABLE_SIZE: number; | |||
const DEFAULT_SETTINGS_ENABLE_PUSH: number; | |||
const DEFAULT_SETTINGS_INITIAL_WINDOW_SIZE: number; | |||
const DEFAULT_SETTINGS_MAX_FRAME_SIZE: number; | |||
const MAX_MAX_FRAME_SIZE: number; | |||
const MIN_MAX_FRAME_SIZE: number; | |||
const MAX_INITIAL_WINDOW_SIZE: number; | |||
const NGHTTP2_DEFAULT_WEIGHT: number; | |||
const NGHTTP2_SETTINGS_HEADER_TABLE_SIZE: number; | |||
const NGHTTP2_SETTINGS_ENABLE_PUSH: number; | |||
const NGHTTP2_SETTINGS_MAX_CONCURRENT_STREAMS: number; | |||
const NGHTTP2_SETTINGS_INITIAL_WINDOW_SIZE: number; | |||
const NGHTTP2_SETTINGS_MAX_FRAME_SIZE: number; | |||
const NGHTTP2_SETTINGS_MAX_HEADER_LIST_SIZE: number; | |||
const PADDING_STRATEGY_NONE: number; | |||
const PADDING_STRATEGY_MAX: number; | |||
const PADDING_STRATEGY_CALLBACK: number; | |||
const HTTP2_HEADER_STATUS: string; | |||
const HTTP2_HEADER_METHOD: string; | |||
const HTTP2_HEADER_AUTHORITY: string; | |||
const HTTP2_HEADER_SCHEME: string; | |||
const HTTP2_HEADER_PATH: string; | |||
const HTTP2_HEADER_ACCEPT_CHARSET: string; | |||
const HTTP2_HEADER_ACCEPT_ENCODING: string; | |||
const HTTP2_HEADER_ACCEPT_LANGUAGE: string; | |||
const HTTP2_HEADER_ACCEPT_RANGES: string; | |||
const HTTP2_HEADER_ACCEPT: string; | |||
const HTTP2_HEADER_ACCESS_CONTROL_ALLOW_ORIGIN: string; | |||
const HTTP2_HEADER_AGE: string; | |||
const HTTP2_HEADER_ALLOW: string; | |||
const HTTP2_HEADER_AUTHORIZATION: string; | |||
const HTTP2_HEADER_CACHE_CONTROL: string; | |||
const HTTP2_HEADER_CONNECTION: string; | |||
const HTTP2_HEADER_CONTENT_DISPOSITION: string; | |||
const HTTP2_HEADER_CONTENT_ENCODING: string; | |||
const HTTP2_HEADER_CONTENT_LANGUAGE: string; | |||
const HTTP2_HEADER_CONTENT_LENGTH: string; | |||
const HTTP2_HEADER_CONTENT_LOCATION: string; | |||
const HTTP2_HEADER_CONTENT_MD5: string; | |||
const HTTP2_HEADER_CONTENT_RANGE: string; | |||
const HTTP2_HEADER_CONTENT_TYPE: string; | |||
const HTTP2_HEADER_COOKIE: string; | |||
const HTTP2_HEADER_DATE: string; | |||
const HTTP2_HEADER_ETAG: string; | |||
const HTTP2_HEADER_EXPECT: string; | |||
const HTTP2_HEADER_EXPIRES: string; | |||
const HTTP2_HEADER_FROM: string; | |||
const HTTP2_HEADER_HOST: string; | |||
const HTTP2_HEADER_IF_MATCH: string; | |||
const HTTP2_HEADER_IF_MODIFIED_SINCE: string; | |||
const HTTP2_HEADER_IF_NONE_MATCH: string; | |||
const HTTP2_HEADER_IF_RANGE: string; | |||
const HTTP2_HEADER_IF_UNMODIFIED_SINCE: string; | |||
const HTTP2_HEADER_LAST_MODIFIED: string; | |||
const HTTP2_HEADER_LINK: string; | |||
const HTTP2_HEADER_LOCATION: string; | |||
const HTTP2_HEADER_MAX_FORWARDS: string; | |||
const HTTP2_HEADER_PREFER: string; | |||
const HTTP2_HEADER_PROXY_AUTHENTICATE: string; | |||
const HTTP2_HEADER_PROXY_AUTHORIZATION: string; | |||
const HTTP2_HEADER_RANGE: string; | |||
const HTTP2_HEADER_REFERER: string; | |||
const HTTP2_HEADER_REFRESH: string; | |||
const HTTP2_HEADER_RETRY_AFTER: string; | |||
const HTTP2_HEADER_SERVER: string; | |||
const HTTP2_HEADER_SET_COOKIE: string; | |||
const HTTP2_HEADER_STRICT_TRANSPORT_SECURITY: string; | |||
const HTTP2_HEADER_TRANSFER_ENCODING: string; | |||
const HTTP2_HEADER_TE: string; | |||
const HTTP2_HEADER_UPGRADE: string; | |||
const HTTP2_HEADER_USER_AGENT: string; | |||
const HTTP2_HEADER_VARY: string; | |||
const HTTP2_HEADER_VIA: string; | |||
const HTTP2_HEADER_WWW_AUTHENTICATE: string; | |||
const HTTP2_HEADER_HTTP2_SETTINGS: string; | |||
const HTTP2_HEADER_KEEP_ALIVE: string; | |||
const HTTP2_HEADER_PROXY_CONNECTION: string; | |||
const HTTP2_METHOD_ACL: string; | |||
const HTTP2_METHOD_BASELINE_CONTROL: string; | |||
const HTTP2_METHOD_BIND: string; | |||
const HTTP2_METHOD_CHECKIN: string; | |||
const HTTP2_METHOD_CHECKOUT: string; | |||
const HTTP2_METHOD_CONNECT: string; | |||
const HTTP2_METHOD_COPY: string; | |||
const HTTP2_METHOD_DELETE: string; | |||
const HTTP2_METHOD_GET: string; | |||
const HTTP2_METHOD_HEAD: string; | |||
const HTTP2_METHOD_LABEL: string; | |||
const HTTP2_METHOD_LINK: string; | |||
const HTTP2_METHOD_LOCK: string; | |||
const HTTP2_METHOD_MERGE: string; | |||
const HTTP2_METHOD_MKACTIVITY: string; | |||
const HTTP2_METHOD_MKCALENDAR: string; | |||
const HTTP2_METHOD_MKCOL: string; | |||
const HTTP2_METHOD_MKREDIRECTREF: string; | |||
const HTTP2_METHOD_MKWORKSPACE: string; | |||
const HTTP2_METHOD_MOVE: string; | |||
const HTTP2_METHOD_OPTIONS: string; | |||
const HTTP2_METHOD_ORDERPATCH: string; | |||
const HTTP2_METHOD_PATCH: string; | |||
const HTTP2_METHOD_POST: string; | |||
const HTTP2_METHOD_PRI: string; | |||
const HTTP2_METHOD_PROPFIND: string; | |||
const HTTP2_METHOD_PROPPATCH: string; | |||
const HTTP2_METHOD_PUT: string; | |||
const HTTP2_METHOD_REBIND: string; | |||
const HTTP2_METHOD_REPORT: string; | |||
const HTTP2_METHOD_SEARCH: string; | |||
const HTTP2_METHOD_TRACE: string; | |||
const HTTP2_METHOD_UNBIND: string; | |||
const HTTP2_METHOD_UNCHECKOUT: string; | |||
const HTTP2_METHOD_UNLINK: string; | |||
const HTTP2_METHOD_UNLOCK: string; | |||
const HTTP2_METHOD_UPDATE: string; | |||
const HTTP2_METHOD_UPDATEREDIRECTREF: string; | |||
const HTTP2_METHOD_VERSION_CONTROL: string; | |||
const HTTP_STATUS_CONTINUE: number; | |||
const HTTP_STATUS_SWITCHING_PROTOCOLS: number; | |||
const HTTP_STATUS_PROCESSING: number; | |||
const HTTP_STATUS_OK: number; | |||
const HTTP_STATUS_CREATED: number; | |||
const HTTP_STATUS_ACCEPTED: number; | |||
const HTTP_STATUS_NON_AUTHORITATIVE_INFORMATION: number; | |||
const HTTP_STATUS_NO_CONTENT: number; | |||
const HTTP_STATUS_RESET_CONTENT: number; | |||
const HTTP_STATUS_PARTIAL_CONTENT: number; | |||
const HTTP_STATUS_MULTI_STATUS: number; | |||
const HTTP_STATUS_ALREADY_REPORTED: number; | |||
const HTTP_STATUS_IM_USED: number; | |||
const HTTP_STATUS_MULTIPLE_CHOICES: number; | |||
const HTTP_STATUS_MOVED_PERMANENTLY: number; | |||
const HTTP_STATUS_FOUND: number; | |||
const HTTP_STATUS_SEE_OTHER: number; | |||
const HTTP_STATUS_NOT_MODIFIED: number; | |||
const HTTP_STATUS_USE_PROXY: number; | |||
const HTTP_STATUS_TEMPORARY_REDIRECT: number; | |||
const HTTP_STATUS_PERMANENT_REDIRECT: number; | |||
const HTTP_STATUS_BAD_REQUEST: number; | |||
const HTTP_STATUS_UNAUTHORIZED: number; | |||
const HTTP_STATUS_PAYMENT_REQUIRED: number; | |||
const HTTP_STATUS_FORBIDDEN: number; | |||
const HTTP_STATUS_NOT_FOUND: number; | |||
const HTTP_STATUS_METHOD_NOT_ALLOWED: number; | |||
const HTTP_STATUS_NOT_ACCEPTABLE: number; | |||
const HTTP_STATUS_PROXY_AUTHENTICATION_REQUIRED: number; | |||
const HTTP_STATUS_REQUEST_TIMEOUT: number; | |||
const HTTP_STATUS_CONFLICT: number; | |||
const HTTP_STATUS_GONE: number; | |||
const HTTP_STATUS_LENGTH_REQUIRED: number; | |||
const HTTP_STATUS_PRECONDITION_FAILED: number; | |||
const HTTP_STATUS_PAYLOAD_TOO_LARGE: number; | |||
const HTTP_STATUS_URI_TOO_LONG: number; | |||
const HTTP_STATUS_UNSUPPORTED_MEDIA_TYPE: number; | |||
const HTTP_STATUS_RANGE_NOT_SATISFIABLE: number; | |||
const HTTP_STATUS_EXPECTATION_FAILED: number; | |||
const HTTP_STATUS_TEAPOT: number; | |||
const HTTP_STATUS_MISDIRECTED_REQUEST: number; | |||
const HTTP_STATUS_UNPROCESSABLE_ENTITY: number; | |||
const HTTP_STATUS_LOCKED: number; | |||
const HTTP_STATUS_FAILED_DEPENDENCY: number; | |||
const HTTP_STATUS_UNORDERED_COLLECTION: number; | |||
const HTTP_STATUS_UPGRADE_REQUIRED: number; | |||
const HTTP_STATUS_PRECONDITION_REQUIRED: number; | |||
const HTTP_STATUS_TOO_MANY_REQUESTS: number; | |||
const HTTP_STATUS_REQUEST_HEADER_FIELDS_TOO_LARGE: number; | |||
const HTTP_STATUS_UNAVAILABLE_FOR_LEGAL_REASONS: number; | |||
const HTTP_STATUS_INTERNAL_SERVER_ERROR: number; | |||
const HTTP_STATUS_NOT_IMPLEMENTED: number; | |||
const HTTP_STATUS_BAD_GATEWAY: number; | |||
const HTTP_STATUS_SERVICE_UNAVAILABLE: number; | |||
const HTTP_STATUS_GATEWAY_TIMEOUT: number; | |||
const HTTP_STATUS_HTTP_VERSION_NOT_SUPPORTED: number; | |||
const HTTP_STATUS_VARIANT_ALSO_NEGOTIATES: number; | |||
const HTTP_STATUS_INSUFFICIENT_STORAGE: number; | |||
const HTTP_STATUS_LOOP_DETECTED: number; | |||
const HTTP_STATUS_BANDWIDTH_LIMIT_EXCEEDED: number; | |||
const HTTP_STATUS_NOT_EXTENDED: number; | |||
const HTTP_STATUS_NETWORK_AUTHENTICATION_REQUIRED: number; | |||
} | |||
export function getDefaultSettings(): Settings; | |||
export function getPackedSettings(settings: Settings): Buffer; | |||
export function getUnpackedSettings(buf: Uint8Array): Settings; | |||
export function createServer(onRequestHandler?: (request: Http2ServerRequest, response: Http2ServerResponse) => void): Http2Server; | |||
export function createServer(options: ServerOptions, onRequestHandler?: (request: Http2ServerRequest, response: Http2ServerResponse) => void): Http2Server; | |||
export function createSecureServer(onRequestHandler?: (request: Http2ServerRequest, response: Http2ServerResponse) => void): Http2SecureServer; | |||
export function createSecureServer(options: SecureServerOptions, onRequestHandler?: (request: Http2ServerRequest, response: Http2ServerResponse) => void): Http2SecureServer; | |||
export function connect(authority: string | url.URL, listener: (session: ClientHttp2Session, socket: net.Socket | tls.TLSSocket) => void): ClientHttp2Session; | |||
export function connect( | |||
authority: string | url.URL, | |||
options?: ClientSessionOptions | SecureClientSessionOptions, | |||
listener?: (session: ClientHttp2Session, socket: net.Socket | tls.TLSSocket) => void | |||
): ClientHttp2Session; | |||
} |
@@ -0,0 +1,37 @@ | |||
declare module "https" { | |||
import * as tls from "tls"; | |||
import * as events from "events"; | |||
import * as http from "http"; | |||
import { URL } from "url"; | |||
type ServerOptions = tls.SecureContextOptions & tls.TlsOptions & http.ServerOptions; | |||
type RequestOptions = http.RequestOptions & tls.SecureContextOptions & { | |||
rejectUnauthorized?: boolean; // Defaults to true | |||
servername?: string; // SNI TLS Extension | |||
}; | |||
interface AgentOptions extends http.AgentOptions, tls.ConnectionOptions { | |||
rejectUnauthorized?: boolean; | |||
maxCachedSessions?: number; | |||
} | |||
class Agent extends http.Agent { | |||
constructor(options?: AgentOptions); | |||
options: AgentOptions; | |||
} | |||
interface Server extends http.HttpBase {} | |||
class Server extends tls.Server { | |||
constructor(requestListener?: http.RequestListener); | |||
constructor(options: ServerOptions, requestListener?: http.RequestListener); | |||
} | |||
function createServer(requestListener?: http.RequestListener): Server; | |||
function createServer(options: ServerOptions, requestListener?: http.RequestListener): Server; | |||
function request(options: RequestOptions | string | URL, callback?: (res: http.IncomingMessage) => void): http.ClientRequest; | |||
function request(url: string | URL, options: RequestOptions, callback?: (res: http.IncomingMessage) => void): http.ClientRequest; | |||
function get(options: RequestOptions | string | URL, callback?: (res: http.IncomingMessage) => void): http.ClientRequest; | |||
function get(url: string | URL, options: RequestOptions, callback?: (res: http.IncomingMessage) => void): http.ClientRequest; | |||
let globalAgent: Agent; | |||
} |
@@ -0,0 +1,92 @@ | |||
// Type definitions for non-npm package Node.js 14.0 | |||
// Project: http://nodejs.org/ | |||
// Definitions by: Microsoft TypeScript <https://github.com/Microsoft> | |||
// DefinitelyTyped <https://github.com/DefinitelyTyped> | |||
// Alberto Schiabel <https://github.com/jkomyno> | |||
// Alexander T. <https://github.com/a-tarasyuk> | |||
// Alvis HT Tang <https://github.com/alvis> | |||
// Andrew Makarov <https://github.com/r3nya> | |||
// Benjamin Toueg <https://github.com/btoueg> | |||
// Bruno Scheufler <https://github.com/brunoscheufler> | |||
// Chigozirim C. <https://github.com/smac89> | |||
// David Junger <https://github.com/touffy> | |||
// Deividas Bakanas <https://github.com/DeividasBakanas> | |||
// Eugene Y. Q. Shen <https://github.com/eyqs> | |||
// Flarna <https://github.com/Flarna> | |||
// Hannes Magnusson <https://github.com/Hannes-Magnusson-CK> | |||
// Hoàng Văn Khải <https://github.com/KSXGitHub> | |||
// Huw <https://github.com/hoo29> | |||
// Kelvin Jin <https://github.com/kjin> | |||
// Klaus Meinhardt <https://github.com/ajafff> | |||
// Lishude <https://github.com/islishude> | |||
// Mariusz Wiktorczyk <https://github.com/mwiktorczyk> | |||
// Mohsen Azimi <https://github.com/mohsen1> | |||
// Nicolas Even <https://github.com/n-e> | |||
// Nicolas Voigt <https://github.com/octo-sniffle> | |||
// Nikita Galkin <https://github.com/galkin> | |||
// Parambir Singh <https://github.com/parambirs> | |||
// Sebastian Silbermann <https://github.com/eps1lon> | |||
// Simon Schick <https://github.com/SimonSchick> | |||
// Thomas den Hollander <https://github.com/ThomasdenH> | |||
// Wilco Bakker <https://github.com/WilcoBakker> | |||
// wwwy3y3 <https://github.com/wwwy3y3> | |||
// Samuel Ainsworth <https://github.com/samuela> | |||
// Kyle Uehlein <https://github.com/kuehlein> | |||
// Jordi Oliveras Rovira <https://github.com/j-oliveras> | |||
// Thanik Bhongbhibhat <https://github.com/bhongy> | |||
// Marcin Kopacz <https://github.com/chyzwar> | |||
// Trivikram Kamat <https://github.com/trivikr> | |||
// Minh Son Nguyen <https://github.com/nguymin4> | |||
// Junxiao Shi <https://github.com/yoursunny> | |||
// Ilia Baryshnikov <https://github.com/qwelias> | |||
// ExE Boss <https://github.com/ExE-Boss> | |||
// Surasak Chaisurin <https://github.com/Ryan-Willpower> | |||
// Piotr Błażejewicz <https://github.com/peterblazejewicz> | |||
// Anna Henningsen <https://github.com/addaleax> | |||
// Jason Kwok <https://github.com/JasonHK> | |||
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped | |||
// NOTE: These definitions support NodeJS and TypeScript 3.5. | |||
// NOTE: TypeScript version-specific augmentations can be found in the following paths: | |||
// - ~/base.d.ts - Shared definitions common to all TypeScript versions | |||
// - ~/index.d.ts - Definitions specific to TypeScript 2.8 | |||
// - ~/ts3.5/index.d.ts - Definitions specific to TypeScript 3.5 | |||
// NOTE: Augmentations for TypeScript 3.5 and later should use individual files for overrides | |||
// within the respective ~/ts3.5 (or later) folder. However, this is disallowed for versions | |||
// prior to TypeScript 3.5, so the older definitions will be found here. | |||
// Base definitions for all NodeJS modules that are not specific to any version of TypeScript: | |||
/// <reference path="base.d.ts" /> | |||
// We can't include globals.global.d.ts in globals.d.ts, as it'll cause duplication errors in TypeScript 3.5+ | |||
/// <reference path="globals.global.d.ts" /> | |||
// We can't include assert.d.ts in base.d.ts, as it'll cause duplication errors in TypeScript 3.7+ | |||
/// <reference path="assert.d.ts" /> | |||
// Forward-declarations for needed types from es2015 and later (in case users are using `--lib es5`) | |||
// Empty interfaces are used here which merge fine with the real declarations in the lib XXX files | |||
// just to ensure the names are known and node typings can be used without importing these libs. | |||
// if someone really needs these types the libs need to be added via --lib or in tsconfig.json | |||
interface AsyncIterable<T> { } | |||
interface IterableIterator<T> { } | |||
interface AsyncIterableIterator<T> {} | |||
interface SymbolConstructor { | |||
readonly asyncIterator: symbol; | |||
} | |||
declare var Symbol: SymbolConstructor; | |||
// even this is just a forward declaration some properties are added otherwise | |||
// it would be allowed to pass anything to e.g. Buffer.from() | |||
interface SharedArrayBuffer { | |||
readonly byteLength: number; | |||
slice(begin?: number, end?: number): SharedArrayBuffer; | |||
} | |||
declare module "util" { | |||
namespace types { | |||
function isBigInt64Array(value: any): boolean; | |||
function isBigUint64Array(value: any): boolean; | |||
} | |||
} |
@@ -0,0 +1,52 @@ | |||
declare module "module" { | |||
import { URL } from "url"; | |||
namespace Module { | |||
/** | |||
* Updates all the live bindings for builtin ES Modules to match the properties of the CommonJS exports. | |||
* It does not add or remove exported names from the ES Modules. | |||
*/ | |||
function syncBuiltinESMExports(): void; | |||
function findSourceMap(path: string, error?: Error): SourceMap; | |||
interface SourceMapPayload { | |||
file: string; | |||
version: number; | |||
sources: string[]; | |||
sourcesContent: string[]; | |||
names: string[]; | |||
mappings: string; | |||
sourceRoot: string; | |||
} | |||
interface SourceMapping { | |||
generatedLine: number; | |||
generatedColumn: number; | |||
originalSource: string; | |||
originalLine: number; | |||
originalColumn: number; | |||
} | |||
class SourceMap { | |||
readonly payload: SourceMapPayload; | |||
constructor(payload: SourceMapPayload); | |||
findEntry(line: number, column: number): SourceMapping; | |||
} | |||
} | |||
interface Module extends NodeModule {} | |||
class Module { | |||
static runMain(): void; | |||
static wrap(code: string): string; | |||
/** | |||
* @deprecated Deprecated since: v12.2.0. Please use createRequire() instead. | |||
*/ | |||
static createRequireFromPath(path: string): NodeRequire; | |||
static createRequire(path: string | URL): NodeRequire; | |||
static builtinModules: string[]; | |||
static Module: typeof Module; | |||
constructor(id: string, parent?: Module); | |||
} | |||
export = Module; | |||
} |
@@ -0,0 +1,268 @@ | |||
declare module "net" { | |||
import * as stream from "stream"; | |||
import * as events from "events"; | |||
import * as dns from "dns"; | |||
type LookupFunction = (hostname: string, options: dns.LookupOneOptions, callback: (err: NodeJS.ErrnoException | null, address: string, family: number) => void) => void; | |||
interface AddressInfo { | |||
address: string; | |||
family: string; | |||
port: number; | |||
} | |||
interface SocketConstructorOpts { | |||
fd?: number; | |||
allowHalfOpen?: boolean; | |||
readable?: boolean; | |||
writable?: boolean; | |||
} | |||
interface OnReadOpts { | |||
buffer: Uint8Array | (() => Uint8Array); | |||
/** | |||
* This function is called for every chunk of incoming data. | |||
* Two arguments are passed to it: the number of bytes written to buffer and a reference to buffer. | |||
* Return false from this function to implicitly pause() the socket. | |||
*/ | |||
callback(bytesWritten: number, buf: Uint8Array): boolean; | |||
} | |||
interface ConnectOpts { | |||
/** | |||
* If specified, incoming data is stored in a single buffer and passed to the supplied callback when data arrives on the socket. | |||
* Note: this will cause the streaming functionality to not provide any data, however events like 'error', 'end', and 'close' will | |||
* still be emitted as normal and methods like pause() and resume() will also behave as expected. | |||
*/ | |||
onread?: OnReadOpts; | |||
} | |||
interface TcpSocketConnectOpts extends ConnectOpts { | |||
port: number; | |||
host?: string; | |||
localAddress?: string; | |||
localPort?: number; | |||
hints?: number; | |||
family?: number; | |||
lookup?: LookupFunction; | |||
} | |||
interface IpcSocketConnectOpts extends ConnectOpts { | |||
path: string; | |||
} | |||
type SocketConnectOpts = TcpSocketConnectOpts | IpcSocketConnectOpts; | |||
class Socket extends stream.Duplex { | |||
constructor(options?: SocketConstructorOpts); | |||
// Extended base methods | |||
write(buffer: Uint8Array | string, cb?: (err?: Error) => void): boolean; | |||
write(str: Uint8Array | string, encoding?: BufferEncoding, cb?: (err?: Error) => void): boolean; | |||
connect(options: SocketConnectOpts, connectionListener?: () => void): this; | |||
connect(port: number, host: string, connectionListener?: () => void): this; | |||
connect(port: number, connectionListener?: () => void): this; | |||
connect(path: string, connectionListener?: () => void): this; | |||
setEncoding(encoding?: BufferEncoding): this; | |||
pause(): this; | |||
resume(): this; | |||
setTimeout(timeout: number, callback?: () => void): this; | |||
setNoDelay(noDelay?: boolean): this; | |||
setKeepAlive(enable?: boolean, initialDelay?: number): this; | |||
address(): AddressInfo | string; | |||
unref(): this; | |||
ref(): this; | |||
readonly bufferSize: number; | |||
readonly bytesRead: number; | |||
readonly bytesWritten: number; | |||
readonly connecting: boolean; | |||
readonly destroyed: boolean; | |||
readonly localAddress: string; | |||
readonly localPort: number; | |||
readonly remoteAddress?: string; | |||
readonly remoteFamily?: string; | |||
readonly remotePort?: number; | |||
// Extended base methods | |||
end(cb?: () => void): void; | |||
end(buffer: Uint8Array | string, cb?: () => void): void; | |||
end(str: Uint8Array | string, encoding?: BufferEncoding, cb?: () => void): void; | |||
/** | |||
* events.EventEmitter | |||
* 1. close | |||
* 2. connect | |||
* 3. data | |||
* 4. drain | |||
* 5. end | |||
* 6. error | |||
* 7. lookup | |||
* 8. timeout | |||
*/ | |||
addListener(event: string, listener: (...args: any[]) => void): this; | |||
addListener(event: "close", listener: (had_error: boolean) => void): this; | |||
addListener(event: "connect", listener: () => void): this; | |||
addListener(event: "data", listener: (data: Buffer) => void): this; | |||
addListener(event: "drain", listener: () => void): this; | |||
addListener(event: "end", listener: () => void): this; | |||
addListener(event: "error", listener: (err: Error) => void): this; | |||
addListener(event: "lookup", listener: (err: Error, address: string, family: string | number, host: string) => void): this; | |||
addListener(event: "timeout", listener: () => void): this; | |||
emit(event: string | symbol, ...args: any[]): boolean; | |||
emit(event: "close", had_error: boolean): boolean; | |||
emit(event: "connect"): boolean; | |||
emit(event: "data", data: Buffer): boolean; | |||
emit(event: "drain"): boolean; | |||
emit(event: "end"): boolean; | |||
emit(event: "error", err: Error): boolean; | |||
emit(event: "lookup", err: Error, address: string, family: string | number, host: string): boolean; | |||
emit(event: "timeout"): boolean; | |||
on(event: string, listener: (...args: any[]) => void): this; | |||
on(event: "close", listener: (had_error: boolean) => void): this; | |||
on(event: "connect", listener: () => void): this; | |||
on(event: "data", listener: (data: Buffer) => void): this; | |||
on(event: "drain", listener: () => void): this; | |||
on(event: "end", listener: () => void): this; | |||
on(event: "error", listener: (err: Error) => void): this; | |||
on(event: "lookup", listener: (err: Error, address: string, family: string | number, host: string) => void): this; | |||
on(event: "timeout", listener: () => void): this; | |||
once(event: string, listener: (...args: any[]) => void): this; | |||
once(event: "close", listener: (had_error: boolean) => void): this; | |||
once(event: "connect", listener: () => void): this; | |||
once(event: "data", listener: (data: Buffer) => void): this; | |||
once(event: "drain", listener: () => void): this; | |||
once(event: "end", listener: () => void): this; | |||
once(event: "error", listener: (err: Error) => void): this; | |||
once(event: "lookup", listener: (err: Error, address: string, family: string | number, host: string) => void): this; | |||
once(event: "timeout", listener: () => void): this; | |||
prependListener(event: string, listener: (...args: any[]) => void): this; | |||
prependListener(event: "close", listener: (had_error: boolean) => void): this; | |||
prependListener(event: "connect", listener: () => void): this; | |||
prependListener(event: "data", listener: (data: Buffer) => void): this; | |||
prependListener(event: "drain", listener: () => void): this; | |||
prependListener(event: "end", listener: () => void): this; | |||
prependListener(event: "error", listener: (err: Error) => void): this; | |||
prependListener(event: "lookup", listener: (err: Error, address: string, family: string | number, host: string) => void): this; | |||
prependListener(event: "timeout", listener: () => void): this; | |||
prependOnceListener(event: string, listener: (...args: any[]) => void): this; | |||
prependOnceListener(event: "close", listener: (had_error: boolean) => void): this; | |||
prependOnceListener(event: "connect", listener: () => void): this; | |||
prependOnceListener(event: "data", listener: (data: Buffer) => void): this; | |||
prependOnceListener(event: "drain", listener: () => void): this; | |||
prependOnceListener(event: "end", listener: () => void): this; | |||
prependOnceListener(event: "error", listener: (err: Error) => void): this; | |||
prependOnceListener(event: "lookup", listener: (err: Error, address: string, family: string | number, host: string) => void): this; | |||
prependOnceListener(event: "timeout", listener: () => void): this; | |||
} | |||
interface ListenOptions { | |||
port?: number; | |||
host?: string; | |||
backlog?: number; | |||
path?: string; | |||
exclusive?: boolean; | |||
readableAll?: boolean; | |||
writableAll?: boolean; | |||
/** | |||
* @default false | |||
*/ | |||
ipv6Only?: boolean; | |||
} | |||
// https://github.com/nodejs/node/blob/master/lib/net.js | |||
class Server extends events.EventEmitter { | |||
constructor(connectionListener?: (socket: Socket) => void); | |||
constructor(options?: { allowHalfOpen?: boolean, pauseOnConnect?: boolean }, connectionListener?: (socket: Socket) => void); | |||
listen(port?: number, hostname?: string, backlog?: number, listeningListener?: () => void): this; | |||
listen(port?: number, hostname?: string, listeningListener?: () => void): this; | |||
listen(port?: number, backlog?: number, listeningListener?: () => void): this; | |||
listen(port?: number, listeningListener?: () => void): this; | |||
listen(path: string, backlog?: number, listeningListener?: () => void): this; | |||
listen(path: string, listeningListener?: () => void): this; | |||
listen(options: ListenOptions, listeningListener?: () => void): this; | |||
listen(handle: any, backlog?: number, listeningListener?: () => void): this; | |||
listen(handle: any, listeningListener?: () => void): this; | |||
close(callback?: (err?: Error) => void): this; | |||
address(): AddressInfo | string | null; | |||
getConnections(cb: (error: Error | null, count: number) => void): void; | |||
ref(): this; | |||
unref(): this; | |||
maxConnections: number; | |||
connections: number; | |||
listening: boolean; | |||
/** | |||
* events.EventEmitter | |||
* 1. close | |||
* 2. connection | |||
* 3. error | |||
* 4. listening | |||
*/ | |||
addListener(event: string, listener: (...args: any[]) => void): this; | |||
addListener(event: "close", listener: () => void): this; | |||
addListener(event: "connection", listener: (socket: Socket) => void): this; | |||
addListener(event: "error", listener: (err: Error) => void): this; | |||
addListener(event: "listening", listener: () => void): this; | |||
emit(event: string | symbol, ...args: any[]): boolean; | |||
emit(event: "close"): boolean; | |||
emit(event: "connection", socket: Socket): boolean; | |||
emit(event: "error", err: Error): boolean; | |||
emit(event: "listening"): boolean; | |||
on(event: string, listener: (...args: any[]) => void): this; | |||
on(event: "close", listener: () => void): this; | |||
on(event: "connection", listener: (socket: Socket) => void): this; | |||
on(event: "error", listener: (err: Error) => void): this; | |||
on(event: "listening", listener: () => void): this; | |||
once(event: string, listener: (...args: any[]) => void): this; | |||
once(event: "close", listener: () => void): this; | |||
once(event: "connection", listener: (socket: Socket) => void): this; | |||
once(event: "error", listener: (err: Error) => void): this; | |||
once(event: "listening", listener: () => void): this; | |||
prependListener(event: string, listener: (...args: any[]) => void): this; | |||
prependListener(event: "close", listener: () => void): this; | |||
prependListener(event: "connection", listener: (socket: Socket) => void): this; | |||
prependListener(event: "error", listener: (err: Error) => void): this; | |||
prependListener(event: "listening", listener: () => void): this; | |||
prependOnceListener(event: string, listener: (...args: any[]) => void): this; | |||
prependOnceListener(event: "close", listener: () => void): this; | |||
prependOnceListener(event: "connection", listener: (socket: Socket) => void): this; | |||
prependOnceListener(event: "error", listener: (err: Error) => void): this; | |||
prependOnceListener(event: "listening", listener: () => void): this; | |||
} | |||
interface TcpNetConnectOpts extends TcpSocketConnectOpts, SocketConstructorOpts { | |||
timeout?: number; | |||
} | |||
interface IpcNetConnectOpts extends IpcSocketConnectOpts, SocketConstructorOpts { | |||
timeout?: number; | |||
} | |||
type NetConnectOpts = TcpNetConnectOpts | IpcNetConnectOpts; | |||
function createServer(connectionListener?: (socket: Socket) => void): Server; | |||
function createServer(options?: { allowHalfOpen?: boolean, pauseOnConnect?: boolean }, connectionListener?: (socket: Socket) => void): Server; | |||
function connect(options: NetConnectOpts, connectionListener?: () => void): Socket; | |||
function connect(port: number, host?: string, connectionListener?: () => void): Socket; | |||
function connect(path: string, connectionListener?: () => void): Socket; | |||
function createConnection(options: NetConnectOpts, connectionListener?: () => void): Socket; | |||
function createConnection(port: number, host?: string, connectionListener?: () => void): Socket; | |||
function createConnection(path: string, connectionListener?: () => void): Socket; | |||
function isIP(input: string): number; | |||
function isIPv4(input: string): boolean; | |||
function isIPv6(input: string): boolean; | |||
} |
@@ -0,0 +1,239 @@ | |||
declare module "os" { | |||
interface CpuInfo { | |||
model: string; | |||
speed: number; | |||
times: { | |||
user: number; | |||
nice: number; | |||
sys: number; | |||
idle: number; | |||
irq: number; | |||
}; | |||
} | |||
interface NetworkInterfaceBase { | |||
address: string; | |||
netmask: string; | |||
mac: string; | |||
internal: boolean; | |||
cidr: string | null; | |||
} | |||
interface NetworkInterfaceInfoIPv4 extends NetworkInterfaceBase { | |||
family: "IPv4"; | |||
} | |||
interface NetworkInterfaceInfoIPv6 extends NetworkInterfaceBase { | |||
family: "IPv6"; | |||
scopeid: number; | |||
} | |||
interface UserInfo<T> { | |||
username: T; | |||
uid: number; | |||
gid: number; | |||
shell: T; | |||
homedir: T; | |||
} | |||
type NetworkInterfaceInfo = NetworkInterfaceInfoIPv4 | NetworkInterfaceInfoIPv6; | |||
function hostname(): string; | |||
function loadavg(): number[]; | |||
function uptime(): number; | |||
function freemem(): number; | |||
function totalmem(): number; | |||
function cpus(): CpuInfo[]; | |||
function type(): string; | |||
function release(): string; | |||
function networkInterfaces(): NodeJS.Dict<NetworkInterfaceInfo[]>; | |||
function homedir(): string; | |||
function userInfo(options: { encoding: 'buffer' }): UserInfo<Buffer>; | |||
function userInfo(options?: { encoding: BufferEncoding }): UserInfo<string>; | |||
type SignalConstants = { | |||
[key in NodeJS.Signals]: number; | |||
}; | |||
namespace constants { | |||
const UV_UDP_REUSEADDR: number; | |||
namespace signals {} | |||
const signals: SignalConstants; | |||
namespace errno { | |||
const E2BIG: number; | |||
const EACCES: number; | |||
const EADDRINUSE: number; | |||
const EADDRNOTAVAIL: number; | |||
const EAFNOSUPPORT: number; | |||
const EAGAIN: number; | |||
const EALREADY: number; | |||
const EBADF: number; | |||
const EBADMSG: number; | |||
const EBUSY: number; | |||
const ECANCELED: number; | |||
const ECHILD: number; | |||
const ECONNABORTED: number; | |||
const ECONNREFUSED: number; | |||
const ECONNRESET: number; | |||
const EDEADLK: number; | |||
const EDESTADDRREQ: number; | |||
const EDOM: number; | |||
const EDQUOT: number; | |||
const EEXIST: number; | |||
const EFAULT: number; | |||
const EFBIG: number; | |||
const EHOSTUNREACH: number; | |||
const EIDRM: number; | |||
const EILSEQ: number; | |||
const EINPROGRESS: number; | |||
const EINTR: number; | |||
const EINVAL: number; | |||
const EIO: number; | |||
const EISCONN: number; | |||
const EISDIR: number; | |||
const ELOOP: number; | |||
const EMFILE: number; | |||
const EMLINK: number; | |||
const EMSGSIZE: number; | |||
const EMULTIHOP: number; | |||
const ENAMETOOLONG: number; | |||
const ENETDOWN: number; | |||
const ENETRESET: number; | |||
const ENETUNREACH: number; | |||
const ENFILE: number; | |||
const ENOBUFS: number; | |||
const ENODATA: number; | |||
const ENODEV: number; | |||
const ENOENT: number; | |||
const ENOEXEC: number; | |||
const ENOLCK: number; | |||
const ENOLINK: number; | |||
const ENOMEM: number; | |||
const ENOMSG: number; | |||
const ENOPROTOOPT: number; | |||
const ENOSPC: number; | |||
const ENOSR: number; | |||
const ENOSTR: number; | |||
const ENOSYS: number; | |||
const ENOTCONN: number; | |||
const ENOTDIR: number; | |||
const ENOTEMPTY: number; | |||
const ENOTSOCK: number; | |||
const ENOTSUP: number; | |||
const ENOTTY: number; | |||
const ENXIO: number; | |||
const EOPNOTSUPP: number; | |||
const EOVERFLOW: number; | |||
const EPERM: number; | |||
const EPIPE: number; | |||
const EPROTO: number; | |||
const EPROTONOSUPPORT: number; | |||
const EPROTOTYPE: number; | |||
const ERANGE: number; | |||
const EROFS: number; | |||
const ESPIPE: number; | |||
const ESRCH: number; | |||
const ESTALE: number; | |||
const ETIME: number; | |||
const ETIMEDOUT: number; | |||
const ETXTBSY: number; | |||
const EWOULDBLOCK: number; | |||
const EXDEV: number; | |||
const WSAEINTR: number; | |||
const WSAEBADF: number; | |||
const WSAEACCES: number; | |||
const WSAEFAULT: number; | |||
const WSAEINVAL: number; | |||
const WSAEMFILE: number; | |||
const WSAEWOULDBLOCK: number; | |||
const WSAEINPROGRESS: number; | |||
const WSAEALREADY: number; | |||
const WSAENOTSOCK: number; | |||
const WSAEDESTADDRREQ: number; | |||
const WSAEMSGSIZE: number; | |||
const WSAEPROTOTYPE: number; | |||
const WSAENOPROTOOPT: number; | |||
const WSAEPROTONOSUPPORT: number; | |||
const WSAESOCKTNOSUPPORT: number; | |||
const WSAEOPNOTSUPP: number; | |||
const WSAEPFNOSUPPORT: number; | |||
const WSAEAFNOSUPPORT: number; | |||
const WSAEADDRINUSE: number; | |||
const WSAEADDRNOTAVAIL: number; | |||
const WSAENETDOWN: number; | |||
const WSAENETUNREACH: number; | |||
const WSAENETRESET: number; | |||
const WSAECONNABORTED: number; | |||
const WSAECONNRESET: number; | |||
const WSAENOBUFS: number; | |||
const WSAEISCONN: number; | |||
const WSAENOTCONN: number; | |||
const WSAESHUTDOWN: number; | |||
const WSAETOOMANYREFS: number; | |||
const WSAETIMEDOUT: number; | |||
const WSAECONNREFUSED: number; | |||
const WSAELOOP: number; | |||
const WSAENAMETOOLONG: number; | |||
const WSAEHOSTDOWN: number; | |||
const WSAEHOSTUNREACH: number; | |||
const WSAENOTEMPTY: number; | |||
const WSAEPROCLIM: number; | |||
const WSAEUSERS: number; | |||
const WSAEDQUOT: number; | |||
const WSAESTALE: number; | |||
const WSAEREMOTE: number; | |||
const WSASYSNOTREADY: number; | |||
const WSAVERNOTSUPPORTED: number; | |||
const WSANOTINITIALISED: number; | |||
const WSAEDISCON: number; | |||
const WSAENOMORE: number; | |||
const WSAECANCELLED: number; | |||
const WSAEINVALIDPROCTABLE: number; | |||
const WSAEINVALIDPROVIDER: number; | |||
const WSAEPROVIDERFAILEDINIT: number; | |||
const WSASYSCALLFAILURE: number; | |||
const WSASERVICE_NOT_FOUND: number; | |||
const WSATYPE_NOT_FOUND: number; | |||
const WSA_E_NO_MORE: number; | |||
const WSA_E_CANCELLED: number; | |||
const WSAEREFUSED: number; | |||
} | |||
namespace priority { | |||
const PRIORITY_LOW: number; | |||
const PRIORITY_BELOW_NORMAL: number; | |||
const PRIORITY_NORMAL: number; | |||
const PRIORITY_ABOVE_NORMAL: number; | |||
const PRIORITY_HIGH: number; | |||
const PRIORITY_HIGHEST: number; | |||
} | |||
} | |||
function arch(): string; | |||
/** | |||
* Returns a string identifying the kernel version. | |||
* On POSIX systems, the operating system release is determined by calling | |||
* [uname(3)][]. On Windows, `pRtlGetVersion` is used, and if it is not available, | |||
* `GetVersionExW()` will be used. See | |||
* https://en.wikipedia.org/wiki/Uname#Examples for more information. | |||
*/ | |||
function version(): string; | |||
function platform(): NodeJS.Platform; | |||
function tmpdir(): string; | |||
const EOL: string; | |||
function endianness(): "BE" | "LE"; | |||
/** | |||
* Gets the priority of a process. | |||
* Defaults to current process. | |||
*/ | |||
function getPriority(pid?: number): number; | |||
/** | |||
* Sets the priority of the current process. | |||
* @param priority Must be in range of -20 to 19 | |||
*/ | |||
function setPriority(priority: number): void; | |||
/** | |||
* Sets the priority of the process specified process. | |||
* @param priority Must be in range of -20 to 19 | |||
*/ | |||
function setPriority(pid: number, priority: number): void; | |||
} |
@@ -0,0 +1,243 @@ | |||
{ | |||
"_from": "@types/node", | |||
"_id": "@types/node@14.0.5", | |||
"_inBundle": false, | |||
"_integrity": "sha512-90hiq6/VqtQgX8Sp0EzeIsv3r+ellbGj4URKj5j30tLlZvRUpnAe9YbYnjl3pJM93GyXU0tghHhvXHq+5rnCKA==", | |||
"_location": "/@types/node", | |||
"_phantomChildren": {}, | |||
"_requested": { | |||
"type": "tag", | |||
"registry": true, | |||
"raw": "@types/node", | |||
"name": "@types/node", | |||
"escapedName": "@types%2fnode", | |||
"scope": "@types", | |||
"rawSpec": "", | |||
"saveSpec": null, | |||
"fetchSpec": "latest" | |||
}, | |||
"_requiredBy": [ | |||
"#DEV:/", | |||
"#USER" | |||
], | |||
"_resolved": "https://registry.npmjs.org/@types/node/-/node-14.0.5.tgz", | |||
"_shasum": "3d03acd3b3414cf67faf999aed11682ed121f22b", | |||
"_spec": "@types/node", | |||
"_where": "/home/cziermann/git/papoh", | |||
"bugs": { | |||
"url": "https://github.com/DefinitelyTyped/DefinitelyTyped/issues" | |||
}, | |||
"bundleDependencies": false, | |||
"contributors": [ | |||
{ | |||
"name": "Microsoft TypeScript", | |||
"url": "https://github.com/Microsoft" | |||
}, | |||
{ | |||
"name": "DefinitelyTyped", | |||
"url": "https://github.com/DefinitelyTyped" | |||
}, | |||
{ | |||
"name": "Alberto Schiabel", | |||
"url": "https://github.com/jkomyno" | |||
}, | |||
{ | |||
"name": "Alexander T.", | |||
"url": "https://github.com/a-tarasyuk" | |||
}, | |||
{ | |||
"name": "Alvis HT Tang", | |||
"url": "https://github.com/alvis" | |||
}, | |||
{ | |||
"name": "Andrew Makarov", | |||
"url": "https://github.com/r3nya" | |||
}, | |||
{ | |||
"name": "Benjamin Toueg", | |||
"url": "https://github.com/btoueg" | |||
}, | |||
{ | |||
"name": "Bruno Scheufler", | |||
"url": "https://github.com/brunoscheufler" | |||
}, | |||
{ | |||
"name": "Chigozirim C.", | |||
"url": "https://github.com/smac89" | |||
}, | |||
{ | |||
"name": "David Junger", | |||
"url": "https://github.com/touffy" | |||
}, | |||
{ | |||
"name": "Deividas Bakanas", | |||
"url": "https://github.com/DeividasBakanas" | |||
}, | |||
{ | |||
"name": "Eugene Y. Q. Shen", | |||
"url": "https://github.com/eyqs" | |||
}, | |||
{ | |||
"name": "Flarna", | |||
"url": "https://github.com/Flarna" | |||
}, | |||
{ | |||
"name": "Hannes Magnusson", | |||
"url": "https://github.com/Hannes-Magnusson-CK" | |||
}, | |||
{ | |||
"name": "Hoàng Văn Khải", | |||
"url": "https://github.com/KSXGitHub" | |||
}, | |||
{ | |||
"name": "Huw", | |||
"url": "https://github.com/hoo29" | |||
}, | |||
{ | |||
"name": "Kelvin Jin", | |||
"url": "https://github.com/kjin" | |||
}, | |||
{ | |||
"name": "Klaus Meinhardt", | |||
"url": "https://github.com/ajafff" | |||
}, | |||
{ | |||
"name": "Lishude", | |||
"url": "https://github.com/islishude" | |||
}, | |||
{ | |||
"name": "Mariusz Wiktorczyk", | |||
"url": "https://github.com/mwiktorczyk" | |||
}, | |||
{ | |||
"name": "Mohsen Azimi", | |||
"url": "https://github.com/mohsen1" | |||
}, | |||
{ | |||
"name": "Nicolas Even", | |||
"url": "https://github.com/n-e" | |||
}, | |||
{ | |||
"name": "Nicolas Voigt", | |||
"url": "https://github.com/octo-sniffle" | |||
}, | |||
{ | |||
"name": "Nikita Galkin", | |||
"url": "https://github.com/galkin" | |||
}, | |||
{ | |||
"name": "Parambir Singh", | |||
"url": "https://github.com/parambirs" | |||
}, | |||
{ | |||
"name": "Sebastian Silbermann", | |||
"url": "https://github.com/eps1lon" | |||
}, | |||
{ | |||
"name": "Simon Schick", | |||
"url": "https://github.com/SimonSchick" | |||
}, | |||
{ | |||
"name": "Thomas den Hollander", | |||
"url": "https://github.com/ThomasdenH" | |||
}, | |||
{ | |||
"name": "Wilco Bakker", | |||
"url": "https://github.com/WilcoBakker" | |||
}, | |||
{ | |||
"name": "wwwy3y3", | |||
"url": "https://github.com/wwwy3y3" | |||
}, | |||
{ | |||
"name": "Samuel Ainsworth", | |||
"url": "https://github.com/samuela" | |||
}, | |||
{ | |||
"name": "Kyle Uehlein", | |||
"url": "https://github.com/kuehlein" | |||
}, | |||
{ | |||
"name": "Jordi Oliveras Rovira", | |||
"url": "https://github.com/j-oliveras" | |||
}, | |||
{ | |||
"name": "Thanik Bhongbhibhat", | |||
"url": "https://github.com/bhongy" | |||
}, | |||
{ | |||
"name": "Marcin Kopacz", | |||
"url": "https://github.com/chyzwar" | |||
}, | |||
{ | |||
"name": "Trivikram Kamat", | |||
"url": "https://github.com/trivikr" | |||
}, | |||
{ | |||
"name": "Minh Son Nguyen", | |||
"url": "https://github.com/nguymin4" | |||
}, | |||
{ | |||
"name": "Junxiao Shi", | |||
"url": "https://github.com/yoursunny" | |||
}, | |||
{ | |||
"name": "Ilia Baryshnikov", | |||
"url": "https://github.com/qwelias" | |||
}, | |||
{ | |||
"name": "ExE Boss", | |||
"url": "https://github.com/ExE-Boss" | |||
}, | |||
{ | |||
"name": "Surasak Chaisurin", | |||
"url": "https://github.com/Ryan-Willpower" | |||
}, | |||
{ | |||
"name": "Piotr Błażejewicz", | |||
"url": "https://github.com/peterblazejewicz" | |||
}, | |||
{ | |||
"name": "Anna Henningsen", | |||
"url": "https://github.com/addaleax" | |||
}, | |||
{ | |||
"name": "Jason Kwok", | |||
"url": "https://github.com/JasonHK" | |||
} | |||
], | |||
"dependencies": {}, | |||
"deprecated": false, | |||
"description": "TypeScript definitions for Node.js", | |||
"homepage": "https://github.com/DefinitelyTyped/DefinitelyTyped#readme", | |||
"license": "MIT", | |||
"main": "", | |||
"name": "@types/node", | |||
"repository": { | |||
"type": "git", | |||
"url": "git+https://github.com/DefinitelyTyped/DefinitelyTyped.git", | |||
"directory": "types/node" | |||
}, | |||
"scripts": {}, | |||
"typeScriptVersion": "3.0", | |||
"types": "index.d.ts", | |||
"typesPublisherContentHash": "3c6dff84a51cbfcb7b5fafcfe136319afe7fe4df89f6246837084ae5c2e5f8b3", | |||
"typesVersions": { | |||
">=3.7.0-0": { | |||
"*": [ | |||
"ts3.7/*" | |||
] | |||
}, | |||
">=3.5.0-0": { | |||
"*": [ | |||
"ts3.5/*" | |||
] | |||
}, | |||
">=3.2.0-0": { | |||
"*": [ | |||
"ts3.2/*" | |||
] | |||
} | |||
}, | |||
"version": "14.0.5" | |||
} |
@@ -0,0 +1,153 @@ | |||
declare module "path" { | |||
namespace path { | |||
/** | |||
* A parsed path object generated by path.parse() or consumed by path.format(). | |||
*/ | |||
interface ParsedPath { | |||
/** | |||
* The root of the path such as '/' or 'c:\' | |||
*/ | |||
root: string; | |||
/** | |||
* The full directory path such as '/home/user/dir' or 'c:\path\dir' | |||
*/ | |||
dir: string; | |||
/** | |||
* The file name including extension (if any) such as 'index.html' | |||
*/ | |||
base: string; | |||
/** | |||
* The file extension (if any) such as '.html' | |||
*/ | |||
ext: string; | |||
/** | |||
* The file name without extension (if any) such as 'index' | |||
*/ | |||
name: string; | |||
} | |||
interface FormatInputPathObject { | |||
/** | |||
* The root of the path such as '/' or 'c:\' | |||
*/ | |||
root?: string; | |||
/** | |||
* The full directory path such as '/home/user/dir' or 'c:\path\dir' | |||
*/ | |||
dir?: string; | |||
/** | |||
* The file name including extension (if any) such as 'index.html' | |||
*/ | |||
base?: string; | |||
/** | |||
* The file extension (if any) such as '.html' | |||
*/ | |||
ext?: string; | |||
/** | |||
* The file name without extension (if any) such as 'index' | |||
*/ | |||
name?: string; | |||
} | |||
interface PlatformPath { | |||
/** | |||
* Normalize a string path, reducing '..' and '.' parts. | |||
* When multiple slashes are found, they're replaced by a single one; when the path contains a trailing slash, it is preserved. On Windows backslashes are used. | |||
* | |||
* @param p string path to normalize. | |||
*/ | |||
normalize(p: string): string; | |||
/** | |||
* Join all arguments together and normalize the resulting path. | |||
* Arguments must be strings. In v0.8, non-string arguments were silently ignored. In v0.10 and up, an exception is thrown. | |||
* | |||
* @param paths paths to join. | |||
*/ | |||
join(...paths: string[]): string; | |||
/** | |||
* The right-most parameter is considered {to}. Other parameters are considered an array of {from}. | |||
* | |||
* Starting from leftmost {from} parameter, resolves {to} to an absolute path. | |||
* | |||
* If {to} isn't already absolute, {from} arguments are prepended in right to left order, | |||
* until an absolute path is found. If after using all {from} paths still no absolute path is found, | |||
* the current working directory is used as well. The resulting path is normalized, | |||
* and trailing slashes are removed unless the path gets resolved to the root directory. | |||
* | |||
* @param pathSegments string paths to join. Non-string arguments are ignored. | |||
*/ | |||
resolve(...pathSegments: string[]): string; | |||
/** | |||
* Determines whether {path} is an absolute path. An absolute path will always resolve to the same location, regardless of the working directory. | |||
* | |||
* @param path path to test. | |||
*/ | |||
isAbsolute(p: string): boolean; | |||
/** | |||
* Solve the relative path from {from} to {to}. | |||
* At times we have two absolute paths, and we need to derive the relative path from one to the other. This is actually the reverse transform of path.resolve. | |||
*/ | |||
relative(from: string, to: string): string; | |||
/** | |||
* Return the directory name of a path. Similar to the Unix dirname command. | |||
* | |||
* @param p the path to evaluate. | |||
*/ | |||
dirname(p: string): string; | |||
/** | |||
* Return the last portion of a path. Similar to the Unix basename command. | |||
* Often used to extract the file name from a fully qualified path. | |||
* | |||
* @param p the path to evaluate. | |||
* @param ext optionally, an extension to remove from the result. | |||
*/ | |||
basename(p: string, ext?: string): string; | |||
/** | |||
* Return the extension of the path, from the last '.' to end of string in the last portion of the path. | |||
* If there is no '.' in the last portion of the path or the first character of it is '.', then it returns an empty string | |||
* | |||
* @param p the path to evaluate. | |||
*/ | |||
extname(p: string): string; | |||
/** | |||
* The platform-specific file separator. '\\' or '/'. | |||
*/ | |||
readonly sep: string; | |||
/** | |||
* The platform-specific file delimiter. ';' or ':'. | |||
*/ | |||
readonly delimiter: string; | |||
/** | |||
* Returns an object from a path string - the opposite of format(). | |||
* | |||
* @param pathString path to evaluate. | |||
*/ | |||
parse(p: string): ParsedPath; | |||
/** | |||
* Returns a path string from an object - the opposite of parse(). | |||
* | |||
* @param pathString path to evaluate. | |||
*/ | |||
format(pP: FormatInputPathObject): string; | |||
/** | |||
* On Windows systems only, returns an equivalent namespace-prefixed path for the given path. | |||
* If path is not a string, path will be returned without modifications. | |||
* This method is meaningful only on Windows system. | |||
* On POSIX systems, the method is non-operational and always returns path without modifications. | |||
*/ | |||
toNamespacedPath(path: string): string; | |||
/** | |||
* Posix specific pathing. | |||
* Same as parent object on posix. | |||
*/ | |||
readonly posix: PlatformPath; | |||
/** | |||
* Windows specific pathing. | |||
* Same as parent object on windows | |||
*/ | |||
readonly win32: PlatformPath; | |||
} | |||
} | |||
const path: path.PlatformPath; | |||
export = path; | |||
} |
@@ -0,0 +1,321 @@ | |||
declare module 'perf_hooks' { | |||
import { AsyncResource } from 'async_hooks'; | |||
type EntryType = 'node' | 'mark' | 'measure' | 'gc' | 'function' | 'http2' | 'http'; | |||
interface PerformanceEntry { | |||
/** | |||
* The total number of milliseconds elapsed for this entry. | |||
* This value will not be meaningful for all Performance Entry types. | |||
*/ | |||
readonly duration: number; | |||
/** | |||
* The name of the performance entry. | |||
*/ | |||
readonly name: string; | |||
/** | |||
* The high resolution millisecond timestamp marking the starting time of the Performance Entry. | |||
*/ | |||
readonly startTime: number; | |||
/** | |||
* The type of the performance entry. | |||
* Currently it may be one of: 'node', 'mark', 'measure', 'gc', or 'function'. | |||
*/ | |||
readonly entryType: EntryType; | |||
/** | |||
* When `performanceEntry.entryType` is equal to 'gc', `the performance.kind` property identifies | |||
* the type of garbage collection operation that occurred. | |||
* See perf_hooks.constants for valid values. | |||
*/ | |||
readonly kind?: number; | |||
/** | |||
* When `performanceEntry.entryType` is equal to 'gc', the `performance.flags` | |||
* property contains additional information about garbage collection operation. | |||
* See perf_hooks.constants for valid values. | |||
*/ | |||
readonly flags?: number; | |||
} | |||
interface PerformanceNodeTiming extends PerformanceEntry { | |||
/** | |||
* The high resolution millisecond timestamp at which the Node.js process completed bootstrap. | |||
*/ | |||
readonly bootstrapComplete: number; | |||
/** | |||
* The high resolution millisecond timestamp at which cluster processing ended. | |||
*/ | |||
readonly clusterSetupEnd: number; | |||
/** | |||
* The high resolution millisecond timestamp at which cluster processing started. | |||
*/ | |||
readonly clusterSetupStart: number; | |||
/** | |||
* The high resolution millisecond timestamp at which the Node.js event loop exited. | |||
*/ | |||
readonly loopExit: number; | |||
/** | |||
* The high resolution millisecond timestamp at which the Node.js event loop started. | |||
*/ | |||
readonly loopStart: number; | |||
/** | |||
* The high resolution millisecond timestamp at which main module load ended. | |||
*/ | |||
readonly moduleLoadEnd: number; | |||
/** | |||
* The high resolution millisecond timestamp at which main module load started. | |||
*/ | |||
readonly moduleLoadStart: number; | |||
/** | |||
* The high resolution millisecond timestamp at which the Node.js process was initialized. | |||
*/ | |||
readonly nodeStart: number; | |||
/** | |||
* The high resolution millisecond timestamp at which preload module load ended. | |||
*/ | |||
readonly preloadModuleLoadEnd: number; | |||
/** | |||
* The high resolution millisecond timestamp at which preload module load started. | |||
*/ | |||
readonly preloadModuleLoadStart: number; | |||
/** | |||
* The high resolution millisecond timestamp at which third_party_main processing ended. | |||
*/ | |||
readonly thirdPartyMainEnd: number; | |||
/** | |||
* The high resolution millisecond timestamp at which third_party_main processing started. | |||
*/ | |||
readonly thirdPartyMainStart: number; | |||
/** | |||
* The high resolution millisecond timestamp at which the V8 platform was initialized. | |||
*/ | |||
readonly v8Start: number; | |||
} | |||
interface Performance { | |||
/** | |||
* If name is not provided, removes all PerformanceFunction objects from the Performance Timeline. | |||
* If name is provided, removes entries with name. | |||
* @param name | |||
*/ | |||
clearFunctions(name?: string): void; | |||
/** | |||
* If name is not provided, removes all PerformanceMark objects from the Performance Timeline. | |||
* If name is provided, removes only the named mark. | |||
* @param name | |||
*/ | |||
clearMarks(name?: string): void; | |||
/** | |||
* If name is not provided, removes all PerformanceMeasure objects from the Performance Timeline. | |||
* If name is provided, removes only objects whose performanceEntry.name matches name. | |||
*/ | |||
clearMeasures(name?: string): void; | |||
/** | |||
* Returns a list of all PerformanceEntry objects in chronological order with respect to performanceEntry.startTime. | |||
* @return list of all PerformanceEntry objects | |||
*/ | |||
getEntries(): PerformanceEntry[]; | |||
/** | |||
* Returns a list of all PerformanceEntry objects in chronological order with respect to performanceEntry.startTime | |||
* whose performanceEntry.name is equal to name, and optionally, whose performanceEntry.entryType is equal to type. | |||
* @param name | |||
* @param type | |||
* @return list of all PerformanceEntry objects | |||
*/ | |||
getEntriesByName(name: string, type?: EntryType): PerformanceEntry[]; | |||
/** | |||
* Returns a list of all PerformanceEntry objects in chronological order with respect to performanceEntry.startTime | |||
* whose performanceEntry.entryType is equal to type. | |||
* @param type | |||
* @return list of all PerformanceEntry objects | |||
*/ | |||
getEntriesByType(type: EntryType): PerformanceEntry[]; | |||
/** | |||
* Creates a new PerformanceMark entry in the Performance Timeline. | |||
* A PerformanceMark is a subclass of PerformanceEntry whose performanceEntry.entryType is always 'mark', | |||
* and whose performanceEntry.duration is always 0. | |||
* Performance marks are used to mark specific significant moments in the Performance Timeline. | |||
* @param name | |||
*/ | |||
mark(name?: string): void; | |||
/** | |||
* Creates a new PerformanceMeasure entry in the Performance Timeline. | |||
* A PerformanceMeasure is a subclass of PerformanceEntry whose performanceEntry.entryType is always 'measure', | |||
* and whose performanceEntry.duration measures the number of milliseconds elapsed since startMark and endMark. | |||
* | |||
* The startMark argument may identify any existing PerformanceMark in the the Performance Timeline, or may identify | |||
* any of the timestamp properties provided by the PerformanceNodeTiming class. If the named startMark does not exist, | |||
* then startMark is set to timeOrigin by default. | |||
* | |||
* The endMark argument must identify any existing PerformanceMark in the the Performance Timeline or any of the timestamp | |||
* properties provided by the PerformanceNodeTiming class. If the named endMark does not exist, an error will be thrown. | |||
* @param name | |||
* @param startMark | |||
* @param endMark | |||
*/ | |||
measure(name: string, startMark: string, endMark: string): void; | |||
/** | |||
* An instance of the PerformanceNodeTiming class that provides performance metrics for specific Node.js operational milestones. | |||
*/ | |||
readonly nodeTiming: PerformanceNodeTiming; | |||
/** | |||
* @return the current high resolution millisecond timestamp | |||
*/ | |||
now(): number; | |||
/** | |||
* The timeOrigin specifies the high resolution millisecond timestamp from which all performance metric durations are measured. | |||
*/ | |||
readonly timeOrigin: number; | |||
/** | |||
* Wraps a function within a new function that measures the running time of the wrapped function. | |||
* A PerformanceObserver must be subscribed to the 'function' event type in order for the timing details to be accessed. | |||
* @param fn | |||
*/ | |||
timerify<T extends (...optionalParams: any[]) => any>(fn: T): T; | |||
} | |||
interface PerformanceObserverEntryList { | |||
/** | |||
* @return a list of PerformanceEntry objects in chronological order with respect to performanceEntry.startTime. | |||
*/ | |||
getEntries(): PerformanceEntry[]; | |||
/** | |||
* @return a list of PerformanceEntry objects in chronological order with respect to performanceEntry.startTime | |||
* whose performanceEntry.name is equal to name, and optionally, whose performanceEntry.entryType is equal to type. | |||
*/ | |||
getEntriesByName(name: string, type?: EntryType): PerformanceEntry[]; | |||
/** | |||
* @return Returns a list of PerformanceEntry objects in chronological order with respect to performanceEntry.startTime | |||
* whose performanceEntry.entryType is equal to type. | |||
*/ | |||
getEntriesByType(type: EntryType): PerformanceEntry[]; | |||
} | |||
type PerformanceObserverCallback = (list: PerformanceObserverEntryList, observer: PerformanceObserver) => void; | |||
class PerformanceObserver extends AsyncResource { | |||
constructor(callback: PerformanceObserverCallback); | |||
/** | |||
* Disconnects the PerformanceObserver instance from all notifications. | |||
*/ | |||
disconnect(): void; | |||
/** | |||
* Subscribes the PerformanceObserver instance to notifications of new PerformanceEntry instances identified by options.entryTypes. | |||
* When options.buffered is false, the callback will be invoked once for every PerformanceEntry instance. | |||
* Property buffered defaults to false. | |||
* @param options | |||
*/ | |||
observe(options: { entryTypes: EntryType[]; buffered?: boolean }): void; | |||
} | |||
namespace constants { | |||
const NODE_PERFORMANCE_GC_MAJOR: number; | |||
const NODE_PERFORMANCE_GC_MINOR: number; | |||
const NODE_PERFORMANCE_GC_INCREMENTAL: number; | |||
const NODE_PERFORMANCE_GC_WEAKCB: number; | |||
const NODE_PERFORMANCE_GC_FLAGS_NO: number; | |||
const NODE_PERFORMANCE_GC_FLAGS_CONSTRUCT_RETAINED: number; | |||
const NODE_PERFORMANCE_GC_FLAGS_FORCED: number; | |||
const NODE_PERFORMANCE_GC_FLAGS_SYNCHRONOUS_PHANTOM_PROCESSING: number; | |||
const NODE_PERFORMANCE_GC_FLAGS_ALL_AVAILABLE_GARBAGE: number; | |||
const NODE_PERFORMANCE_GC_FLAGS_ALL_EXTERNAL_MEMORY: number; | |||
const NODE_PERFORMANCE_GC_FLAGS_SCHEDULE_IDLE: number; | |||
} | |||
const performance: Performance; | |||
interface EventLoopMonitorOptions { | |||
/** | |||
* The sampling rate in milliseconds. | |||
* Must be greater than zero. | |||
* @default 10 | |||
*/ | |||
resolution?: number; | |||
} | |||
interface EventLoopDelayMonitor { | |||
/** | |||
* Enables the event loop delay sample timer. Returns `true` if the timer was started, `false` if it was already started. | |||
*/ | |||
enable(): boolean; | |||
/** | |||
* Disables the event loop delay sample timer. Returns `true` if the timer was stopped, `false` if it was already stopped. | |||
*/ | |||
disable(): boolean; | |||
/** | |||
* Resets the collected histogram data. | |||
*/ | |||
reset(): void; | |||
/** | |||
* Returns the value at the given percentile. | |||
* @param percentile A percentile value between 1 and 100. | |||
*/ | |||
percentile(percentile: number): number; | |||
/** | |||
* A `Map` object detailing the accumulated percentile distribution. | |||
*/ | |||
readonly percentiles: Map<number, number>; | |||
/** | |||
* The number of times the event loop delay exceeded the maximum 1 hour eventloop delay threshold. | |||
*/ | |||
readonly exceeds: number; | |||
/** | |||
* The minimum recorded event loop delay. | |||
*/ | |||
readonly min: number; | |||
/** | |||
* The maximum recorded event loop delay. | |||
*/ | |||
readonly max: number; | |||
/** | |||
* The mean of the recorded event loop delays. | |||
*/ | |||
readonly mean: number; | |||
/** | |||
* The standard deviation of the recorded event loop delays. | |||
*/ | |||
readonly stddev: number; | |||
} | |||
function monitorEventLoopDelay(options?: EventLoopMonitorOptions): EventLoopDelayMonitor; | |||
} |
@@ -0,0 +1,15 @@ | |||
declare module "process" { | |||
import * as tty from "tty"; | |||
global { | |||
namespace NodeJS { | |||
// this namespace merge is here because these are specifically used | |||
// as the type for process.stdin, process.stdout, and process.stderr. | |||
// they can't live in tty.d.ts because we need to disambiguate the imported name. | |||
interface ReadStream extends tty.ReadStream {} | |||
interface WriteStream extends tty.WriteStream {} | |||
} | |||
} | |||
export = process; | |||
} |
@@ -0,0 +1,12 @@ | |||
declare module "punycode" { | |||
function decode(string: string): string; | |||
function encode(string: string): string; | |||
function toUnicode(domain: string): string; | |||
function toASCII(domain: string): string; | |||
const ucs2: ucs2; | |||
interface ucs2 { | |||
decode(string: string): number[]; | |||
encode(codePoints: number[]): string; | |||
} | |||
const version: string; | |||
} |
@@ -0,0 +1,28 @@ | |||
declare module "querystring" { | |||
interface StringifyOptions { | |||
encodeURIComponent?: (str: string) => string; | |||
} | |||
interface ParseOptions { | |||
maxKeys?: number; | |||
decodeURIComponent?: (str: string) => string; | |||
} | |||
interface ParsedUrlQuery extends NodeJS.Dict<string | string[]> { } | |||
interface ParsedUrlQueryInput extends NodeJS.Dict<string | number | boolean | string[] | number[] | boolean[] | null> { | |||
} | |||
function stringify(obj?: ParsedUrlQueryInput, sep?: string, eq?: string, options?: StringifyOptions): string; | |||
function parse(str: string, sep?: string, eq?: string, options?: ParseOptions): ParsedUrlQuery; | |||
/** | |||
* The querystring.encode() function is an alias for querystring.stringify(). | |||
*/ | |||
const encode: typeof stringify; | |||
/** | |||
* The querystring.decode() function is an alias for querystring.parse(). | |||
*/ | |||
const decode: typeof parse; | |||
function escape(str: string): string; | |||
function unescape(str: string): string; | |||
} |
@@ -0,0 +1,171 @@ | |||
declare module "readline" { | |||
import * as events from "events"; | |||
import * as stream from "stream"; | |||
interface Key { | |||
sequence?: string; | |||
name?: string; | |||
ctrl?: boolean; | |||
meta?: boolean; | |||
shift?: boolean; | |||
} | |||
class Interface extends events.EventEmitter { | |||
readonly terminal: boolean; | |||
// Need direct access to line/cursor data, for use in external processes | |||
// see: https://github.com/nodejs/node/issues/30347 | |||
/** The current input data */ | |||
readonly line: string; | |||
/** The current cursor position in the input line */ | |||
readonly cursor: number; | |||
/** | |||
* NOTE: According to the documentation: | |||
* | |||
* > Instances of the `readline.Interface` class are constructed using the | |||
* > `readline.createInterface()` method. | |||
* | |||
* @see https://nodejs.org/dist/latest-v10.x/docs/api/readline.html#readline_class_interface | |||
*/ | |||
protected constructor(input: NodeJS.ReadableStream, output?: NodeJS.WritableStream, completer?: Completer | AsyncCompleter, terminal?: boolean); | |||
/** | |||
* NOTE: According to the documentation: | |||
* | |||
* > Instances of the `readline.Interface` class are constructed using the | |||
* > `readline.createInterface()` method. | |||
* | |||
* @see https://nodejs.org/dist/latest-v10.x/docs/api/readline.html#readline_class_interface | |||
*/ | |||
protected constructor(options: ReadLineOptions); | |||
setPrompt(prompt: string): void; | |||
prompt(preserveCursor?: boolean): void; | |||
question(query: string, callback: (answer: string) => void): void; | |||
pause(): this; | |||
resume(): this; | |||
close(): void; | |||
write(data: string | Buffer, key?: Key): void; | |||
/** | |||
* Returns the real position of the cursor in relation to the input | |||
* prompt + string. Long input (wrapping) strings, as well as multiple | |||
* line prompts are included in the calculations. | |||
*/ | |||
getCursorPos(): CursorPos; | |||
/** | |||
* events.EventEmitter | |||
* 1. close | |||
* 2. line | |||
* 3. pause | |||
* 4. resume | |||
* 5. SIGCONT | |||
* 6. SIGINT | |||
* 7. SIGTSTP | |||
*/ | |||
addListener(event: string, listener: (...args: any[]) => void): this; | |||
addListener(event: "close", listener: () => void): this; | |||
addListener(event: "line", listener: (input: string) => void): this; | |||
addListener(event: "pause", listener: () => void): this; | |||
addListener(event: "resume", listener: () => void): this; | |||
addListener(event: "SIGCONT", listener: () => void): this; | |||
addListener(event: "SIGINT", listener: () => void): this; | |||
addListener(event: "SIGTSTP", listener: () => void): this; | |||
emit(event: string | symbol, ...args: any[]): boolean; | |||
emit(event: "close"): boolean; | |||
emit(event: "line", input: string): boolean; | |||
emit(event: "pause"): boolean; | |||
emit(event: "resume"): boolean; | |||
emit(event: "SIGCONT"): boolean; | |||
emit(event: "SIGINT"): boolean; | |||
emit(event: "SIGTSTP"): boolean; | |||
on(event: string, listener: (...args: any[]) => void): this; | |||
on(event: "close", listener: () => void): this; | |||
on(event: "line", listener: (input: string) => void): this; | |||
on(event: "pause", listener: () => void): this; | |||
on(event: "resume", listener: () => void): this; | |||
on(event: "SIGCONT", listener: () => void): this; | |||
on(event: "SIGINT", listener: () => void): this; | |||
on(event: "SIGTSTP", listener: () => void): this; | |||
once(event: string, listener: (...args: any[]) => void): this; | |||
once(event: "close", listener: () => void): this; | |||
once(event: "line", listener: (input: string) => void): this; | |||
once(event: "pause", listener: () => void): this; | |||
once(event: "resume", listener: () => void): this; | |||
once(event: "SIGCONT", listener: () => void): this; | |||
once(event: "SIGINT", listener: () => void): this; | |||
once(event: "SIGTSTP", listener: () => void): this; | |||
prependListener(event: string, listener: (...args: any[]) => void): this; | |||
prependListener(event: "close", listener: () => void): this; | |||
prependListener(event: "line", listener: (input: string) => void): this; | |||
prependListener(event: "pause", listener: () => void): this; | |||
prependListener(event: "resume", listener: () => void): this; | |||
prependListener(event: "SIGCONT", listener: () => void): this; | |||
prependListener(event: "SIGINT", listener: () => void): this; | |||
prependListener(event: "SIGTSTP", listener: () => void): this; | |||
prependOnceListener(event: string, listener: (...args: any[]) => void): this; | |||
prependOnceListener(event: "close", listener: () => void): this; | |||
prependOnceListener(event: "line", listener: (input: string) => void): this; | |||
prependOnceListener(event: "pause", listener: () => void): this; | |||
prependOnceListener(event: "resume", listener: () => void): this; | |||
prependOnceListener(event: "SIGCONT", listener: () => void): this; | |||
prependOnceListener(event: "SIGINT", listener: () => void): this; | |||
prependOnceListener(event: "SIGTSTP", listener: () => void): this; | |||
[Symbol.asyncIterator](): AsyncIterableIterator<string>; | |||
} | |||
type ReadLine = Interface; // type forwarded for backwards compatiblity | |||
type Completer = (line: string) => CompleterResult; | |||
type AsyncCompleter = (line: string, callback: (err?: null | Error, result?: CompleterResult) => void) => any; | |||
type CompleterResult = [string[], string]; | |||
interface ReadLineOptions { | |||
input: NodeJS.ReadableStream; | |||
output?: NodeJS.WritableStream; | |||
completer?: Completer | AsyncCompleter; | |||
terminal?: boolean; | |||
historySize?: number; | |||
prompt?: string; | |||
crlfDelay?: number; | |||
removeHistoryDuplicates?: boolean; | |||
escapeCodeTimeout?: number; | |||
tabSize?: number; | |||
} | |||
function createInterface(input: NodeJS.ReadableStream, output?: NodeJS.WritableStream, completer?: Completer | AsyncCompleter, terminal?: boolean): Interface; | |||
function createInterface(options: ReadLineOptions): Interface; | |||
function emitKeypressEvents(stream: NodeJS.ReadableStream, readlineInterface?: Interface): void; | |||
type Direction = -1 | 0 | 1; | |||
interface CursorPos { | |||
rows: number; | |||
cols: number; | |||
} | |||
/** | |||
* Clears the current line of this WriteStream in a direction identified by `dir`. | |||
*/ | |||
function clearLine(stream: NodeJS.WritableStream, dir: Direction, callback?: () => void): boolean; | |||
/** | |||
* Clears this `WriteStream` from the current cursor down. | |||
*/ | |||
function clearScreenDown(stream: NodeJS.WritableStream, callback?: () => void): boolean; | |||
/** | |||
* Moves this WriteStream's cursor to the specified position. | |||
*/ | |||
function cursorTo(stream: NodeJS.WritableStream, x: number, y?: number, callback?: () => void): boolean; | |||
/** | |||
* Moves this WriteStream's cursor relative to its current position. | |||
*/ | |||
function moveCursor(stream: NodeJS.WritableStream, dx: number, dy: number, callback?: () => void): boolean; | |||
} |
@@ -0,0 +1,387 @@ | |||
declare module "repl" { | |||
import { Interface, Completer, AsyncCompleter } from "readline"; | |||
import { Context } from "vm"; | |||
import { InspectOptions } from "util"; | |||
interface ReplOptions { | |||
/** | |||
* The input prompt to display. | |||
* Default: `"> "` | |||
*/ | |||
prompt?: string; | |||
/** | |||
* The `Readable` stream from which REPL input will be read. | |||
* Default: `process.stdin` | |||
*/ | |||
input?: NodeJS.ReadableStream; | |||
/** | |||
* The `Writable` stream to which REPL output will be written. | |||
* Default: `process.stdout` | |||
*/ | |||
output?: NodeJS.WritableStream; | |||
/** | |||
* If `true`, specifies that the output should be treated as a TTY terminal, and have | |||
* ANSI/VT100 escape codes written to it. | |||
* Default: checking the value of the `isTTY` property on the output stream upon | |||
* instantiation. | |||
*/ | |||
terminal?: boolean; | |||
/** | |||
* The function to be used when evaluating each given line of input. | |||
* Default: an async wrapper for the JavaScript `eval()` function. An `eval` function can | |||
* error with `repl.Recoverable` to indicate the input was incomplete and prompt for | |||
* additional lines. | |||
* | |||
* @see https://nodejs.org/dist/latest-v10.x/docs/api/repl.html#repl_default_evaluation | |||
* @see https://nodejs.org/dist/latest-v10.x/docs/api/repl.html#repl_custom_evaluation_functions | |||
*/ | |||
eval?: REPLEval; | |||
/** | |||
* Defines if the repl prints output previews or not. | |||
* @default `true` Always `false` in case `terminal` is falsy. | |||
*/ | |||
preview?: boolean; | |||
/** | |||
* If `true`, specifies that the default `writer` function should include ANSI color | |||
* styling to REPL output. If a custom `writer` function is provided then this has no | |||
* effect. | |||
* Default: the REPL instance's `terminal` value. | |||
*/ | |||
useColors?: boolean; | |||
/** | |||
* If `true`, specifies that the default evaluation function will use the JavaScript | |||
* `global` as the context as opposed to creating a new separate context for the REPL | |||
* instance. The node CLI REPL sets this value to `true`. | |||
* Default: `false`. | |||
*/ | |||
useGlobal?: boolean; | |||
/** | |||
* If `true`, specifies that the default writer will not output the return value of a | |||
* command if it evaluates to `undefined`. | |||
* Default: `false`. | |||
*/ | |||
ignoreUndefined?: boolean; | |||
/** | |||
* The function to invoke to format the output of each command before writing to `output`. | |||
* Default: a wrapper for `util.inspect`. | |||
* | |||
* @see https://nodejs.org/dist/latest-v10.x/docs/api/repl.html#repl_customizing_repl_output | |||
*/ | |||
writer?: REPLWriter; | |||
/** | |||
* An optional function used for custom Tab auto completion. | |||
* | |||
* @see https://nodejs.org/dist/latest-v11.x/docs/api/readline.html#readline_use_of_the_completer_function | |||
*/ | |||
completer?: Completer | AsyncCompleter; | |||
/** | |||
* A flag that specifies whether the default evaluator executes all JavaScript commands in | |||
* strict mode or default (sloppy) mode. | |||
* Accepted values are: | |||
* - `repl.REPL_MODE_SLOPPY` - evaluates expressions in sloppy mode. | |||
* - `repl.REPL_MODE_STRICT` - evaluates expressions in strict mode. This is equivalent to | |||
* prefacing every repl statement with `'use strict'`. | |||
*/ | |||
replMode?: typeof REPL_MODE_SLOPPY | typeof REPL_MODE_STRICT; | |||
/** | |||
* Stop evaluating the current piece of code when `SIGINT` is received, i.e. `Ctrl+C` is | |||
* pressed. This cannot be used together with a custom `eval` function. | |||
* Default: `false`. | |||
*/ | |||
breakEvalOnSigint?: boolean; | |||
} | |||
type REPLEval = (this: REPLServer, evalCmd: string, context: Context, file: string, cb: (err: Error | null, result: any) => void) => void; | |||
type REPLWriter = (this: REPLServer, obj: any) => string; | |||
/** | |||
* This is the default "writer" value, if none is passed in the REPL options, | |||
* and it can be overridden by custom print functions. | |||
*/ | |||
const writer: REPLWriter & { options: InspectOptions }; | |||
type REPLCommandAction = (this: REPLServer, text: string) => void; | |||
interface REPLCommand { | |||
/** | |||
* Help text to be displayed when `.help` is entered. | |||
*/ | |||
help?: string; | |||
/** | |||
* The function to execute, optionally accepting a single string argument. | |||
*/ | |||
action: REPLCommandAction; | |||
} | |||
/** | |||
* Provides a customizable Read-Eval-Print-Loop (REPL). | |||
* | |||
* Instances of `repl.REPLServer` will accept individual lines of user input, evaluate those | |||
* according to a user-defined evaluation function, then output the result. Input and output | |||
* may be from `stdin` and `stdout`, respectively, or may be connected to any Node.js `stream`. | |||
* | |||
* Instances of `repl.REPLServer` support automatic completion of inputs, simplistic Emacs-style | |||
* line editing, multi-line inputs, ANSI-styled output, saving and restoring current REPL session | |||
* state, error recovery, and customizable evaluation functions. | |||
* | |||
* Instances of `repl.REPLServer` are created using the `repl.start()` method and _should not_ | |||
* be created directly using the JavaScript `new` keyword. | |||
* | |||
* @see https://nodejs.org/dist/latest-v10.x/docs/api/repl.html#repl_repl | |||
*/ | |||
class REPLServer extends Interface { | |||
/** | |||
* The `vm.Context` provided to the `eval` function to be used for JavaScript | |||
* evaluation. | |||
*/ | |||
readonly context: Context; | |||
/** | |||
* The `Readable` stream from which REPL input will be read. | |||
*/ | |||
readonly inputStream: NodeJS.ReadableStream; | |||
/** | |||
* The `Writable` stream to which REPL output will be written. | |||
*/ | |||
readonly outputStream: NodeJS.WritableStream; | |||
/** | |||
* The commands registered via `replServer.defineCommand()`. | |||
*/ | |||
readonly commands: NodeJS.ReadOnlyDict<REPLCommand>; | |||
/** | |||
* A value indicating whether the REPL is currently in "editor mode". | |||
* | |||
* @see https://nodejs.org/dist/latest-v10.x/docs/api/repl.html#repl_commands_and_special_keys | |||
*/ | |||
readonly editorMode: boolean; | |||
/** | |||
* A value indicating whether the `_` variable has been assigned. | |||
* | |||
* @see https://nodejs.org/dist/latest-v10.x/docs/api/repl.html#repl_assignment_of_the_underscore_variable | |||
*/ | |||
readonly underscoreAssigned: boolean; | |||
/** | |||
* The last evaluation result from the REPL (assigned to the `_` variable inside of the REPL). | |||
* | |||
* @see https://nodejs.org/dist/latest-v10.x/docs/api/repl.html#repl_assignment_of_the_underscore_variable | |||
*/ | |||
readonly last: any; | |||
/** | |||
* A value indicating whether the `_error` variable has been assigned. | |||
* | |||
* @since v9.8.0 | |||
* @see https://nodejs.org/dist/latest-v10.x/docs/api/repl.html#repl_assignment_of_the_underscore_variable | |||
*/ | |||
readonly underscoreErrAssigned: boolean; | |||
/** | |||
* The last error raised inside the REPL (assigned to the `_error` variable inside of the REPL). | |||
* | |||
* @since v9.8.0 | |||
* @see https://nodejs.org/dist/latest-v10.x/docs/api/repl.html#repl_assignment_of_the_underscore_variable | |||
*/ | |||
readonly lastError: any; | |||
/** | |||
* Specified in the REPL options, this is the function to be used when evaluating each | |||
* given line of input. If not specified in the REPL options, this is an async wrapper | |||
* for the JavaScript `eval()` function. | |||
*/ | |||
readonly eval: REPLEval; | |||
/** | |||
* Specified in the REPL options, this is a value indicating whether the default | |||
* `writer` function should include ANSI color styling to REPL output. | |||
*/ | |||
readonly useColors: boolean; | |||
/** | |||
* Specified in the REPL options, this is a value indicating whether the default `eval` | |||
* function will use the JavaScript `global` as the context as opposed to creating a new | |||
* separate context for the REPL instance. | |||
*/ | |||
readonly useGlobal: boolean; | |||
/** | |||
* Specified in the REPL options, this is a value indicating whether the default `writer` | |||
* function should output the result of a command if it evaluates to `undefined`. | |||
*/ | |||
readonly ignoreUndefined: boolean; | |||
/** | |||
* Specified in the REPL options, this is the function to invoke to format the output of | |||
* each command before writing to `outputStream`. If not specified in the REPL options, | |||
* this will be a wrapper for `util.inspect`. | |||
*/ | |||
readonly writer: REPLWriter; | |||
/** | |||
* Specified in the REPL options, this is the function to use for custom Tab auto-completion. | |||
*/ | |||
readonly completer: Completer | AsyncCompleter; | |||
/** | |||
* Specified in the REPL options, this is a flag that specifies whether the default `eval` | |||
* function should execute all JavaScript commands in strict mode or default (sloppy) mode. | |||
* Possible values are: | |||
* - `repl.REPL_MODE_SLOPPY` - evaluates expressions in sloppy mode. | |||
* - `repl.REPL_MODE_STRICT` - evaluates expressions in strict mode. This is equivalent to | |||
* prefacing every repl statement with `'use strict'`. | |||
*/ | |||
readonly replMode: typeof REPL_MODE_SLOPPY | typeof REPL_MODE_STRICT; | |||
/** | |||
* NOTE: According to the documentation: | |||
* | |||
* > Instances of `repl.REPLServer` are created using the `repl.start()` method and | |||
* > _should not_ be created directly using the JavaScript `new` keyword. | |||
* | |||
* `REPLServer` cannot be subclassed due to implementation specifics in NodeJS. | |||
* | |||
* @see https://nodejs.org/dist/latest-v10.x/docs/api/repl.html#repl_class_replserver | |||
*/ | |||
private constructor(); | |||
/** | |||
* Used to add new `.`-prefixed commands to the REPL instance. Such commands are invoked | |||
* by typing a `.` followed by the `keyword`. | |||
* | |||
* @param keyword The command keyword (_without_ a leading `.` character). | |||
* @param cmd The function to invoke when the command is processed. | |||
* | |||
* @see https://nodejs.org/dist/latest-v10.x/docs/api/repl.html#repl_replserver_definecommand_keyword_cmd | |||
*/ | |||
defineCommand(keyword: string, cmd: REPLCommandAction | REPLCommand): void; | |||
/** | |||
* Readies the REPL instance for input from the user, printing the configured `prompt` to a | |||
* new line in the `output` and resuming the `input` to accept new input. | |||
* | |||
* When multi-line input is being entered, an ellipsis is printed rather than the 'prompt'. | |||
* | |||
* This method is primarily intended to be called from within the action function for | |||
* commands registered using the `replServer.defineCommand()` method. | |||
* | |||
* @param preserveCursor When `true`, the cursor placement will not be reset to `0`. | |||
*/ | |||
displayPrompt(preserveCursor?: boolean): void; | |||
/** | |||
* Clears any command that has been buffered but not yet executed. | |||
* | |||
* This method is primarily intended to be called from within the action function for | |||
* commands registered using the `replServer.defineCommand()` method. | |||
* | |||
* @since v9.0.0 | |||
*/ | |||
clearBufferedCommand(): void; | |||
/** | |||
* Initializes a history log file for the REPL instance. When executing the | |||
* Node.js binary and using the command line REPL, a history file is initialized | |||
* by default. However, this is not the case when creating a REPL | |||
* programmatically. Use this method to initialize a history log file when working | |||
* with REPL instances programmatically. | |||
* @param path The path to the history file | |||
*/ | |||
setupHistory(path: string, cb: (err: Error | null, repl: this) => void): void; | |||
/** | |||
* events.EventEmitter | |||
* 1. close - inherited from `readline.Interface` | |||
* 2. line - inherited from `readline.Interface` | |||
* 3. pause - inherited from `readline.Interface` | |||
* 4. resume - inherited from `readline.Interface` | |||
* 5. SIGCONT - inherited from `readline.Interface` | |||
* 6. SIGINT - inherited from `readline.Interface` | |||
* 7. SIGTSTP - inherited from `readline.Interface` | |||
* 8. exit | |||
* 9. reset | |||
*/ | |||
addListener(event: string, listener: (...args: any[]) => void): this; | |||
addListener(event: "close", listener: () => void): this; | |||
addListener(event: "line", listener: (input: string) => void): this; | |||
addListener(event: "pause", listener: () => void): this; | |||
addListener(event: "resume", listener: () => void): this; | |||
addListener(event: "SIGCONT", listener: () => void): this; | |||
addListener(event: "SIGINT", listener: () => void): this; | |||
addListener(event: "SIGTSTP", listener: () => void): this; | |||
addListener(event: "exit", listener: () => void): this; | |||
addListener(event: "reset", listener: (context: Context) => void): this; | |||
emit(event: string | symbol, ...args: any[]): boolean; | |||
emit(event: "close"): boolean; | |||
emit(event: "line", input: string): boolean; | |||
emit(event: "pause"): boolean; | |||
emit(event: "resume"): boolean; | |||
emit(event: "SIGCONT"): boolean; | |||
emit(event: "SIGINT"): boolean; | |||
emit(event: "SIGTSTP"): boolean; | |||
emit(event: "exit"): boolean; | |||
emit(event: "reset", context: Context): boolean; | |||
on(event: string, listener: (...args: any[]) => void): this; | |||
on(event: "close", listener: () => void): this; | |||
on(event: "line", listener: (input: string) => void): this; | |||
on(event: "pause", listener: () => void): this; | |||
on(event: "resume", listener: () => void): this; | |||
on(event: "SIGCONT", listener: () => void): this; | |||
on(event: "SIGINT", listener: () => void): this; | |||
on(event: "SIGTSTP", listener: () => void): this; | |||
on(event: "exit", listener: () => void): this; | |||
on(event: "reset", listener: (context: Context) => void): this; | |||
once(event: string, listener: (...args: any[]) => void): this; | |||
once(event: "close", listener: () => void): this; | |||
once(event: "line", listener: (input: string) => void): this; | |||
once(event: "pause", listener: () => void): this; | |||
once(event: "resume", listener: () => void): this; | |||
once(event: "SIGCONT", listener: () => void): this; | |||
once(event: "SIGINT", listener: () => void): this; | |||
once(event: "SIGTSTP", listener: () => void): this; | |||
once(event: "exit", listener: () => void): this; | |||
once(event: "reset", listener: (context: Context) => void): this; | |||
prependListener(event: string, listener: (...args: any[]) => void): this; | |||
prependListener(event: "close", listener: () => void): this; | |||
prependListener(event: "line", listener: (input: string) => void): this; | |||
prependListener(event: "pause", listener: () => void): this; | |||
prependListener(event: "resume", listener: () => void): this; | |||
prependListener(event: "SIGCONT", listener: () => void): this; | |||
prependListener(event: "SIGINT", listener: () => void): this; | |||
prependListener(event: "SIGTSTP", listener: () => void): this; | |||
prependListener(event: "exit", listener: () => void): this; | |||
prependListener(event: "reset", listener: (context: Context) => void): this; | |||
prependOnceListener(event: string, listener: (...args: any[]) => void): this; | |||
prependOnceListener(event: "close", listener: () => void): this; | |||
prependOnceListener(event: "line", listener: (input: string) => void): this; | |||
prependOnceListener(event: "pause", listener: () => void): this; | |||
prependOnceListener(event: "resume", listener: () => void): this; | |||
prependOnceListener(event: "SIGCONT", listener: () => void): this; | |||
prependOnceListener(event: "SIGINT", listener: () => void): this; | |||
prependOnceListener(event: "SIGTSTP", listener: () => void): this; | |||
prependOnceListener(event: "exit", listener: () => void): this; | |||
prependOnceListener(event: "reset", listener: (context: Context) => void): this; | |||
} | |||
/** | |||
* A flag passed in the REPL options. Evaluates expressions in sloppy mode. | |||
*/ | |||
const REPL_MODE_SLOPPY: unique symbol; | |||
/** | |||
* A flag passed in the REPL options. Evaluates expressions in strict mode. | |||
* This is equivalent to prefacing every repl statement with `'use strict'`. | |||
*/ | |||
const REPL_MODE_STRICT: unique symbol; | |||
/** | |||
* Creates and starts a `repl.REPLServer` instance. | |||
* | |||
* @param options The options for the `REPLServer`. If `options` is a string, then it specifies | |||
* the input prompt. | |||
*/ | |||
function start(options?: string | ReplOptions): REPLServer; | |||
/** | |||
* Indicates a recoverable error that a `REPLServer` can use to support multi-line input. | |||
* | |||
* @see https://nodejs.org/dist/latest-v10.x/docs/api/repl.html#repl_recoverable_errors | |||
*/ | |||
class Recoverable extends SyntaxError { | |||
err: Error; | |||
constructor(err: Error); | |||
} | |||
} |
@@ -0,0 +1,348 @@ | |||
declare module "stream" { | |||
import * as events from "events"; | |||
class internal extends events.EventEmitter { | |||
pipe<T extends NodeJS.WritableStream>(destination: T, options?: { end?: boolean; }): T; | |||
} | |||
namespace internal { | |||
class Stream extends internal { | |||
constructor(opts?: ReadableOptions); | |||
} | |||
interface ReadableOptions { | |||
highWaterMark?: number; | |||
encoding?: BufferEncoding; | |||
objectMode?: boolean; | |||
read?(this: Readable, size: number): void; | |||
destroy?(this: Readable, error: Error | null, callback: (error: Error | null) => void): void; | |||
autoDestroy?: boolean; | |||
} | |||
class Readable extends Stream implements NodeJS.ReadableStream { | |||
/** | |||
* A utility method for creating Readable Streams out of iterators. | |||
*/ | |||
static from(iterable: Iterable<any> | AsyncIterable<any>, options?: ReadableOptions): Readable; | |||
readable: boolean; | |||
readonly readableHighWaterMark: number; | |||
readonly readableLength: number; | |||
readonly readableObjectMode: boolean; | |||
destroyed: boolean; | |||
constructor(opts?: ReadableOptions); | |||
_read(size: number): void; | |||
read(size?: number): any; | |||
setEncoding(encoding: BufferEncoding): this; | |||
pause(): this; | |||
resume(): this; | |||
isPaused(): boolean; | |||
unpipe(destination?: NodeJS.WritableStream): this; | |||
unshift(chunk: any, encoding?: BufferEncoding): void; | |||
wrap(oldStream: NodeJS.ReadableStream): this; | |||
push(chunk: any, encoding?: BufferEncoding): boolean; | |||
_destroy(error: Error | null, callback: (error?: Error | null) => void): void; | |||
destroy(error?: Error): void; | |||
/** | |||
* Event emitter | |||
* The defined events on documents including: | |||
* 1. close | |||
* 2. data | |||
* 3. end | |||
* 4. error | |||
* 5. pause | |||
* 6. readable | |||
* 7. resume | |||
*/ | |||
addListener(event: "close", listener: () => void): this; | |||
addListener(event: "data", listener: (chunk: any) => void): this; | |||
addListener(event: "end", listener: () => void): this; | |||
addListener(event: "error", listener: (err: Error) => void): this; | |||
addListener(event: "pause", listener: () => void): this; | |||
addListener(event: "readable", listener: () => void): this; | |||
addListener(event: "resume", listener: () => void): this; | |||
addListener(event: string | symbol, listener: (...args: any[]) => void): this; | |||
emit(event: "close"): boolean; | |||
emit(event: "data", chunk: any): boolean; | |||
emit(event: "end"): boolean; | |||
emit(event: "error", err: Error): boolean; | |||
emit(event: "pause"): boolean; | |||
emit(event: "readable"): boolean; | |||
emit(event: "resume"): boolean; | |||
emit(event: string | symbol, ...args: any[]): boolean; | |||
on(event: "close", listener: () => void): this; | |||
on(event: "data", listener: (chunk: any) => void): this; | |||
on(event: "end", listener: () => void): this; | |||
on(event: "error", listener: (err: Error) => void): this; | |||
on(event: "pause", listener: () => void): this; | |||
on(event: "readable", listener: () => void): this; | |||
on(event: "resume", listener: () => void): this; | |||
on(event: string | symbol, listener: (...args: any[]) => void): this; | |||
once(event: "close", listener: () => void): this; | |||
once(event: "data", listener: (chunk: any) => void): this; | |||
once(event: "end", listener: () => void): this; | |||
once(event: "error", listener: (err: Error) => void): this; | |||
once(event: "pause", listener: () => void): this; | |||
once(event: "readable", listener: () => void): this; | |||
once(event: "resume", listener: () => void): this; | |||
once(event: string | symbol, listener: (...args: any[]) => void): this; | |||
prependListener(event: "close", listener: () => void): this; | |||
prependListener(event: "data", listener: (chunk: any) => void): this; | |||
prependListener(event: "end", listener: () => void): this; | |||
prependListener(event: "error", listener: (err: Error) => void): this; | |||
prependListener(event: "pause", listener: () => void): this; | |||
prependListener(event: "readable", listener: () => void): this; | |||
prependListener(event: "resume", listener: () => void): this; | |||
prependListener(event: string | symbol, listener: (...args: any[]) => void): this; | |||
prependOnceListener(event: "close", listener: () => void): this; | |||
prependOnceListener(event: "data", listener: (chunk: any) => void): this; | |||
prependOnceListener(event: "end", listener: () => void): this; | |||
prependOnceListener(event: "error", listener: (err: Error) => void): this; | |||
prependOnceListener(event: "pause", listener: () => void): this; | |||
prependOnceListener(event: "readable", listener: () => void): this; | |||
prependOnceListener(event: "resume", listener: () => void): this; | |||
prependOnceListener(event: string | symbol, listener: (...args: any[]) => void): this; | |||
removeListener(event: "close", listener: () => void): this; | |||
removeListener(event: "data", listener: (chunk: any) => void): this; | |||
removeListener(event: "end", listener: () => void): this; | |||
removeListener(event: "error", listener: (err: Error) => void): this; | |||
removeListener(event: "pause", listener: () => void): this; | |||
removeListener(event: "readable", listener: () => void): this; | |||
removeListener(event: "resume", listener: () => void): this; | |||
removeListener(event: string | symbol, listener: (...args: any[]) => void): this; | |||
[Symbol.asyncIterator](): AsyncIterableIterator<any>; | |||
} | |||
interface WritableOptions { | |||
highWaterMark?: number; | |||
decodeStrings?: boolean; | |||
defaultencoding?: BufferEncoding; | |||
objectMode?: boolean; | |||
emitClose?: boolean; | |||
write?(this: Writable, chunk: any, encoding: BufferEncoding, callback: (error?: Error | null) => void): void; | |||
writev?(this: Writable, chunks: Array<{ chunk: any, encoding: BufferEncoding }>, callback: (error?: Error | null) => void): void; | |||
destroy?(this: Writable, error: Error | null, callback: (error: Error | null) => void): void; | |||
final?(this: Writable, callback: (error?: Error | null) => void): void; | |||
autoDestroy?: boolean; | |||
} | |||
class Writable extends Stream implements NodeJS.WritableStream { | |||
readonly writable: boolean; | |||
readonly writableEnded: boolean; | |||
readonly writableFinished: boolean; | |||
readonly writableHighWaterMark: number; | |||
readonly writableLength: number; | |||
readonly writableObjectMode: boolean; | |||
readonly writableCorked: number; | |||
destroyed: boolean; | |||
constructor(opts?: WritableOptions); | |||
_write(chunk: any, encoding: BufferEncoding, callback: (error?: Error | null) => void): void; | |||
_writev?(chunks: Array<{ chunk: any, encoding: BufferEncoding }>, callback: (error?: Error | null) => void): void; | |||
_destroy(error: Error | null, callback: (error?: Error | null) => void): void; | |||
_final(callback: (error?: Error | null) => void): void; | |||
write(chunk: any, cb?: (error: Error | null | undefined) => void): boolean; | |||
write(chunk: any, encoding: BufferEncoding, cb?: (error: Error | null | undefined) => void): boolean; | |||
setDefaultEncoding(encoding: BufferEncoding): this; | |||
end(cb?: () => void): void; | |||
end(chunk: any, cb?: () => void): void; | |||
end(chunk: any, encoding: BufferEncoding, cb?: () => void): void; | |||
cork(): void; | |||
uncork(): void; | |||
destroy(error?: Error): void; | |||
/** | |||
* Event emitter | |||
* The defined events on documents including: | |||
* 1. close | |||
* 2. drain | |||
* 3. error | |||
* 4. finish | |||
* 5. pipe | |||
* 6. unpipe | |||
*/ | |||
addListener(event: "close", listener: () => void): this; | |||
addListener(event: "drain", listener: () => void): this; | |||
addListener(event: "error", listener: (err: Error) => void): this; | |||
addListener(event: "finish", listener: () => void): this; | |||
addListener(event: "pipe", listener: (src: Readable) => void): this; | |||
addListener(event: "unpipe", listener: (src: Readable) => void): this; | |||
addListener(event: string | symbol, listener: (...args: any[]) => void): this; | |||
emit(event: "close"): boolean; | |||
emit(event: "drain"): boolean; | |||
emit(event: "error", err: Error): boolean; | |||
emit(event: "finish"): boolean; | |||
emit(event: "pipe", src: Readable): boolean; | |||
emit(event: "unpipe", src: Readable): boolean; | |||
emit(event: string | symbol, ...args: any[]): boolean; | |||
on(event: "close", listener: () => void): this; | |||
on(event: "drain", listener: () => void): this; | |||
on(event: "error", listener: (err: Error) => void): this; | |||
on(event: "finish", listener: () => void): this; | |||
on(event: "pipe", listener: (src: Readable) => void): this; | |||
on(event: "unpipe", listener: (src: Readable) => void): this; | |||
on(event: string | symbol, listener: (...args: any[]) => void): this; | |||
once(event: "close", listener: () => void): this; | |||
once(event: "drain", listener: () => void): this; | |||
once(event: "error", listener: (err: Error) => void): this; | |||
once(event: "finish", listener: () => void): this; | |||
once(event: "pipe", listener: (src: Readable) => void): this; | |||
once(event: "unpipe", listener: (src: Readable) => void): this; | |||
once(event: string | symbol, listener: (...args: any[]) => void): this; | |||
prependListener(event: "close", listener: () => void): this; | |||
prependListener(event: "drain", listener: () => void): this; | |||
prependListener(event: "error", listener: (err: Error) => void): this; | |||
prependListener(event: "finish", listener: () => void): this; | |||
prependListener(event: "pipe", listener: (src: Readable) => void): this; | |||
prependListener(event: "unpipe", listener: (src: Readable) => void): this; | |||
prependListener(event: string | symbol, listener: (...args: any[]) => void): this; | |||
prependOnceListener(event: "close", listener: () => void): this; | |||
prependOnceListener(event: "drain", listener: () => void): this; | |||
prependOnceListener(event: "error", listener: (err: Error) => void): this; | |||
prependOnceListener(event: "finish", listener: () => void): this; | |||
prependOnceListener(event: "pipe", listener: (src: Readable) => void): this; | |||
prependOnceListener(event: "unpipe", listener: (src: Readable) => void): this; | |||
prependOnceListener(event: string | symbol, listener: (...args: any[]) => void): this; | |||
removeListener(event: "close", listener: () => void): this; | |||
removeListener(event: "drain", listener: () => void): this; | |||
removeListener(event: "error", listener: (err: Error) => void): this; | |||
removeListener(event: "finish", listener: () => void): this; | |||
removeListener(event: "pipe", listener: (src: Readable) => void): this; | |||
removeListener(event: "unpipe", listener: (src: Readable) => void): this; | |||
removeListener(event: string | symbol, listener: (...args: any[]) => void): this; | |||
} | |||
interface DuplexOptions extends ReadableOptions, WritableOptions { | |||
allowHalfOpen?: boolean; | |||
readableObjectMode?: boolean; | |||
writableObjectMode?: boolean; | |||
readableHighWaterMark?: number; | |||
writableHighWaterMark?: number; | |||
writableCorked?: number; | |||
read?(this: Duplex, size: number): void; | |||
write?(this: Duplex, chunk: any, encoding: BufferEncoding, callback: (error?: Error | null) => void): void; | |||
writev?(this: Duplex, chunks: Array<{ chunk: any, encoding: BufferEncoding }>, callback: (error?: Error | null) => void): void; | |||
final?(this: Duplex, callback: (error?: Error | null) => void): void; | |||
destroy?(this: Duplex, error: Error | null, callback: (error: Error | null) => void): void; | |||
} | |||
// Note: Duplex extends both Readable and Writable. | |||
class Duplex extends Readable implements Writable { | |||
readonly writable: boolean; | |||
readonly writableEnded: boolean; | |||
readonly writableFinished: boolean; | |||
readonly writableHighWaterMark: number; | |||
readonly writableLength: number; | |||
readonly writableObjectMode: boolean; | |||
readonly writableCorked: number; | |||
constructor(opts?: DuplexOptions); | |||
_write(chunk: any, encoding: BufferEncoding, callback: (error?: Error | null) => void): void; | |||
_writev?(chunks: Array<{ chunk: any, encoding: BufferEncoding }>, callback: (error?: Error | null) => void): void; | |||
_destroy(error: Error | null, callback: (error: Error | null) => void): void; | |||
_final(callback: (error?: Error | null) => void): void; | |||
write(chunk: any, encoding?: BufferEncoding, cb?: (error: Error | null | undefined) => void): boolean; | |||
write(chunk: any, cb?: (error: Error | null | undefined) => void): boolean; | |||
setDefaultEncoding(encoding: BufferEncoding): this; | |||
end(cb?: () => void): void; | |||
end(chunk: any, cb?: () => void): void; | |||
end(chunk: any, encoding?: BufferEncoding, cb?: () => void): void; | |||
cork(): void; | |||
uncork(): void; | |||
} | |||
type TransformCallback = (error?: Error | null, data?: any) => void; | |||
interface TransformOptions extends DuplexOptions { | |||
read?(this: Transform, size: number): void; | |||
write?(this: Transform, chunk: any, encoding: BufferEncoding, callback: (error?: Error | null) => void): void; | |||
writev?(this: Transform, chunks: Array<{ chunk: any, encoding: BufferEncoding }>, callback: (error?: Error | null) => void): void; | |||
final?(this: Transform, callback: (error?: Error | null) => void): void; | |||
destroy?(this: Transform, error: Error | null, callback: (error: Error | null) => void): void; | |||
transform?(this: Transform, chunk: any, encoding: BufferEncoding, callback: TransformCallback): void; | |||
flush?(this: Transform, callback: TransformCallback): void; | |||
} | |||
class Transform extends Duplex { | |||
constructor(opts?: TransformOptions); | |||
_transform(chunk: any, encoding: BufferEncoding, callback: TransformCallback): void; | |||
_flush(callback: TransformCallback): void; | |||
} | |||
class PassThrough extends Transform { } | |||
interface FinishedOptions { | |||
error?: boolean; | |||
readable?: boolean; | |||
writable?: boolean; | |||
} | |||
function finished(stream: NodeJS.ReadableStream | NodeJS.WritableStream | NodeJS.ReadWriteStream, options: FinishedOptions, callback: (err?: NodeJS.ErrnoException | null) => void): () => void; | |||
function finished(stream: NodeJS.ReadableStream | NodeJS.WritableStream | NodeJS.ReadWriteStream, callback: (err?: NodeJS.ErrnoException | null) => void): () => void; | |||
namespace finished { | |||
function __promisify__(stream: NodeJS.ReadableStream | NodeJS.WritableStream | NodeJS.ReadWriteStream, options?: FinishedOptions): Promise<void>; | |||
} | |||
function pipeline<T extends NodeJS.WritableStream>(stream1: NodeJS.ReadableStream, stream2: T, callback?: (err: NodeJS.ErrnoException | null) => void): T; | |||
function pipeline<T extends NodeJS.WritableStream>(stream1: NodeJS.ReadableStream, stream2: NodeJS.ReadWriteStream, stream3: T, callback?: (err: NodeJS.ErrnoException | null) => void): T; | |||
function pipeline<T extends NodeJS.WritableStream>( | |||
stream1: NodeJS.ReadableStream, | |||
stream2: NodeJS.ReadWriteStream, | |||
stream3: NodeJS.ReadWriteStream, | |||
stream4: T, | |||
callback?: (err: NodeJS.ErrnoException | null) => void, | |||
): T; | |||
function pipeline<T extends NodeJS.WritableStream>( | |||
stream1: NodeJS.ReadableStream, | |||
stream2: NodeJS.ReadWriteStream, | |||
stream3: NodeJS.ReadWriteStream, | |||
stream4: NodeJS.ReadWriteStream, | |||
stream5: T, | |||
callback?: (err: NodeJS.ErrnoException | null) => void, | |||
): T; | |||
function pipeline(streams: Array<NodeJS.ReadableStream | NodeJS.WritableStream | NodeJS.ReadWriteStream>, callback?: (err: NodeJS.ErrnoException | null) => void): NodeJS.WritableStream; | |||
function pipeline( | |||
stream1: NodeJS.ReadableStream, | |||
stream2: NodeJS.ReadWriteStream | NodeJS.WritableStream, | |||
...streams: Array<NodeJS.ReadWriteStream | NodeJS.WritableStream | ((err: NodeJS.ErrnoException | null) => void)>, | |||
): NodeJS.WritableStream; | |||
namespace pipeline { | |||
function __promisify__(stream1: NodeJS.ReadableStream, stream2: NodeJS.WritableStream): Promise<void>; | |||
function __promisify__(stream1: NodeJS.ReadableStream, stream2: NodeJS.ReadWriteStream, stream3: NodeJS.WritableStream): Promise<void>; | |||
function __promisify__(stream1: NodeJS.ReadableStream, stream2: NodeJS.ReadWriteStream, stream3: NodeJS.ReadWriteStream, stream4: NodeJS.WritableStream): Promise<void>; | |||
function __promisify__( | |||
stream1: NodeJS.ReadableStream, | |||
stream2: NodeJS.ReadWriteStream, | |||
stream3: NodeJS.ReadWriteStream, | |||
stream4: NodeJS.ReadWriteStream, | |||
stream5: NodeJS.WritableStream, | |||
): Promise<void>; | |||
function __promisify__(streams: Array<NodeJS.ReadableStream | NodeJS.WritableStream | NodeJS.ReadWriteStream>): Promise<void>; | |||
function __promisify__( | |||
stream1: NodeJS.ReadableStream, | |||
stream2: NodeJS.ReadWriteStream | NodeJS.WritableStream, | |||
...streams: Array<NodeJS.ReadWriteStream | NodeJS.WritableStream>, | |||
): Promise<void>; | |||
} | |||
interface Pipe { | |||
close(): void; | |||
hasRef(): boolean; | |||
ref(): void; | |||
unref(): void; | |||
} | |||
} | |||
export = internal; | |||
} |
@@ -0,0 +1,7 @@ | |||
declare module "string_decoder" { | |||
class StringDecoder { | |||
constructor(encoding?: BufferEncoding); | |||
write(buffer: Buffer): string; | |||
end(buffer?: Buffer): string; | |||
} | |||
} |
@@ -0,0 +1,16 @@ | |||
declare module "timers" { | |||
function setTimeout(callback: (...args: any[]) => void, ms: number, ...args: any[]): NodeJS.Timeout; | |||
namespace setTimeout { | |||
function __promisify__(ms: number): Promise<void>; | |||
function __promisify__<T>(ms: number, value: T): Promise<T>; | |||
} | |||
function clearTimeout(timeoutId: NodeJS.Timeout): void; | |||
function setInterval(callback: (...args: any[]) => void, ms: number, ...args: any[]): NodeJS.Timeout; | |||
function clearInterval(intervalId: NodeJS.Timeout): void; | |||
function setImmediate(callback: (...args: any[]) => void, ...args: any[]): NodeJS.Immediate; | |||
namespace setImmediate { | |||
function __promisify__(): Promise<void>; | |||
function __promisify__<T>(value: T): Promise<T>; | |||
} | |||
function clearImmediate(immediateId: NodeJS.Immediate): void; | |||
} |
@@ -0,0 +1,768 @@ | |||
declare module "tls" { | |||
import * as crypto from "crypto"; | |||
import * as dns from "dns"; | |||
import * as net from "net"; | |||
import * as stream from "stream"; | |||
const CLIENT_RENEG_LIMIT: number; | |||
const CLIENT_RENEG_WINDOW: number; | |||
interface Certificate { | |||
/** | |||
* Country code. | |||
*/ | |||
C: string; | |||
/** | |||
* Street. | |||
*/ | |||
ST: string; | |||
/** | |||
* Locality. | |||
*/ | |||
L: string; | |||
/** | |||
* Organization. | |||
*/ | |||
O: string; | |||
/** | |||
* Organizational unit. | |||
*/ | |||
OU: string; | |||
/** | |||
* Common name. | |||
*/ | |||
CN: string; | |||
} | |||
interface PeerCertificate { | |||
subject: Certificate; | |||
issuer: Certificate; | |||
subjectaltname: string; | |||
infoAccess: NodeJS.Dict<string[]>; | |||
modulus: string; | |||
exponent: string; | |||
valid_from: string; | |||
valid_to: string; | |||
fingerprint: string; | |||
fingerprint256: string; | |||
ext_key_usage: string[]; | |||
serialNumber: string; | |||
raw: Buffer; | |||
} | |||
interface DetailedPeerCertificate extends PeerCertificate { | |||
issuerCertificate: DetailedPeerCertificate; | |||
} | |||
interface CipherNameAndProtocol { | |||
/** | |||
* The cipher name. | |||
*/ | |||
name: string; | |||
/** | |||
* SSL/TLS protocol version. | |||
*/ | |||
version: string; | |||
/** | |||
* IETF name for the cipher suite. | |||
*/ | |||
standardName: string; | |||
} | |||
interface EphemeralKeyInfo { | |||
/** | |||
* The supported types are 'DH' and 'ECDH'. | |||
*/ | |||
type: string; | |||
/** | |||
* The name property is available only when type is 'ECDH'. | |||
*/ | |||
name?: string; | |||
/** | |||
* The size of parameter of an ephemeral key exchange. | |||
*/ | |||
size: number; | |||
} | |||
interface KeyObject { | |||
/** | |||
* Private keys in PEM format. | |||
*/ | |||
pem: string | Buffer; | |||
/** | |||
* Optional passphrase. | |||
*/ | |||
passphrase?: string; | |||
} | |||
interface PxfObject { | |||
/** | |||
* PFX or PKCS12 encoded private key and certificate chain. | |||
*/ | |||
buf: string | Buffer; | |||
/** | |||
* Optional passphrase. | |||
*/ | |||
passphrase?: string; | |||
} | |||
interface TLSSocketOptions extends SecureContextOptions, CommonConnectionOptions { | |||
/** | |||
* If true the TLS socket will be instantiated in server-mode. | |||
* Defaults to false. | |||
*/ | |||
isServer?: boolean; | |||
/** | |||
* An optional net.Server instance. | |||
*/ | |||
server?: net.Server; | |||
/** | |||
* An optional Buffer instance containing a TLS session. | |||
*/ | |||
session?: Buffer; | |||
/** | |||
* If true, specifies that the OCSP status request extension will be | |||
* added to the client hello and an 'OCSPResponse' event will be | |||
* emitted on the socket before establishing a secure communication | |||
*/ | |||
requestOCSP?: boolean; | |||
} | |||
class TLSSocket extends net.Socket { | |||
/** | |||
* Construct a new tls.TLSSocket object from an existing TCP socket. | |||
*/ | |||
constructor(socket: net.Socket, options?: TLSSocketOptions); | |||
/** | |||
* A boolean that is true if the peer certificate was signed by one of the specified CAs, otherwise false. | |||
*/ | |||
authorized: boolean; | |||
/** | |||
* The reason why the peer's certificate has not been verified. | |||
* This property becomes available only when tlsSocket.authorized === false. | |||
*/ | |||
authorizationError: Error; | |||
/** | |||
* Static boolean value, always true. | |||
* May be used to distinguish TLS sockets from regular ones. | |||
*/ | |||
encrypted: boolean; | |||
/** | |||
* String containing the selected ALPN protocol. | |||
* When ALPN has no selected protocol, tlsSocket.alpnProtocol equals false. | |||
*/ | |||
alpnProtocol?: string; | |||
/** | |||
* Returns an object representing the local certificate. The returned | |||
* object has some properties corresponding to the fields of the | |||
* certificate. | |||
* | |||
* See tls.TLSSocket.getPeerCertificate() for an example of the | |||
* certificate structure. | |||
* | |||
* If there is no local certificate, an empty object will be returned. | |||
* If the socket has been destroyed, null will be returned. | |||
*/ | |||
getCertificate(): PeerCertificate | object | null; | |||
/** | |||
* Returns an object representing the cipher name and the SSL/TLS protocol version of the current connection. | |||
* @returns Returns an object representing the cipher name | |||
* and the SSL/TLS protocol version of the current connection. | |||
*/ | |||
getCipher(): CipherNameAndProtocol; | |||
/** | |||
* Returns an object representing the type, name, and size of parameter | |||
* of an ephemeral key exchange in Perfect Forward Secrecy on a client | |||
* connection. It returns an empty object when the key exchange is not | |||
* ephemeral. As this is only supported on a client socket; null is | |||
* returned if called on a server socket. The supported types are 'DH' | |||
* and 'ECDH'. The name property is available only when type is 'ECDH'. | |||
* | |||
* For example: { type: 'ECDH', name: 'prime256v1', size: 256 }. | |||
*/ | |||
getEphemeralKeyInfo(): EphemeralKeyInfo | object | null; | |||
/** | |||
* Returns the latest Finished message that has | |||
* been sent to the socket as part of a SSL/TLS handshake, or undefined | |||
* if no Finished message has been sent yet. | |||
* | |||
* As the Finished messages are message digests of the complete | |||
* handshake (with a total of 192 bits for TLS 1.0 and more for SSL | |||
* 3.0), they can be used for external authentication procedures when | |||
* the authentication provided by SSL/TLS is not desired or is not | |||
* enough. | |||
* | |||
* Corresponds to the SSL_get_finished routine in OpenSSL and may be | |||
* used to implement the tls-unique channel binding from RFC 5929. | |||
*/ | |||
getFinished(): Buffer | undefined; | |||
/** | |||
* Returns an object representing the peer's certificate. | |||
* The returned object has some properties corresponding to the field of the certificate. | |||
* If detailed argument is true the full chain with issuer property will be returned, | |||
* if false only the top certificate without issuer property. | |||
* If the peer does not provide a certificate, it returns null or an empty object. | |||
* @param detailed - If true; the full chain with issuer property will be returned. | |||
* @returns An object representing the peer's certificate. | |||
*/ | |||
getPeerCertificate(detailed: true): DetailedPeerCertificate; | |||
getPeerCertificate(detailed?: false): PeerCertificate; | |||
getPeerCertificate(detailed?: boolean): PeerCertificate | DetailedPeerCertificate; | |||
/** | |||
* Returns the latest Finished message that is expected or has actually | |||
* been received from the socket as part of a SSL/TLS handshake, or | |||
* undefined if there is no Finished message so far. | |||
* | |||
* As the Finished messages are message digests of the complete | |||
* handshake (with a total of 192 bits for TLS 1.0 and more for SSL | |||
* 3.0), they can be used for external authentication procedures when | |||
* the authentication provided by SSL/TLS is not desired or is not | |||
* enough. | |||
* | |||
* Corresponds to the SSL_get_peer_finished routine in OpenSSL and may | |||
* be used to implement the tls-unique channel binding from RFC 5929. | |||
*/ | |||
getPeerFinished(): Buffer | undefined; | |||
/** | |||
* Returns a string containing the negotiated SSL/TLS protocol version of the current connection. | |||
* The value `'unknown'` will be returned for connected sockets that have not completed the handshaking process. | |||
* The value `null` will be returned for server sockets or disconnected client sockets. | |||
* See https://www.openssl.org/docs/man1.0.2/ssl/SSL_get_version.html for more information. | |||
* @returns negotiated SSL/TLS protocol version of the current connection | |||
*/ | |||
getProtocol(): string | null; | |||
/** | |||
* Could be used to speed up handshake establishment when reconnecting to the server. | |||
* @returns ASN.1 encoded TLS session or undefined if none was negotiated. | |||
*/ | |||
getSession(): Buffer | undefined; | |||
/** | |||
* Returns a list of signature algorithms shared between the server and | |||
* the client in the order of decreasing preference. | |||
*/ | |||
getSharedSigalgs(): string[]; | |||
/** | |||
* NOTE: Works only with client TLS sockets. | |||
* Useful only for debugging, for session reuse provide session option to tls.connect(). | |||
* @returns TLS session ticket or undefined if none was negotiated. | |||
*/ | |||
getTLSTicket(): Buffer | undefined; | |||
/** | |||
* Returns true if the session was reused, false otherwise. | |||
*/ | |||
isSessionReused(): boolean; | |||
/** | |||
* Initiate TLS renegotiation process. | |||
* | |||
* NOTE: Can be used to request peer's certificate after the secure connection has been established. | |||
* ANOTHER NOTE: When running as the server, socket will be destroyed with an error after handshakeTimeout timeout. | |||
* @param options - The options may contain the following fields: rejectUnauthorized, | |||
* requestCert (See tls.createServer() for details). | |||
* @param callback - callback(err) will be executed with null as err, once the renegotiation | |||
* is successfully completed. | |||
* @return `undefined` when socket is destroy, `false` if negotiaion can't be initiated. | |||
*/ | |||
renegotiate(options: { rejectUnauthorized?: boolean, requestCert?: boolean }, callback: (err: Error | null) => void): undefined | boolean; | |||
/** | |||
* Set maximum TLS fragment size (default and maximum value is: 16384, minimum is: 512). | |||
* Smaller fragment size decreases buffering latency on the client: large fragments are buffered by | |||
* the TLS layer until the entire fragment is received and its integrity is verified; | |||
* large fragments can span multiple roundtrips, and their processing can be delayed due to packet | |||
* loss or reordering. However, smaller fragments add extra TLS framing bytes and CPU overhead, | |||
* which may decrease overall server throughput. | |||
* @param size - TLS fragment size (default and maximum value is: 16384, minimum is: 512). | |||
* @returns Returns true on success, false otherwise. | |||
*/ | |||
setMaxSendFragment(size: number): boolean; | |||
/** | |||
* Disables TLS renegotiation for this TLSSocket instance. Once called, | |||
* attempts to renegotiate will trigger an 'error' event on the | |||
* TLSSocket. | |||
*/ | |||
disableRenegotiation(): void; | |||
/** | |||
* When enabled, TLS packet trace information is written to `stderr`. This can be | |||
* used to debug TLS connection problems. | |||
* | |||
* Note: The format of the output is identical to the output of `openssl s_client | |||
* -trace` or `openssl s_server -trace`. While it is produced by OpenSSL's | |||
* `SSL_trace()` function, the format is undocumented, can change without notice, | |||
* and should not be relied on. | |||
*/ | |||
enableTrace(): void; | |||
/** | |||
* @param length number of bytes to retrieve from keying material | |||
* @param label an application specific label, typically this will be a value from the | |||
* [IANA Exporter Label Registry](https://www.iana.org/assignments/tls-parameters/tls-parameters.xhtml#exporter-labels). | |||
* @param context optionally provide a context. | |||
*/ | |||
exportKeyingMaterial(length: number, label: string, context: Buffer): Buffer; | |||
addListener(event: string, listener: (...args: any[]) => void): this; | |||
addListener(event: "OCSPResponse", listener: (response: Buffer) => void): this; | |||
addListener(event: "secureConnect", listener: () => void): this; | |||
addListener(event: "session", listener: (session: Buffer) => void): this; | |||
addListener(event: "keylog", listener: (line: Buffer) => void): this; | |||
emit(event: string | symbol, ...args: any[]): boolean; | |||
emit(event: "OCSPResponse", response: Buffer): boolean; | |||
emit(event: "secureConnect"): boolean; | |||
emit(event: "session", session: Buffer): boolean; | |||
emit(event: "keylog", line: Buffer): boolean; | |||
on(event: string, listener: (...args: any[]) => void): this; | |||
on(event: "OCSPResponse", listener: (response: Buffer) => void): this; | |||
on(event: "secureConnect", listener: () => void): this; | |||
on(event: "session", listener: (session: Buffer) => void): this; | |||
on(event: "keylog", listener: (line: Buffer) => void): this; | |||
once(event: string, listener: (...args: any[]) => void): this; | |||
once(event: "OCSPResponse", listener: (response: Buffer) => void): this; | |||
once(event: "secureConnect", listener: () => void): this; | |||
once(event: "session", listener: (session: Buffer) => void): this; | |||
once(event: "keylog", listener: (line: Buffer) => void): this; | |||
prependListener(event: string, listener: (...args: any[]) => void): this; | |||
prependListener(event: "OCSPResponse", listener: (response: Buffer) => void): this; | |||
prependListener(event: "secureConnect", listener: () => void): this; | |||
prependListener(event: "session", listener: (session: Buffer) => void): this; | |||
prependListener(event: "keylog", listener: (line: Buffer) => void): this; | |||
prependOnceListener(event: string, listener: (...args: any[]) => void): this; | |||
prependOnceListener(event: "OCSPResponse", listener: (response: Buffer) => void): this; | |||
prependOnceListener(event: "secureConnect", listener: () => void): this; | |||
prependOnceListener(event: "session", listener: (session: Buffer) => void): this; | |||
prependOnceListener(event: "keylog", listener: (line: Buffer) => void): this; | |||
} | |||
interface CommonConnectionOptions { | |||
/** | |||
* An optional TLS context object from tls.createSecureContext() | |||
*/ | |||
secureContext?: SecureContext; | |||
/** | |||
* When enabled, TLS packet trace information is written to `stderr`. This can be | |||
* used to debug TLS connection problems. | |||
* @default false | |||
*/ | |||
enableTrace?: boolean; | |||
/** | |||
* If true the server will request a certificate from clients that | |||
* connect and attempt to verify that certificate. Defaults to | |||
* false. | |||
*/ | |||
requestCert?: boolean; | |||
/** | |||
* An array of strings or a Buffer naming possible ALPN protocols. | |||
* (Protocols should be ordered by their priority.) | |||
*/ | |||
ALPNProtocols?: string[] | Uint8Array[] | Uint8Array; | |||
/** | |||
* SNICallback(servername, cb) <Function> A function that will be | |||
* called if the client supports SNI TLS extension. Two arguments | |||
* will be passed when called: servername and cb. SNICallback should | |||
* invoke cb(null, ctx), where ctx is a SecureContext instance. | |||
* (tls.createSecureContext(...) can be used to get a proper | |||
* SecureContext.) If SNICallback wasn't provided the default callback | |||
* with high-level API will be used (see below). | |||
*/ | |||
SNICallback?: (servername: string, cb: (err: Error | null, ctx: SecureContext) => void) => void; | |||
/** | |||
* If true the server will reject any connection which is not | |||
* authorized with the list of supplied CAs. This option only has an | |||
* effect if requestCert is true. | |||
* @default true | |||
*/ | |||
rejectUnauthorized?: boolean; | |||
} | |||
interface TlsOptions extends SecureContextOptions, CommonConnectionOptions { | |||
/** | |||
* Abort the connection if the SSL/TLS handshake does not finish in the | |||
* specified number of milliseconds. A 'tlsClientError' is emitted on | |||
* the tls.Server object whenever a handshake times out. Default: | |||
* 120000 (120 seconds). | |||
*/ | |||
handshakeTimeout?: number; | |||
/** | |||
* The number of seconds after which a TLS session created by the | |||
* server will no longer be resumable. See Session Resumption for more | |||
* information. Default: 300. | |||
*/ | |||
sessionTimeout?: number; | |||
/** | |||
* 48-bytes of cryptographically strong pseudo-random data. | |||
*/ | |||
ticketKeys?: Buffer; | |||
/** | |||
* | |||
* @param socket | |||
* @param identity identity parameter sent from the client. | |||
* @return pre-shared key that must either be | |||
* a buffer or `null` to stop the negotiation process. Returned PSK must be | |||
* compatible with the selected cipher's digest. | |||
* | |||
* When negotiating TLS-PSK (pre-shared keys), this function is called | |||
* with the identity provided by the client. | |||
* If the return value is `null` the negotiation process will stop and an | |||
* "unknown_psk_identity" alert message will be sent to the other party. | |||
* If the server wishes to hide the fact that the PSK identity was not known, | |||
* the callback must provide some random data as `psk` to make the connection | |||
* fail with "decrypt_error" before negotiation is finished. | |||
* PSK ciphers are disabled by default, and using TLS-PSK thus | |||
* requires explicitly specifying a cipher suite with the `ciphers` option. | |||
* More information can be found in the RFC 4279. | |||
*/ | |||
pskCallback?(socket: TLSSocket, identity: string): DataView | NodeJS.TypedArray | null; | |||
/** | |||
* hint to send to a client to help | |||
* with selecting the identity during TLS-PSK negotiation. Will be ignored | |||
* in TLS 1.3. Upon failing to set pskIdentityHint `tlsClientError` will be | |||
* emitted with `ERR_TLS_PSK_SET_IDENTIY_HINT_FAILED` code. | |||
*/ | |||
pskIdentityHint?: string; | |||
} | |||
interface PSKCallbackNegotation { | |||
psk: DataView | NodeJS.TypedArray; | |||
identitty: string; | |||
} | |||
interface ConnectionOptions extends SecureContextOptions, CommonConnectionOptions { | |||
host?: string; | |||
port?: number; | |||
path?: string; // Creates unix socket connection to path. If this option is specified, `host` and `port` are ignored. | |||
socket?: net.Socket; // Establish secure connection on a given socket rather than creating a new socket | |||
checkServerIdentity?: typeof checkServerIdentity; | |||
servername?: string; // SNI TLS Extension | |||
session?: Buffer; | |||
minDHSize?: number; | |||
lookup?: net.LookupFunction; | |||
timeout?: number; | |||
/** | |||
* When negotiating TLS-PSK (pre-shared keys), this function is called | |||
* with optional identity `hint` provided by the server or `null` | |||
* in case of TLS 1.3 where `hint` was removed. | |||
* It will be necessary to provide a custom `tls.checkServerIdentity()` | |||
* for the connection as the default one will try to check hostname/IP | |||
* of the server against the certificate but that's not applicable for PSK | |||
* because there won't be a certificate present. | |||
* More information can be found in the RFC 4279. | |||
* | |||
* @param hint message sent from the server to help client | |||
* decide which identity to use during negotiation. | |||
* Always `null` if TLS 1.3 is used. | |||
* @returns Return `null` to stop the negotiation process. `psk` must be | |||
* compatible with the selected cipher's digest. | |||
* `identity` must use UTF-8 encoding. | |||
*/ | |||
pskCallback?(hint: string | null): PSKCallbackNegotation | null; | |||
} | |||
class Server extends net.Server { | |||
/** | |||
* The server.addContext() method adds a secure context that will be | |||
* used if the client request's SNI name matches the supplied hostname | |||
* (or wildcard). | |||
*/ | |||
addContext(hostName: string, credentials: SecureContextOptions): void; | |||
/** | |||
* Returns the session ticket keys. | |||
*/ | |||
getTicketKeys(): Buffer; | |||
/** | |||
* | |||
* The server.setSecureContext() method replaces the | |||
* secure context of an existing server. Existing connections to the | |||
* server are not interrupted. | |||
*/ | |||
setSecureContext(details: SecureContextOptions): void; | |||
/** | |||
* The server.setSecureContext() method replaces the secure context of | |||
* an existing server. Existing connections to the server are not | |||
* interrupted. | |||
*/ | |||
setTicketKeys(keys: Buffer): void; | |||
/** | |||
* events.EventEmitter | |||
* 1. tlsClientError | |||
* 2. newSession | |||
* 3. OCSPRequest | |||
* 4. resumeSession | |||
* 5. secureConnection | |||
* 6. keylog | |||
*/ | |||
addListener(event: string, listener: (...args: any[]) => void): this; | |||
addListener(event: "tlsClientError", listener: (err: Error, tlsSocket: TLSSocket) => void): this; | |||
addListener(event: "newSession", listener: (sessionId: Buffer, sessionData: Buffer, callback: (err: Error, resp: Buffer) => void) => void): this; | |||
addListener(event: "OCSPRequest", listener: (certificate: Buffer, issuer: Buffer, callback: (err: Error | null, resp: Buffer) => void) => void): this; | |||
addListener(event: "resumeSession", listener: (sessionId: Buffer, callback: (err: Error, sessionData: Buffer) => void) => void): this; | |||
addListener(event: "secureConnection", listener: (tlsSocket: TLSSocket) => void): this; | |||
addListener(event: "keylog", listener: (line: Buffer, tlsSocket: TLSSocket) => void): this; | |||
emit(event: string | symbol, ...args: any[]): boolean; | |||
emit(event: "tlsClientError", err: Error, tlsSocket: TLSSocket): boolean; | |||
emit(event: "newSession", sessionId: Buffer, sessionData: Buffer, callback: (err: Error, resp: Buffer) => void): boolean; | |||
emit(event: "OCSPRequest", certificate: Buffer, issuer: Buffer, callback: (err: Error | null, resp: Buffer) => void): boolean; | |||
emit(event: "resumeSession", sessionId: Buffer, callback: (err: Error, sessionData: Buffer) => void): boolean; | |||
emit(event: "secureConnection", tlsSocket: TLSSocket): boolean; | |||
emit(event: "keylog", line: Buffer, tlsSocket: TLSSocket): boolean; | |||
on(event: string, listener: (...args: any[]) => void): this; | |||
on(event: "tlsClientError", listener: (err: Error, tlsSocket: TLSSocket) => void): this; | |||
on(event: "newSession", listener: (sessionId: Buffer, sessionData: Buffer, callback: (err: Error, resp: Buffer) => void) => void): this; | |||
on(event: "OCSPRequest", listener: (certificate: Buffer, issuer: Buffer, callback: (err: Error | null, resp: Buffer) => void) => void): this; | |||
on(event: "resumeSession", listener: (sessionId: Buffer, callback: (err: Error, sessionData: Buffer) => void) => void): this; | |||
on(event: "secureConnection", listener: (tlsSocket: TLSSocket) => void): this; | |||
on(event: "keylog", listener: (line: Buffer, tlsSocket: TLSSocket) => void): this; | |||
once(event: string, listener: (...args: any[]) => void): this; | |||
once(event: "tlsClientError", listener: (err: Error, tlsSocket: TLSSocket) => void): this; | |||
once(event: "newSession", listener: (sessionId: Buffer, sessionData: Buffer, callback: (err: Error, resp: Buffer) => void) => void): this; | |||
once(event: "OCSPRequest", listener: (certificate: Buffer, issuer: Buffer, callback: (err: Error | null, resp: Buffer) => void) => void): this; | |||
once(event: "resumeSession", listener: (sessionId: Buffer, callback: (err: Error, sessionData: Buffer) => void) => void): this; | |||
once(event: "secureConnection", listener: (tlsSocket: TLSSocket) => void): this; | |||
once(event: "keylog", listener: (line: Buffer, tlsSocket: TLSSocket) => void): this; | |||
prependListener(event: string, listener: (...args: any[]) => void): this; | |||
prependListener(event: "tlsClientError", listener: (err: Error, tlsSocket: TLSSocket) => void): this; | |||
prependListener(event: "newSession", listener: (sessionId: Buffer, sessionData: Buffer, callback: (err: Error, resp: Buffer) => void) => void): this; | |||
prependListener(event: "OCSPRequest", listener: (certificate: Buffer, issuer: Buffer, callback: (err: Error | null, resp: Buffer) => void) => void): this; | |||
prependListener(event: "resumeSession", listener: (sessionId: Buffer, callback: (err: Error, sessionData: Buffer) => void) => void): this; | |||
prependListener(event: "secureConnection", listener: (tlsSocket: TLSSocket) => void): this; | |||
prependListener(event: "keylog", listener: (line: Buffer, tlsSocket: TLSSocket) => void): this; | |||
prependOnceListener(event: string, listener: (...args: any[]) => void): this; | |||
prependOnceListener(event: "tlsClientError", listener: (err: Error, tlsSocket: TLSSocket) => void): this; | |||
prependOnceListener(event: "newSession", listener: (sessionId: Buffer, sessionData: Buffer, callback: (err: Error, resp: Buffer) => void) => void): this; | |||
prependOnceListener(event: "OCSPRequest", listener: (certificate: Buffer, issuer: Buffer, callback: (err: Error | null, resp: Buffer) => void) => void): this; | |||
prependOnceListener(event: "resumeSession", listener: (sessionId: Buffer, callback: (err: Error, sessionData: Buffer) => void) => void): this; | |||
prependOnceListener(event: "secureConnection", listener: (tlsSocket: TLSSocket) => void): this; | |||
prependOnceListener(event: "keylog", listener: (line: Buffer, tlsSocket: TLSSocket) => void): this; | |||
} | |||
interface SecurePair { | |||
encrypted: TLSSocket; | |||
cleartext: TLSSocket; | |||
} | |||
type SecureVersion = 'TLSv1.3' | 'TLSv1.2' | 'TLSv1.1' | 'TLSv1'; | |||
interface SecureContextOptions { | |||
/** | |||
* Optionally override the trusted CA certificates. Default is to trust | |||
* the well-known CAs curated by Mozilla. Mozilla's CAs are completely | |||
* replaced when CAs are explicitly specified using this option. | |||
*/ | |||
ca?: string | Buffer | Array<string | Buffer>; | |||
/** | |||
* Cert chains in PEM format. One cert chain should be provided per | |||
* private key. Each cert chain should consist of the PEM formatted | |||
* certificate for a provided private key, followed by the PEM | |||
* formatted intermediate certificates (if any), in order, and not | |||
* including the root CA (the root CA must be pre-known to the peer, | |||
* see ca). When providing multiple cert chains, they do not have to | |||
* be in the same order as their private keys in key. If the | |||
* intermediate certificates are not provided, the peer will not be | |||
* able to validate the certificate, and the handshake will fail. | |||
*/ | |||
cert?: string | Buffer | Array<string | Buffer>; | |||
/** | |||
* Colon-separated list of supported signature algorithms. The list | |||
* can contain digest algorithms (SHA256, MD5 etc.), public key | |||
* algorithms (RSA-PSS, ECDSA etc.), combination of both (e.g | |||
* 'RSA+SHA384') or TLS v1.3 scheme names (e.g. rsa_pss_pss_sha512). | |||
*/ | |||
sigalgs?: string; | |||
/** | |||
* Cipher suite specification, replacing the default. For more | |||
* information, see modifying the default cipher suite. Permitted | |||
* ciphers can be obtained via tls.getCiphers(). Cipher names must be | |||
* uppercased in order for OpenSSL to accept them. | |||
*/ | |||
ciphers?: string; | |||
/** | |||
* Name of an OpenSSL engine which can provide the client certificate. | |||
*/ | |||
clientCertEngine?: string; | |||
/** | |||
* PEM formatted CRLs (Certificate Revocation Lists). | |||
*/ | |||
crl?: string | Buffer | Array<string | Buffer>; | |||
/** | |||
* Diffie Hellman parameters, required for Perfect Forward Secrecy. Use | |||
* openssl dhparam to create the parameters. The key length must be | |||
* greater than or equal to 1024 bits or else an error will be thrown. | |||
* Although 1024 bits is permissible, use 2048 bits or larger for | |||
* stronger security. If omitted or invalid, the parameters are | |||
* silently discarded and DHE ciphers will not be available. | |||
*/ | |||
dhparam?: string | Buffer; | |||
/** | |||
* A string describing a named curve or a colon separated list of curve | |||
* NIDs or names, for example P-521:P-384:P-256, to use for ECDH key | |||
* agreement. Set to auto to select the curve automatically. Use | |||
* crypto.getCurves() to obtain a list of available curve names. On | |||
* recent releases, openssl ecparam -list_curves will also display the | |||
* name and description of each available elliptic curve. Default: | |||
* tls.DEFAULT_ECDH_CURVE. | |||
*/ | |||
ecdhCurve?: string; | |||
/** | |||
* Attempt to use the server's cipher suite preferences instead of the | |||
* client's. When true, causes SSL_OP_CIPHER_SERVER_PREFERENCE to be | |||
* set in secureOptions | |||
*/ | |||
honorCipherOrder?: boolean; | |||
/** | |||
* Private keys in PEM format. PEM allows the option of private keys | |||
* being encrypted. Encrypted keys will be decrypted with | |||
* options.passphrase. Multiple keys using different algorithms can be | |||
* provided either as an array of unencrypted key strings or buffers, | |||
* or an array of objects in the form {pem: <string|buffer>[, | |||
* passphrase: <string>]}. The object form can only occur in an array. | |||
* object.passphrase is optional. Encrypted keys will be decrypted with | |||
* object.passphrase if provided, or options.passphrase if it is not. | |||
*/ | |||
key?: string | Buffer | Array<Buffer | KeyObject>; | |||
/** | |||
* Name of an OpenSSL engine to get private key from. Should be used | |||
* together with privateKeyIdentifier. | |||
*/ | |||
privateKeyEngine?: string; | |||
/** | |||
* Identifier of a private key managed by an OpenSSL engine. Should be | |||
* used together with privateKeyEngine. Should not be set together with | |||
* key, because both options define a private key in different ways. | |||
*/ | |||
privateKeyIdentifier?: string; | |||
/** | |||
* Optionally set the maximum TLS version to allow. One | |||
* of `'TLSv1.3'`, `'TLSv1.2'`, `'TLSv1.1'`, or `'TLSv1'`. Cannot be specified along with the | |||
* `secureProtocol` option, use one or the other. | |||
* **Default:** `'TLSv1.3'`, unless changed using CLI options. Using | |||
* `--tls-max-v1.2` sets the default to `'TLSv1.2'`. Using `--tls-max-v1.3` sets the default to | |||
* `'TLSv1.3'`. If multiple of the options are provided, the highest maximum is used. | |||
*/ | |||
maxVersion?: SecureVersion; | |||
/** | |||
* Optionally set the minimum TLS version to allow. One | |||
* of `'TLSv1.3'`, `'TLSv1.2'`, `'TLSv1.1'`, or `'TLSv1'`. Cannot be specified along with the | |||
* `secureProtocol` option, use one or the other. It is not recommended to use | |||
* less than TLSv1.2, but it may be required for interoperability. | |||
* **Default:** `'TLSv1.2'`, unless changed using CLI options. Using | |||
* `--tls-v1.0` sets the default to `'TLSv1'`. Using `--tls-v1.1` sets the default to | |||
* `'TLSv1.1'`. Using `--tls-min-v1.3` sets the default to | |||
* 'TLSv1.3'. If multiple of the options are provided, the lowest minimum is used. | |||
*/ | |||
minVersion?: SecureVersion; | |||
/** | |||
* Shared passphrase used for a single private key and/or a PFX. | |||
*/ | |||
passphrase?: string; | |||
/** | |||
* PFX or PKCS12 encoded private key and certificate chain. pfx is an | |||
* alternative to providing key and cert individually. PFX is usually | |||
* encrypted, if it is, passphrase will be used to decrypt it. Multiple | |||
* PFX can be provided either as an array of unencrypted PFX buffers, | |||
* or an array of objects in the form {buf: <string|buffer>[, | |||
* passphrase: <string>]}. The object form can only occur in an array. | |||
* object.passphrase is optional. Encrypted PFX will be decrypted with | |||
* object.passphrase if provided, or options.passphrase if it is not. | |||
*/ | |||
pfx?: string | Buffer | Array<string | Buffer | PxfObject>; | |||
/** | |||
* Optionally affect the OpenSSL protocol behavior, which is not | |||
* usually necessary. This should be used carefully if at all! Value is | |||
* a numeric bitmask of the SSL_OP_* options from OpenSSL Options | |||
*/ | |||
secureOptions?: number; // Value is a numeric bitmask of the `SSL_OP_*` options | |||
/** | |||
* Legacy mechanism to select the TLS protocol version to use, it does | |||
* not support independent control of the minimum and maximum version, | |||
* and does not support limiting the protocol to TLSv1.3. Use | |||
* minVersion and maxVersion instead. The possible values are listed as | |||
* SSL_METHODS, use the function names as strings. For example, use | |||
* 'TLSv1_1_method' to force TLS version 1.1, or 'TLS_method' to allow | |||
* any TLS protocol version up to TLSv1.3. It is not recommended to use | |||
* TLS versions less than 1.2, but it may be required for | |||
* interoperability. Default: none, see minVersion. | |||
*/ | |||
secureProtocol?: string; | |||
/** | |||
* Opaque identifier used by servers to ensure session state is not | |||
* shared between applications. Unused by clients. | |||
*/ | |||
sessionIdContext?: string; | |||
} | |||
interface SecureContext { | |||
context: any; | |||
} | |||
/* | |||
* Verifies the certificate `cert` is issued to host `host`. | |||
* @host The hostname to verify the certificate against | |||
* @cert PeerCertificate representing the peer's certificate | |||
* | |||
* Returns Error object, populating it with the reason, host and cert on failure. On success, returns undefined. | |||
*/ | |||
function checkServerIdentity(host: string, cert: PeerCertificate): Error | undefined; | |||
function createServer(secureConnectionListener?: (socket: TLSSocket) => void): Server; | |||
function createServer(options: TlsOptions, secureConnectionListener?: (socket: TLSSocket) => void): Server; | |||
function connect(options: ConnectionOptions, secureConnectListener?: () => void): TLSSocket; | |||
function connect(port: number, host?: string, options?: ConnectionOptions, secureConnectListener?: () => void): TLSSocket; | |||
function connect(port: number, options?: ConnectionOptions, secureConnectListener?: () => void): TLSSocket; | |||
/** | |||
* @deprecated | |||
*/ | |||
function createSecurePair(credentials?: SecureContext, isServer?: boolean, requestCert?: boolean, rejectUnauthorized?: boolean): SecurePair; | |||
function createSecureContext(details: SecureContextOptions): SecureContext; | |||
function getCiphers(): string[]; | |||
/** | |||
* The default curve name to use for ECDH key agreement in a tls server. | |||
* The default value is 'auto'. See tls.createSecureContext() for further | |||
* information. | |||
*/ | |||
let DEFAULT_ECDH_CURVE: string; | |||
/** | |||
* The default value of the maxVersion option of | |||
* tls.createSecureContext(). It can be assigned any of the supported TLS | |||
* protocol versions, 'TLSv1.3', 'TLSv1.2', 'TLSv1.1', or 'TLSv1'. Default: | |||
* 'TLSv1.3', unless changed using CLI options. Using --tls-max-v1.2 sets | |||
* the default to 'TLSv1.2'. Using --tls-max-v1.3 sets the default to | |||
* 'TLSv1.3'. If multiple of the options are provided, the highest maximum | |||
* is used. | |||
*/ | |||
let DEFAULT_MAX_VERSION: SecureVersion; | |||
/** | |||
* The default value of the minVersion option of tls.createSecureContext(). | |||
* It can be assigned any of the supported TLS protocol versions, | |||
* 'TLSv1.3', 'TLSv1.2', 'TLSv1.1', or 'TLSv1'. Default: 'TLSv1.2', unless | |||
* changed using CLI options. Using --tls-min-v1.0 sets the default to | |||
* 'TLSv1'. Using --tls-min-v1.1 sets the default to 'TLSv1.1'. Using | |||
* --tls-min-v1.3 sets the default to 'TLSv1.3'. If multiple of the options | |||
* are provided, the lowest minimum is used. | |||
*/ | |||
let DEFAULT_MIN_VERSION: SecureVersion; | |||
/** | |||
* An immutable array of strings representing the root certificates (in PEM | |||
* format) used for verifying peer certificates. This is the default value | |||
* of the ca option to tls.createSecureContext(). | |||
*/ | |||
const rootCertificates: ReadonlyArray<string>; | |||
} |
@@ -0,0 +1,61 @@ | |||
declare module "trace_events" { | |||
/** | |||
* The `Tracing` object is used to enable or disable tracing for sets of | |||
* categories. Instances are created using the | |||
* `trace_events.createTracing()` method. | |||
* | |||
* When created, the `Tracing` object is disabled. Calling the | |||
* `tracing.enable()` method adds the categories to the set of enabled trace | |||
* event categories. Calling `tracing.disable()` will remove the categories | |||
* from the set of enabled trace event categories. | |||
*/ | |||
interface Tracing { | |||
/** | |||
* A comma-separated list of the trace event categories covered by this | |||
* `Tracing` object. | |||
*/ | |||
readonly categories: string; | |||
/** | |||
* Disables this `Tracing` object. | |||
* | |||
* Only trace event categories _not_ covered by other enabled `Tracing` | |||
* objects and _not_ specified by the `--trace-event-categories` flag | |||
* will be disabled. | |||
*/ | |||
disable(): void; | |||
/** | |||
* Enables this `Tracing` object for the set of categories covered by | |||
* the `Tracing` object. | |||
*/ | |||
enable(): void; | |||
/** | |||
* `true` only if the `Tracing` object has been enabled. | |||
*/ | |||
readonly enabled: boolean; | |||
} | |||
interface CreateTracingOptions { | |||
/** | |||
* An array of trace category names. Values included in the array are | |||
* coerced to a string when possible. An error will be thrown if the | |||
* value cannot be coerced. | |||
*/ | |||
categories: string[]; | |||
} | |||
/** | |||
* Creates and returns a Tracing object for the given set of categories. | |||
*/ | |||
function createTracing(options: CreateTracingOptions): Tracing; | |||
/** | |||
* Returns a comma-separated list of all currently-enabled trace event | |||
* categories. The current set of enabled trace event categories is | |||
* determined by the union of all currently-enabled `Tracing` objects and | |||
* any categories enabled using the `--trace-event-categories` flag. | |||
*/ | |||
function getEnabledCategories(): string | undefined; | |||
} |
@@ -0,0 +1,22 @@ | |||
// NOTE: These definitions support NodeJS and TypeScript 3.2. | |||
// NOTE: TypeScript version-specific augmentations can be found in the following paths: | |||
// - ~/base.d.ts - Shared definitions common to all TypeScript versions | |||
// - ~/index.d.ts - Definitions specific to TypeScript 2.1 | |||
// - ~/ts3.2/base.d.ts - Definitions specific to TypeScript 3.2 | |||
// - ~/ts3.2/index.d.ts - Definitions specific to TypeScript 3.2 with global and assert pulled in | |||
// Reference required types from the default lib: | |||
/// <reference lib="es2018" /> | |||
/// <reference lib="esnext.asynciterable" /> | |||
/// <reference lib="esnext.intl" /> | |||
/// <reference lib="esnext.bigint" /> | |||
// Base definitions for all NodeJS modules that are not specific to any version of TypeScript: | |||
// tslint:disable-next-line:no-bad-reference | |||
/// <reference path="../base.d.ts" /> | |||
// TypeScript 3.2-specific augmentations: | |||
/// <reference path="fs.d.ts" /> | |||
/// <reference path="util.d.ts" /> | |||
/// <reference path="globals.d.ts" /> |
@@ -0,0 +1,33 @@ | |||
// tslint:disable-next-line:no-bad-reference | |||
/// <reference path="../fs.d.ts" /> | |||
declare module 'fs' { | |||
interface BigIntStats extends StatsBase<bigint> { | |||
} | |||
class BigIntStats { | |||
atimeNs: bigint; | |||
mtimeNs: bigint; | |||
ctimeNs: bigint; | |||
birthtimeNs: bigint; | |||
} | |||
interface BigIntOptions { | |||
bigint: true; | |||
} | |||
interface StatOptions { | |||
bigint: boolean; | |||
} | |||
function stat(path: PathLike, options: BigIntOptions, callback: (err: NodeJS.ErrnoException | null, stats: BigIntStats) => void): void; | |||
function stat(path: PathLike, options: StatOptions, callback: (err: NodeJS.ErrnoException | null, stats: Stats | BigIntStats) => void): void; | |||
namespace stat { | |||
function __promisify__(path: PathLike, options: BigIntOptions): Promise<BigIntStats>; | |||
function __promisify__(path: PathLike, options: StatOptions): Promise<Stats | BigIntStats>; | |||
} | |||
function statSync(path: PathLike, options: BigIntOptions): BigIntStats; | |||
function statSync(path: PathLike, options: StatOptions): Stats | BigIntStats; | |||
} |
@@ -0,0 +1,19 @@ | |||
// tslint:disable-next-line:no-bad-reference | |||
/// <reference path="../globals.d.ts" /> | |||
declare namespace NodeJS { | |||
interface HRTime { | |||
bigint(): bigint; | |||
} | |||
} | |||
interface Buffer extends Uint8Array { | |||
readBigUInt64BE(offset?: number): bigint; | |||
readBigUInt64LE(offset?: number): bigint; | |||
readBigInt64BE(offset?: number): bigint; | |||
readBigInt64LE(offset?: number): bigint; | |||
writeBigInt64BE(value: bigint, offset?: number): number; | |||
writeBigInt64LE(value: bigint, offset?: number): number; | |||
writeBigUInt64BE(value: bigint, offset?: number): number; | |||
writeBigUInt64LE(value: bigint, offset?: number): number; | |||
} |
@@ -0,0 +1,12 @@ | |||
// NOTE: These definitions support NodeJS and TypeScript 3.2. | |||
// This is requried to enable globalThis support for global in ts3.5 without causing errors | |||
// This is requried to enable typing assert in ts3.7 without causing errors | |||
// Typically type modifiations should be made in base.d.ts instead of here | |||
/// <reference path="base.d.ts" /> | |||
// tslint:disable-next-line:no-bad-reference | |||
/// <reference path="../assert.d.ts" /> | |||
// tslint:disable-next-line:no-bad-reference | |||
/// <reference path="../globals.global.d.ts" /> |
@@ -0,0 +1,9 @@ | |||
// tslint:disable-next-line:no-bad-reference | |||
/// <reference path="../util.d.ts" /> | |||
declare module "util" { | |||
namespace types { | |||
function isBigInt64Array(value: any): value is BigInt64Array; | |||
function isBigUint64Array(value: any): value is BigUint64Array; | |||
} | |||
} |
@@ -0,0 +1,23 @@ | |||
// NOTE: These definitions support NodeJS and TypeScript 3.5. | |||
// NOTE: TypeScript version-specific augmentations can be found in the following paths: | |||
// - ~/base.d.ts - Shared definitions common to all TypeScript versions | |||
// - ~/index.d.ts - Definitions specific to TypeScript 2.1 | |||
// - ~/ts3.5/base.d.ts - Definitions specific to TypeScript 3.5 | |||
// - ~/ts3.5/index.d.ts - Definitions specific to TypeScript 3.5 with assert pulled in | |||
// Reference required types from the default lib: | |||
/// <reference lib="es2018" /> | |||
/// <reference lib="esnext.asynciterable" /> | |||
/// <reference lib="esnext.intl" /> | |||
/// <reference lib="esnext.bigint" /> | |||
// Base definitions for all NodeJS modules that are not specific to any version of TypeScript: | |||
// tslint:disable-next-line:no-bad-reference | |||
/// <reference path="../ts3.2/base.d.ts" /> | |||
// TypeScript 3.5-specific augmentations: | |||
/// <reference path="globals.global.d.ts" /> | |||
// TypeScript 3.5-specific augmentations: | |||
/// <reference path="wasi.d.ts" /> |
@@ -0,0 +1 @@ | |||
declare var global: NodeJS.Global & typeof globalThis; |
@@ -0,0 +1,8 @@ | |||
// NOTE: These definitions support NodeJS and TypeScript 3.5. | |||
// This is requried to enable typing assert in ts3.7 without causing errors | |||
// Typically type modifiations should be made in base.d.ts instead of here | |||
/// <reference path="base.d.ts" /> | |||
// tslint:disable-next-line:no-bad-reference | |||
/// <reference path="../assert.d.ts" /> |
@@ -0,0 +1,52 @@ | |||
declare module 'wasi' { | |||
interface WASIOptions { | |||
/** | |||
* An array of strings that the WebAssembly application will | |||
* see as command line arguments. The first argument is the virtual path to the | |||
* WASI command itself. | |||
*/ | |||
args?: string[]; | |||
/** | |||
* An object similar to `process.env` that the WebAssembly | |||
* application will see as its environment. | |||
*/ | |||
env?: object; | |||
/** | |||
* This object represents the WebAssembly application's | |||
* sandbox directory structure. The string keys of `preopens` are treated as | |||
* directories within the sandbox. The corresponding values in `preopens` are | |||
* the real paths to those directories on the host machine. | |||
*/ | |||
preopens?: NodeJS.Dict<string>; | |||
/** | |||
* By default, WASI applications terminate the Node.js | |||
* process via the `__wasi_proc_exit()` function. Setting this option to `true` | |||
* causes `wasi.start()` to return the exit code rather than terminate the | |||
* process. | |||
* @default false | |||
*/ | |||
returnOnExit?: boolean; | |||
} | |||
class WASI { | |||
constructor(options?: WASIOptions); | |||
/** | |||
* | |||
* Attempt to begin execution of `instance` by invoking its `_start()` export. | |||
* If `instance` does not contain a `_start()` export, then `start()` attempts to | |||
* invoke the `__wasi_unstable_reactor_start()` export. If neither of those exports | |||
* is present on `instance`, then `start()` does nothing. | |||
* | |||
* `start()` requires that `instance` exports a [`WebAssembly.Memory`][] named | |||
* `memory`. If `instance` does not have a `memory` export an exception is thrown. | |||
*/ | |||
start(instance: object): void; // TODO: avoid DOM dependency until WASM moved to own lib. | |||
/** | |||
* Is an object that implements the WASI system call API. This object | |||
* should be passed as the `wasi_unstable` import during the instantiation of a | |||
* [`WebAssembly.Instance`][]. | |||
*/ | |||
readonly wasiImport: NodeJS.Dict<any>; // TODO: Narrow to DOM types | |||
} | |||
} |
@@ -0,0 +1,57 @@ | |||
declare module "assert" { | |||
function assert(value: any, message?: string | Error): asserts value; | |||
namespace assert { | |||
class AssertionError implements Error { | |||
name: string; | |||
message: string; | |||
actual: any; | |||
expected: any; | |||
operator: string; | |||
generatedMessage: boolean; | |||
code: 'ERR_ASSERTION'; | |||
constructor(options?: { | |||
message?: string; actual?: any; expected?: any; | |||
operator?: string; stackStartFn?: Function | |||
}); | |||
} | |||
type AssertPredicate = RegExp | (new() => object) | ((thrown: any) => boolean) | object | Error; | |||
function fail(message?: string | Error): never; | |||
/** @deprecated since v10.0.0 - use fail([message]) or other assert functions instead. */ | |||
function fail(actual: any, expected: any, message?: string | Error, operator?: string, stackStartFn?: Function): never; | |||
function ok(value: any, message?: string | Error): asserts value; | |||
/** @deprecated since v9.9.0 - use strictEqual() instead. */ | |||
function equal(actual: any, expected: any, message?: string | Error): void; | |||
/** @deprecated since v9.9.0 - use notStrictEqual() instead. */ | |||
function notEqual(actual: any, expected: any, message?: string | Error): void; | |||
/** @deprecated since v9.9.0 - use deepStrictEqual() instead. */ | |||
function deepEqual(actual: any, expected: any, message?: string | Error): void; | |||
/** @deprecated since v9.9.0 - use notDeepStrictEqual() instead. */ | |||
function notDeepEqual(actual: any, expected: any, message?: string | Error): void; | |||
function strictEqual<T>(actual: any, expected: T, message?: string | Error): asserts actual is T; | |||
function notStrictEqual(actual: any, expected: any, message?: string | Error): void; | |||
function deepStrictEqual<T>(actual: any, expected: T, message?: string | Error): asserts actual is T; | |||
function notDeepStrictEqual(actual: any, expected: any, message?: string | Error): void; | |||
function throws(block: () => any, message?: string | Error): void; | |||
function throws(block: () => any, error: AssertPredicate, message?: string | Error): void; | |||
function doesNotThrow(block: () => any, message?: string | Error): void; | |||
function doesNotThrow(block: () => any, error: RegExp | Function, message?: string | Error): void; | |||
function ifError(value: any): asserts value is null | undefined; | |||
function rejects(block: (() => Promise<any>) | Promise<any>, message?: string | Error): Promise<void>; | |||
function rejects(block: (() => Promise<any>) | Promise<any>, error: AssertPredicate, message?: string | Error): Promise<void>; | |||
function doesNotReject(block: (() => Promise<any>) | Promise<any>, message?: string | Error): Promise<void>; | |||
function doesNotReject(block: (() => Promise<any>) | Promise<any>, error: RegExp | Function, message?: string | Error): Promise<void>; | |||
function match(value: string, regExp: RegExp, message?: string | Error): void; | |||
function doesNotMatch(value: string, regExp: RegExp, message?: string | Error): void; | |||
const strict: typeof assert; | |||
} | |||
export = assert; | |||
} |
@@ -0,0 +1,20 @@ | |||
// NOTE: These definitions support NodeJS and TypeScript 3.7. | |||
// NOTE: TypeScript version-specific augmentations can be found in the following paths: | |||
// - ~/base.d.ts - Shared definitions common to all TypeScript versions | |||
// - ~/index.d.ts - Definitions specific to TypeScript 2.1 | |||
// - ~/ts3.7/base.d.ts - Definitions specific to TypeScript 3.7 | |||
// - ~/ts3.7/index.d.ts - Definitions specific to TypeScript 3.7 with assert pulled in | |||
// Reference required types from the default lib: | |||
/// <reference lib="es2018" /> | |||
/// <reference lib="esnext.asynciterable" /> | |||
/// <reference lib="esnext.intl" /> | |||
/// <reference lib="esnext.bigint" /> | |||
// Base definitions for all NodeJS modules that are not specific to any version of TypeScript: | |||
// tslint:disable-next-line:no-bad-reference | |||
/// <reference path="../ts3.5/base.d.ts" /> | |||
// TypeScript 3.7-specific augmentations: | |||
/// <reference path="assert.d.ts" /> |
@@ -0,0 +1,5 @@ | |||
// NOTE: These definitions support NodeJS and TypeScript 3.7. | |||
// This isn't strictly needed since 3.7 has the assert module, but this way we're consistent. | |||
// Typically type modificatons should be made in base.d.ts instead of here | |||
/// <reference path="base.d.ts" /> |
@@ -0,0 +1,66 @@ | |||
declare module "tty" { | |||
import * as net from "net"; | |||
function isatty(fd: number): boolean; | |||
class ReadStream extends net.Socket { | |||
constructor(fd: number, options?: net.SocketConstructorOpts); | |||
isRaw: boolean; | |||
setRawMode(mode: boolean): this; | |||
isTTY: boolean; | |||
} | |||
/** | |||
* -1 - to the left from cursor | |||
* 0 - the entire line | |||
* 1 - to the right from cursor | |||
*/ | |||
type Direction = -1 | 0 | 1; | |||
class WriteStream extends net.Socket { | |||
constructor(fd: number); | |||
addListener(event: string, listener: (...args: any[]) => void): this; | |||
addListener(event: "resize", listener: () => void): this; | |||
emit(event: string | symbol, ...args: any[]): boolean; | |||
emit(event: "resize"): boolean; | |||
on(event: string, listener: (...args: any[]) => void): this; | |||
on(event: "resize", listener: () => void): this; | |||
once(event: string, listener: (...args: any[]) => void): this; | |||
once(event: "resize", listener: () => void): this; | |||
prependListener(event: string, listener: (...args: any[]) => void): this; | |||
prependListener(event: "resize", listener: () => void): this; | |||
prependOnceListener(event: string, listener: (...args: any[]) => void): this; | |||
prependOnceListener(event: "resize", listener: () => void): this; | |||
/** | |||
* Clears the current line of this WriteStream in a direction identified by `dir`. | |||
*/ | |||
clearLine(dir: Direction, callback?: () => void): boolean; | |||
/** | |||
* Clears this `WriteStream` from the current cursor down. | |||
*/ | |||
clearScreenDown(callback?: () => void): boolean; | |||
/** | |||
* Moves this WriteStream's cursor to the specified position. | |||
*/ | |||
cursorTo(x: number, y?: number, callback?: () => void): boolean; | |||
cursorTo(x: number, callback: () => void): boolean; | |||
/** | |||
* Moves this WriteStream's cursor relative to its current position. | |||
*/ | |||
moveCursor(dx: number, dy: number, callback?: () => void): boolean; | |||
/** | |||
* @default `process.env` | |||
*/ | |||
getColorDepth(env?: {}): number; | |||
hasColors(depth?: number): boolean; | |||
hasColors(env?: {}): boolean; | |||
hasColors(depth: number, env?: {}): boolean; | |||
getWindowSize(): [number, number]; | |||
columns: number; | |||
rows: number; | |||
isTTY: boolean; | |||
} | |||
} |
@@ -0,0 +1,110 @@ | |||
declare module "url" { | |||
import { ParsedUrlQuery, ParsedUrlQueryInput } from 'querystring'; | |||
// Input to `url.format` | |||
interface UrlObject { | |||
auth?: string | null; | |||
hash?: string | null; | |||
host?: string | null; | |||
hostname?: string | null; | |||
href?: string | null; | |||
pathname?: string | null; | |||
protocol?: string | null; | |||
search?: string | null; | |||
slashes?: boolean | null; | |||
port?: string | number | null; | |||
query?: string | null | ParsedUrlQueryInput; | |||
} | |||
// Output of `url.parse` | |||
interface Url { | |||
auth: string | null; | |||
hash: string | null; | |||
host: string | null; | |||
hostname: string | null; | |||
href: string; | |||
path: string | null; | |||
pathname: string | null; | |||
protocol: string | null; | |||
search: string | null; | |||
slashes: boolean | null; | |||
port: string | null; | |||
query: string | null | ParsedUrlQuery; | |||
} | |||
interface UrlWithParsedQuery extends Url { | |||
query: ParsedUrlQuery; | |||
} | |||
interface UrlWithStringQuery extends Url { | |||
query: string | null; | |||
} | |||
function parse(urlStr: string): UrlWithStringQuery; | |||
function parse(urlStr: string, parseQueryString: false | undefined, slashesDenoteHost?: boolean): UrlWithStringQuery; | |||
function parse(urlStr: string, parseQueryString: true, slashesDenoteHost?: boolean): UrlWithParsedQuery; | |||
function parse(urlStr: string, parseQueryString: boolean, slashesDenoteHost?: boolean): Url; | |||
function format(URL: URL, options?: URLFormatOptions): string; | |||
function format(urlObject: UrlObject | string): string; | |||
function resolve(from: string, to: string): string; | |||
function domainToASCII(domain: string): string; | |||
function domainToUnicode(domain: string): string; | |||
/** | |||
* This function ensures the correct decodings of percent-encoded characters as | |||
* well as ensuring a cross-platform valid absolute path string. | |||
* @param url The file URL string or URL object to convert to a path. | |||
*/ | |||
function fileURLToPath(url: string | URL): string; | |||
/** | |||
* This function ensures that path is resolved absolutely, and that the URL | |||
* control characters are correctly encoded when converting into a File URL. | |||
* @param url The path to convert to a File URL. | |||
*/ | |||
function pathToFileURL(url: string): URL; | |||
interface URLFormatOptions { | |||
auth?: boolean; | |||
fragment?: boolean; | |||
search?: boolean; | |||
unicode?: boolean; | |||
} | |||
class URL { | |||
constructor(input: string, base?: string | URL); | |||
hash: string; | |||
host: string; | |||
hostname: string; | |||
href: string; | |||
readonly origin: string; | |||
password: string; | |||
pathname: string; | |||
port: string; | |||
protocol: string; | |||
search: string; | |||
readonly searchParams: URLSearchParams; | |||
username: string; | |||
toString(): string; | |||
toJSON(): string; | |||
} | |||
class URLSearchParams implements Iterable<[string, string]> { | |||
constructor(init?: URLSearchParams | string | NodeJS.Dict<string | string[]> | Iterable<[string, string]> | Array<[string, string]>); | |||
append(name: string, value: string): void; | |||
delete(name: string): void; | |||
entries(): IterableIterator<[string, string]>; | |||
forEach(callback: (value: string, name: string, searchParams: this) => void): void; | |||
get(name: string): string | null; | |||
getAll(name: string): string[]; | |||
has(name: string): boolean; | |||
keys(): IterableIterator<string>; | |||
set(name: string, value: string): void; | |||
sort(): void; | |||
toString(): string; | |||
values(): IterableIterator<string>; | |||
[Symbol.iterator](): IterableIterator<[string, string]>; | |||
} | |||
} |
@@ -0,0 +1,194 @@ | |||
declare module "util" { | |||
interface InspectOptions extends NodeJS.InspectOptions { } | |||
type Style = 'special' | 'number' | 'bigint' | 'boolean' | 'undefined' | 'null' | 'string' | 'symbol' | 'date' | 'regexp' | 'module'; | |||
type CustomInspectFunction = (depth: number, options: InspectOptionsStylized) => string; | |||
interface InspectOptionsStylized extends InspectOptions { | |||
stylize(text: string, styleType: Style): string; | |||
} | |||
function format(format: any, ...param: any[]): string; | |||
function formatWithOptions(inspectOptions: InspectOptions, format: string, ...param: any[]): string; | |||
/** @deprecated since v0.11.3 - use a third party module instead. */ | |||
function log(string: string): void; | |||
function inspect(object: any, showHidden?: boolean, depth?: number | null, color?: boolean): string; | |||
function inspect(object: any, options: InspectOptions): string; | |||
namespace inspect { | |||
let colors: NodeJS.Dict<[number, number]>; | |||
let styles: { | |||
[K in Style]: string | |||
}; | |||
let defaultOptions: InspectOptions; | |||
/** | |||
* Allows changing inspect settings from the repl. | |||
*/ | |||
let replDefaults: InspectOptions; | |||
const custom: unique symbol; | |||
} | |||
/** @deprecated since v4.0.0 - use `Array.isArray()` instead. */ | |||
function isArray(object: any): object is any[]; | |||
/** @deprecated since v4.0.0 - use `util.types.isRegExp()` instead. */ | |||
function isRegExp(object: any): object is RegExp; | |||
/** @deprecated since v4.0.0 - use `util.types.isDate()` instead. */ | |||
function isDate(object: any): object is Date; | |||
/** @deprecated since v4.0.0 - use `util.types.isNativeError()` instead. */ | |||
function isError(object: any): object is Error; | |||
function inherits(constructor: any, superConstructor: any): void; | |||
function debuglog(key: string): (msg: string, ...param: any[]) => void; | |||
/** @deprecated since v4.0.0 - use `typeof value === 'boolean'` instead. */ | |||
function isBoolean(object: any): object is boolean; | |||
/** @deprecated since v4.0.0 - use `Buffer.isBuffer()` instead. */ | |||
function isBuffer(object: any): object is Buffer; | |||
/** @deprecated since v4.0.0 - use `typeof value === 'function'` instead. */ | |||
function isFunction(object: any): boolean; | |||
/** @deprecated since v4.0.0 - use `value === null` instead. */ | |||
function isNull(object: any): object is null; | |||
/** @deprecated since v4.0.0 - use `value === null || value === undefined` instead. */ | |||
function isNullOrUndefined(object: any): object is null | undefined; | |||
/** @deprecated since v4.0.0 - use `typeof value === 'number'` instead. */ | |||
function isNumber(object: any): object is number; | |||
/** @deprecated since v4.0.0 - use `value !== null && typeof value === 'object'` instead. */ | |||
function isObject(object: any): boolean; | |||
/** @deprecated since v4.0.0 - use `(typeof value !== 'object' && typeof value !== 'function') || value === null` instead. */ | |||
function isPrimitive(object: any): boolean; | |||
/** @deprecated since v4.0.0 - use `typeof value === 'string'` instead. */ | |||
function isString(object: any): object is string; | |||
/** @deprecated since v4.0.0 - use `typeof value === 'symbol'` instead. */ | |||
function isSymbol(object: any): object is symbol; | |||
/** @deprecated since v4.0.0 - use `value === undefined` instead. */ | |||
function isUndefined(object: any): object is undefined; | |||
function deprecate<T extends Function>(fn: T, message: string, code?: string): T; | |||
function isDeepStrictEqual(val1: any, val2: any): boolean; | |||
function callbackify(fn: () => Promise<void>): (callback: (err: NodeJS.ErrnoException) => void) => void; | |||
function callbackify<TResult>(fn: () => Promise<TResult>): (callback: (err: NodeJS.ErrnoException, result: TResult) => void) => void; | |||
function callbackify<T1>(fn: (arg1: T1) => Promise<void>): (arg1: T1, callback: (err: NodeJS.ErrnoException) => void) => void; | |||
function callbackify<T1, TResult>(fn: (arg1: T1) => Promise<TResult>): (arg1: T1, callback: (err: NodeJS.ErrnoException, result: TResult) => void) => void; | |||
function callbackify<T1, T2>(fn: (arg1: T1, arg2: T2) => Promise<void>): (arg1: T1, arg2: T2, callback: (err: NodeJS.ErrnoException) => void) => void; | |||
function callbackify<T1, T2, TResult>(fn: (arg1: T1, arg2: T2) => Promise<TResult>): (arg1: T1, arg2: T2, callback: (err: NodeJS.ErrnoException | null, result: TResult) => void) => void; | |||
function callbackify<T1, T2, T3>(fn: (arg1: T1, arg2: T2, arg3: T3) => Promise<void>): (arg1: T1, arg2: T2, arg3: T3, callback: (err: NodeJS.ErrnoException) => void) => void; | |||
function callbackify<T1, T2, T3, TResult>( | |||
fn: (arg1: T1, arg2: T2, arg3: T3) => Promise<TResult>): (arg1: T1, arg2: T2, arg3: T3, callback: (err: NodeJS.ErrnoException | null, result: TResult) => void) => void; | |||
function callbackify<T1, T2, T3, T4>( | |||
fn: (arg1: T1, arg2: T2, arg3: T3, arg4: T4) => Promise<void>): (arg1: T1, arg2: T2, arg3: T3, arg4: T4, callback: (err: NodeJS.ErrnoException) => void) => void; | |||
function callbackify<T1, T2, T3, T4, TResult>( | |||
fn: (arg1: T1, arg2: T2, arg3: T3, arg4: T4) => Promise<TResult>): (arg1: T1, arg2: T2, arg3: T3, arg4: T4, callback: (err: NodeJS.ErrnoException | null, result: TResult) => void) => void; | |||
function callbackify<T1, T2, T3, T4, T5>( | |||
fn: (arg1: T1, arg2: T2, arg3: T3, arg4: T4, arg5: T5) => Promise<void>): (arg1: T1, arg2: T2, arg3: T3, arg4: T4, arg5: T5, callback: (err: NodeJS.ErrnoException) => void) => void; | |||
function callbackify<T1, T2, T3, T4, T5, TResult>( | |||
fn: (arg1: T1, arg2: T2, arg3: T3, arg4: T4, arg5: T5) => Promise<TResult>, | |||
): (arg1: T1, arg2: T2, arg3: T3, arg4: T4, arg5: T5, callback: (err: NodeJS.ErrnoException | null, result: TResult) => void) => void; | |||
function callbackify<T1, T2, T3, T4, T5, T6>( | |||
fn: (arg1: T1, arg2: T2, arg3: T3, arg4: T4, arg5: T5, arg6: T6) => Promise<void>, | |||
): (arg1: T1, arg2: T2, arg3: T3, arg4: T4, arg5: T5, arg6: T6, callback: (err: NodeJS.ErrnoException) => void) => void; | |||
function callbackify<T1, T2, T3, T4, T5, T6, TResult>( | |||
fn: (arg1: T1, arg2: T2, arg3: T3, arg4: T4, arg5: T5, arg6: T6) => Promise<TResult> | |||
): (arg1: T1, arg2: T2, arg3: T3, arg4: T4, arg5: T5, arg6: T6, callback: (err: NodeJS.ErrnoException | null, result: TResult) => void) => void; | |||
interface CustomPromisifyLegacy<TCustom extends Function> extends Function { | |||
__promisify__: TCustom; | |||
} | |||
interface CustomPromisifySymbol<TCustom extends Function> extends Function { | |||
[promisify.custom]: TCustom; | |||
} | |||
type CustomPromisify<TCustom extends Function> = CustomPromisifySymbol<TCustom> | CustomPromisifyLegacy<TCustom>; | |||
function promisify<TCustom extends Function>(fn: CustomPromisify<TCustom>): TCustom; | |||
function promisify<TResult>(fn: (callback: (err: any, result: TResult) => void) => void): () => Promise<TResult>; | |||
function promisify(fn: (callback: (err?: any) => void) => void): () => Promise<void>; | |||
function promisify<T1, TResult>(fn: (arg1: T1, callback: (err: any, result: TResult) => void) => void): (arg1: T1) => Promise<TResult>; | |||
function promisify<T1>(fn: (arg1: T1, callback: (err?: any) => void) => void): (arg1: T1) => Promise<void>; | |||
function promisify<T1, T2, TResult>(fn: (arg1: T1, arg2: T2, callback: (err: any, result: TResult) => void) => void): (arg1: T1, arg2: T2) => Promise<TResult>; | |||
function promisify<T1, T2>(fn: (arg1: T1, arg2: T2, callback: (err?: any) => void) => void): (arg1: T1, arg2: T2) => Promise<void>; | |||
function promisify<T1, T2, T3, TResult>(fn: (arg1: T1, arg2: T2, arg3: T3, callback: (err: any, result: TResult) => void) => void): | |||
(arg1: T1, arg2: T2, arg3: T3) => Promise<TResult>; | |||
function promisify<T1, T2, T3>(fn: (arg1: T1, arg2: T2, arg3: T3, callback: (err?: any) => void) => void): (arg1: T1, arg2: T2, arg3: T3) => Promise<void>; | |||
function promisify<T1, T2, T3, T4, TResult>( | |||
fn: (arg1: T1, arg2: T2, arg3: T3, arg4: T4, callback: (err: any, result: TResult) => void) => void, | |||
): (arg1: T1, arg2: T2, arg3: T3, arg4: T4) => Promise<TResult>; | |||
function promisify<T1, T2, T3, T4>(fn: (arg1: T1, arg2: T2, arg3: T3, arg4: T4, callback: (err?: any) => void) => void): | |||
(arg1: T1, arg2: T2, arg3: T3, arg4: T4) => Promise<void>; | |||
function promisify<T1, T2, T3, T4, T5, TResult>( | |||
fn: (arg1: T1, arg2: T2, arg3: T3, arg4: T4, arg5: T5, callback: (err: any, result: TResult) => void) => void, | |||
): (arg1: T1, arg2: T2, arg3: T3, arg4: T4, arg5: T5) => Promise<TResult>; | |||
function promisify<T1, T2, T3, T4, T5>( | |||
fn: (arg1: T1, arg2: T2, arg3: T3, arg4: T4, arg5: T5, callback: (err?: any) => void) => void, | |||
): (arg1: T1, arg2: T2, arg3: T3, arg4: T4, arg5: T5) => Promise<void>; | |||
function promisify(fn: Function): Function; | |||
namespace promisify { | |||
const custom: unique symbol; | |||
} | |||
namespace types { | |||
function isAnyArrayBuffer(object: any): boolean; | |||
function isArgumentsObject(object: any): object is IArguments; | |||
function isArrayBuffer(object: any): object is ArrayBuffer; | |||
function isArrayBufferView(object: any): object is ArrayBufferView; | |||
function isAsyncFunction(object: any): boolean; | |||
function isBooleanObject(object: any): object is Boolean; | |||
function isBoxedPrimitive(object: any): object is (Number | Boolean | String | Symbol /* | Object(BigInt) | Object(Symbol) */); | |||
function isDataView(object: any): object is DataView; | |||
function isDate(object: any): object is Date; | |||
function isExternal(object: any): boolean; | |||
function isFloat32Array(object: any): object is Float32Array; | |||
function isFloat64Array(object: any): object is Float64Array; | |||
function isGeneratorFunction(object: any): boolean; | |||
function isGeneratorObject(object: any): boolean; | |||
function isInt8Array(object: any): object is Int8Array; | |||
function isInt16Array(object: any): object is Int16Array; | |||
function isInt32Array(object: any): object is Int32Array; | |||
function isMap(object: any): boolean; | |||
function isMapIterator(object: any): boolean; | |||
function isModuleNamespaceObject(value: any): boolean; | |||
function isNativeError(object: any): object is Error; | |||
function isNumberObject(object: any): object is Number; | |||
function isPromise(object: any): boolean; | |||
function isProxy(object: any): boolean; | |||
function isRegExp(object: any): object is RegExp; | |||
function isSet(object: any): boolean; | |||
function isSetIterator(object: any): boolean; | |||
function isSharedArrayBuffer(object: any): boolean; | |||
function isStringObject(object: any): boolean; | |||
function isSymbolObject(object: any): boolean; | |||
function isTypedArray(object: any): object is NodeJS.TypedArray; | |||
function isUint8Array(object: any): object is Uint8Array; | |||
function isUint8ClampedArray(object: any): object is Uint8ClampedArray; | |||
function isUint16Array(object: any): object is Uint16Array; | |||
function isUint32Array(object: any): object is Uint32Array; | |||
function isWeakMap(object: any): boolean; | |||
function isWeakSet(object: any): boolean; | |||
function isWebAssemblyCompiledModule(object: any): boolean; | |||
} | |||
class TextDecoder { | |||
readonly encoding: string; | |||
readonly fatal: boolean; | |||
readonly ignoreBOM: boolean; | |||
constructor( | |||
encoding?: string, | |||
options?: { fatal?: boolean; ignoreBOM?: boolean } | |||
); | |||
decode( | |||
input?: NodeJS.ArrayBufferView | ArrayBuffer | null, | |||
options?: { stream?: boolean } | |||
): string; | |||
} | |||
interface EncodeIntoResult { | |||
/** | |||
* The read Unicode code units of input. | |||
*/ | |||
read: number; | |||
/** | |||
* The written UTF-8 bytes of output. | |||
*/ | |||
written: number; | |||
} | |||
class TextEncoder { | |||
readonly encoding: string; | |||
encode(input?: string): Uint8Array; | |||
encodeInto(input: string, output: Uint8Array): EncodeIntoResult; | |||
} | |||
} |
@@ -0,0 +1,187 @@ | |||
declare module "v8" { | |||
import { Readable } from "stream"; | |||
interface HeapSpaceInfo { | |||
space_name: string; | |||
space_size: number; | |||
space_used_size: number; | |||
space_available_size: number; | |||
physical_space_size: number; | |||
} | |||
// ** Signifies if the --zap_code_space option is enabled or not. 1 == enabled, 0 == disabled. */ | |||
type DoesZapCodeSpaceFlag = 0 | 1; | |||
interface HeapInfo { | |||
total_heap_size: number; | |||
total_heap_size_executable: number; | |||
total_physical_size: number; | |||
total_available_size: number; | |||
used_heap_size: number; | |||
heap_size_limit: number; | |||
malloced_memory: number; | |||
peak_malloced_memory: number; | |||
does_zap_garbage: DoesZapCodeSpaceFlag; | |||
number_of_native_contexts: number; | |||
number_of_detached_contexts: number; | |||
} | |||
interface HeapCodeStatistics { | |||
code_and_metadata_size: number; | |||
bytecode_and_metadata_size: number; | |||
external_script_source_size: number; | |||
} | |||
/** | |||
* Returns an integer representing a "version tag" derived from the V8 version, command line flags and detected CPU features. | |||
* This is useful for determining whether a vm.Script cachedData buffer is compatible with this instance of V8. | |||
*/ | |||
function cachedDataVersionTag(): number; | |||
function getHeapStatistics(): HeapInfo; | |||
function getHeapSpaceStatistics(): HeapSpaceInfo[]; | |||
function setFlagsFromString(flags: string): void; | |||
/** | |||
* Generates a snapshot of the current V8 heap and returns a Readable | |||
* Stream that may be used to read the JSON serialized representation. | |||
* This conversation was marked as resolved by joyeecheung | |||
* This JSON stream format is intended to be used with tools such as | |||
* Chrome DevTools. The JSON schema is undocumented and specific to the | |||
* V8 engine, and may change from one version of V8 to the next. | |||
*/ | |||
function getHeapSnapshot(): Readable; | |||
/** | |||
* | |||
* @param fileName The file path where the V8 heap snapshot is to be | |||
* saved. If not specified, a file name with the pattern | |||
* `'Heap-${yyyymmdd}-${hhmmss}-${pid}-${thread_id}.heapsnapshot'` will be | |||
* generated, where `{pid}` will be the PID of the Node.js process, | |||
* `{thread_id}` will be `0` when `writeHeapSnapshot()` is called from | |||
* the main Node.js thread or the id of a worker thread. | |||
*/ | |||
function writeHeapSnapshot(fileName?: string): string; | |||
function getHeapCodeStatistics(): HeapCodeStatistics; | |||
class Serializer { | |||
/** | |||
* Writes out a header, which includes the serialization format version. | |||
*/ | |||
writeHeader(): void; | |||
/** | |||
* Serializes a JavaScript value and adds the serialized representation to the internal buffer. | |||
* This throws an error if value cannot be serialized. | |||
*/ | |||
writeValue(val: any): boolean; | |||
/** | |||
* Returns the stored internal buffer. | |||
* This serializer should not be used once the buffer is released. | |||
* Calling this method results in undefined behavior if a previous write has failed. | |||
*/ | |||
releaseBuffer(): Buffer; | |||
/** | |||
* Marks an ArrayBuffer as having its contents transferred out of band.\ | |||
* Pass the corresponding ArrayBuffer in the deserializing context to deserializer.transferArrayBuffer(). | |||
*/ | |||
transferArrayBuffer(id: number, arrayBuffer: ArrayBuffer): void; | |||
/** | |||
* Write a raw 32-bit unsigned integer. | |||
*/ | |||
writeUint32(value: number): void; | |||
/** | |||
* Write a raw 64-bit unsigned integer, split into high and low 32-bit parts. | |||
*/ | |||
writeUint64(hi: number, lo: number): void; | |||
/** | |||
* Write a JS number value. | |||
*/ | |||
writeDouble(value: number): void; | |||
/** | |||
* Write raw bytes into the serializer’s internal buffer. | |||
* The deserializer will require a way to compute the length of the buffer. | |||
*/ | |||
writeRawBytes(buffer: NodeJS.TypedArray): void; | |||
} | |||
/** | |||
* A subclass of `Serializer` that serializes `TypedArray` (in particular `Buffer`) and `DataView` objects as host objects, | |||
* and only stores the part of their underlying `ArrayBuffers` that they are referring to. | |||
*/ | |||
class DefaultSerializer extends Serializer { | |||
} | |||
class Deserializer { | |||
constructor(data: NodeJS.TypedArray); | |||
/** | |||
* Reads and validates a header (including the format version). | |||
* May, for example, reject an invalid or unsupported wire format. | |||
* In that case, an Error is thrown. | |||
*/ | |||
readHeader(): boolean; | |||
/** | |||
* Deserializes a JavaScript value from the buffer and returns it. | |||
*/ | |||
readValue(): any; | |||
/** | |||
* Marks an ArrayBuffer as having its contents transferred out of band. | |||
* Pass the corresponding `ArrayBuffer` in the serializing context to serializer.transferArrayBuffer() | |||
* (or return the id from serializer._getSharedArrayBufferId() in the case of SharedArrayBuffers). | |||
*/ | |||
transferArrayBuffer(id: number, arrayBuffer: ArrayBuffer): void; | |||
/** | |||
* Reads the underlying wire format version. | |||
* Likely mostly to be useful to legacy code reading old wire format versions. | |||
* May not be called before .readHeader(). | |||
*/ | |||
getWireFormatVersion(): number; | |||
/** | |||
* Read a raw 32-bit unsigned integer and return it. | |||
*/ | |||
readUint32(): number; | |||
/** | |||
* Read a raw 64-bit unsigned integer and return it as an array [hi, lo] with two 32-bit unsigned integer entries. | |||
*/ | |||
readUint64(): [number, number]; | |||
/** | |||
* Read a JS number value. | |||
*/ | |||
readDouble(): number; | |||
/** | |||
* Read raw bytes from the deserializer’s internal buffer. | |||
* The length parameter must correspond to the length of the buffer that was passed to serializer.writeRawBytes(). | |||
*/ | |||
readRawBytes(length: number): Buffer; | |||
} | |||
/** | |||
* A subclass of `Serializer` that serializes `TypedArray` (in particular `Buffer`) and `DataView` objects as host objects, | |||
* and only stores the part of their underlying `ArrayBuffers` that they are referring to. | |||
*/ | |||
class DefaultDeserializer extends Deserializer { | |||
} | |||
/** | |||
* Uses a `DefaultSerializer` to serialize value into a buffer. | |||
*/ | |||
function serialize(value: any): Buffer; | |||
/** | |||
* Uses a `DefaultDeserializer` with default options to read a JS value from a buffer. | |||
*/ | |||
function deserialize(data: NodeJS.TypedArray): any; | |||
} |
@@ -0,0 +1,142 @@ | |||
declare module "vm" { | |||
interface Context extends NodeJS.Dict<any> { } | |||
interface BaseOptions { | |||
/** | |||
* Specifies the filename used in stack traces produced by this script. | |||
* Default: `''`. | |||
*/ | |||
filename?: string; | |||
/** | |||
* Specifies the line number offset that is displayed in stack traces produced by this script. | |||
* Default: `0`. | |||
*/ | |||
lineOffset?: number; | |||
/** | |||
* Specifies the column number offset that is displayed in stack traces produced by this script. | |||
* Default: `0` | |||
*/ | |||
columnOffset?: number; | |||
} | |||
interface ScriptOptions extends BaseOptions { | |||
displayErrors?: boolean; | |||
timeout?: number; | |||
cachedData?: Buffer; | |||
produceCachedData?: boolean; | |||
} | |||
interface RunningScriptOptions extends BaseOptions { | |||
/** | |||
* When `true`, if an `Error` occurs while compiling the `code`, the line of code causing the error is attached to the stack trace. | |||
* Default: `true`. | |||
*/ | |||
displayErrors?: boolean; | |||
/** | |||
* Specifies the number of milliseconds to execute code before terminating execution. | |||
* If execution is terminated, an `Error` will be thrown. This value must be a strictly positive integer. | |||
*/ | |||
timeout?: number; | |||
/** | |||
* If `true`, the execution will be terminated when `SIGINT` (Ctrl+C) is received. | |||
* Existing handlers for the event that have been attached via `process.on('SIGINT')` will be disabled during script execution, but will continue to work after that. | |||
* If execution is terminated, an `Error` will be thrown. | |||
* Default: `false`. | |||
*/ | |||
breakOnSigint?: boolean; | |||
} | |||
interface CompileFunctionOptions extends BaseOptions { | |||
/** | |||
* Provides an optional data with V8's code cache data for the supplied source. | |||
*/ | |||
cachedData?: Buffer; | |||
/** | |||
* Specifies whether to produce new cache data. | |||
* Default: `false`, | |||
*/ | |||
produceCachedData?: boolean; | |||
/** | |||
* The sandbox/context in which the said function should be compiled in. | |||
*/ | |||
parsingContext?: Context; | |||
/** | |||
* An array containing a collection of context extensions (objects wrapping the current scope) to be applied while compiling | |||
*/ | |||
contextExtensions?: Object[]; | |||
} | |||
interface CreateContextOptions { | |||
/** | |||
* Human-readable name of the newly created context. | |||
* @default 'VM Context i' Where i is an ascending numerical index of the created context. | |||
*/ | |||
name?: string; | |||
/** | |||
* Corresponds to the newly created context for display purposes. | |||
* The origin should be formatted like a `URL`, but with only the scheme, host, and port (if necessary), | |||
* like the value of the `url.origin` property of a URL object. | |||
* Most notably, this string should omit the trailing slash, as that denotes a path. | |||
* @default '' | |||
*/ | |||
origin?: string; | |||
codeGeneration?: { | |||
/** | |||
* If set to false any calls to eval or function constructors (Function, GeneratorFunction, etc) | |||
* will throw an EvalError. | |||
* @default true | |||
*/ | |||
strings?: boolean; | |||
/** | |||
* If set to false any attempt to compile a WebAssembly module will throw a WebAssembly.CompileError. | |||
* @default true | |||
*/ | |||
wasm?: boolean; | |||
}; | |||
} | |||
type MeasureMemoryMode = 'summary' | 'detailed'; | |||
interface MeasureMemoryOptions { | |||
/** | |||
* @default 'summary' | |||
*/ | |||
mode?: MeasureMemoryMode; | |||
context?: Context; | |||
} | |||
interface MemoryMeasurement { | |||
total: { | |||
jsMemoryEstimate: number; | |||
jsMemoryRange: [number, number]; | |||
}; | |||
} | |||
class Script { | |||
constructor(code: string, options?: ScriptOptions); | |||
runInContext(contextifiedSandbox: Context, options?: RunningScriptOptions): any; | |||
runInNewContext(sandbox?: Context, options?: RunningScriptOptions): any; | |||
runInThisContext(options?: RunningScriptOptions): any; | |||
createCachedData(): Buffer; | |||
} | |||
function createContext(sandbox?: Context, options?: CreateContextOptions): Context; | |||
function isContext(sandbox: Context): boolean; | |||
function runInContext(code: string, contextifiedSandbox: Context, options?: RunningScriptOptions | string): any; | |||
function runInNewContext(code: string, sandbox?: Context, options?: RunningScriptOptions | string): any; | |||
function runInThisContext(code: string, options?: RunningScriptOptions | string): any; | |||
function compileFunction(code: string, params?: string[], options?: CompileFunctionOptions): Function; | |||
/** | |||
* Measure the memory known to V8 and used by the current execution context or a specified context. | |||
* | |||
* The format of the object that the returned Promise may resolve with is | |||
* specific to the V8 engine and may change from one version of V8 to the next. | |||
* | |||
* The returned result is different from the statistics returned by | |||
* `v8.getHeapSpaceStatistics()` in that `vm.measureMemory()` measures | |||
* the memory reachable by V8 from a specific context, while | |||
* `v8.getHeapSpaceStatistics()` measures the memory used by an instance | |||
* of V8 engine, which can switch among multiple contexts that reference | |||
* objects in the heap of one engine. | |||
* | |||
* @experimental | |||
*/ | |||
function measureMemory(options?: MeasureMemoryOptions): Promise<MemoryMeasurement>; | |||
} |