npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@anzuev/notify

v0.0.1

Published

Notification service for StudCloud project

Downloads

6

Readme

Notify

Notify~Notify

Kind: inner class of Notify
Friend: BaseNotification

Notify.configure(config)

Настройка модуля(логгера)

Kind: static method of Notify

| Param | Description | | --- | --- | | config | конфиг типа nconf |

Notify.setMailAccounts(accounts) ⇒

Передача почтовых аккаунтов, с которых будут слаться уведомления

Kind: static method of Notify
Returns: void

| Param | Description | | --- | --- | | accounts | аккаунты для связки |

Example

let accounts = {
		mailConfirm: { // название нотификации
		mail: '[email protected]', // какой адрес используем
			password: "quetbxdfpzhtsnid", // какой пароль к ящику
			htmlTemp: "/Users/anton/GitHub/Notify/templates/MailConfirm.html" // путь к шаблону письма
		},
		restorePassword: {
			mail: "[email protected]",
			password: "quetbxdfpzhtsnid"
		}
	};
Notify.setMailAccounts(accounts);

Notify.getMailConfirmNotification() ⇒ MailConfirmationNotification

Получение класса для создания нотификации для подтверждения почты

Kind: static method of Notify
Throws:

  • ValidationError , code = 500, Модуль Notify не был настроен(Notify.configure and Notify.setMailAccounts)

Notify~BaseNotification

Класс для представления нотификации по почте. Здесь определены сеттеры/геттеры для нотификации, а также отправка в общем случае(без рендеринга сообщения)

Kind: inner class of Notify
Properties

| Name | Type | Description | | --- | --- | --- | | subject | String | тема письма | | cc | Array.<String> | массив адрессов в открытой копии | | bcc | Array.<String> | массив адрессов в закрытой копии | | type | String | тип нотификации(mailConfirm и тд) | | html | String | html-содержимое письма | | text | Sting | raw-содержимое пиьсма | | attachment | | массив прикрепленных докумнетов(не реализовано) |

baseNotification.setCc(addresses)

Установка адресов в копию

Kind: instance method of BaseNotification

| Param | Type | Description | | --- | --- | --- | | addresses | Array.<String> | адреса |

baseNotification.setBcc(addresses)

Установка адресов в скрытую копию

Kind: instance method of BaseNotification

| Param | Type | Description | | --- | --- | --- | | addresses | Array.<String> | адреса |

baseNotification.setHtml(html)

Установка html-содержимого для письма

Kind: instance method of BaseNotification

| Param | Type | Description | | --- | --- | --- | | html | String | html-содержимое |

baseNotification.setText(text)

Установка raw-содержимого для письма

Kind: instance method of BaseNotification

| Param | Type | Description | | --- | --- | --- | | text | String | raw-содержимое |

baseNotification.setSubject(subject)

Установка темы для письма

Kind: instance method of BaseNotification

| Param | Type | Description | | --- | --- | --- | | subject | String | subject-содержимое |

baseNotification.getType() ⇒ String

Получение типа

Kind: instance method of BaseNotification
Returns: String - type

baseNotification.getHtml() ⇒ String

Получение html-содержимого

Kind: instance method of BaseNotification
Returns: String - html

baseNotification.getText() ⇒ String

Получение raw-текста

Kind: instance method of BaseNotification
Returns: String - text

baseNotification.getSubject() ⇒ String

Получение темы

Kind: instance method of BaseNotification
Returns: String - topic

baseNotification.getCc() ⇒ Array.<String>

Получение копии

Kind: instance method of BaseNotification
Returns: Array.<String> - сс

baseNotification.getBcc() ⇒ Array.<String>

Получение скрытой копии

Kind: instance method of BaseNotification
Returns: Array.<String> - bсс

BaseNotification.BaseNotification

Kind: static class of BaseNotification

new BaseNotification()

Конструктор, создает новую нотификацию

Notify~MailConfirmationNotification ⇐ BaseNotification

Класс, представляющий нотификацию, отправляемую на почту, для подтверждения почты. Наследуется от Base

Kind: inner class of Notify
Extends: BaseNotification

mailConfirmationNotification.sendToMany(users) ⇒ void

Отправка уведомления нескольким пользователям

Kind: instance method of MailConfirmationNotification
Access: public

| Param | Type | Description | | --- | --- | --- | | users | Array.<String> | массив адресов для отправки |

mailConfirmationNotification.sendToOne(user) ⇒ void

Отправка уведомления одному пользователю

Kind: instance method of MailConfirmationNotification
Access: public

| Param | Type | Description | | --- | --- | --- | | user | String | адрес для отправки |

MailConfirmationNotification.MailConfirmationNotification

Kind: static class of MailConfirmationNotification
Access: public

new MailConfirmationNotification(link)

Конструктор для MailConfirmationNotification

| Param | Description | | --- | --- | | link | ссылка для подтверждения почты(уже с вставленной почтой и ключом) Формат - host + /auth/confirmMail?mail=%s&key=%s |