iSharkFly-Docs
/
angular-docs-cn
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

fix(common): let `KeyValuePipe` accept type unions with `null` (#36093) 

`KeyValuePipe` currently accepts `null` values as well as `Map`s and a
few others. However, due to the way in which TS overloads work, a type
of `T|null` will not be accepted by `KeyValuePipe`'s signatures, even
though both `T` and `null` individually would be.

To make this work, each signature that accepts some type `T` has been
duplicated with a second one below it that accepts a `T|null` and
includes `null` in its return type.

Fixes #35743

PR Close #36093
This commit is contained in:
JoostK 2020-03-16 22:48:45 +01:00 committed by Misko Hevery
parent b8e9a30d3b
commit d783519835
3 changed files with 33 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
goldens/public-api/common/common.d.ts vendored
View File

@ -139,10 +139,17 @@ export declare class KeyValuePipe implements PipeTransform {
transform<V>(input: { transform<V>(input: {
[key: string]: V; [key: string]: V;
} | Map<string, V>, compareFn?: (a: KeyValue<string, V>, b: KeyValue<string, V>) => number): Array<KeyValue<string, V>>; } | Map<string, V>, compareFn?: (a: KeyValue<string, V>, b: KeyValue<string, V>) => number): Array<KeyValue<string, V>>;
transform<V>(input: {
[key: string]: V;
} | Map<string, V> | null, compareFn?: (a: KeyValue<string, V>, b: KeyValue<string, V>) => number): Array<KeyValue<string, V>> | null;
transform<V>(input: { transform<V>(input: {
[key: number]: V; [key: number]: V;
} | Map<number, V>, compareFn?: (a: KeyValue<number, V>, b: KeyValue<number, V>) => number): Array<KeyValue<number, V>>; } | Map<number, V>, compareFn?: (a: KeyValue<number, V>, b: KeyValue<number, V>) => number): Array<KeyValue<number, V>>;
transform<V>(input: {
[key: number]: V;
} | Map<number, V> | null, compareFn?: (a: KeyValue<number, V>, b: KeyValue<number, V>) => number): Array<KeyValue<number, V>> | null;
transform<K, V>(input: Map<K, V>, compareFn?: (a: KeyValue<K, V>, b: KeyValue<K, V>) => number): Array<KeyValue<K, V>>; transform<K, V>(input: Map<K, V>, compareFn?: (a: KeyValue<K, V>, b: KeyValue<K, V>) => number): Array<KeyValue<K, V>>;
transform<K, V>(input: Map<K, V> | null, compareFn?: (a: KeyValue<K, V>, b: KeyValue<K, V>) => number): Array<KeyValue<K, V>> | null;
} }
export declare class Location { export declare class Location {

11
packages/common/src/pipes/keyvalue_pipe.ts
View File

@ -55,12 +55,23 @@ export class KeyValuePipe implements PipeTransform {
input: {[key: string]: V}|Map<string, V>, input: {[key: string]: V}|Map<string, V>,
compareFn?: (a: KeyValue<string, V>, b: KeyValue<string, V>) => number): compareFn?: (a: KeyValue<string, V>, b: KeyValue<string, V>) => number):
Array<KeyValue<string, V>>; Array<KeyValue<string, V>>;
transform<V>(
input: {[key: string]: V}|Map<string, V>|null,
compareFn?: (a: KeyValue<string, V>, b: KeyValue<string, V>) => number):
Array<KeyValue<string, V>>|null;
transform<V>( transform<V>(
input: {[key: number]: V}|Map<number, V>, input: {[key: number]: V}|Map<number, V>,
compareFn?: (a: KeyValue<number, V>, b: KeyValue<number, V>) => number): compareFn?: (a: KeyValue<number, V>, b: KeyValue<number, V>) => number):
Array<KeyValue<number, V>>; Array<KeyValue<number, V>>;
transform<V>(
input: {[key: number]: V}|Map<number, V>|null,
compareFn?: (a: KeyValue<number, V>, b: KeyValue<number, V>) => number):
Array<KeyValue<number, V>>|null;
transform<K, V>(input: Map<K, V>, compareFn?: (a: KeyValue<K, V>, b: KeyValue<K, V>) => number): transform<K, V>(input: Map<K, V>, compareFn?: (a: KeyValue<K, V>, b: KeyValue<K, V>) => number):
Array<KeyValue<K, V>>; Array<KeyValue<K, V>>;
transform<K, V>(
input: Map<K, V>|null,
compareFn?: (a: KeyValue<K, V>, b: KeyValue<K, V>) => number): Array<KeyValue<K, V>>|null;
transform<K, V>( transform<K, V>(
input: null|{[key: string]: V, [key: number]: V}|Map<K, V>, input: null|{[key: string]: V, [key: number]: V}|Map<K, V>,
compareFn: (a: KeyValue<K, V>, b: KeyValue<K, V>) => number = defaultComparator): compareFn: (a: KeyValue<K, V>, b: KeyValue<K, V>) => number = defaultComparator):

15
packages/common/test/pipes/keyvalue_pipe_spec.ts
View File

@ -63,6 +63,16 @@ describe('KeyValuePipe', () => {
const transform2 = pipe.transform({1: 3}); const transform2 = pipe.transform({1: 3});
expect(transform1 !== transform2).toEqual(true); expect(transform1 !== transform2).toEqual(true);
}); });
it('should accept a type union of an object with string keys and null', () => {
let value !: {[key: string]: string} | null;
const pipe = new KeyValuePipe(defaultKeyValueDiffers);
expect(pipe.transform(value)).toEqual(null);
});
it('should accept a type union of an object with number keys and null', () => {
let value !: {[key: number]: string} | null;
const pipe = new KeyValuePipe(defaultKeyValueDiffers);
expect(pipe.transform(value)).toEqual(null);
});
}); });
describe('Map', () => { describe('Map', () => {
@ -115,6 +125,11 @@ describe('KeyValuePipe', () => {
const transform2 = pipe.transform(new Map([[1, 3]])); const transform2 = pipe.transform(new Map([[1, 3]]));
expect(transform1 !== transform2).toEqual(true); expect(transform1 !== transform2).toEqual(true);
}); });
it('should accept a type union of a Map and null', () => {
let value !: Map<number, number>| null;
const pipe = new KeyValuePipe(defaultKeyValueDiffers);
expect(pipe.transform(value)).toEqual(null);
});
}); });
}); });