mirror of
https://github.com/gosticks/DefinitelyTyped.git
synced 2025-10-16 12:05:41 +00:00
964674cbc1
- update definition to v6 - v5 created for backward compatible use - change type definition for `NotificationCenter.timeout` documenting change in v6 compared to v5 - added missing `sound` property of WindowsBalloon - update the `notify` parameters for general notification - update package configuration to support current DT defaults - reflect the package structure with `.d.ts` files location Thanks!
61 lines
2.3 KiB
TypeScript
61 lines
2.3 KiB
TypeScript
// Type definitions for node-notifier 6.0
|
|
// Project: https://github.com/mikaelbr/node-notifier
|
|
// Definitions by: Qubo <https://github.com/tkQubo>
|
|
// Lorenzo Rapetti <https://github.com/loryman>
|
|
// Piotr Błażejewicz <https://github.com/peterblazejewicz>
|
|
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
|
|
|
|
/// <reference types="node" />
|
|
|
|
import NotificationCenter = require('./notifiers/notificationcenter');
|
|
import NotifySend = require('./notifiers/notifysend');
|
|
import WindowsToaster = require('./notifiers/toaster');
|
|
import WindowsBalloon = require('./notifiers/balloon');
|
|
import Growl = require('./notifiers/growl');
|
|
|
|
declare namespace nodeNotifier {
|
|
interface NodeNotifier extends NodeJS.EventEmitter {
|
|
notify(notification?: NotificationCenter.Notification, callback?: NotificationCallback): NotificationCenter;
|
|
notify(notification?: WindowsToaster.Notification, callback?: NotificationCallback): WindowsToaster;
|
|
notify(notification?: WindowsBalloon.Notification, callback?: NotificationCallback): WindowsBalloon;
|
|
notify(notification?: NotifySend.Notification, callback?: NotificationCallback): NotifySend;
|
|
notify(notification?: Growl.Notification, callback?: NotificationCallback): Growl;
|
|
notify(notification?: Notification | string, callback?: NotificationCallback): NodeNotifier;
|
|
NotificationCenter: typeof NotificationCenter;
|
|
NotifySend: typeof NotifySend;
|
|
WindowsToaster: typeof WindowsToaster;
|
|
WindowsBalloon: typeof WindowsBalloon;
|
|
Growl: typeof Growl;
|
|
}
|
|
|
|
interface Notification {
|
|
title?: string;
|
|
message?: string;
|
|
/** Absolute path (not balloons) */
|
|
icon?: string;
|
|
/** Wait with callback until user action is taken on notification */
|
|
wait?: boolean;
|
|
}
|
|
|
|
interface NotificationMetadata {
|
|
activationType?: string;
|
|
activationAt?: string;
|
|
deliveredAt?: string;
|
|
activationValue?: string;
|
|
activationValueIndex?: string;
|
|
}
|
|
|
|
interface NotificationCallback {
|
|
(err: Error | null, response: string, metadata?: NotificationMetadata): void;
|
|
}
|
|
|
|
interface Option {
|
|
withFallback?: boolean;
|
|
customPath?: string;
|
|
}
|
|
}
|
|
|
|
declare var nodeNotifier: nodeNotifier.NodeNotifier;
|
|
|
|
export = nodeNotifier;
|