@drenso/homey-log 9.34.1 → 9.35.0

package/build/index.d.ts

@@ -1,86 +1,86 @@
-export class Log {
-    /**
-     * Mimic SDK log method.
-     * @private
-     */
-    private static _log;
-    /**
-     * Mimic SDK error method.
-     * @private
-     */
-    private static _error;
-    /**
-     * Mimic SDK timestamp.
-     * @returns {string}
-     * @private
-     */
-    private static _logTime;
-    /**
-     * Whether logging is forced.
-     * @returns {boolean}
-     * @private
-     */
-    private static _isLogForced;
-    /**
-     * Construct a new Log instance.
-     * @param {object} args
-     * @param {import('homey/lib/Homey').default} args.homey - `this.homey` instance in
-     * your app (e.g. `App#homey`/`Driver#homey`/`Device#homey`).
-     *
-     * @param {object} [args.options] - Additional options for Sentry
-     *
-     * @example
-     * class MyApp extends Homey.App {
-     *   onInit() {
-     *     this.homeyLog = new Log({ homey: this.homey });
-     *   }
-     * }
-     */
-    constructor({ homey, options }: {
-        homey: import('homey/lib/Homey').default;
-        options?: object;
-    });
-    _capturedMessages: any[];
-    _capturedExceptions: any[];
-    _manifest: any;
-    _homeyVersion: any;
-    _managerCloud: any;
-    _homeyPlatform: any;
-    _homeyPlatformVersion: any;
-    /**
-     * Init Sentry.
-     * @param {string} dsn The Sentry DSN
-     * @param {object} opts Options to be passed to the Sentry init
-     * @returns {Log}
-     * @private
-     */
-    private init;
-    /**
-     * Set `tags` that will be sent as context with every message or error. See the Sentry Node.js
-     * documentation: https://docs.sentry.io/platforms/javascript/guides/node/enriching-events/tags/
-     * @param {object} tags
-     * @returns {Log}
-     */
-    setTags(tags: object): Log;
-    /**
-     * Set `user` that will be sent as context with every message or error. See the Sentry Node.js
-     * documentation: https://docs.sentry.io/platforms/javascript/guides/node/enriching-events/identify-user/.
-     * @param {object} user
-     * @returns {Log}
-     */
-    setUser(user: object): Log;
-    /**
-     * Create and send message event to Sentry. See the Sentry Node.js documentation:
-     * https://docs.sentry.io/platforms/javascript/guides/node/usage/
-     * @param {string} message - Message to be sent
-     * @returns {Promise<string>|undefined}
-     */
-    captureMessage(message: string): Promise<string> | undefined;
-    /**
-     * Create and send exception event to Sentry. See the sentry Node.js documentation:
-     * https://docs.sentry.io/platforms/javascript/guides/node/usage/
-     * @param {Error} err - Error instance to be sent
-     * @returns {Promise<string>|undefined}
-     */
-    captureException(err: Error): Promise<string> | undefined;
-}
+export class Log {
+    /**
+     * Mimic SDK log method.
+     * @private
+     */
+    private static _log;
+    /**
+     * Mimic SDK error method.
+     * @private
+     */
+    private static _error;
+    /**
+     * Mimic SDK timestamp.
+     * @returns {string}
+     * @private
+     */
+    private static _logTime;
+    /**
+     * Whether logging is forced.
+     * @returns {boolean}
+     * @private
+     */
+    private static _isLogForced;
+    /**
+     * Construct a new Log instance.
+     * @param {object} args
+     * @param {import('homey/lib/Homey').default} args.homey - `this.homey` instance in
+     * your app (e.g. `App#homey`/`Driver#homey`/`Device#homey`).
+     *
+     * @param {object} [args.options] - Additional options for Sentry
+     *
+     * @example
+     * class MyApp extends Homey.App {
+     *   onInit() {
+     *     this.homeyLog = new Log({ homey: this.homey });
+     *   }
+     * }
+     */
+    constructor({ homey, options }: {
+        homey: import('homey/lib/Homey').default;
+        options?: object;
+    });
+    _capturedMessages: any[];
+    _capturedExceptions: any[];
+    _manifest: any;
+    _homeyVersion: any;
+    _managerCloud: any;
+    _homeyPlatform: any;
+    _homeyPlatformVersion: any;
+    /**
+     * Init Sentry.
+     * @param {string} dsn The Sentry DSN
+     * @param {object} opts Options to be passed to the Sentry init
+     * @returns {Log}
+     * @private
+     */
+    private init;
+    /**
+     * Set `tags` that will be sent as context with every message or error. See the Sentry Node.js
+     * documentation: https://docs.sentry.io/platforms/javascript/guides/node/enriching-events/tags/
+     * @param {object} tags
+     * @returns {Log}
+     */
+    setTags(tags: object): Log;
+    /**
+     * Set `user` that will be sent as context with every message or error. See the Sentry Node.js
+     * documentation: https://docs.sentry.io/platforms/javascript/guides/node/enriching-events/identify-user/.
+     * @param {object} user
+     * @returns {Log}
+     */
+    setUser(user: object): Log;
+    /**
+     * Create and send message event to Sentry. See the Sentry Node.js documentation:
+     * https://docs.sentry.io/platforms/javascript/guides/node/usage/
+     * @param {string} message - Message to be sent
+     * @returns {Promise<string>|undefined}
+     */
+    captureMessage(message: string): Promise<string> | undefined;
+    /**
+     * Create and send exception event to Sentry. See the sentry Node.js documentation:
+     * https://docs.sentry.io/platforms/javascript/guides/node/usage/
+     * @param {Error} err - Error instance to be sent
+     * @returns {Promise<string>|undefined}
+     */
+    captureException(err: Error): Promise<string> | undefined;
+}