deprecate hasOwnProperty in favour of has

gcanti · Mar 2, 2021 · 281dc29 · 281dc29
1 parent de69ce5
commit 281dc29
Show file tree

Hide file tree

Showing 7 changed files with 94 additions and 28 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -25,7 +25,7 @@ high state of flux, you're at risk of it changing without notice.
   - `Applicative`
     - deprecate `getApplicativeComposition`, use `ap` helper instead
   - `Array`
-    - deprecate `prependToAll`, use `prependAll`
+    - deprecate `prependToAll`, use `prependAll` instead
   - `BooleanAlgebra`
     - deprecate `booleanAlgebraBoolean`, use `boolean.BooleanAlgebra` instead
     - deprecate `getFunctionBooleanAlgebra`, use `function.getBooleanAlgebra` instead
@@ -88,7 +88,7 @@ high state of flux, you're at risk of it changing without notice.
     - deprecate `getTupleMonoid`, use `tuple` instead
   - `NonEmptyArray`
     - deprecate `fold`, use `concatAll` instead
-    - deprecate `prependToAll`, use `prependAll`
+    - deprecate `prependToAll`, use `prependAll` instead
   - `Option`
     - deprecate `getApplySemigroup` in favour of `Apply.getApplySemigroup`
     - deprecate `getApplyMonoid` in favour of `Applicative.getApplicativeMonoid`
@@ -128,10 +128,14 @@ high state of flux, you're at risk of it changing without notice.
   - `ReaderTaskEither`
     - deprecate `run`
   - `ReadonlyArray`
-    - deprecate `prependToAll`, use `prependAll`
+    - deprecate `prependToAll`, use `prependAll` instead
   - `ReadonlyNonEmptyArray`
     - deprecate `fold`, use `concatAll` instead
-    - deprecate `prependToAll`, use `prependAll`
+    - deprecate `prependToAll`, use `prependAll` instead
+  - `ReadonlyRecord`
+    - deprecate `hasOwnProperty`, use `has` instead
+  - `Record`
+    - deprecate `hasOwnProperty`, use `has` instead
   - `Ring`
     - deprecate `getTupleRing`, use `tuple` instead
   - `Semigroup`

