vhad/DefinitelyTyped
1
0
Fork 0
mirror of https://github.com/gosticks/DefinitelyTyped.git synced 2026-08-12 04:50:18 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Activate strictNullChecks

Browse Source
This commit is contained in:
denis
2018-09-01 12:57:24 +02:00
parent 2025fc00e6
commit a9fd158150
4 changed files with 276 additions and 38 deletions
Download Patch File Download Diff File Expand all files Collapse all files
types/d3-request/d3-request-tests.ts
+25 -22
View File
@@ -36,13 +36,13 @@ interface ResponseDatumPOST {
success: boolean;
}
let listenerXhr: (this: d3Request.Request, xhr: XMLHttpRequest) => void;
let listenerXhr: ((this: d3Request.Request, xhr: XMLHttpRequest) => void) | undefined;
let listenerProgress: (this: d3Request.Request, progEvent: ProgressEvent) => void;
let listenerProgress: ((this: d3Request.Request, progEvent: ProgressEvent) => void) | undefined;
let listenerError: (this: d3Request.Request, error: any) => void;
let listenerError: ((this: d3Request.Request, error: any) => void) | undefined;
let listenerResult: (this: d3Request.Request, result: ResponseDatumGET[]) => void;
let listenerResult: ((this: d3Request.Request, result: ResponseDatumGET[]) => void) | undefined;
// -------------------------------------------------------------------------------
// Generic Request
@@ -108,7 +108,7 @@ const r7: d3Request.Request = request.header('Accept-Encoding', null);
// Mime Type -------------------------------------------------------------------
// get
let mimeType: string = request.mimeType();
let mimeType: string | null = request.mimeType();
// set
const r8: d3Request.Request = request.mimeType('application/json');
// remove
@@ -162,11 +162,12 @@ r10 = r10.on('load', function(result: ResponseDatumGET[]) {
// do something;
});
// r10 = r10.on<ResponseDatumGET[]>('load', function(result: number) { // fails, wrong argument type for callback
// const that: d3Request.Request = this;
// const res: number = result;
// // do something;
// });
// $ExpectError
r10 = r10.on<ResponseDatumGET[]>('load', function(result: number) { // fails, wrong argument type for callback
const that: d3Request.Request = this;
const res: number = result;
// do something;
});
listenerResult = r10.on<ResponseDatumGET[]>('load');
@@ -191,9 +192,10 @@ listenerError = r10.on('error.foo');
// Password ---------------------------------------------------------------------
// get
const password: string = request.password();
const password: string | null = request.password();
// set
const r11: d3Request.Request = request.password('MyPassword');
const r25: d3Request.Request = request.password(null);
// Post -------------------------------------------------------------------------
@@ -238,11 +240,11 @@ const r16: d3Request.Request = d3Request.request(url)
// ResponseType -----------------------------------------------------------------
// get
const responseType: string = d3Request.request(url)
const responseType: XMLHttpRequestResponseType | undefined = d3Request.request(url)
.responseType();
// set
const r17: d3Request.Request = d3Request.request(url)
.responseType('application/json');
.responseType('json');
// Send ------------------------------------------------------------------------
@@ -259,7 +261,7 @@ const r20: d3Request.Request = d3Request.request(url)
.response(xhr2Listing)
.send<ResponseDatumGET[]>('GET', (error, response) => {
if (!error) {
const r: ResponseDatumGET[] = response;
const r: ResponseDatumGET[] | null = response;
console.log(r);
}
});
@@ -269,7 +271,7 @@ const r21: d3Request.Request = d3Request.request(url)
.response(xhr2Listing)
.send<RequestDatumGET, ResponseDatumGET[]>('GET', { kind: 'Listing' }, (error, response) => {
if (!error) {
const r: ResponseDatumGET[] = response;
const r: ResponseDatumGET[] | null = response;
console.log(r);
}
});
@@ -286,9 +288,10 @@ const r22: d3Request.Request = d3Request.request(url)
// User----------------------------------------------------------------------------
// get
const user: string = request.user();
const user: string | null = request.user();
// set
const r23: d3Request.Request = request.user('User');
const r24: d3Request.Request = request.user(null);
// -------------------------------------------------------------------------------
// HTML Request
@@ -360,8 +363,8 @@ const csvRequestWithRowWithCallback: d3Request.DsvRequest = d3Request.csv<Respon
const i: number = index;
const cols: string[] = columns;
const mappedRow: ResponseDatumGET = {
test: rr['test'],
value: +rr['value']
test: rr['test']!,
value: +rr['value']!
};
return mappedRow;
},
@@ -394,8 +397,8 @@ const tsvRequestWithRowWithCallback: d3Request.DsvRequest = d3Request.tsv<Respon
const i: number = index;
const cols: string[] = columns;
const mappedRow: ResponseDatumGET = {
test: rr['test'],
value: +rr['value']
test: rr['test']!,
value: +rr['value']!
};
return mappedRow;
},
@@ -418,8 +421,8 @@ csvRequest = csvRequest
const i: number = index;
const cols: string[] = columns;
const mappedRow: ResponseDatumGET = {
test: rr['test'],
value: +rr['value']
test: rr['test']!,
value: +rr['value']!
};
return mappedRow;
});
types/d3-request/index.d.ts
Vendored
+248 -11
View File
@@ -1,94 +1,331 @@
// Type definitions for D3JS d3-request module 1.0
// Project: https://github.com/d3/d3-request/
// Definitions by: Hugues Stefanski <https://github.com/Ledragon>, Alex Ford <https://github.com/gustavderdrache>, Boris Yankov <https://github.com/borisyankov>, Tom Wanzek <https://github.com/tomwanzek>
// Definitions by: Hugues Stefanski <https://github.com/Ledragon>
// Alex Ford <https://github.com/gustavderdrache>
// Boris Yankov <https://github.com/borisyankov>
// Tom Wanzek <https://github.com/tomwanzek>
// denisname <https://github.com/denisname>
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
// TypeScript Version: 2.3
// Last module patch version validated against: 1.0.2
// Last module patch version validated against: 1.0.6
import { DSVParsedArray, DSVRowString, DSVRowAny } from 'd3-dsv';
export interface Request {
/**
* Aborts this request, if it is currently in-flight, and returns this request instance.
* See XMLHttpRequest’s abort.
*/
abort(): this;
/**
* Equivalent to `request.send` with the GET method: `request.send("GET")`.
*/
get(): this;
/**
* Equivalent to `request.send` with the GET method: `request.send("GET", data)`.
*/
get<RequestData>(data: RequestData): this;
/**
* Equivalent to `request.send` with the GET method: `request.send("GET", callback)`.
*/
get<ResponseData>(callback: (error: any, d: ResponseData) => void): this;
/**
* Equivalent to `request.send` with the GET method: `request.send("GET", data, callback)`.
*/
get<RequestData, ResponseData>(data: RequestData, callback: (error: any, d: ResponseData) => void): this;
/**
* Returns the current value of the request header with the specified name.
* Header names are case-insensitive.
*/
header(name: string): string;
/**
* Sets the request header with the specified name to the specified value and returns this request instance.
* If value is null, removes the request header with the specified name instead.
* Header names are case-insensitive.
*
* Request headers can only be modified before the request is sent.
* Therefore, you cannot pass a callback to the request constructor if you wish to specify a header;
* use `request.get` or similar instead.
*/
header(name: string, value: string | null): this;
/**
* Returns the current mime type, which defaults to null.
*/
mimeType(): string | null;
/**
* Sets the request mime type to the specified value and returns this request instance.
* If type is null, clears the current mime type (if any) instead.
*
* The mime type is used to both set the "Accept" request header and for `overrideMimeType`, where supported.
*
* The request mime type can only be modified before the request is sent.
* Therefore, you cannot pass a callback to the request constructor if you wish to override the mime type;
* use `request.get` or similar instead.
*/
mimeType(value: string | null): this;
on(type: 'beforesend'): (this: this, xhr: XMLHttpRequest) => void;
on(type: 'progress'): (this: this, progressEvent: ProgressEvent) => void;
on(type: 'error'): (this: this, error: any) => void;
on<ResponseData>(type: 'load'): (this: this, data: ResponseData) => void;
on(type: string): (this: this, data: any) => void;
/**
* Returns the currently-assigned listener for the "beforesend" type, if any.
*/
on(type: 'beforesend'): ((this: this, xhr: XMLHttpRequest) => void) | undefined;
/**
* Returns the currently-assigned listener for the "progress" type, if any.
*/
on(type: 'progress'): ((this: this, progressEvent: ProgressEvent) => void) | undefined;
/**
* Returns the currently-assigned listener for the "error" type, if any.
*/
on(type: 'error'): ((this: this, error: any) => void) | undefined;
/**
* Returns the currently-assigned listener for the "load" type, if any.
*/
on<ResponseData>(type: 'load'): ((this: this, data: ResponseData) => void) | undefined;
/**
* Returns the currently-assigned listener for the specified type, if any.
*/
on(type: string): ((this: this, data: any) => void) | undefined;
/**
* Removes the current event listener for the specified type, if any.
*/
on(type: string, listener: null): this;
/**
* Sets the event listener for the "beforesend" type,
* to allow custom headers and the like to be set before the request is sent,
* and returns this request instance.
*
* If an event listener was already registered for the same type, the existing listener is removed before the new listener is added.
* To register multiple listeners for the same type, the type may be followed by an optional name, such as `beforesend.foo`. See d3-dispatch for details.
*/
on(type: 'beforesend', listener: (this: this, xhr: XMLHttpRequest) => void): this;
/**
* Sets the event listener for the "progress" type,
* to monitor the progress of the request,
* and returns this request instance.
*
* If an event listener was already registered for the same type, the existing listener is removed before the new listener is added.
* To register multiple listeners for the same type, the type may be followed by an optional name, such as `progress.foo`. See d3-dispatch for details.
*/
on(type: 'progress', listener: (this: this, progressEvent: ProgressEvent) => void): this;
/**
* Sets the event listener for the "error" type,
* when the request completes unsuccessfully; this includes 4xx and 5xx response codes,
* and returns this request instance.
*
* If an event listener was already registered for the same type, the existing listener is removed before the new listener is added.
* To register multiple listeners for the same type, the type may be followed by an optional name, such as `error.foo`. See d3-dispatch for details.
*/
on(type: 'error', listener: (this: this, error: any) => void): this;
/**
* Sets the event listener for the "load" type,
* when the request completes successfully,
* and returns this request instance.
*
* If an event listener was already registered for the same type, the existing listener is removed before the new listener is added.
* To register multiple listeners for the same type, the type may be followed by an optional name, such as `load.foo`. See d3-dispatch for details.
*/
on<ResponseData>(type: 'load', listener: (this: this, data: ResponseData) => void): this;
/**
* Sets the event listener for the specified type,
* and returns this request instance.
*
* The type must be one of the following: "beforesend", "progress", "load", "error".
*
* If an event listener was already registered for the same type, the existing listener is removed before the new listener is added.
* To register multiple listeners for the same type, the type may be followed by an optional name, such as `load.foo`. See d3-dispatch for details.
*/
on(type: string, listener: (this: this, data: any) => void): this;
/**
* Returns the current password, which defaults to null.
*/
password(): string | null;
password(value: string): this;
/**
* Sets the password for authentication to the specified string and returns this request instance.
*/
password(value: string | null): this;
/**
* Equivalent to `request.send` with the POST method: `request.send("POST")`.
*/
post(): this;
/**
* Equivalent to `request.send` with the POST method: `request.send("POST", data)`.
*/
post<RequestData>(data: RequestData): this;
/**
* Equivalent to `request.send` with the POST method: `request.send("POST", callback)`.
*/
post<ResponseData>(callback: (this: this, error: any, d: ResponseData) => void): this;
/**
* Equivalent to `request.send` with the POST method: `request.send("POST", data, callback)`.
*/
post<RequestData, ResponseData>(data: RequestData, callback: (this: this, error: any, d: ResponseData) => void): this;
/**
* Sets the response value function to the specified function and returns this request instance.
* The response value function is used to map the response XMLHttpRequest object to a useful data value.
* See the convenience methods `json` and `text` for examples.
*/
response<ResponseData>(callback: (this: this, response: XMLHttpRequest) => ResponseData): this;
responseType(): string | null;
responseType(value: string): this;
/**
* Returns the current response type, which defaults to `` (the empty string).
*/
responseType(): XMLHttpRequestResponseType | undefined;
/**
* Sets the response type attribute of the request and returns this request instance. Typical values are: `` (the empty string), `arraybuffer`, `blob`, `document`, and `text`.
*/
responseType(value: XMLHttpRequestResponseType): this;
/**
* Issues this request using the specified method (such as GET or POST).
*
* The listeners "load" and "error" should be registered via `request.on`.
*/
send(method: string): this;
/**
* Issues this request using the specified method (such as GET or POST), posting the specified data in the request body, and returns this request instance.
*
* The listeners "load" and "error" should be registered via `request.on`.
*/
send<RequestData>(method: string, data: RequestData): this;
/**
* Issues this request using the specified method (such as GET or POST) and returns this request instance.
* The callback will be invoked asynchronously when the request succeeds or fails.
* The callback is invoked with two arguments: the error, if any, and the response value.
* The response value is undefined if an error occurs.
*/
send<ResponseData>(method: string, callback: (this: this, error: any | null, d: ResponseData | null) => void): this;
/**
* Issues this request using the specified method (such as GET or POST), posting the specified data in the request body, and returns this request instance.
* The callback will be invoked asynchronously when the request succeeds or fails.
* The callback is invoked with two arguments: the error, if any, and the response value.
* The response value is undefined if an error occurs.
*/
send<RequestData, ResponseData>(method: string, data: RequestData, callback: (this: this, error: any | null, d: ResponseData | null) => void): this;
/**
* Returns the current response timeout, which defaults to 0.
*/
timeout(): number;
/**
* Sets the timeout attribute of the request to the specified number of milliseconds and returns this request instance.
*/
timeout(value: number): this;
/**
* Returns the current user name, which defaults to null.
*/
user(): string | null;
user(value: string): this;
/**
* Sets the user name for authentication to the specified string and returns this request instance.
*/
user(value: string | null): this;
}
export interface DsvRequest extends Request {
row<ParsedRow extends DSVRowAny>(value: (rawRow: DSVRowString, index: number, columns: string[]) => ParsedRow): DsvRequest;
}
/**
* Returns a new request for the CSV file at the specified url with the default mime type `text/csv`.
*/
export function csv(url: string): DsvRequest;
/**
* Returns a new request for the CSV file at the specified url with the default mime type `text/csv`.
* And send a GET request.
*/
export function csv(url: string, callback: (this: DsvRequest, error: any, d: DSVParsedArray<DSVRowString>) => void): DsvRequest;
/**
* Returns a new request for the CSV file at the specified url with the default mime type `text/csv`.
* And send a GET request.
* Use a row conversion function to map and filter row objects to a more-specific representation; see `dsv.parse` for details.
*/
export function csv<ParsedRow extends DSVRowAny>(
url: string,
row: (rawRow: DSVRowString, index: number, columns: string[]) => ParsedRow,
callback: (this: DsvRequest, error: any, d: DSVParsedArray<ParsedRow>) => void
): DsvRequest;
/**
* Returns a new request for the HTML file at the specified url with the default mime type `text/html`. The HTML file is returned as a document fragment.
*/
export function html(url: string): Request;
/**
* Returns a new request for the HTML file at the specified url with the default mime type `text/html`. The HTML file is returned as a document fragment.
* And send a GET request.
*/
export function html(url: string, callback: (this: Request, error: any, d: DocumentFragment) => void): Request;
/**
* Returns a new request to get the JSON file at the specified url with the default mime type `application/json`.
*/
export function json(url: string): Request;
/**
* Returns a new request to get the JSON file at the specified url with the default mime type `application/json`.
* And send a GET request.
*/
export function json<ParsedObject extends { [key: string]: any }>(url: string, callback: (this: Request, error: any, d: ParsedObject) => void): Request;
/**
* Returns a new request for specified url. The returned request is not yet sent and can be further configured.
*
* See `d3.json`, `d3.csv`, `d3.tsv`, `d3.text`, `d3.html` and `d3.xml` for content-specific convenience constructors.
*/
export function request(url: string): Request;
/**
* Returns a new request for specified url. It is equivalent to calling `request.get` immediately after construction: `d3.request(url).get(callback)`.
* And send a GET request.
*
* If you wish to specify a request header or a mime type, you must not specify a callback to the constructor.
* Use `request.header` or `request.mimeType` followed by `request.get` instead.
*
* See `d3.json`, `d3.csv`, `d3.tsv`, `d3.text`, `d3.html` and `d3.xml` for content-specific convenience constructors.
*/
export function request(url: string, callback: (this: Request, error: any, d: XMLHttpRequest) => void): Request;
/**
* Returns a new request to get the text file at the specified url with the default mime type `text/plain`.
*/
export function text(url: string): Request;
/**
* Returns a new request to get the text file at the specified url with the default mime type `text/plain`.
* And send a GET request.
*/
export function text(url: string, callback: (this: Request, error: any, d: string) => void): Request;
/**
* Returns a new request for a TSV file at the specified url with the default mime type `text/tab-separated-values`.
*/
export function tsv(url: string): DsvRequest;
/**
* Returns a new request for a TSV file at the specified url with the default mime type `text/tab-separated-values`.
* And send a GET request.
*/
export function tsv(url: string, callback: (this: DsvRequest, error: any, d: DSVParsedArray<DSVRowString>) => void): DsvRequest;
/**
* Returns a new request for a TSV file at the specified url with the default mime type `text/tab-separated-values`.
* And send a GET request.
* Use a row conversion function to map and filter row objects to a more-specific representation; see `dsv.parse` for details.
*/
export function tsv<ParsedRow extends DSVRowAny>(
url: string,
row: (rawRow: DSVRowString, index: number, columns: string[]) => ParsedRow,
callback: (this: DsvRequest, error: any, d: DSVParsedArray<ParsedRow>) => void
): DsvRequest;
/**
* Returns a new request to get the XML file at the specified url with the default mime type `application/xml`.
*/
export function xml(url: string): Request;
/**
* Returns a new request to get the XML file at the specified url with the default mime type `application/xml`.
* And send a GET request.
*/
export function xml(url: string, callback: (this: Request, error: any, d: any) => void): Request;
types/d3-request/tsconfig.json
+2 -2
View File
@@ -6,8 +6,8 @@
"dom"
],
"noImplicitAny": true,
"noImplicitThis": false,
"strictNullChecks": false,
"noImplicitThis": true,
"strictNullChecks": true,
"strictFunctionTypes": false,
"baseUrl": "../",
"typeRoots": [
types/d3-request/tslint.json
+1 -3
View File
@@ -3,9 +3,7 @@
"rules": {
// TODOs
"no-any-union": false,
"no-this-assignment": false,
"no-unnecessary-generics": false,
"unified-signatures": false,
"max-line-length": [false, 145]
"unified-signatures": false
}
}