Merge pull request #2125 from wellwelwel/deprecateds

chore: deprecate `OkPacket` type and `changedRows` property
sidorares · Jul 10, 2023 · aee1d5d · aee1d5d
2 parents fd44a2a + 8e728d9
commit aee1d5d
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 0 deletions.
diff --git a/typings/mysql/lib/protocol/packets/OkPacket.d.ts b/typings/mysql/lib/protocol/packets/OkPacket.d.ts
@@ -1,9 +1,17 @@
+/**
+ * @deprecated
+ * `OkPacket` is deprecated and might be removed in the future major release. Please use `ResultSetHeader` instead.
+ */
 declare interface OkPacket {
   constructor: {
     name: 'OkPacket';
   };
   fieldCount: number;
   affectedRows: number;
+  /**
+   * @deprecated
+   * `changedRows` is deprecated and might be removed in the future major release. Please use `affectedRows` property instead.
+   */
   changedRows: number;
   insertId: number;
   serverStatus: number;

diff --git a/typings/mysql/lib/protocol/packets/ResultSetHeader.d.ts b/typings/mysql/lib/protocol/packets/ResultSetHeader.d.ts
@@ -8,6 +8,10 @@ declare interface ResultSetHeader {
   insertId: number;
   serverStatus: number;
   warningStatus: number;
+  /**
+   * @deprecated
+   * `changedRows` is deprecated and might be removed in the future major release. Please use `affectedRows` property instead.
+   */
   changedRows: number;
 }