chore: release first package version

.changeset/README.md

@@ -0,0 +1,3 @@
+# Changesets 🎉
+
+This file lists all the changes made to the `set-interval-manager` package between releases 🚀.

.changeset/config.json

@@ -0,0 +1,11 @@
+{
+  "$schema": "https://unpkg.com/@changesets/config@2.3.0/schema.json",
+  "changelog": "@changesets/cli/changelog",
+  "commit": false,
+  "fixed": [],
+  "linked": [],
+  "access": "restricted",
+  "baseBranch": "main",
+  "updateInternalDependencies": "patch",
+  "ignore": []
+}

.github/workflows/main.yml

@@ -0,0 +1,21 @@
+name: CI
+on:
+  push:
+    branches:
+      - '**'
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: pnpm/action-setup@v2
+        with:
+          version: 7
+      - uses: actions/setup-node@v3
+        with:
+          node-version: 16.x
+          cache: 'pnpm'
+
+      - run: pnpm install --frozen-lockfile
+      - run: pnpm run lint && pnpm run test && pnpm run build

.github/workflows/publish.yml

@@ -0,0 +1,36 @@
+name: Publish
+on:
+  workflow_run:
+    workflows: [CI]
+    branches: [main]
+    types: [completed]
+
+concurrency: ${{ github.workflow }}-${{ github.ref }}
+
+permissions:
+  contents: write
+  pull-requests: write
+
+jobs:
+  publish:
+    if: ${{ github.event.workflow_run.conclusion == 'success' }}
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: pnpm/action-setup@v2
+        with:
+          version: 7
+      - uses: actions/setup-node@v3
+        with:
+          node-version: 16.x
+          cache: 'pnpm'
+
+      - run: pnpm install --frozen-lockfile
+      - name: Create Release Pull Request or Publish
+        id: changesets
+        uses: changesets/action@v1
+        with:
+          publish: pnpm run release
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          NPM_TOKEN: ${{ secrets.NPM_TOKEN }}

.gitignore

@@ -0,0 +1,177 @@
+# Created by https://www.toptal.com/developers/gitignore/api/macos,node
+# Edit at https://www.toptal.com/developers/gitignore?templates=macos,node
+
+### macOS ###
+# General
+.DS_Store
+.AppleDouble
+.LSOverride
+
+# Icon must end with two \r
+Icon
+
+
+# Thumbnails
+._*
+
+# Files that might appear in the root of a volume
+.DocumentRevisions-V100
+.fseventsd
+.Spotlight-V100
+.TemporaryItems
+.Trashes
+.VolumeIcon.icns
+.com.apple.timemachine.donotpresent
+
+# Directories potentially created on remote AFP share
+.AppleDB
+.AppleDesktop
+Network Trash Folder
+Temporary Items
+.apdisk
+
+### macOS Patch ###
+# iCloud generated files
+*.icloud
+
+### Node ###
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+lerna-debug.log*
+.pnpm-debug.log*
+
+# Diagnostic reports (https://nodejs.org/api/report.html)
+report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
+
+# Runtime data
+pids
+*.pid
+*.seed
+*.pid.lock
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+lib-cov
+
+# Coverage directory used by tools like istanbul
+coverage
+*.lcov
+
+# nyc test coverage
+.nyc_output
+
+# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
+.grunt
+
+# Bower dependency directory (https://bower.io/)
+bower_components
+
+# node-waf configuration
+.lock-wscript
+
+# Compiled binary addons (https://nodejs.org/api/addons.html)
+build/Release
+
+# Dependency directories
+node_modules/
+jspm_packages/
+
+# Snowpack dependency directory (https://snowpack.dev/)
+web_modules/
+
+# TypeScript cache
+*.tsbuildinfo
+
+# Optional npm cache directory
+.npm
+
+# Optional eslint cache
+.eslintcache
+
+# Optional stylelint cache
+.stylelintcache
+
+# Microbundle cache
+.rpt2_cache/
+.rts2_cache_cjs/
+.rts2_cache_es/
+.rts2_cache_umd/
+
+# Optional REPL history
+.node_repl_history
+
+# Output of 'npm pack'
+*.tgz
+
+# Yarn Integrity file
+.yarn-integrity
+
+# dotenv environment variable files
+.env
+.env.development.local
+.env.test.local
+.env.production.local
+.env.local
+
+# parcel-bundler cache (https://parceljs.org/)
+.cache
+.parcel-cache
+
+# Next.js build output
+.next
+out
+
+# Nuxt.js build / generate output
+.nuxt
+dist
+
+# Gatsby files
+.cache/
+# Comment in the public line in if your project uses Gatsby and not Next.js
+# https://nextjs.org/blog/next-9-1#public-directory-support
+# public
+
+# vuepress build output
+.vuepress/dist
+
+# vuepress v2.x temp and cache directory
+.temp
+
+# Docusaurus cache and generated files
+.docusaurus
+
+# Serverless directories
+.serverless/
+
+# FuseBox cache
+.fusebox/
+
+# DynamoDB Local files
+.dynamodb/
+
+# TernJS port file
+.tern-port
+
+# Stores VSCode versions used for testing VSCode extensions
+.vscode-test
+
+# yarn v2
+.yarn/cache
+.yarn/unplugged
+.yarn/build-state.yml
+.yarn/install-state.gz
+.pnp.*
+
+### Node Patch ###
+# Serverless Webpack directories
+.webpack/
+
+# Optional stylelint cache
+
+# SvelteKit build / generate output
+.svelte-kit
+
+# End of https://www.toptal.com/developers/gitignore/api/macos,node

