dangosan

This is react native library.

Background(foreground) job scheduling system on memory.

Did not complete jobs in the foreground will also continue running in the background.

Dependencies

• react-native-background-timer
• react-native-background-job

How to use

Please install.

yarn add dangosan react-native-background-timer react-native-background-job

Let's run dangosan.

import { Dangosan } from 'dangosan';
...

React.useEffect(() => {
  const dango = new Dangosan({
    interval: 900000,
    queue: {
      greeting: {
        slotSize: 1
      }
    }
  });

  dango.setup();
  dango.enqueue('greeting', {
    worker: {
      perform: () => {
        console.log('hello');
      }
    }
  });
}, []);

Options

| option | type | default | description | |--------------------|----------|---------|---------------------------------| | debug | boolean? | false | Output debug console.log. | | interval | number? | 900000 | How often to monitor the queue. | | queue[key].slotSize| number? | null | Enqueue limit size. |

Methods

| if | args | description | |------------------------|--------------------------------------------------------------------|---------------------------| | setup | | Setup job schedule. | | stop | | Stop job schedule. | | enqueue | key: string, slot: Slot | Add job. | | dequeue | key: string | Delete job. | | terminateRunningWorker | key: string | Terminate running worker. | | addEventListener | key: string, event: typeof SUPPORTED_EVENTS[number], EventListener | Add event listener. | | removeEventListener | key: string, event: typeof SUPPORTED_EVENTS[number], EventListener | Remove event listener. |

Type definitions

• Slot

export interface Slot {
  worker: Worker;
}

• Worker

export interface Worker {
  perform(): Promise<void>;
  terminate(): Promise<void>;
}

• SUPPORTED_EVENTS

const SUPPORTED_EVENTS = ["run", "success", "fail", "done"] as const;

• EventListener

type EventListener = (slot: Slot) => void;