@types/ng-notify

Installation

npm install --save @types/ng-notify

Summary

This package contains type definitions for ng-notify (https://github.com/matowens/ng-notify).

Details

Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/ng-notify.

index.d.ts

/// <reference types="angular"/>

declare namespace ngNotify {
    /**
     * Contains the options used to configure notification.
     */
    interface IUserOptions {
        type?: string | undefined;
        theme?: string | undefined;
        position?: string | undefined;
        duration?: number | undefined;
        sticky?: boolean | undefined;
        button?: boolean | undefined;
        html?: boolean | undefined;
    }

    /**
     * Simply and lightweight notification service for AngularJS
     */
    interface INotifyService {
        /**
         * Allows to create a whole new set of styles for each notification type.
         * @param themeName The name used when setting the theme in the config object.
         * @param className The class used to target this theme in the stylesheet.
         */
        addTheme(themeName: string, className: string): void;

        /**
         * Allows to create a new type of notification to use in their app.
         * @param typeName The name used to trigger this notification type in the set method.
         * @param className The class used to target this type in the stylesheet.
         */
        addType(typeName: string, className: string): void;

        /**
         * Sets default settings for all notifications to take into account when displaying.
         * @param userOptions Notification configuration object
         */
        config(userOptions: IUserOptions): void;

        /**
         * Manually dismisses any sticky notifications that may still be set.
         */
        dismiss(): void;

        /**
         * Displays a notification message.
         * @param message A message text to display.
         */
        set(message: string): void;

        /**
         * Displays a notification message and sets the type for this one notification.
         * @param message A message text to display.
         * @param type The type of the notification.
         */
        set(message: string, type: string): void;

        /**
         * displays a notification message and sets the formatting/behavioral options for this one notification.
         * @param message A message text to display.
         * @param userOptions Notification configuration object.
         */
        set(message: string, userOptions: IUserOptions): void;
    }
}

Additional Details

• Last updated: Tue, 07 Nov 2023 09:09:39 GMT
• Dependencies: @types/angular

Credits

These definitions were written by Nick Zamosenchuk.