mirror of
https://github.com/gosticks/DefinitelyTyped.git
synced 2026-05-29 15:44:31 +00:00
Deprecate urllib and add three dep to forge-viewer (#34669)
This commit is contained in:
Nathan Shively-Sanders
committed by
GitHub
GitHub
parent
f5ad4616f0
commit
e853ebb6cb
@@ -2544,6 +2544,12 @@
|
||||
"sourceRepoURL": "https://github.com/blakeembrey/upper-case-first",
|
||||
"asOfVersion": "1.1.2"
|
||||
},
|
||||
{
|
||||
"libraryName": "urllib",
|
||||
"typingsPackageName": "urllib",
|
||||
"sourceRepoURL": "https://github.com/node-modules/urllib",
|
||||
"asOfVersion": "2.33.0"
|
||||
},
|
||||
{
|
||||
"libraryName": "UUID.js",
|
||||
"typingsPackageName": "uuidjs",
|
||||
|
||||
6
types/forge-viewer/package.json
Normal file
6
types/forge-viewer/package.json
Normal file
@@ -0,0 +1,6 @@
|
||||
{
|
||||
"private": true,
|
||||
"dependencies": {
|
||||
"@types/three": "^0.93.30"
|
||||
}
|
||||
}
|
||||
@@ -1,29 +0,0 @@
|
||||
# DefinitelyTyped for Urllib
|
||||
|
||||
## Current Urllib Version
|
||||
`v2.25.4`
|
||||
## Usage
|
||||
|
||||
```bash
|
||||
npm install --save-dev @types/urllib
|
||||
```
|
||||
|
||||
example:
|
||||
```ts
|
||||
import * as urllib from ".";
|
||||
|
||||
urllib.curl('https://example.test.com', {
|
||||
method: "GET",
|
||||
data: {
|
||||
test: 'test',
|
||||
}
|
||||
})
|
||||
```
|
||||
## License
|
||||
MIT
|
||||
|
||||
## dependencies
|
||||
`@types/node`
|
||||
|
||||
## Author
|
||||
[SoraYama](https://github.com/sorayama)
|
||||
250
types/urllib/index.d.ts
vendored
250
types/urllib/index.d.ts
vendored
@@ -1,250 +0,0 @@
|
||||
// Type definitions for urllib 2.28
|
||||
// Project: https://github.com/node-modules/urllib
|
||||
// Definitions by: SoraYama <https://github.com/sorayama>
|
||||
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
|
||||
|
||||
import 'node';
|
||||
import * as https from 'https';
|
||||
import * as http from 'http';
|
||||
import * as url from 'url';
|
||||
import { Readable, Writable } from 'stream';
|
||||
import { EventEmitter } from 'events';
|
||||
import { LookupFunction } from 'net';
|
||||
|
||||
export as namespace urllib;
|
||||
export interface RequestOptions {
|
||||
/** Request method, defaults to GET. Could be GET, POST, DELETE or PUT. Alias 'type'. */
|
||||
method?: "GET" | "POST" | "DELETE" | "PUT";
|
||||
/** Alias method */
|
||||
type?: "GET" | "POST" | "DELETE" | "PUT";
|
||||
/** Data to be sent. Will be stringify automatically. */
|
||||
data?: any;
|
||||
/** Force convert data to query string. */
|
||||
dataAsQueryString?: boolean;
|
||||
/** Manually set the content of payload. If set, data will be ignored. */
|
||||
content?: string | Buffer;
|
||||
/** Stream to be pipe to the remote.If set, data and content will be ignored. */
|
||||
stream?: Readable;
|
||||
/**
|
||||
* A writable stream to be piped by the response stream.
|
||||
* Responding data will be write to this stream and callback
|
||||
* will be called with data set null after finished writing.
|
||||
*/
|
||||
writeStream?: Writable;
|
||||
/** consume the writeStream, invoke the callback after writeStream close. */
|
||||
consumeWriteStream?: boolean;
|
||||
/** Type of request data.Could be json.If it's json, will auto set Content-Type: application/json header. */
|
||||
contentType?: string;
|
||||
/**
|
||||
* urllib default use querystring to stringify form data which don't support nested object,
|
||||
* will use qs instead of querystring to support nested object by set this option to true.
|
||||
*/
|
||||
nestedQuerystring?: boolean;
|
||||
/**
|
||||
* Type of response data. Could be text or json.
|
||||
* If it's text, the callbacked data would be a String.
|
||||
* If it's json, the data of callback would be a parsed JSON Object
|
||||
* and will auto set Accept: application/json header. Default callbacked data would be a Buffer.
|
||||
*/
|
||||
dataType?: string;
|
||||
/** Fix the control characters (U+0000 through U+001F) before JSON parse response. Default is false. */
|
||||
fixJSONCtlChars?: boolean;
|
||||
/** Request headers. */
|
||||
headers?: { [key: string]: any };
|
||||
/**
|
||||
* Request timeout in milliseconds for connecting phase and response receiving phase.
|
||||
* Defaults to exports.
|
||||
* TIMEOUT, both are 5s.You can use timeout: 5000 to tell urllib use same timeout on two phase or set them seperately such as
|
||||
* timeout: [3000, 5000], which will set connecting timeout to 3s and response 5s.
|
||||
*/
|
||||
timeout?: number | number[];
|
||||
/** username:password used in HTTP Basic Authorization. */
|
||||
auth?: string;
|
||||
/** username:password used in HTTP Digest Authorization. */
|
||||
digestAuth?: string;
|
||||
/** HTTP Agent object.Set false if you does not use agent. */
|
||||
agent?: http.Agent;
|
||||
/** HTTPS Agent object. Set false if you does not use agent. */
|
||||
httpsAgent?: https.Agent;
|
||||
/**
|
||||
* An array of strings or Buffers of trusted certificates.
|
||||
* If this is omitted several well known "root" CAs will be used, like VeriSign.
|
||||
* These are used to authorize connections.
|
||||
* Notes: This is necessary only if the server uses the self - signed certificate
|
||||
*/
|
||||
ca?: string | Buffer | string[] | Buffer[];
|
||||
/**
|
||||
* If true, the server certificate is verified against the list of supplied CAs.
|
||||
* An 'error' event is emitted if verification fails.Default: true.
|
||||
*/
|
||||
rejectUnauthorized?: boolean;
|
||||
/** A string or Buffer containing the private key, certificate and CA certs of the server in PFX or PKCS12 format. */
|
||||
pfx?: string | Buffer;
|
||||
/**
|
||||
* A string or Buffer containing the private key of the client in PEM format.
|
||||
* Notes: This is necessary only if using the client certificate authentication
|
||||
*/
|
||||
key?: string | Buffer;
|
||||
/**
|
||||
* A string or Buffer containing the certificate key of the client in PEM format.
|
||||
* Notes: This is necessary only if using the client certificate authentication
|
||||
*/
|
||||
cert?: string | Buffer;
|
||||
/** A string of passphrase for the private key or pfx. */
|
||||
passphrase?: string;
|
||||
/** A string describing the ciphers to use or exclude. */
|
||||
ciphers?: string;
|
||||
/** The SSL method to use, e.g.SSLv3_method to force SSL version 3. */
|
||||
secureProtocol?: string;
|
||||
/** follow HTTP 3xx responses as redirects. defaults to false. */
|
||||
followRedirect?: boolean;
|
||||
/** The maximum number of redirects to follow, defaults to 10. */
|
||||
maxRedirects?: number;
|
||||
/** Format the redirect url by your self. Default is url.resolve(from, to). */
|
||||
formatRedirectUrl?: (a: any, b: any) => void;
|
||||
/** Before request hook, you can change every thing here. */
|
||||
beforeRequest?: (...args: any[]) => void;
|
||||
/** let you get the res object when request connected, default false. alias customResponse */
|
||||
streaming?: boolean;
|
||||
/** Accept gzip response content and auto decode it, default is false. */
|
||||
gzip?: boolean;
|
||||
/** Enable timing or not, default is false. */
|
||||
timing?: boolean;
|
||||
/** Enable proxy request, default is false. */
|
||||
enableProxy?: boolean;
|
||||
/** proxy agent uri or options, default is null. */
|
||||
proxy?: string | { [key: string]: any };
|
||||
/**
|
||||
* Custom DNS lookup function, default is dns.lookup.
|
||||
* Require node >= 4.0.0(for http protocol) and node >=8(for https protocol)
|
||||
*/
|
||||
lookup?: LookupFunction;
|
||||
/**
|
||||
* check request address to protect from SSRF and similar attacks.
|
||||
* It receive two arguments(ip and family) and should return true or false to identified the address is legal or not.
|
||||
* It rely on lookup and have the same version requirement.
|
||||
*/
|
||||
checkAddress?: (ip: string, family: number | string) => boolean;
|
||||
}
|
||||
|
||||
/**
|
||||
* @param data Outgoing message
|
||||
* @param res http response
|
||||
*/
|
||||
export type Callback = (err: Error, data: any, res: http.IncomingMessage) => void;
|
||||
|
||||
/**
|
||||
* Handle all http request, both http and https support well.
|
||||
*
|
||||
* @example
|
||||
* // GET http://httptest.cnodejs.net
|
||||
* urllib.request('http://httptest.cnodejs.net/test/get', function(err, data, res) {});
|
||||
* // POST http://httptest.cnodejs.net
|
||||
* var args = { type: 'post', data: { foo: 'bar' } };
|
||||
* urllib.request('http://httptest.cnodejs.net/test/post', args, function(err, data, res) {});
|
||||
*
|
||||
* @param url The URL to request, either a String or a Object that return by url.parse.
|
||||
*/
|
||||
export function request(url: string | url.URL, options?: RequestOptions): Promise<any>;
|
||||
/**
|
||||
* @param url The URL to request, either a String or a Object that return by url.parse.
|
||||
*/
|
||||
export function request(url: string | url.URL, callback: Callback): void;
|
||||
/**
|
||||
* @param url The URL to request, either a String or a Object that return by url.parse.
|
||||
*/
|
||||
export function request(url: string | url.URL, options: RequestOptions, callback: Callback): void;
|
||||
|
||||
/**
|
||||
* Handle request with a callback.
|
||||
* @param url The URL to request, either a String or a Object that return by url.parse.
|
||||
*/
|
||||
export function requestWithCallback(url: string | url.URL, callback: Callback): void;
|
||||
/**
|
||||
* @param url The URL to request, either a String or a Object that return by url.parse.
|
||||
*/
|
||||
export function requestWithCallback(url: string | url.URL, options: RequestOptions, callback: Callback): void;
|
||||
|
||||
/**
|
||||
* yield urllib.requestThunk(url, args)
|
||||
* @param url The URL to request, either a String or a Object that return by url.parse.
|
||||
*/
|
||||
export function requestThunk(url: string | url.URL, options?: RequestOptions): (callback: (...args: any[]) => void) => void;
|
||||
|
||||
/**
|
||||
* alias to request.
|
||||
* Handle all http request, both http and https support well.
|
||||
*
|
||||
* @example
|
||||
* // GET http://httptest.cnodejs.net
|
||||
* urllib.request('http://httptest.cnodejs.net/test/get', function(err, data, res) {});
|
||||
* // POST http://httptest.cnodejs.net
|
||||
* var args = { type: 'post', data: { foo: 'bar' } };
|
||||
* urllib.request('http://httptest.cnodejs.net/test/post', args, function(err, data, res) {});
|
||||
*
|
||||
* @param url The URL to request, either a String or a Object that return by url.parse.
|
||||
* @param options Optional, @see RequestOptions.
|
||||
*/
|
||||
export function curl(url: string | url.URL, options?: RequestOptions): Promise<any>;
|
||||
/**
|
||||
* @param url The URL to request, either a String or a Object that return by url.parse.
|
||||
*/
|
||||
export function curl(url: string | url.URL, callback: Callback): void;
|
||||
/**
|
||||
* @param url The URL to request, either a String or a Object that return by url.parse.
|
||||
*/
|
||||
export function curl(url: string | url.URL, options: RequestOptions, callback: Callback): void;
|
||||
/**
|
||||
* The default request timeout(in milliseconds).
|
||||
*/
|
||||
export const TIMEOUT: number;
|
||||
/**
|
||||
* The default request & response timeout(in milliseconds).
|
||||
*/
|
||||
export const TIMEOUTS: [number, number];
|
||||
|
||||
/**
|
||||
* Request user agent.
|
||||
*/
|
||||
export const USER_AGENT: string;
|
||||
|
||||
/**
|
||||
* Request http agent.
|
||||
*/
|
||||
export const agent: http.Agent;
|
||||
|
||||
/**
|
||||
* Request https agent.
|
||||
*/
|
||||
export const httpsAgent: https.Agent;
|
||||
|
||||
export class HttpClient extends EventEmitter {
|
||||
constructor(options?: RequestOptions);
|
||||
|
||||
request(url: string | url.URL, callback: Callback): void;
|
||||
request(url: string | url.URL, options: RequestOptions, callback: Callback): void;
|
||||
|
||||
curl(url: string | url.URL, callback: Callback): void;
|
||||
curl(url: string | url.URL, options: RequestOptions, callback: Callback): void;
|
||||
|
||||
requestThunk(url: string | url.URL, options?: RequestOptions): (callback: (...args: any[]) => void) => void;
|
||||
}
|
||||
|
||||
/**
|
||||
* request method only return a promise,
|
||||
* compatible with async/await and generator in co.
|
||||
*/
|
||||
export class HttpClient2 extends EventEmitter {
|
||||
constructor(options?: RequestOptions);
|
||||
|
||||
request(url: string | url.URL, options?: RequestOptions): Promise<any>;
|
||||
|
||||
curl(url: string | url.URL, options?: RequestOptions): Promise<any>;
|
||||
|
||||
requestThunk(url: string | url.URL, options?: RequestOptions): (callback: (...args: any[]) => void) => void;
|
||||
}
|
||||
|
||||
/**
|
||||
* Create a HttpClient instance.
|
||||
*/
|
||||
export function create(options?: RequestOptions): HttpClient;
|
||||
@@ -1,24 +0,0 @@
|
||||
{
|
||||
"compilerOptions": {
|
||||
"module": "commonjs",
|
||||
"lib": [
|
||||
"es6"
|
||||
],
|
||||
"noImplicitAny": true,
|
||||
"noImplicitThis": true,
|
||||
"strictNullChecks": true,
|
||||
"strictFunctionTypes": true,
|
||||
"esModuleInterop": true,
|
||||
"baseUrl": "../",
|
||||
"typeRoots": [
|
||||
"../"
|
||||
],
|
||||
"types": [],
|
||||
"noEmit": true,
|
||||
"forceConsistentCasingInFileNames": true
|
||||
},
|
||||
"files": [
|
||||
"index.d.ts",
|
||||
"urllib-tests.ts"
|
||||
]
|
||||
}
|
||||
@@ -1,3 +0,0 @@
|
||||
{
|
||||
"extends": "dtslint/dt.json"
|
||||
}
|
||||
@@ -1,8 +0,0 @@
|
||||
import * as urllib from "urllib";
|
||||
|
||||
urllib.curl('https://example.test.com', {
|
||||
method: "GET",
|
||||
data: {
|
||||
test: 'test',
|
||||
}
|
||||
});
|
||||
Reference in New Issue
Block a user