🤖 Merge PR DefinitelyTyped#73783 [chrome] update readingList namespace by @erwanjugand

Author: erwanjugand

types/chrome/index.d.ts

@@ -8503,57 +8503,48 @@ declare namespace chrome {
 
         /**
          * Adds an entry to the reading list if it does not exist.
-         * @since Chrome 120, MV3
+         *
+         * Can return its result via Promise.
          * @param entry The entry to add to the reading list.
-         * @param callback
          */
         export function addEntry(entry: AddEntryOptions): Promise<void>;
         export function addEntry(entry: AddEntryOptions, callback: () => void): void;
 
         /**
          * Retrieves all entries that match the `QueryInfo` properties. Properties that are not provided will not be matched.
-         * @since Chrome 120, MV3
+         *
+         * Can return its result via Promise.
          * @param info The properties to search for.
-         * @param callback
          */
         export function query(info: QueryInfo): Promise<ReadingListEntry[]>;
         export function query(info: QueryInfo, callback: (entries: ReadingListEntry[]) => void): void;
 
         /**
          * Removes an entry from the reading list if it exists.
-         * @since Chrome 120, MV3
+         *
+         * Can return its result via Promise.
          * @param info The entry to remove from the reading list.
-         * @param callback
          */
         export function removeEntry(info: RemoveOptions): Promise<void>;
         export function removeEntry(info: RemoveOptions, callback: () => void): void;
 
         /**
          * Updates a reading list entry if it exists.
-         * @since Chrome 120, MV3
+         *
+         * Can return its result via Promise.
          * @param info The entry to update.
-         * @param callback
          */
         export function updateEntry(info: UpdateEntryOptions): Promise<void>;
         export function updateEntry(info: UpdateEntryOptions, callback: () => void): void;
 
-        /**
-         * Triggered when a ReadingListEntry is added to the reading list.
-         * @since Chrome 120, MV3
-         */
-        export const onEntryAdded: chrome.events.Event<(entry: ReadingListEntry) => void>;
+        /** Triggered when a `ReadingListEntry` is added to the reading list. */
+        export const onEntryAdded: events.Event<(entry: ReadingListEntry) => void>;
 
-        /**
-         * Triggered when a ReadingListEntry is removed from the reading list.
-         * @since Chrome 120, MV3
-         */
-        export const onEntryRemoved: chrome.events.Event<(entry: ReadingListEntry) => void>;
+        /** Triggered when a `ReadingListEntry` is removed from the reading list. */
+        export const onEntryRemoved: events.Event<(entry: ReadingListEntry) => void>;
 
-        /**
-         * Triggered when a ReadingListEntry is updated in the reading list.
-         * @since Chrome 120, MV3
-         */
-        export const onEntryUpdated: chrome.events.Event<(entry: ReadingListEntry) => void>;
+        /** Triggered when a `ReadingListEntry` is updated in the reading list. */
+        export const onEntryUpdated: events.Event<(entry: ReadingListEntry) => void>;
     }
 
     ////////////////////

types/chrome/test/index.ts

