timer-creator

Timer Creator

What is this?

A simple library to manage timeouts and intervals.

How to use it?

First you need to import it in your project

The require way

let { createInterval, destroyInterval, TimeUnit } = require("timer-creator");

The import way

import { createTimeout, destroyTimeout, TimeUnit } from "timer-creator";

Then use it to establish a periodic callback execution until condition

  import { createInterval, destroyInterval, TimeUnit } from "timer-creator";

  const TIMER_NAME = 'myIntervalName'

  function myFunction() {
    // YOUR OWN CODE AND STUFF
    hasConditionMeeted && destroyInterval(TIMER_NAME)
  }

  createInterval(TIMER_NAME, myFunction, 2 * TimeUnit.MINUTE)

Or one time callback execution

  import { createTimeout, TimeUnit } from "timer-creator";

  function myFunction(arg1, arg2) {
    // YOUR OWN CODE AND STUFF
  }

  createTimeout('myTimeoutName', myFunction, 30 * TimeUnit.SECOND, [arg1, arg2])

Additional JSDOC info

JSDOC

Table of Contents

• TimeUnit
  • MILISECOND
  • SECOND
  • MINUTE
  • HOUR
  • DAY
• existInterval
  • Parameters
• getInterval
  • Parameters
• createInterval
  • Parameters
• destroyInterval
  • Parameters
• existTimeout
  • Parameters
• getTimeout
  • Parameters
• createTimeout
  • Parameters
• destroyTimeout
  • Parameters

TimeUnit

Contains time unit constants

Type: object

MILISECOND

Time unit referent to Milisecond

Type: number

SECOND

Time unit referent to Second in miliseconds

Type: number

MINUTE

Time unit referent to Minute in miliseconds

Type: number

HOUR

Time unit referent to Hour in miliseconds

Type: number

DAY

Time unit referent to Day in miliseconds

Type: number

existInterval

Checks whether exist interval with given name.

Parameters

• name string interval name

Returns boolean true or false wheter interval is stored or not

getInterval

Retrieves interval value for given name.

Parameters

• name string interval name

Returns number interval number reference

createInterval

Creates and _store interval object with given name, to execute callback function on the waitTime specified with given args.

Parameters

• name string interval name
• callback Function the function to be executed as a callback
• waitTime number the waiting time for the interval
• args (string | Array | null) arguments to be passed to the callback function

destroyInterval

Destroy interval with given name and removes it from _store.

Parameters

• name string interval name

existTimeout

Checks whether exist timeout with given name.

Parameters

• name string timeout name

Returns boolean true or false wheter timeout is stored or not

getTimeout

Retrieves timeout value for given name.

Parameters

• name string timeout name

Returns number timeout number reference

createTimeout

Creates and store timeout object with given name, to execute callback function on the waitTime specified with given args, its removed from store when callback is executed.

Parameters

• name string timeout name
• callback Function the function to be executed as a callback
• waitTime number the waiting time for the timeout
• args (string | Array | null) arguments to be passed to the callback function

destroyTimeout

Destroy timeout with given name and removes it from store.

Parameters

• name string timeout name

TimeUnit

Contains time unit constants

Type: Object

MILISECOND

Time unit referent to Milisecond

Type: number

SECOND

Time unit referent to Second in miliseconds

Type: number

MINUTE

Time unit referent to Minute in miliseconds

Type: number

HOUR

Time unit referent to Hour in miliseconds

Type: number

DAY

Time unit referent to Day in miliseconds

Type: number

existInterval

Checks whether exist interval with given name.

Parameters

• name string interval name

Returns boolean true or false wheter interval is stored or not

getInterval

Retrieves interval value for given name.

Parameters

• name string interval name

Returns number interval number reference

createInterval

Creates and _store interval object with given name, to execute callback function on the waitTime specified with given args.

Parameters

• name string interval name
• callback Function the function to be executed as a callback
• waitTime number the waiting time for the interval
• args (string | Array | null) arguments to be passed to the callback function

destroyInterval

Destroy interval with given name and removes it from _store.

Parameters

• name string interval name

existTimeout

Checks whether exist timeout with given name.

Parameters

• name string timeout name

Returns boolean true or false wheter timeout is stored or not

getTimeout

Retrieves timeout value for given name.

Parameters

• name string timeout name

Returns number timeout number reference

createTimeout

Creates and store timeout object with given name, to execute callback function on the waitTime specified with given args, its removed from store when callback is executed.

Parameters

• name string timeout name
• callback Function the function to be executed as a callback
• waitTime number the waiting time for the timeout
• args (string | Array | null) arguments to be passed to the callback function

destroyTimeout

Destroy timeout with given name and removes it from store.

Parameters

• name string timeout name