obniz/dist/src/obniz/ObnizApp.js

obniz sdk for javascript

"use strict";
/**
 * @packageDocumentation
 * @module ObnizApp
 */
Object.defineProperty(exports, "__esModule", { value: true });
exports.ObnizApp = void 0;
class ObnizApp {
    /**
     * Determine obniz.js is running on obniz Cloud or not.
     */
    static isCloudRunning() {
        return typeof done === 'function';
    }
    /**
     * request object on obniz Cloud execution for webhook call.
     *
     * ```javascript
     * // JavaScript example
     * const req = Obniz.App.req();
     * console.log(req.query);
     * console.log(req.body);
     * ```
     *
     */
    static req() {
        if (this.isCloudRunning()) {
            return req;
        }
        return null;
    }
    /**
     * done call for obniz Cloud execution.
     * Pass arguemnt for update cloud execution status.
     *
     * ```javascript
     * // JavaScript example
     * Obniz.App.done({
     *   status: 'success',  // 'success' | 'error'
     *   text: 'ex. Door Opened'
     * });
     * ```
     *
     */
    static done(arg) {
        if (this.isCloudRunning()) {
            // wait a few for last communication sent to socket.
            setTimeout(() => {
                done(arg);
            }, 1 * 1000);
        }
        else {
            console.error(`This program is not running on obniz Cloud.`);
        }
    }
    /**
     * Configration by user for This App. Only Available for BrowserApp
     */
    static configs() {
        if (typeof configs === 'object') {
            return configs;
        }
        else {
            return null;
        }
    }
}
exports.ObnizApp = ObnizApp;