README.md

@@ -0,0 +1,88 @@
+# set-interval-manager
+
+[![npm version](https://img.shields.io/npm/v/set-interval-manager.svg)](https://www.npmjs.com/package/set-interval-manager)
+[![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/ftonato/set-interval-manager/blob/main/LICENSE)
+
+A utility class for managing intervals created by `setInterval`.
+
+## Installation
+
+You can install the package using npm:
+
+```bash
+npm install set-interval-manager
+```
+
+## Examples
+
+```js
+// ES6 import
+import SetInterval from 'set-interval-manager';
+
+// (or) CommonJS require
+const SetInterval = require('set-interval-manager');
+
+
+const mockFn = () => 'set-interval-manager';
+
+// --- (start + clear) ---
+
+SetInterval.start(mockFn, 1000, 'basic-example');
+
+SetInterval.clear('basic-example');
+
+// --- (start + clearAll) ---
+
+SetInterval.start(mockFn, 1000, 'interval-one');
+SetInterval.start(mockFn, 1500, 'interval-two');
+SetInterval.start(mockFn, 2000, 'interval-three');
+
+SetInterval.clearAll();
+
+// --- (start + listAll) ---
+
+SetInterval.start(mockFn, 1000, 'interval-one');
+SetInterval.start(mockFn, 1500, 'interval-two');
+
+SetInterval.listAll(); // => ['interval-one', 'interval-two']
+
+SetInterval.clear('interval-one');
+
+SetInterval.listAll(); // => ['interval-two']
+```
+
+----
+
+## API
+
+### `SetInterval`
+
+The main class exported by the package.
+
+#### `start(fn: IntervalFn, interval: number, key: string): void`
+
+Starts a new interval that calls the specified function at the specified interval.
+
+- `fn` (required): The function to call.
+- `interval` (required): The interval (in milliseconds) at which to call the function.
+- `key` (required): A unique string identifier for the interval.
+
+#### `clear(key: string): void`
+
+Stops the interval with the specified key.
+
+- `key` (required): The string identifier for the interval to stop.
+
+#### `clearAll(): void`
+
+Stops all intervals managed by this utility.
+
+#### `listAll(): string[]`
+
+Gets an array of all keys currently being used to manage intervals.
+
+----
+
+## License
+
+This package is released under the [MIT License](https://github.com/ftonato/set-interval-manager/blob/main/LICENSE).