Home Reference Source Test Repository
public class | source

Alarm

Extends:

events~EventEmitter → Alarm

A simple wrapper for chrome.alarms API

See:

Example:

    const alarm = new Alarm("myalarm");
    alarm.on("alarm", () => {
      // Do something
    });
    alarm.start({ periodInMinutes: 5 });

Test:

Constructor Summary

Public Constructor
public

Member Summary

Public Members
public

Name of the alarm.

Method Summary

Public Methods
public

start(options: Object)

Start the alarm.

public

Stop the alarm.

Public Constructors

public constructor(name: string) source

Params:

NameTypeAttributeDescription
name string

Name of the alarm.

Public Members

public name: string source

Name of the alarm.

Public Methods

public start(options: Object) source

Start the alarm.

Params:

NameTypeAttributeDescription
options Object

Alarm options. See Chrome API document for details.

Emit:

alarm

when the alarm is ringing.

Test:

See:

public stop(): Promise<boolean> source

Stop the alarm.

Return:

Promise<boolean>

Test: