Apply lint rule @typescript-eslint/no-empty-object-type (#29159)

* Apply lint rule @typescript-eslint/no-empty-object-type To avoid the footgun that is https://www.totaltypescript.com/the-empty-object-type-in-typescript Signed-off-by: Michael Telatynski <7t3chguy@gmail.com> * Iterate Signed-off-by: Michael Telatynski <7t3chguy@gmail.com> --------- Signed-off-by: Michael Telatynski <7t3chguy@gmail.com>
2025-02-04 13:41:34 +00:00
parent 8cae1e9f5e
commit 7eb969bbc2
56 changed files with 157 additions and 158 deletions
--- a/src/utils/MultiInviter.ts
+++ b/src/utils/MultiInviter.ts
@@ -6,7 +6,7 @@ SPDX-License-Identifier: AGPL-3.0-only OR GPL-3.0-only OR LicenseRef-Element-Com
 Please see LICENSE files in the repository root for full details.
 */

-import { MatrixError, MatrixClient, EventType } from "matrix-js-sdk/src/matrix";
+import { MatrixError, MatrixClient, EventType, EmptyObject } from "matrix-js-sdk/src/matrix";
 import { KnownMembership } from "matrix-js-sdk/src/types";
 import { defer, IDeferred } from "matrix-js-sdk/src/utils";
 import { logger } from "matrix-js-sdk/src/logger";
@@ -117,7 +117,7 @@ export default class MultiInviter {
        return this.errors[addr]?.errorText ?? null;
    }

-    private async inviteToRoom(roomId: string, addr: string, ignoreProfile = false): Promise<{}> {
+    private async inviteToRoom(roomId: string, addr: string, ignoreProfile = false): Promise<EmptyObject> {
        const addrType = getAddressType(addr);

        if (addrType === AddressType.Email) {
--- a/src/utils/PinningUtils.ts
+++ b/src/utils/PinningUtils.ts
@@ -6,7 +6,15 @@ SPDX-License-Identifier: AGPL-3.0-only OR GPL-3.0-only OR LicenseRef-Element-Com
 Please see LICENSE files in the repository root for full details.
 */

-import { MatrixEvent, EventType, M_POLL_START, MatrixClient, EventTimeline, Room } from "matrix-js-sdk/src/matrix";
+import {
+    MatrixEvent,
+    EventType,
+    M_POLL_START,
+    MatrixClient,
+    EventTimeline,
+    Room,
+    EmptyObject,
+} from "matrix-js-sdk/src/matrix";

 import { isContentActionable } from "./EventUtils";
 import { ReadPinsEventId } from "../components/views/right_panel/types";
@@ -123,7 +131,7 @@ export default class PinningUtils {
                ?.getStateEvents(EventType.RoomPinnedEvents, "")
                ?.getContent().pinned || [];

-        let roomAccountDataPromise: Promise<{} | void> = Promise.resolve();
+        let roomAccountDataPromise: Promise<EmptyObject | void> = Promise.resolve();
        // If the event is already pinned, unpin it
        if (pinnedIds.includes(eventId)) {
            pinnedIds.splice(pinnedIds.indexOf(eventId), 1);
--- a/src/utils/notifications.ts
+++ b/src/utils/notifications.ts
@@ -14,6 +14,7 @@ import {
    LocalNotificationSettings,
    ReceiptType,
    IMarkedUnreadEvent,
+    EmptyObject,
 } from "matrix-js-sdk/src/matrix";
 import { IndicatorIcon } from "@vector-im/compound-web";

@@ -80,7 +81,7 @@ export function localNotificationsAreSilenced(cli: MatrixClient): boolean {
 * @param client
 * @returns a promise that resolves when the room has been marked as read
 */
-export async function clearRoomNotification(room: Room, client: MatrixClient): Promise<{} | undefined> {
+export async function clearRoomNotification(room: Room, client: MatrixClient): Promise<EmptyObject | undefined> {
    const lastEvent = room.getLastLiveEvent();

    await setMarkedUnreadState(room, client, false);
@@ -115,15 +116,17 @@ export async function clearRoomNotification(room: Room, client: MatrixClient): P
 * @param client The matrix client
 * @returns a promise that resolves when all rooms have been marked as read
 */
-export function clearAllNotifications(client: MatrixClient): Promise<Array<{} | undefined>> {
-    const receiptPromises = client.getRooms().reduce((promises: Array<Promise<{} | undefined>>, room: Room) => {
-        if (doesRoomHaveUnreadMessages(room, true)) {
-            const promise = clearRoomNotification(room, client);
-            promises.push(promise);
-        }
+export function clearAllNotifications(client: MatrixClient): Promise<Array<EmptyObject | undefined>> {
+    const receiptPromises = client
+        .getRooms()
+        .reduce((promises: Array<Promise<EmptyObject | undefined>>, room: Room) => {
+            if (doesRoomHaveUnreadMessages(room, true)) {
+                const promise = clearRoomNotification(room, client);
+                promises.push(promise);
+            }

-        return promises;
-    }, []);
+            return promises;
+        }, []);

    return Promise.all(receiptPromises);
 }
--- a/src/utils/objects.ts
+++ b/src/utils/objects.ts
@@ -8,7 +8,7 @@ Please see LICENSE files in the repository root for full details.

 import { arrayDiff, arrayUnion, arrayIntersection } from "./arrays";

-type ObjectExcluding<O extends {}, P extends (keyof O)[]> = { [k in Exclude<keyof O, P[number]>]: O[k] };
+type ObjectExcluding<O extends object, P extends (keyof O)[]> = { [k in Exclude<keyof O, P[number]>]: O[k] };

 /**
 * Gets a new object which represents the provided object, excluding some properties.
@@ -16,7 +16,7 @@ type ObjectExcluding<O extends {}, P extends (keyof O)[]> = { [k in Exclude<keyo
 * @param props The property names to remove.
 * @returns The new object without the provided properties.
 */
-export function objectExcluding<O extends {}, P extends Array<keyof O>>(a: O, props: P): ObjectExcluding<O, P> {
+export function objectExcluding<O extends object, P extends Array<keyof O>>(a: O, props: P): ObjectExcluding<O, P> {
    // We use a Map to avoid hammering the `delete` keyword, which is slow and painful.
    const tempMap = new Map<keyof O, any>(Object.entries(a) as [keyof O, any][]);
    for (const prop of props) {
@@ -37,7 +37,7 @@ export function objectExcluding<O extends {}, P extends Array<keyof O>>(a: O, pr
 * @param props The property names to keep.
 * @returns The new object with only the provided properties.
 */
-export function objectWithOnly<O extends {}, P extends Array<keyof O>>(a: O, props: P): { [k in P[number]]: O[k] } {
+export function objectWithOnly<O extends object, P extends Array<keyof O>>(a: O, props: P): { [k in P[number]]: O[k] } {
    const existingProps = Object.keys(a) as (keyof O)[];
    const diff = arrayDiff(existingProps, props);
    if (diff.removed.length === 0) {
@@ -58,7 +58,7 @@ export function objectWithOnly<O extends {}, P extends Array<keyof O>>(a: O, pro
 * First argument is the property key with the second being the current value.
 * @returns A cloned object.
 */
-export function objectShallowClone<O extends {}>(a: O, propertyCloner?: (k: keyof O, v: O[keyof O]) => any): O {
+export function objectShallowClone<O extends object>(a: O, propertyCloner?: (k: keyof O, v: O[keyof O]) => any): O {
    const newObj = {} as O;
    for (const [k, v] of Object.entries(a) as [keyof O, O[keyof O]][]) {
        newObj[k] = v;
@@ -77,7 +77,7 @@ export function objectShallowClone<O extends {}>(a: O, propertyCloner?: (k: keyo
 * @param b The second object. Must be defined.
 * @returns True if there's a difference between the objects, false otherwise
 */
-export function objectHasDiff<O extends {}>(a: O, b: O): boolean {
+export function objectHasDiff<O extends object>(a: O, b: O): boolean {
    if (a === b) return false;
    const aKeys = Object.keys(a);
    const bKeys = Object.keys(b);
@@ -99,7 +99,7 @@ type Diff<K> = { changed: K[]; added: K[]; removed: K[] };
 * @param b The second object. Must be defined.
 * @returns The difference between the keys of each object.
 */
-export function objectDiff<O extends {}>(a: O, b: O): Diff<keyof O> {
+export function objectDiff<O extends object>(a: O, b: O): Diff<keyof O> {
    const aKeys = Object.keys(a) as (keyof O)[];
    const bKeys = Object.keys(b) as (keyof O)[];
    const keyDiff = arrayDiff(aKeys, bKeys);
@@ -118,7 +118,7 @@ export function objectDiff<O extends {}>(a: O, b: O): Diff<keyof O> {
 * @returns The keys which have been added, removed, or changed between the
 * two objects.
 */
-export function objectKeyChanges<O extends {}>(a: O, b: O): (keyof O)[] {
+export function objectKeyChanges<O extends object>(a: O, b: O): (keyof O)[] {
    const diff = objectDiff(a, b);
    return arrayUnion(diff.removed, diff.added, diff.changed);
 }
@@ -130,7 +130,7 @@ export function objectKeyChanges<O extends {}>(a: O, b: O): (keyof O)[] {
 * @param obj The object to clone.
 * @returns The cloned object
 */
-export function objectClone<O extends {}>(obj: O): O {
+export function objectClone<O extends object>(obj: O): O {
    return JSON.parse(JSON.stringify(obj));
 }