Skip to content

Latest commit

 

History

History
73 lines (49 loc) · 3.05 KB

README.md

File metadata and controls

73 lines (49 loc) · 3.05 KB
Raw

Welcome to One Dionys - Notification System! 👋

Package to display notifications to users such as success, warning, or error messages. 💖

💾 Requirements

  • Web Browser - Can be used as an emulator to build applications. Example [Chrome, Firefox, Safari & Opera].
  • Internet - Because many use CDN and to make it easier to find solutions to all problems.

🎯 How To Use

Example Syntax

const NotificationSystem = require('notification-system');

const notificationSystem = new NotificationSystem();

notificationSystem.addNotification('Hello world!');
console.log(notificationSystem.getNotifications()); // Output: [{ message: 'Hello world!', type: 'info' }]

notificationSystem.clearNotifications();
console.log(notificationSystem.getNotifications()); // Output: []

Explanation

  • This package provides a NotificationSystem class with methods to add, clear, and retrieve notifications. Notifications are stored as objects with message and type properties.

Return Value

  • addNotification(message, type): Adds a notification to the system. The type parameter is optional and defaults to 'info'.
  • clearNotifications(): Clears all notifications from the system.
  • getNotifications(): Returns an array of all current notifications.

📆 Release Date

  • v1.0.0 : 08 March 2024
  • v1.0.1 : 11 March 2024
  • v4.0.0 : 11 March 2024
  • v4.0.1 : 13 March 2024
  • v4.0.2 : 18 March 2024
  • v5.0.0 : 31 March 2024

🧑 Author

📝 License

  • Copyright © 2024 One Dionys
  • One Dionys - Notification System is an open source project licensed under the MIT license

☕️ Suppport & Donation

Love One Dionys - Notification System? Support this project by donating or sharing with others in need.

Made with ❤️ One Dionys