Add symbol docs and revrite tests from TODO

Author: OSA413

src/index.ts

@@ -7,11 +7,13 @@ import pify from "pify";
 import bodyParser, { OptionsJson, OptionsText, OptionsUrlencoded } from "body-parser";
 
 // Thank @midgleyc for providing the type definitions
+/** The test server itself */
 export type TestServer = TestServerWrapper
     & Omit<express.Express, 'listen'>
     & {get: (url: string, response: unknown) => void};
 
-export interface Options {
+/** Options that can be provided to the `createTestServer` function */
+export interface TestServerOptions {
     /**
      * Body parser options object to be passed to `body-parser` methods.
      *
@@ -23,6 +25,7 @@ export interface Options {
         & OptionsUrlencoded;
 }
 
+/** Internal wrapper for the test server */
 export interface TestServerWrapper {
     /**
      * The url you can reach the HTTP server on.
@@ -61,7 +64,8 @@ export interface TestServerWrapper {
     close: () => Promise<void>;
 }
 
-export const createTestServer = (opts: Options = {}): Promise<TestServer> => {
+/** Creates the test server that you can use it the tests */
+export const createTestServer = (opts: TestServerOptions = {}): Promise<TestServer> => {
     const _express = express();
     const server = _express as never as TestServer;
     server.http = http.createServer(_express);

test/index.test.ts

@@ -3,7 +3,6 @@ import { createTestServer } from '../src';
 import { expect, test } from 'vitest'
 import * as querystring from 'querystring';
 import axios from 'axios';
-import express from "express";
 
 test('server instance exposes useful properties', async () => {
 	const server = await createTestServer();
@@ -119,7 +118,7 @@ test('opts.bodyParser is passed through to bodyParser', async () => {
 	const buf = Buffer.alloc(150 * 1024);
 
 	// Custom error handler so we don't dump the stack trace in the test output
-	smallServer.use((_err: any, _req: any, res: any, _next: any) => { // eslint-disable-line no-unused-vars
+	smallServer.use((_err: any, _req: any, res: any, _next: any) => {
 		res.status(500).end();
 	});
 
@@ -134,15 +133,13 @@ test('opts.bodyParser is passed through to bodyParser', async () => {
 	});
 
 	// TODO: Rewrite
-	// await t.throws(got.post(smallServer.url, {
-	// 	headers: { 'content-type': 'application/octet-stream' },
-	// 	body: buf
-	// }));
-
-	// await t.notThrows(got.post(bigServer.url, {
-	// 	headers: { 'content-type': 'application/octet-stream' },
-	// 	body: buf
-	// }));
+	await expect(axios.post(smallServer.url!, buf, {
+		headers: { 'content-type': 'application/octet-stream' },
+	})).rejects.toThrow("500")
+
+	await expect(axios.post(bigServer.url!, buf, {
+		headers: { 'content-type': 'application/octet-stream' },
+	})).resolves.toMatchObject({status: 200});
 });
 
 test('if opts.bodyParser is false body parsing middleware is disabled', async () => {