Refresh Interval made configurable.

Author: arpitbbhayani

src/_constants.ts

@@ -47,6 +47,7 @@ export const DEFAULT_CACHE: DictionaryCache = {
 
 export const DEFAULT_SETTINGS: DictionarySettings = {
     defaultLanguage: "en_US",
+    defaultRefreshInterval: "60",
     shouldShowSynonymPopover: true,
     shouldShowCustomContextMenu: false,
     definitionApiName: "Free Dictionary API",

src/l10n/locale/de.ts

@@ -17,7 +17,9 @@ export default {
 
     //settingsTab.ts
     "Reset to default": "Zurücksetzen",
-    'Dictionary Settings': 'Wörterbuch Einstellungen',
+    'HackerNews Settings': 'Wörterbuch Einstellungen',
+    'Refresh Interval': 'Refresh Interval',
+    'The time interval in seconds after which the next top story will be fetched. Default and invalid values will be considered as 60 seconds.': 'The time interval in seconds after which the next top story will be fetched. Default and invalid values will be considered as 60 seconds.',
     'Language': 'Sprache',
     'The Language the Plugin will use to search for Definitions and Pronunciations.': 'Die Sprache, welche von dieser Erweiterung verwendet wird, um nach Definitionen zu suchen.',
     'Synonym Suggestions': 'Synonym Vorschläge',

src/l10n/locale/en.ts

@@ -17,7 +17,9 @@ export default {
 
     //settingsTab.ts
     "Reset to default": "Reset to default",
-    'Dictionary Settings': 'Dictionary Settings',
+    'HackerNews Settings': 'HackerNews Settings',
+    'Refresh Interval': 'Refresh Interval',
+    'The time interval in seconds after which the next top story will be fetched. Default and invalid values will be considered as 60 seconds.': 'The time interval in seconds after which the next top story will be fetched. Default and invalid values will be considered as 60 seconds.',
     'Language': 'Language',
     'The Language the Plugin will use to search for Definitions and Pronunciations.': 'The Language the Plugin will use to search for Definitions and Pronunciations.',
     'Synonym Suggestions': 'Synonym Suggestions',

src/l10n/locale/zh-cn.ts

@@ -15,7 +15,9 @@ export default {
     'Look up': '查询',
 
     //settingsTab.ts
-    'Dictionary Settings': '词典设置',
+    'HackerNews Settings': '词典设置',
+    'Refresh Interval': 'Refresh Interval',
+    'The time interval in seconds after which the next top story will be fetched. Default and invalid values will be considered as 60 seconds.': 'The time interval in seconds after which the next top story will be fetched. Default and invalid values will be considered as 60 seconds.',
     'Language': '语言',
     'The Language the Plugin will use to search for Definitions and Pronunciations.': '插件会根据该语言来搜索语义以及发音',
     'Synonym Suggestions': '同义词建议',

src/main.ts

@@ -120,6 +120,16 @@ export default class DictionaryPlugin extends Plugin {
         // Editor mode
         // @ts-ignore
         this.registerEvent(this.app.workspace.on('editor-menu', this.handleContextMenuHelper));
+
+        let refreshInterval = parseInt(this.settings.defaultRefreshInterval)
+        if (Number.isNaN(refreshInterval) || refreshInterval <= 0) { refreshInterval = 60 }
+
+        dispatchEvent(new Event('obsidian-hackernews-fetchTopHN'))
+        this.registerInterval(window.setInterval(() => {
+            dispatchEvent(new Event('obsidian-hackernews-fetchTopHN'))
+        }, refreshInterval * 1000))
+
+        console.log('refreshInterval', refreshInterval, 'seconds');
     }
 
     onunload(): void {

src/types.ts

@@ -15,6 +15,7 @@ export interface DictionarySettings {
 	suffix: string;
 	prefix: string;
 	template: string;
+	defaultRefreshInterval: string;
 }
 
 export interface DictionaryCache {

src/ui/dictionary/dictionaryView.svelte

@@ -1,4 +1,5 @@
 <script lang="ts">
+  import { onDestroy } from 'svelte';
   import type APIManager from "src/apiManager";
   import type { DictionaryWord, HNItem } from "src/integrations/types";
   
@@ -20,7 +21,8 @@
     }
   }
 
-  async function fetchTopHN() {
+  export async function fetchTopHN() {
+    console.log('fetching top story from HackerNews');
     dataHN = await manager.requestTopHN();
   }
 
@@ -32,15 +34,17 @@
     search();
   });
 
-  addEventListener("obsidian-hackernews-fetchTopHN", () => {
-    fetchTopHN();
-  });
+  addEventListener("obsidian-hackernews-fetchTopHN", fetchTopHN);
 
   function handleKeyDown(e: KeyboardEvent) {
     if (e.key === "Enter") {
       search();
     }
   }
+
+  onDestroy(() => {
+    removeEventListener('obsidian-hackernews-fetchTopHN', fetchTopHN)
+  })
 </script>
 
 <div class="main">

src/ui/dictionary/dictionaryView.ts

@@ -1,6 +1,6 @@
 import type DictionaryPlugin from "src/main";
 
-import { ItemView, WorkspaceLeaf, debounce } from "obsidian";
+import { ItemView, WorkspaceLeaf } from "obsidian";
 import { VIEW_TYPE, VIEW_DISPLAY_TEXT, VIEW_ICON } from "src/_constants";
 import DictionaryComponent from "./dictionaryView.svelte";
 import LanguageChooser from "src/ui/modals/languageChooser";
@@ -9,7 +9,6 @@ export default class DictionaryView extends ItemView {
 
     plugin: DictionaryPlugin;
     private _view: DictionaryComponent;
-    clock: NodeJS.Timeout;
 
     constructor(leaf: WorkspaceLeaf, plugin: DictionaryPlugin) {
         super(leaf);
@@ -36,7 +35,6 @@ export default class DictionaryView extends ItemView {
     }
 
     onClose(): Promise<void> {
-        clearInterval(this.clock)
         this._view.$destroy();
         return super.onClose();
     }
@@ -49,9 +47,6 @@ export default class DictionaryView extends ItemView {
                 localDictionary: this.plugin.localDictionary,
             }
         });
-        this.clock = setInterval(debounce(() => {
-            dispatchEvent(new Event('obsidian-hackernews-fetchTopHN'))
-        }, 60 * 1000), 1000, true)
         addEventListener('dictionary-open-language-switcher', () => {
             new LanguageChooser(this.app, this.plugin).open();
         });

src/ui/settings/settingsTab.ts

@@ -18,8 +18,18 @@ export default class SettingsTab extends PluginSettingTab {
 
         containerEl.empty();
 
-        containerEl.createEl('h2', { text: t('Dictionary Settings') });
+        containerEl.createEl('h2', { text: t('HackerNews Settings') });
 
+        new Setting(containerEl)
+            .setName(t('Refresh Interval'))
+            .setDesc(t('The time interval in seconds after which the next top story will be fetched. Default and invalid values will be considered as 60 seconds.'))
+            .addText(text => text
+                .setPlaceholder('60')
+                .setValue(plugin.settings.defaultRefreshInterval)
+                .onChange(async (value) => {
+                    plugin.settings.defaultRefreshInterval = value;
+                    await this.save();
+                }));
         new Setting(containerEl)
             .setName(t('Language'))
             .setDesc(t('The Language the Plugin will use to search for Definitions and Pronunciations.'))