Add newTestUserAgent example

mojolicious · Mar 18, 2023 · cc51cf4 · cc51cf4
1 parent a064777
commit cc51cf4
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/src/app.ts b/src/app.ts
@@ -353,6 +353,10 @@ export class App {
 
   /**
    * Create a new test user-agent for application.
+   * @example
+   * // Test plain text endpoint
+   * const ua = await app.newTestUserAgent();
+   * (await ua.getOk('/')).statusIs(200).bodyIs('Hello World!');
    */
   async newTestUserAgent(options?: TestUserAgentOptions, serverOptions?: ServerOptions): Promise<TestUserAgent> {
     return await TestUserAgent.newTestUserAgent(this, options, serverOptions);