@@ -7254,111 +7254,64 @@ function testPrivacy() {
 
 // https://developer.chrome.com/docs/extensions/reference/api/readingList
 function testReadingList() {
-    const {
-        addEntry,
-        query,
-        removeEntry,
-        updateEntry,
-        onEntryAdded,
-        onEntryRemoved,
-        onEntryUpdated,
-    } = chrome.readingList;
-
-    const testAddEntry = () => {
-        const entry = {
-            hasBeenRead: true,
-            title: "title",
-            url: "url",
-        };
-
-        // @ts-expect-error
-        addEntry();
-
-        // @ts-expect-error
-        addEntry({});
-        addEntry(entry); // $ExpectType Promise<void>
-
-        // @ts-expect-error
-        addEntry({}, () => {});
-        addEntry(entry, () => {}); // $ExpectType void
-
-        // @ts-expect-error
-        addEntry(entry, () => {}).then(() => {});
+    const entry: chrome.readingList.AddEntryOptions = {
+        hasBeenRead: true,
+        title: "title",
+        url: "url",
     };
 
-    const testQuery = () => {
-        const info = {
-            hasBeenRead: true,
-            title: "title",
-            url: "url",
-        };
-
-        // @ts-expect-error
-        query();
-
-        query({}); // $ExpectType Promise<ReadingListEntry[]>
-        query(info); // $ExpectType Promise<ReadingListEntry[]>
-
-        query({}, () => {}); // $ExpectType void
-        query(info, () => {}); // $ExpectType void
+    chrome.readingList.addEntry(entry); // $ExpectType Promise<void>
+    chrome.readingList.addEntry(entry, () => void 0); // $ExpectType void
+    // @ts-expect-error
+    chrome.readingList.addEntry(entry, () => {}).then(() => {});
 
-        // @ts-expect-error
-        query(info, () => {}).then(() => {});
+    const queryInfo: chrome.readingList.QueryInfo = {
+        hasBeenRead: true,
+        title: "title",
+        url: "url",
     };
 
-    const testRemoveEntry = () => {
-        const info = {
-            url: "url",
-        };
-
-        // @ts-expect-error
-        removeEntry();
-
-        // @ts-expect-error
-        removeEntry({});
-        removeEntry(info); // $ExpectType Promise<void>
-
-        // @ts-expect-error
-        removeEntry({}, () => {});
-        removeEntry(info, () => {}); // $ExpectType void
+    chrome.readingList.query(queryInfo); // $ExpectType Promise<ReadingListEntry[]>
+    chrome.readingList.query(queryInfo, ([entry]) => { // $ExpectType void
+        entry; // $ExpectType ReadingListEntry
+        entry.creationTime; // $ExpectType number
+        entry.hasBeenRead; // $ExpectType boolean
+        entry.lastUpdateTime; // $ExpectType number
+        entry.title; // $ExpectType string
+        entry.url; // $ExpectType string
+    });
+    // @ts-expect-error
+    chrome.readingList.query(queryInfo, () => {}).then(() => {});
 
-        // @ts-expect-error
-        removeEntry(info, () => {}).then(() => {});
+    const removeInfo: chrome.readingList.RemoveOptions = {
+        url: "url",
     };
 
-    const testUpdateEntry = () => {
-        const info = {
-            hasBeenRead: true,
-            title: "title",
-            url: "url",
-        };
-
-        // @ts-expect-error
-        updateEntry();
-
-        // @ts-expect-error
-        updateEntry({});
-        updateEntry({ url: "url" }); // $ExpectType Promise<void>
-        updateEntry(info); // $ExpectType Promise<void>
-
-        // @ts-expect-error
-        updateEntry({}, () => {});
-        updateEntry({ url: "url" }, () => {}); // $ExpectType void
-        updateEntry(info, () => {}); // $ExpectType void
+    chrome.readingList.removeEntry(removeInfo); // $ExpectType Promise<void>
+    chrome.readingList.removeEntry(removeInfo, () => void 0); // $ExpectType void
+    // @ts-expect-error
+    chrome.readingList.removeEntry(removeInfo, () => {}).then(() => {});
 
-        // @ts-expect-error
-        updateEntry(info, () => {}).then(() => {});
+    const updateInfo: chrome.readingList.UpdateEntryOptions = {
+        hasBeenRead: true,
+        title: "title",
+        url: "url",
     };
 
-    checkChromeEvent(onEntryAdded, (entry) => {
+    chrome.readingList.updateEntry(updateInfo); // $ExpectType Promise<void>
+    chrome.readingList.updateEntry(updateInfo, () => void 0); // $ExpectType void
+    // @ts-expect-error
+    chrome.readingList.updateEntry(updateInfo, () => {}).then(() => {});
+
+    checkChromeEvent(chrome.readingList.onEntryAdded, (entry) => {
         entry; // $ExpectType ReadingListEntry
     });
 
-    checkChromeEvent(onEntryRemoved, (entry) => {
+    checkChromeEvent(chrome.readingList.onEntryRemoved, (entry) => {
         entry; // $ExpectType ReadingListEntry
     });
 
-    checkChromeEvent(onEntryUpdated, (entry) => {
+    checkChromeEvent(chrome.readingList.onEntryUpdated, (entry) => {
         entry; // $ExpectType ReadingListEntry
     });
 }