lib/notifier/client

Type Aliases

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

UserNotificationOptions

'Read the “', UserNotificationOptions, '” section'

type UserNotificationOptions = typeof notificationOptions[number];

Defined in: studiocms/packages/studiocms/src/lib/notifier/client.ts:14

Functions

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

formatNotificationOptions()

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

function formatNotificationOptions(options: (
  | "account_updated"
  | "page_updated"
  | "page_deleted"
  | "new_page"
  | "folder_updated"
  | "folder_deleted"
  | "new_folder"
  | "user_updated"
  | "user_deleted"
  | "new_user")[]): string

Defined in: studiocms/packages/studiocms/src/lib/notifier/client.ts:21

Parameters

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

options

'Read the “', options, '” section'

( | "account_updated" | "page_updated" | "page_deleted" | "new_page" | "folder_updated" | "folder_deleted" | "new_folder" | "user_updated" | "user_deleted" | "new_user")[]

Returns

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

string

---

getEnabledNotificationCheckboxes()

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

function getEnabledNotificationCheckboxes(formData: FormData): (
  | "account_updated"
  | "page_updated"
  | "page_deleted"
  | "new_page"
  | "folder_updated"
  | "folder_deleted"
  | "new_folder"
  | "user_updated"
  | "user_deleted"
  | "new_user")[]

Defined in: studiocms/packages/studiocms/src/lib/notifier/client.ts:16

Parameters

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

formData

'Read the “', formData, '” section'

FormData

Returns

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

( | "account_updated" | "page_updated" | "page_deleted" | "new_page" | "folder_updated" | "folder_deleted" | "new_folder" | "user_updated" | "user_deleted" | "new_user")[]