📘 doc(plugin/stream): add event and retry

Author: SaltyAom

docs/.vitepress/config.ts

@@ -290,6 +290,10 @@ export default defineConfig({
                                 text: 'JWT',
                                 link: '/plugins/jwt'
                             },
+                            {
+                                text: 'Server Timing',
+                                link: '/plugins/server-timing'
+                            },
                             {
                                 text: 'Static',
                                 link: '/plugins/static'

docs/plugins/overview.md

@@ -34,6 +34,7 @@ That's why Elysia is creating pre-built common pattern plugin for convinient usa
 - [GraphQL Yoga](/plugins/graphql-yoga) - run GraphQL Yoga on Elysia
 - [HTML](/plugins/html) - convenient plugin for handling HTML response
 - [JWT](/plugins/jwt) - authentication with JWT
+- [Server Timing](/plugins/server-timing) - audit performance bottleneck with Server Timing API
 - [Static](/plugins/static) - serve static file/folders
 - [Stream](/plugins/stream) - response streaming, and server sent event
 - [Swagger](/plugins/swagger) - generate Swagger documentation in 1 line

docs/plugins/server-timing.md

@@ -0,0 +1,89 @@
+---
+title: Server Timing Plugin - ElysiaJS
+head:
+    - - meta
+      - property: 'og:title'
+        content: Server Timing Plugin - ElysiaJS
+
+    - - meta
+      - name: 'description'
+        content: Plugin for Elysia for performance audit via Server Timing API. Start by installing the plugin with "bun add @elysiajs/server-timing".
+
+    - - meta
+      - name: 'og:description'
+        content: Plugin for Elysia that add support for streaming response and Server Sent Event, eg. OpenAI integration. Start by installing the plugin with "bun add @elysiajs/server-timing".
+---
+
+# Stream Plugin
+This plugin add support for streaming response or sending Server Sent Event back to client.
+
+Install with:
+```bash
+bun add @elysiajs/server-timing
+```
+
+Then use it:
+```typescript
+import { Elysia } from 'elysia'
+import { serverTiming } from '@elysiajs/server-timing'
+
+new Elysia()
+    .use(serverTiming())
+    .get('/', () => 'hello')
+    .listen(8080)
+```
+
+Server Timing then will append header 'Server-Timing' with log duration, function name and detail for each life-cycle function.
+
+To inspect, open browser developer tools > Network > [Request made through Elysia server] > Timing.
+
+Then inspect the Server Timing of your server
+
+## Config
+Below is a config which is accepted by the plugin
+
+### enabled
+@default `NODE_ENV !== 'production'`
+
+Determine whether or not Server Timing should be enabled
+
+### allow
+@default `undefined`
+
+A condition whether server timing should be log
+
+### trace
+@default `undefined`
+
+Allow Server Timing to log specified life-cycle events:
+
+Trace accepts object of the following:
+- request: capture duration from request
+- parse: capture duration from parse
+- transform: capture duration from transform
+- beforeHandle: capture duration from beforeHandle
+- handle: capture duration from handle
+- afterHandle: capture duration from afterHandle
+- total: capture total duration from start to finish
+
+## Pattern
+Below you can find the common patterns to use the plugin.
+
+- [Allow Condition](#allow-condition)
+
+## Allow Condition
+You may disabled Server Timing on specific route via `allow` property
+
+```ts
+import { Elysia } from 'elysia'
+import { serverTiming } from '@elysiajs/server-timing'
+
+new Elysia()
+    .use(
+        serverTiming({
+            allow: ({ request }) => {
+                return new URL(request.url).pathname !== '/no-trace'
+            }
+        })
+    )
+```

docs/plugins/static.md

@@ -85,6 +85,8 @@ Set response headers of files
 ## Pattern
 Below you can find the common patterns to use the plugin.
 
+- [Single File](#single-file)
+
 ## Single file
 Suppose you want to return just a single file, you can use `Bun.file` instead of using static plugin
 ```typescript

docs/plugins/stream.md

@@ -7,11 +7,11 @@ head:
 
     - - meta
       - name: 'description'
-        content: Plugin for Elysia that add support for streaming response and Server Sent Event, eg. OpenAI integration. Start by installing the plugin with "bun add @elysiajs/static".
+        content: Plugin for Elysia that add support for streaming response and Server Sent Event, eg. OpenAI integration. Start by installing the plugin with "bun add @elysiajs/stream".
 
     - - meta
       - name: 'og:description'
-        content: Plugin for Elysia that add support for streaming response and Server Sent Event, eg. OpenAI integration. Start by installing the plugin with "bun add @elysiajs/static".
+        content: Plugin for Elysia that add support for streaming response and Server Sent Event, eg. OpenAI integration. Start by installing the plugin with "bun add @elysiajs/stream".
 ---
 
 # Stream Plugin
@@ -43,12 +43,16 @@ By default, `Stream` will return `Response` with `content-type` of `text/event-s
 
 ## Constructor
 Below is the constructor parameter accept by `Stream`:
-- Automatic: 
-    - Iterable
-    - AsyncIterable
-    - ReadableStream
-    - Response
-- Manual: Callback of `(stream: this) => unknown` or `undefined`
+1. Stream:
+    - Automatic: Automatically stream response from provided value
+        - Iterable
+        - AsyncIterable
+        - ReadableStream
+        - Response
+    - Manual: Callback of `(stream: this) => unknown` or `undefined`
+2. Options: `StreamOptions`
+    - [event](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events#event): A string identifying the type of event described
+    - [retry](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events#retry): The reconnection time in milliseconds
 
 ## Method
 Below is the method provided by `Stream`:
@@ -65,7 +69,11 @@ Return a promise that resolved in provided value in ms
 ### value
 Inner value of the `ReadableStream`
 
-# Example
+## Pattern
+Below you can find the common patterns to use the plugin.
+- [OpenAI](#openai)
+- [Fetch Stream](#fetch-stream)
+- [Server Sent Event](#server-sent-event)
 
 ## OpenAI
 Automatic mode is triggered when parameter is either `Iterable` or `AsyncIterable` streaming response back to client automatically.