CalvinBackup/tauri-plugins-workspace
1
0
Fork 0
mirror of https://github.com/tauri-apps/plugins-workspace.git synced 2026-05-29 13:31:27 +02:00
Code Issues Packages Projects Releases Wiki Activity

fix(docs): plugin usage examples using wrong package name (#527)

Browse Source
This commit is contained in:
Lucas Fernandes Nogueira
2023-08-02 03:41:14 -07:00
committed by GitHub
parent 6f01bc11ab
commit 7f2e2dd5b8
4 changed files with 74 additions and 74 deletions
Download Patch File Download Diff File Expand all files Collapse all files
plugins/notification/guest-js/index.ts
+13 -13
View File
@@ -296,7 +296,7 @@ type Permission = "granted" | "denied" | "default";
* Checks if the permission to send notifications is granted.
* @example
* ```typescript
* import { isPermissionGranted } from '@tauri-apps/api/notification';
* import { isPermissionGranted } from '@tauri-apps/plugin-notification';
* const permissionGranted = await isPermissionGranted();
* ```
*
@@ -313,7 +313,7 @@ async function isPermissionGranted(): Promise<boolean> {
* Requests the permission to send notifications.
* @example
* ```typescript
* import { isPermissionGranted, requestPermission } from '@tauri-apps/api/notification';
* import { isPermissionGranted, requestPermission } from '@tauri-apps/plugin-notification';
* let permissionGranted = await isPermissionGranted();
* if (!permissionGranted) {
* const permission = await requestPermission();
@@ -333,7 +333,7 @@ async function requestPermission(): Promise<Permission> {
* Sends a notification to the user.
* @example
* ```typescript
* import { isPermissionGranted, requestPermission, sendNotification } from '@tauri-apps/api/notification';
* import { isPermissionGranted, requestPermission, sendNotification } from '@tauri-apps/plugin-notification';
* let permissionGranted = await isPermissionGranted();
* if (!permissionGranted) {
* const permission = await requestPermission();
@@ -362,7 +362,7 @@ function sendNotification(options: Options | string): void {
*
* @example
* ```typescript
* import { registerActionTypes } from '@tauri-apps/api/notification';
* import { registerActionTypes } from '@tauri-apps/plugin-notification';
* await registerActionTypes([{
* id: 'tauri',
* actions: [{
@@ -385,7 +385,7 @@ async function registerActionTypes(types: ActionType[]): Promise<void> {
*
* @example
* ```typescript
* import { pending } from '@tauri-apps/api/notification';
* import { pending } from '@tauri-apps/plugin-notification';
* const pendingNotifications = await pending();
* ```
*
@@ -402,7 +402,7 @@ async function pending(): Promise<PendingNotification[]> {
*
* @example
* ```typescript
* import { cancel } from '@tauri-apps/api/notification';
* import { cancel } from '@tauri-apps/plugin-notification';
* await cancel([-34234, 23432, 4311]);
* ```
*
@@ -419,7 +419,7 @@ async function cancel(notifications: number[]): Promise<void> {
*
* @example
* ```typescript
* import { cancelAll } from '@tauri-apps/api/notification';
* import { cancelAll } from '@tauri-apps/plugin-notification';
* await cancelAll();
* ```
*
@@ -436,7 +436,7 @@ async function cancelAll(): Promise<void> {
*
* @example
* ```typescript
* import { active } from '@tauri-apps/api/notification';
* import { active } from '@tauri-apps/plugin-notification';
* const activeNotifications = await active();
* ```
*
@@ -453,7 +453,7 @@ async function active(): Promise<ActiveNotification[]> {
*
* @example
* ```typescript
* import { cancel } from '@tauri-apps/api/notification';
* import { cancel } from '@tauri-apps/plugin-notification';
* await cancel([-34234, 23432, 4311])
* ```
*
@@ -470,7 +470,7 @@ async function removeActive(notifications: number[]): Promise<void> {
*
* @example
* ```typescript
* import { removeAllActive } from '@tauri-apps/api/notification';
* import { removeAllActive } from '@tauri-apps/plugin-notification';
* await removeAllActive()
* ```
*
@@ -487,7 +487,7 @@ async function removeAllActive(): Promise<void> {
*
* @example
* ```typescript
* import { createChannel, Importance, Visibility } from '@tauri-apps/api/notification';
* import { createChannel, Importance, Visibility } from '@tauri-apps/plugin-notification';
* await createChannel({
* id: 'new-messages',
* name: 'New Messages',
@@ -511,7 +511,7 @@ async function createChannel(channel: Channel): Promise<void> {
*
* @example
* ```typescript
* import { removeChannel } from '@tauri-apps/api/notification';
* import { removeChannel } from '@tauri-apps/plugin-notification';
* await removeChannel();
* ```
*
@@ -528,7 +528,7 @@ async function removeChannel(id: string): Promise<void> {
*
* @example
* ```typescript
* import { channels } from '@tauri-apps/api/notification';
* import { channels } from '@tauri-apps/plugin-notification';
* const notificationChannels = await channels();
* ```
*