From b27afe8334fde2a5a0af2fe93d61065e0932be51 Mon Sep 17 00:00:00 2001 From: Kharazyan Aram Date: Sat, 14 Oct 2023 11:12:05 +0400 Subject: [PATCH] fix(propEq): improve propEq typings * remove unnecessary constraint from propEq value: the function should receive any type values of object, no matter what parameter it received; * add additional types to use with placeholder --- test/anyPass.test.ts | 2 +- test/propEq.test.ts | 35 ++++++++++++++++++++++++----------- types/propEq.d.ts | 33 ++++++++++++++++++++++++++++----- 3 files changed, 53 insertions(+), 17 deletions(-) diff --git a/test/anyPass.test.ts b/test/anyPass.test.ts index ff46aa58..b3f96319 100644 --- a/test/anyPass.test.ts +++ b/test/anyPass.test.ts @@ -25,7 +25,7 @@ expectType( }) ); -expectError( +expectType( isVampire({ age: 21, garlic_allergy: true, diff --git a/test/propEq.test.ts b/test/propEq.test.ts index dc5b9098..f64c8121 100644 --- a/test/propEq.test.ts +++ b/test/propEq.test.ts @@ -1,6 +1,6 @@ import { expectError, expectType } from 'tsd'; -import { propEq } from '../es'; +import {__, propEq} from '../es'; type Obj = { union: 'foo' | 'bar'; @@ -12,28 +12,41 @@ type Obj = { // propEq(val, name, obj) expectType(propEq('foo', 'union', {} as Obj)); -// non-union string fails -expectError(propEq('nope', 'union', {} as Obj)); -// completely different type fails -expectError(propEq(2, 'union', {} as Obj)); +// propEq doesn't create unnecessary values constraint for object +expectType(propEq(1, 'union', {} as Obj)); +// unknown field names fails +expectError(propEq('foo', 'unknown', {} as Obj)); // propEq(val)(name)(obj) expectType(propEq('foo')('union')({} as Obj)); // 'nope' is inferred as 'string' here. expectType(propEq('nope')('union')({} as Obj)); -// completely different type fails -expectError(propEq(2)('union')({} as Obj)); +// unknown field names fails +expectError(propEq('foo')('unknown')({} as Obj)); // propEq(val)(name), obj) expectType(propEq('foo')('union', {} as Obj)); // 'nope' is inferred as 'string' here. expectType(propEq('nope')('union', {} as Obj)); -// completely different type fails -expectError(propEq(2)('union', {} as Obj)); +// unknown field names fails +expectError(propEq('foo')('unknown', {} as Obj)); // propEq(val, name)(obj) expectType(propEq('foo', 'union')({} as Obj)); // 'nope' is inferred as 'string' here. expectType(propEq('nope', 'union')({} as Obj)); -// completely different type fails -expectError(propEq(2, 'union')({} as Obj)); +// unknown field names fails +expectError(propEq('foo', 'unknown')({} as Obj)); + +// propEq(__, name, obj)(val) +expectType(propEq(__, 'union', {} as Obj)('foo')); +// propEq(val, __, obj)(val) +expectType(propEq('foo', __, {} as Obj)('union')); +// propEq(__, __, obj)(val, name) +expectType(propEq(__, __, {} as Obj)('foo', 'union')); +// propEq(__, __, obj)(val)(name) +expectType(propEq(__, __, {} as Obj)('foo')('union')); + +expectError(propEq('foo', __, {} as Obj)('unknown')); +expectError(propEq(__, __, {} as Obj)('foo', 'unknown')); +expectError(propEq(__, __, {} as Obj)('foo')('unknown')); diff --git a/types/propEq.d.ts b/types/propEq.d.ts index e667fb28..9ce99c5f 100644 --- a/types/propEq.d.ts +++ b/types/propEq.d.ts @@ -1,6 +1,29 @@ -export function propEq(val: T): { - (name: K): (obj: Record) => boolean; - (name: K, obj: Record): boolean; +import { Placeholder } from 'ramda'; + +export function propEq(__: Placeholder): never; +export function propEq(val: V): { + (name: K): (obj: Record) => boolean; + >(__: Placeholder, obj: U): (name: keyof U) => boolean; + >(name: K, obj: U): boolean; }; -export function propEq(val: T, name: K): (obj: Record) => boolean; -export function propEq(val: U[K], name: K, obj: U): boolean; +export function propEq(__: Placeholder, name: K): { + (__: Placeholder, obj: Record): (val: V) => boolean; + (val: V, obj: Record): boolean + (val: V): (obj: Record) => boolean +}; +export function propEq(val: V, name: K): (obj: Record) => boolean; + + +export function propEq>(__: Placeholder, ___: Placeholder, obj: U): { + (__: Placeholder, name: keyof U): (__: Placeholder) => boolean; + (__: Placeholder, name: keyof U): (val: V) => boolean; + (val: V, name: keyof U): boolean; + (val: Placeholder): never; + (val: V): (name: keyof U) => boolean; +}; +export function propEq(__: Placeholder, name: K, obj: Record): { + (val: Placeholder): never; + (val: V): boolean; +}; +export function propEq>(val: V, __: Placeholder, obj: U): (name: keyof U) => boolean; +export function propEq>(val: V, name: keyof U, obj: U): boolean;