diff --git a/docs/modules/ReadonlyRecord.ts.md b/docs/modules/ReadonlyRecord.ts.md
@@ -69,7 +69,7 @@ Added in v2.5.0
   - [foldMapWithIndex](#foldmapwithindex)
   - [fromFoldable](#fromfoldable)
   - [fromFoldableMap](#fromfoldablemap)
-  - [hasOwnProperty (function)](#hasownproperty-function)
+  - [has](#has)
   - [isEmpty](#isempty)
   - [isSubrecord](#issubrecord)
   - [keys](#keys)
@@ -86,6 +86,7 @@ Added in v2.5.0
   - [traverse](#traverse)
   - [traverseWithIndex](#traversewithindex)
   - [updateAt](#updateat)
+  - [~~hasOwnProperty (function)~~](#hasownproperty-function)
 
 ---
 
@@ -744,15 +745,19 @@ assert.deepStrictEqual(
 
 Added in v2.5.0
 
-## hasOwnProperty (function)
+## has
+
+Test whether or not a key exists in a `ReadonlyRecord`.
+
+Note. This function is not pipeable because is a custom type guard.
 
 **Signature**
 
 ```ts
-export declare function hasOwnProperty<K extends string>(k: string, r: ReadonlyRecord<K, unknown>): k is K
+export declare const has: <K extends string>(k: string, r: Readonly<Record<K, unknown>>) => k is K
 ```
 
-Added in v2.5.0
+Added in v2.10.0
 
 ## isEmpty
 
@@ -1021,3 +1026,15 @@ export declare function updateAt<A>(
 ```
 
 Added in v2.5.0
+
+## ~~hasOwnProperty (function)~~
+
+Use `has` instead.
+
+**Signature**
+
+```ts
+export declare function hasOwnProperty<K extends string>(k: string, r: ReadonlyRecord<K, unknown>): k is K
+```
+
+Added in v2.5.0
diff --git a/docs/modules/Record.ts.md b/docs/modules/Record.ts.md
@@ -57,7 +57,7 @@ Added in v2.0.0
   - [getEq](#geteq)
   - [getMonoid](#getmonoid)
   - [getShow](#getshow)
-  - [hasOwnProperty (function)](#hasownproperty-function)
+  - [has](#has)
   - [insertAt](#insertat)
   - [isEmpty](#isempty)
   - [isSubrecord](#issubrecord)
@@ -80,6 +80,7 @@ Added in v2.0.0
   - [traverse](#traverse)
   - [traverseWithIndex](#traversewithindex)
   - [updateAt](#updateat)
+  - [~~hasOwnProperty (function)~~](#hasownproperty-function)
 
 ---
 
@@ -611,15 +612,19 @@ export declare const getShow: <A>(S: Show<A>) => Show<Record<string, A>>
 
 Added in v2.0.0
 
-## hasOwnProperty (function)
+## has
+
+Test whether or not a key exists in a `Record`.
+
+Note. This function is not pipeable because is a custom type guard.
 
 **Signature**
 
 ```ts
-export declare const hasOwnProperty: <K extends string>(k: string, r: Record<K, unknown>) => k is K
+export declare const has: <K extends string>(k: string, r: Record<K, unknown>) => k is K
 ```
 
-Added in v2.0.0
+Added in v2.10.0
 
 ## insertAt
 
@@ -947,3 +952,15 @@ export declare const updateAt: <A>(k: string, a: A) => <K extends string>(r: Rec
 ```
 
 Added in v2.0.0
+
+## ~~hasOwnProperty (function)~~
+
+Use `has` instead.
+
+**Signature**
+
+```ts
+export declare const hasOwnProperty: <K extends string>(k: string, r: Record<K, unknown>) => k is K
+```
+
+Added in v2.0.0
diff --git a/src/ReadonlyRecord.ts b/src/ReadonlyRecord.ts
@@ -160,14 +160,14 @@ export function insertAt<A>(k: string, a: A): (r: ReadonlyRecord<string, A>) =>
 
 const _hasOwnProperty = Object.prototype.hasOwnProperty
 
-// TODO: rename in v3 to avoid #1249
 /**
- * @since 2.5.0
+ * Test whether or not a key exists in a `ReadonlyRecord`.
+ *
+ * Note. This function is not pipeable because is a custom type guard.
+ *
+ * @since 2.10.0
  */
-export function hasOwnProperty<K extends string>(k: string, r: ReadonlyRecord<K, unknown>): k is K
-export function hasOwnProperty<K extends string>(this: any, k: string, r?: ReadonlyRecord<K, unknown>): k is K {
-  return _hasOwnProperty.call(r === undefined ? this : r, k)
-}
+export const has = <K extends string>(k: string, r: ReadonlyRecord<K, unknown>): k is K => _hasOwnProperty.call(r, k)
 
 /**
  * Delete a key and value from a map
@@ -197,7 +197,7 @@ export function updateAt<A>(
   a: A
 ): <K extends string>(r: ReadonlyRecord<K, A>) => Option<ReadonlyRecord<K, A>> {
   return <K extends string>(r: ReadonlyRecord<K, A>) => {
-    if (!hasOwnProperty(k, r)) {
+    if (!has(k, r)) {
       return none
     }
     if (r[k] === a) {
@@ -217,7 +217,7 @@ export function modifyAt<A>(
   f: (a: A) => A
 ): <K extends string>(r: ReadonlyRecord<K, A>) => Option<ReadonlyRecord<K, A>> {
   return <K extends string>(r: ReadonlyRecord<K, A>) => {
-    if (!hasOwnProperty(k, r)) {
+    if (!has(k, r)) {
       return none
     }
     const out: Record<K, A> = Object.assign({}, r)
@@ -1229,6 +1229,17 @@ export const Witherable: Witherable1<URI> = {
 // deprecated
 // -------------------------------------------------------------------------------------
 
+/**
+ * Use `has` instead.
+ *
+ * @since 2.5.0
+ * @deprecated
+ */
+export function hasOwnProperty<K extends string>(k: string, r: ReadonlyRecord<K, unknown>): k is K
+export function hasOwnProperty<K extends string>(this: any, k: string, r?: ReadonlyRecord<K, unknown>): k is K {
+  return _hasOwnProperty.call(r === undefined ? this : r, k)
+}
+
 /**
  * Use small, specific instances instead.
  *

diff --git a/src/Record.ts b/src/Record.ts
@@ -102,9 +102,13 @@ export function insertAt<A>(k: string, a: A): (r: Record<string, A>) => Record<s
 }
 
 /**
- * @since 2.0.0
+ * Test whether or not a key exists in a `Record`.
+ *
+ * Note. This function is not pipeable because is a custom type guard.
+ *
+ * @since 2.10.0
  */
-export const hasOwnProperty: <K extends string>(k: string, r: Record<K, unknown>) => k is K = RR.hasOwnProperty
+export const has: <K extends string>(k: string, r: Record<K, unknown>) => k is K = RR.has
 
 /**
  * Delete a key and value from a map
@@ -783,6 +787,14 @@ export const Witherable: Witherable1<URI> = {
 // deprecated
 // -------------------------------------------------------------------------------------
 
+/**
+ * Use `has` instead.
+ *
+ * @since 2.0.0
+ * @deprecated
+ */
+export const hasOwnProperty: <K extends string>(k: string, r: Record<K, unknown>) => k is K = RR.has
+
 /**
  * Use small, specific instances instead.
  *

diff --git a/test/ReadonlyRecord.ts b/test/ReadonlyRecord.ts
@@ -386,12 +386,17 @@ describe('ReadonlyRecord', () => {
     U.deepStrictEqual(_.singleton('a', 1), { a: 1 })
   })
 
-  it('hasOwnProperty', () => {
+  it('has', () => {
     const x: _.ReadonlyRecord<string, number> = { a: 1 }
-    U.deepStrictEqual(_.hasOwnProperty('a', x), true)
-    U.deepStrictEqual(_.hasOwnProperty('b', x), false)
+    U.deepStrictEqual(_.has('a', x), true)
+    U.deepStrictEqual(_.has('b', x), false)
     // TODO: remove in v3
     // #1249
+    // tslint:disable-next-line: deprecation
+    U.deepStrictEqual(_.hasOwnProperty('a', x), true)
+    // tslint:disable-next-line: deprecation
+    U.deepStrictEqual(_.hasOwnProperty('b', x), false)
+    // tslint:disable-next-line: deprecation
     const hasOwnProperty: any = _.hasOwnProperty
     U.deepStrictEqual(hasOwnProperty.call(x, 'a'), true)
     U.deepStrictEqual(hasOwnProperty.call(x, 'b'), false)

diff --git a/test/Record.ts b/test/Record.ts
@@ -390,10 +390,10 @@ describe('Record', () => {
     U.deepStrictEqual(_.singleton('a', 1), { a: 1 })
   })
 
-  it('hasOwnProperty', () => {
+  it('has', () => {
     const x: Record<string, number> = { a: 1 }
-    U.deepStrictEqual(_.hasOwnProperty('a', x), true)
-    U.deepStrictEqual(_.hasOwnProperty('b', x), false)
+    U.deepStrictEqual(_.has('a', x), true)
+    U.deepStrictEqual(_.has('b', x), false)
   })
 
   it('updateAt', () => {