{"id":20535425,"url":"https://github.com/xiscodev/timer-creator","last_synced_at":"2025-03-06T03:24:25.952Z","repository":{"id":54160746,"uuid":"244565945","full_name":"xiscodev/timer-creator","owner":"xiscodev","description":"A simple library to manage timeouts and intervals.","archived":false,"fork":false,"pushed_at":"2021-03-06T15:37:05.000Z","size":58,"stargazers_count":1,"open_issues_count":0,"forks_count":1,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-02-25T17:14:18.277Z","etag":null,"topics":["interval","javascript","library","timeout","timer-manager"],"latest_commit_sha":null,"homepage":"https://www.npmjs.com/package/timer-creator","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/xiscodev.png","metadata":{"files":{"readme":"readme.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2020-03-03T07:08:13.000Z","updated_at":"2023-01-01T20:41:07.000Z","dependencies_parsed_at":"2022-08-13T08:00:34.430Z","dependency_job_id":null,"html_url":"https://github.com/xiscodev/timer-creator","commit_stats":null,"previous_names":["deepertech-com/timer-creator"],"tags_count":5,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/xiscodev%2Ftimer-creator","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/xiscodev%2Ftimer-creator/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/xiscodev%2Ftimer-creator/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/xiscodev%2Ftimer-creator/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/xiscodev","download_url":"https://codeload.github.com/xiscodev/timer-creator/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":242140197,"owners_count":20078270,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["interval","javascript","library","timeout","timer-manager"],"created_at":"2024-11-16T00:31:14.179Z","updated_at":"2025-03-06T03:24:25.910Z","avatar_url":"https://github.com/xiscodev.png","language":"JavaScript","readme":"\u003cdiv style=\"display: -ms-flexbox; display: -webkit-flex; display: flex; -webkit-flex-direction: row; -ms-flex-direction: row; flex-direction: row; -webkit-flex-wrap: wrap; -ms-flex-wrap: wrap; flex-wrap: wrap; -webkit-justify-content: center; -ms-flex-pack: center; justify-content: center; -webkit-align-content: center; -ms-flex-line-pack: center; align-content: center; -webkit-align-items: center; -ms-flex-align: center; align-items: center;\"\u003e\n  \u003cimg style=\"-webkit-order: 0; -ms-flex-order: 0; order: 0; -webkit-flex: 0 1 auto; -ms-flex: 0 1 auto; flex: 0 1 auto; -webkit-align-self: auto; -ms-flex-item-align: auto; align-self: auto;\" src=\"icon.png\" /\u003e\n\u003c/div\u003e\n\n\u003ch1 style=\"text-align:center;\"\u003eTimer Creator\u003c/h1\u003e\n\n## What is this?\n\nA simple library to manage timeouts and intervals.\n\n## How to use it?\n\nFirst you need to import it in your project\n\n_The require way_\n\n```js\nlet { createInterval, destroyInterval, TimeUnit } = require(\"timer-creator\");\n```\n\n_The import way_\n\n```js\nimport { createTimeout, destroyTimeout, TimeUnit } from \"timer-creator\";\n```\n\nThen use it to establish a periodic callback execution until condition\n\n```js\n  import { createInterval, destroyInterval, TimeUnit } from \"timer-creator\";\n\n  const TIMER_NAME = 'myIntervalName'\n\n  function myFunction() {\n    // YOUR OWN CODE AND STUFF\n    hasConditionMeeted \u0026\u0026 destroyInterval(TIMER_NAME)\n  }\n\n  createInterval(TIMER_NAME, myFunction, 2 * TimeUnit.MINUTE)\n```\n\nOr one time callback execution\n\n```js\n  import { createTimeout, TimeUnit } from \"timer-creator\";\n\n  function myFunction(arg1, arg2) {\n    // YOUR OWN CODE AND STUFF\n  }\n\n  createTimeout('myTimeoutName', myFunction, 30 * TimeUnit.SECOND, [arg1, arg2])\n```\n\n\u003cdetails\u003e\n\u003csummary\u003eAdditional JSDOC info\u003c/summary\u003e\n\n### JSDOC\n\n\u003c!-- Generated by documentation.js. Update this documentation by updating the source code. --\u003e\n\n##### Table of Contents\n\n-   [TimeUnit](#timeunit)\n    -   [MILISECOND](#milisecond)\n    -   [SECOND](#second)\n    -   [MINUTE](#minute)\n    -   [HOUR](#hour)\n    -   [DAY](#day)\n-   [existInterval](#existinterval)\n    -   [Parameters](#parameters)\n-   [getInterval](#getinterval)\n    -   [Parameters](#parameters-1)\n-   [createInterval](#createinterval)\n    -   [Parameters](#parameters-2)\n-   [destroyInterval](#destroyinterval)\n    -   [Parameters](#parameters-3)\n-   [existTimeout](#existtimeout)\n    -   [Parameters](#parameters-4)\n-   [getTimeout](#gettimeout)\n    -   [Parameters](#parameters-5)\n-   [createTimeout](#createtimeout)\n    -   [Parameters](#parameters-6)\n-   [destroyTimeout](#destroytimeout)\n    -   [Parameters](#parameters-7)\n\n#### TimeUnit\n\nContains time unit constants\n\nType: [object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)\n\n##### MILISECOND\n\nTime unit referent to Milisecond\n\nType: [number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number)\n\n##### SECOND\n\nTime unit referent to Second in miliseconds\n\nType: [number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number)\n\n##### MINUTE\n\nTime unit referent to Minute in miliseconds\n\nType: [number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number)\n\n##### HOUR\n\nTime unit referent to Hour in miliseconds\n\nType: [number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number)\n\n##### DAY\n\nTime unit referent to Day in miliseconds\n\nType: [number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number)\n\n#### existInterval\n\nChecks whether exist interval with given name.\n\n##### Parameters\n\n-   `name` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** interval name\n\nReturns **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** true or false wheter interval is stored or not\n\n#### getInterval\n\nRetrieves interval value for given name.\n\n##### Parameters\n\n-   `name` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** interval name\n\nReturns **[number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number)** interval number reference\n\n#### createInterval\n\nCreates and \\_store interval object with given name,\nto execute callback function on the waitTime specified with given args.\n\n##### Parameters\n\n-   `name` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** interval name\n-   `callback` **[Function](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function)** the function to be executed as a callback\n-   `waitTime` **[number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number)** the waiting time for the interval\n-   `args` **([string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String) \\| [Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array) | null)** arguments to be passed to the callback function\n\n#### destroyInterval\n\nDestroy interval with given name and removes it from \\_store.\n\n##### Parameters\n\n-   `name` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** interval name\n\n#### existTimeout\n\nChecks whether exist timeout with given name.\n\n##### Parameters\n\n-   `name` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** timeout name\n\nReturns **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** true or false wheter timeout is stored or not\n\n#### getTimeout\n\nRetrieves timeout value for given name.\n\n##### Parameters\n\n-   `name` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** timeout name\n\nReturns **[number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number)** timeout number reference\n\n#### createTimeout\n\nCreates and store timeout object with given name,\nto execute callback function on the waitTime specified with given args,\nits removed from store when callback is executed.\n\n##### Parameters\n\n-   `name` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** timeout name\n-   `callback` **[Function](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function)** the function to be executed as a callback\n-   `waitTime` **[number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number)** the waiting time for the timeout\n-   `args` **([string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String) \\| [Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array) | null)** arguments to be passed to the callback function\n\n#### destroyTimeout\n\nDestroy timeout with given name and removes it from store.\n\n##### Parameters\n\n-   `name` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** timeout name\n\n### TimeUnit\n\nContains time unit constants\n\nType: [Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)\n\n#### MILISECOND\n\nTime unit referent to Milisecond\n\nType: [number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number)\n\n#### SECOND\n\nTime unit referent to Second in miliseconds\n\nType: [number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number)\n\n#### MINUTE\n\nTime unit referent to Minute in miliseconds\n\nType: [number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number)\n\n#### HOUR\n\nTime unit referent to Hour in miliseconds\n\nType: [number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number)\n\n#### DAY\n\nTime unit referent to Day in miliseconds\n\nType: [number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number)\n\n### existInterval\n\nChecks whether exist interval with given name.\n\n#### Parameters\n\n-   `name` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** interval name\n\nReturns **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** true or false wheter interval is stored or not\n\n### getInterval\n\nRetrieves interval value for given name.\n\n#### Parameters\n\n-   `name` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** interval name\n\nReturns **[number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number)** interval number reference\n\n### createInterval\n\nCreates and \\_store interval object with given name,\nto execute callback function on the waitTime specified with given args.\n\n#### Parameters\n\n-   `name` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** interval name\n-   `callback` **[Function](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function)** the function to be executed as a callback\n-   `waitTime` **[number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number)** the waiting time for the interval\n-   `args` **([string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String) \\| [Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array) | null)** arguments to be passed to the callback function\n\n### destroyInterval\n\nDestroy interval with given name and removes it from \\_store.\n\n#### Parameters\n\n-   `name` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** interval name\n\n### existTimeout\n\nChecks whether exist timeout with given name.\n\n#### Parameters\n\n-   `name` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** timeout name\n\nReturns **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** true or false wheter timeout is stored or not\n\n### getTimeout\n\nRetrieves timeout value for given name.\n\n#### Parameters\n\n-   `name` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** timeout name\n\nReturns **[number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number)** timeout number reference\n\n### createTimeout\n\nCreates and store timeout object with given name,\nto execute callback function on the waitTime specified with given args,\nits removed from store when callback is executed.\n\n#### Parameters\n\n-   `name` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** timeout name\n-   `callback` **[Function](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function)** the function to be executed as a callback\n-   `waitTime` **[number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number)** the waiting time for the timeout\n-   `args` **([string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String) \\| [Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array) | null)** arguments to be passed to the callback function\n\n### destroyTimeout\n\nDestroy timeout with given name and removes it from store.\n\n#### Parameters\n\n-   `name` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** timeout name\n\n\u003c/details\u003e\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fxiscodev%2Ftimer-creator","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fxiscodev%2Ftimer-creator","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fxiscodev%2Ftimer-creator/lists"}