updated the examples for beforeSend/afterSend hooks

Author: ganigeorgiev

README.md

@@ -404,6 +404,8 @@ To accomplish this, the SDK provides 2 function hooks:
 
         return { url, options };
     };
+
+    // use the created client as usual...
     ```
 
 - `afterSend` - triggered after successfully sending the `fetch` request, allowing you to inspect/modify the response object and its parsed data.
@@ -419,6 +421,8 @@ To accomplish this, the SDK provides 2 function hooks:
             "additionalField": 123,
         });
     };
+
+    // use the created client as usual...
     ```
 
 ### SSR integration

dist/pocketbase.cjs.d.ts

@@ -1202,13 +1202,17 @@ declare class Client {
      *
      * Example:
      * ```js
-     * client.beforeSend = function (url, options) {
+     * const pb = new PocketBase("https://example.com")
+     *
+     * pb.beforeSend = function (url, options) {
      *     options.headers = Object.assign({}, options.headers, {
      *         'X-Custom-Header': 'example',
-     *     });
+     *     })
      *
      *     return { url, options }
-     * };
+     * }
+     *
+     * // use the created client as usual...
      * ```
      */
     beforeSend?: (url: string, options: SendOptions) => BeforeSendResult | Promise<BeforeSendResult>;
@@ -1220,17 +1224,21 @@ declare class Client {
      *
      * Example:
      * ```js
-     * client.afterSend = function (response, data, options) {
+     * const pb = new PocketBase("https://example.com")
+     *
+     * pb.afterSend = function (response, data, options) {
      *     if (response.status != 200) {
      *         throw new ClientResponseError({
      *             url:      response.url,
      *             status:   response.status,
      *             response: { ... },
-     *         });
+     *         })
      *     }
      *
      *     return data;
-     * };
+     * }
+     *
+     * // use the created client as usual...
      * ```
      */
     afterSend?: ((response: Response, data: any) => any) & ((response: Response, data: any, options: SendOptions) => any);

dist/pocketbase.cjs.js.map

@@ -1245,13 +1245,17 @@ declare class Client {
      *
      * Example:
      * ```js
-     * client.beforeSend = function (url, options) {
+     * const pb = new PocketBase("https://example.com")
+     *
+     * pb.beforeSend = function (url, options) {
      *     options.headers = Object.assign({}, options.headers, {
      *         'X-Custom-Header': 'example',
-     *     });
+     *     })
      *
      *     return { url, options }
-     * };
+     * }
+     *
+     * // use the created client as usual...
      * ```
      */
     beforeSend?: (url: string, options: SendOptions) => BeforeSendResult | Promise<BeforeSendResult>;
@@ -1263,17 +1267,21 @@ declare class Client {
      *
      * Example:
      * ```js
-     * client.afterSend = function (response, data, options) {
+     * const pb = new PocketBase("https://example.com")
+     *
+     * pb.afterSend = function (response, data, options) {
      *     if (response.status != 200) {
      *         throw new ClientResponseError({
      *             url:      response.url,
      *             status:   response.status,
      *             response: { ... },
-     *         });
+     *         })
      *     }
      *
      *     return data;
-     * };
+     * }
+     *
+     * // use the created client as usual...
      * ```
      */
     afterSend?: ((response: Response, data: any) => any) & ((response: Response, data: any, options: SendOptions) => any);

dist/pocketbase.es.d.mts

@@ -1245,13 +1245,17 @@ declare class Client {
      *
      * Example:
      * ```js
-     * client.beforeSend = function (url, options) {
+     * const pb = new PocketBase("https://example.com")
+     *
+     * pb.beforeSend = function (url, options) {
      *     options.headers = Object.assign({}, options.headers, {
      *         'X-Custom-Header': 'example',
-     *     });
+     *     })
      *
      *     return { url, options }
-     * };
+     * }
+     *
+     * // use the created client as usual...
      * ```
      */
     beforeSend?: (url: string, options: SendOptions) => BeforeSendResult | Promise<BeforeSendResult>;
@@ -1263,17 +1267,21 @@ declare class Client {
      *
      * Example:
      * ```js
-     * client.afterSend = function (response, data, options) {
+     * const pb = new PocketBase("https://example.com")
+     *
+     * pb.afterSend = function (response, data, options) {
      *     if (response.status != 200) {
      *         throw new ClientResponseError({
      *             url:      response.url,
      *             status:   response.status,
      *             response: { ... },
-     *         });
+     *         })
      *     }
      *
      *     return data;
-     * };
+     * }
+     *
+     * // use the created client as usual...
      * ```
      */
     afterSend?: ((response: Response, data: any) => any) & ((response: Response, data: any, options: SendOptions) => any);

dist/pocketbase.es.d.ts

@@ -1202,13 +1202,17 @@ declare class Client {
      *
      * Example:
      * ```js
-     * client.beforeSend = function (url, options) {
+     * const pb = new PocketBase("https://example.com")
+     *
+     * pb.beforeSend = function (url, options) {
      *     options.headers = Object.assign({}, options.headers, {
      *         'X-Custom-Header': 'example',
-     *     });
+     *     })
      *
      *     return { url, options }
-     * };
+     * }
+     *
+     * // use the created client as usual...
      * ```
      */
     beforeSend?: (url: string, options: SendOptions) => BeforeSendResult | Promise<BeforeSendResult>;
@@ -1220,17 +1224,21 @@ declare class Client {
      *
      * Example:
      * ```js
-     * client.afterSend = function (response, data, options) {
+     * const pb = new PocketBase("https://example.com")
+     *
+     * pb.afterSend = function (response, data, options) {
      *     if (response.status != 200) {
      *         throw new ClientResponseError({
      *             url:      response.url,
      *             status:   response.status,
      *             response: { ... },
-     *         });
+     *         })
      *     }
      *
      *     return data;
-     * };
+     * }
+     *
+     * // use the created client as usual...
      * ```
      */
     afterSend?: ((response: Response, data: any) => any) & ((response: Response, data: any, options: SendOptions) => any);

dist/pocketbase.es.js.map

@@ -1202,13 +1202,17 @@ declare class Client {
      *
      * Example:
      * ```js
-     * client.beforeSend = function (url, options) {
+     * const pb = new PocketBase("https://example.com")
+     *
+     * pb.beforeSend = function (url, options) {
      *     options.headers = Object.assign({}, options.headers, {
      *         'X-Custom-Header': 'example',
-     *     });
+     *     })
      *
      *     return { url, options }
-     * };
+     * }
+     *
+     * // use the created client as usual...
      * ```
      */
     beforeSend?: (url: string, options: SendOptions) => BeforeSendResult | Promise<BeforeSendResult>;
@@ -1220,17 +1224,21 @@ declare class Client {
      *
      * Example:
      * ```js
-     * client.afterSend = function (response, data, options) {
+     * const pb = new PocketBase("https://example.com")
+     *
+     * pb.afterSend = function (response, data, options) {
      *     if (response.status != 200) {
      *         throw new ClientResponseError({
      *             url:      response.url,
      *             status:   response.status,
      *             response: { ... },
-     *         });
+     *         })
      *     }
      *
      *     return data;
-     * };
+     * }
+     *
+     * // use the created client as usual...
      * ```
      */
     afterSend?: ((response: Response, data: any) => any) & ((response: Response, data: any, options: SendOptions) => any);