chore: Document axios interceptor and PwdConfirmationMode

README.md

@@ -16,18 +16,21 @@ This library exports a function that displays a password confirmation dialog whe
 
 ## Versions compatibility
 
-Nextcloud   | @nextcloud/vue | @nextcloud/password-confirmation
-------------|----------------|---------------------------------
-28.x        | 8.x            | 5.x
-25.x - 27.x | 7.x            | 2.x - 4.x
-< 25.x      | -              | 1.x
+| Nextcloud   | @nextcloud/vue | @nextcloud/password-confirmation |
+| ----------- | -------------- | -------------------------------- |
+| 28+         | 8.x            | 5.x                              |
+| 25.x - 27.x | 7.x            | 2.x - 4.x                        |
+| < 25.x      | -              | 1.x                              |
 
 ## Installation
 ```sh
 npm add @nextcloud/password-confirmation
 ```
 
 ## Usage
+
+### Direct usage
+
 ```js
 import { confirmPassword } from '@nextcloud/password-confirmation'
 import '@nextcloud/password-confirmation/style.css' // Required for dialog styles
@@ -42,6 +45,30 @@ const foo = async () => {
 }
 ```
 
+### Usage with axios interceptor
+
+```js
+import axios from '@nextcloud/axios'
+import { addPasswordConfirmationInterceptors, PwdConfirmationMode } from '@nextcloud/password-confirmation'
+import '@nextcloud/password-confirmation/style.css' // Required for dialog styles
+
+addPasswordConfirmationInterceptors(axios)
+
+const foo = async () => {
+    try {
+        const response = await axios.request({
+            confirmPassword: PwdConfirmationMode.Strict,
+            method,
+            url,
+            data: this.getData(),
+        })
+        // Your logic
+    } catch (error) {
+        // Your error handling logic
+    }
+}
+```
+
 ## API Reference
 ```ts
 /**
@@ -62,6 +89,15 @@ declare function isPasswordConfirmationRequired(): boolean
  *                         or confirmation is already in process.
  */
 declare function confirmPassword(): Promise<void>
+
+/**
+ * Lax: Confirm password if needed.
+ * Strict: Confirm in the request.
+ */
+export enum PwdConfirmationMode {
+	Lax = 'lax',
+	Strict = 'strict',
+}
 ```
 
 ## Releasing

src/globals.ts

@@ -3,6 +3,10 @@
  * SPDX-License-Identifier: MIT
  */
 
+/**
+ * Lax: Confirm password if needed.
+ * Strict: Confirm in the request.
+ */
 export enum PwdConfirmationMode {
 	Lax = 'lax',
 	Strict = 'strict',