summaryrefslogtreecommitdiff
path: root/packages/frontend-shared/js/use-interval.ts
diff options
context:
space:
mode:
Diffstat (limited to 'packages/frontend-shared/js/use-interval.ts')
-rw-r--r--packages/frontend-shared/js/use-interval.ts46
1 files changed, 46 insertions, 0 deletions
diff --git a/packages/frontend-shared/js/use-interval.ts b/packages/frontend-shared/js/use-interval.ts
new file mode 100644
index 0000000000..b50e78c3cc
--- /dev/null
+++ b/packages/frontend-shared/js/use-interval.ts
@@ -0,0 +1,46 @@
+/*
+ * SPDX-FileCopyrightText: syuilo and misskey-project
+ * SPDX-License-Identifier: AGPL-3.0-only
+ */
+
+import { onActivated, onDeactivated, onMounted, onUnmounted } from 'vue';
+
+export function useInterval(fn: () => void, interval: number, options: {
+ immediate: boolean;
+ afterMounted: boolean;
+}): (() => void) | undefined {
+ if (Number.isNaN(interval)) return;
+
+ let intervalId: number | null = null;
+
+ if (options.afterMounted) {
+ onMounted(() => {
+ if (options.immediate) fn();
+ intervalId = window.setInterval(fn, interval);
+ });
+ } else {
+ if (options.immediate) fn();
+ intervalId = window.setInterval(fn, interval);
+ }
+
+ const clear = () => {
+ if (intervalId) window.clearInterval(intervalId);
+ intervalId = null;
+ };
+
+ onActivated(() => {
+ if (intervalId) return;
+ if (options.immediate) fn();
+ intervalId = window.setInterval(fn, interval);
+ });
+
+ onDeactivated(() => {
+ clear();
+ });
+
+ onUnmounted(() => {
+ clear();
+ });
+
+ return clear;
+}