lib/notifier

Type Aliases

'Read the “', Type Aliases, '” section'

AdminNotification

'Read the “', AdminNotification, '” section'

type AdminNotification = keyof AdminNotifications;

Defined in: studiocms/packages/studiocms/src/lib/notifier/index.ts:112

The type of the adminNotificationTypes array.

---

EditorNotification

'Read the “', EditorNotification, '” section'

type EditorNotification = keyof EditorNotifications;

Defined in: studiocms/packages/studiocms/src/lib/notifier/index.ts:107

The type of the editorNotificationTypes array.

---

UserNotification

'Read the “', UserNotification, '” section'

type UserNotification = keyof UserNotifications;

Defined in: studiocms/packages/studiocms/src/lib/notifier/index.ts:102

The type of the userNotificationTypes array.

Variables

'Read the “', Variables, '” section'

notificationTitleStrings

'Read the “', notificationTitleStrings, '” section'

const notificationTitleStrings: Record<UserNotificationOptions, string>;

Defined in: studiocms/packages/studiocms/src/lib/notifier/index.ts:57

An object containing notification titles for each notification type.

---

notificationTypes

'Read the “', notificationTypes, '” section'

const notificationTypes: {
  admin: string[];
  editor: string[];
  user: string[];
};

Defined in: studiocms/packages/studiocms/src/lib/notifier/index.ts:93

An object containing all notification types.

Type declaration

'Read the “', Type declaration, '” section'

admin

'Read the “', admin, '” section'

admin: string[];

editor

'Read the “', editor, '” section'

editor: string[];

user

'Read the “', user, '” section'

user: string[];

Functions

'Read the “', Functions, '” section'

sendAdminNotification()

'Read the “', sendAdminNotification(), '” section'

function sendAdminNotification<T, K>(notification: T, data: K): Promise<void>

Defined in: studiocms/packages/studiocms/src/lib/notifier/index.ts:292

Sends an admin notification if the mailer is enabled and the mail connection is verified.

Type Parameters

'Read the “', Type Parameters, '” section'

T

'Read the “', T, '” section'

T extends "user_updated" | "user_deleted" | "new_user"

The type of the admin notification.

K

'Read the “', K, '” section'

K extends string

The type of the data required by the notification.

Parameters

'Read the “', Parameters, '” section'

notification

'Read the “', notification, '” section'

T

The type of notification to send.

data

'Read the “', data, '” section'

K

The data to include in the notification.

Returns

'Read the “', Returns, '” section'

Promise<void>

---

sendEditorNotification()

'Read the “', sendEditorNotification(), '” section'

function sendEditorNotification<T, K>(notification: T, data: K): Promise<void>

Defined in: studiocms/packages/studiocms/src/lib/notifier/index.ts:251

Sends an editor notification if the mailer is enabled and the mail connection is verified.

Type Parameters

'Read the “', Type Parameters, '” section'

T

'Read the “', T, '” section'

T extends | "page_updated" | "page_deleted" | "new_page" | "folder_updated" | "folder_deleted" | "new_folder"

The type of the editor notification.

K

'Read the “', K, '” section'

K extends string

The type of the data required by the notification.

Parameters

'Read the “', Parameters, '” section'

notification

'Read the “', notification, '” section'

T

The type of notification to send.

data

'Read the “', data, '” section'

K

The data to include in the notification.

Returns

'Read the “', Returns, '” section'

Promise<void>

---

sendUserNotification()

'Read the “', sendUserNotification(), '” section'

function sendUserNotification<T>(notification: T, userId: string): Promise<void>

Defined in: studiocms/packages/studiocms/src/lib/notifier/index.ts:204

Sends a user notification if the mailer is enabled and the mail connection is verified.

Type Parameters

'Read the “', Type Parameters, '” section'

T

'Read the “', T, '” section'

T extends "account_updated"

The type of the user notification.

Parameters

'Read the “', Parameters, '” section'

notification

'Read the “', notification, '” section'

T

The notification to be sent.

userId

'Read the “', userId, '” section'

string

The ID of the user to whom the notification will be sent.

Returns

'Read the “', Returns, '” section'

Promise<void>

A promise that resolves when the notification is sent or if the mailer is disabled.