bun-crumb 0.12.1 → 0.12.2

package/dist/index.d.ts

@@ -121,6 +121,45 @@ interface RouteResponse<T extends {
 } = {
     body: unknown;
 }> {
+    /**
+     * Sets Response body to provided `data`.
+     * Automatically sets `Content-Type` to `application/json` if an object was provided and transforms `data` to JSON.
+     *
+     * ### **IMPORTANT NOTES**:
+     *  - #### If `Content-Type` header is already set, this function will not change this header.
+     *
+     *
+     *
+     *
+     *  - #### If you want to complete request and send response, you must necessarily `return` the call of this function. Otherwise, code of your handler will continue executing and `Response` body could be changed.
+     *
+     * @param data value that will be sent to client
+     * @param options standard `Response` options from web API
+     *
+     * @example
+     * ```typescript
+     * response.setHeader('content-type', 'x-www-form-urlencoded'); // Set `Content-Type` header
+     *
+     * return response.send('Hello'); // This does not change `Content-Type` header, because this header is set above
+     * ```
+     *
+     * @example
+     * ```typescript
+     * return response.send('Hello'); // This sets `Content-Type` header to `text/plain`, because this header is not set above.
+     * ```
+     *
+     * @example
+     * ```typescript
+     * return response.send({ key: 'value' }); // This will set `Content-Type` header to `application/json`, because this header is not set above. Object is transformed to JSON automatically
+     * ```
+     *
+     * @example
+     * ```typescript
+     * response.send({key: 'value'}); // ❌ Without return, the code below changes the body of response
+     * response.send('Hello'); // ❌ This changes the body of response, but `Content-Type` header will not change
+     * ```
+     *
+     */
     send: (data?: T['body'], options?: ResponseOptions) => void;
     /**
      * Sets `Location` header to provided `url` and `response.status` to provided `status`
@@ -129,7 +168,7 @@ interface RouteResponse<T extends {
      *
      * @param url `Location` to redirect
      *
-     * @param status redirect http code (`3xx`)
+     * @param status redirect http code (`3xx`). Equals to 302 by default
      *
      * @example
      *
@@ -140,7 +179,7 @@ interface RouteResponse<T extends {
      * The same behaviour is
      * ```typescript
      * response.setHeader('Location', 'https://bun-crumb.vercel.app');
-     * return response.send('', {status: 302});
+     * return response.send('', { status: 302 });
      * ```
      */
     redirect: (url: string, status?: RedirectStatusCode | (number & {})) => void;
@@ -237,7 +276,8 @@ interface ListenOptions {
 declare const listen: (options?: ListenOptions) => void;
 
 /**
- * Creates a route with `url`, `method` and `handler`.
+ * #### Creates a route with `url`, `method` and `handler`.
+ *
  * Should be called before `listen` function is called.
  *
  *
@@ -261,8 +301,8 @@ declare const listen: (options?: ListenOptions) => void;
  *
  * @example
  * ```typescript
- * const deleteProduct = (
- *   request: RouteRequest,
+ * const deleteProduct: RouteHandler = (
+ *   request,
  *   response: RouteResponse<{ body: { error: string } | { product: Product } }>
  * ) => {
  *     const id = request.params.id;

package/dist/route.d.ts

@@ -1,6 +1,7 @@
 import type { RouteOptions } from './types';
 /**
- * Creates a route with `url`, `method` and `handler`.
+ * #### Creates a route with `url`, `method` and `handler`.
+ *
  * Should be called before `listen` function is called.
  *
  *
@@ -24,8 +25,8 @@ import type { RouteOptions } from './types';
  *
  * @example
  * ```typescript
- * const deleteProduct = (
- *   request: RouteRequest,
+ * const deleteProduct: RouteHandler = (
+ *   request,
  *   response: RouteResponse<{ body: { error: string } | { product: Product } }>
  * ) => {
  *     const id = request.params.id;

package/dist/runtime.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/types/route.d.ts

@@ -60,6 +60,45 @@ export interface RouteResponse<T extends {
 } = {
     body: unknown;
 }> {
+    /**
+     * Sets Response body to provided `data`.
+     * Automatically sets `Content-Type` to `application/json` if an object was provided and transforms `data` to JSON.
+     *
+     * ### **IMPORTANT NOTES**:
+     *  - #### If `Content-Type` header is already set, this function will not change this header.
+     *
+     *
+     *
+     *
+     *  - #### If you want to complete request and send response, you must necessarily `return` the call of this function. Otherwise, code of your handler will continue executing and `Response` body could be changed.
+     *
+     * @param data value that will be sent to client
+     * @param options standard `Response` options from web API
+     *
+     * @example
+     * ```typescript
+     * response.setHeader('content-type', 'x-www-form-urlencoded'); // Set `Content-Type` header
+     *
+     * return response.send('Hello'); // This does not change `Content-Type` header, because this header is set above
+     * ```
+     *
+     * @example
+     * ```typescript
+     * return response.send('Hello'); // This sets `Content-Type` header to `text/plain`, because this header is not set above.
+     * ```
+     *
+     * @example
+     * ```typescript
+     * return response.send({ key: 'value' }); // This will set `Content-Type` header to `application/json`, because this header is not set above. Object is transformed to JSON automatically
+     * ```
+     *
+     * @example
+     * ```typescript
+     * response.send({key: 'value'}); // ❌ Without return, the code below changes the body of response
+     * response.send('Hello'); // ❌ This changes the body of response, but `Content-Type` header will not change
+     * ```
+     *
+     */
     send: (data?: T['body'], options?: ResponseOptions) => void;
     /**
      * Sets `Location` header to provided `url` and `response.status` to provided `status`
@@ -68,7 +107,7 @@ export interface RouteResponse<T extends {
      *
      * @param url `Location` to redirect
      *
-     * @param status redirect http code (`3xx`)
+     * @param status redirect http code (`3xx`). Equals to 302 by default
      *
      * @example
      *
@@ -79,7 +118,7 @@ export interface RouteResponse<T extends {
      * The same behaviour is
      * ```typescript
      * response.setHeader('Location', 'https://bun-crumb.vercel.app');
-     * return response.send('', {status: 302});
+     * return response.send('', { status: 302 });
      * ```
      */
     redirect: (url: string, status?: RedirectStatusCode | (number & {})) => void;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "bun-crumb",
-    "version": "0.12.1",
+    "version": "0.12.2",
     "author": "marigold",
     "module": "dist/index.js",
     "license": "UNLICENSED",
@@ -17,6 +17,7 @@
         "rollup-plugin-dts": "^6.3.0",
         "tslib": "^2.8.1"
     },
+    "homepage": "https://bun-crumb.vercel.app",
     "files": [
         "dist"
     ],