@twin.org/api-models 0.0.1-next.11 → 0.0.1-next.12

package/dist/types/index.d.ts

@@ -35,6 +35,7 @@ export * from "./models/routes/IRestRouteResponseOptions";
 export * from "./models/routes/ISocketRoute";
 export * from "./models/routes/ITag";
 export * from "./models/server/IHttpRestRouteProcessor";
+export * from "./models/server/IMimeTypeProcessor";
 export * from "./models/server/IWebServer";
 export * from "./models/server/IWebServerOptions";
 export * from "./models/services/healthStatus";

package/dist/types/models/server/IMimeTypeProcessor.d.ts

@@ -0,0 +1,16 @@
+/**
+ * The definition for a handler for a specific MIME type.
+ */
+export interface IMimeTypeProcessor {
+    /**
+     * Get the MIME types that this handler can handle.
+     * @returns The MIME types that this handler can handle.
+     */
+    getTypes(): string[];
+    /**
+     * Handle content.
+     * @param body The body to process.
+     * @returns The processed body.
+     */
+    handle(body: Uint8Array): Promise<unknown>;
+}

package/docs/changelog.md

@@ -1,5 +1,5 @@
 # @twin.org/api-models - Changelog
 
-## v0.0.1-next.11
+## v0.0.1-next.12
 
 - Initial Release

package/docs/reference/index.md

@@ -42,6 +42,7 @@
 - [ISocketRoute](interfaces/ISocketRoute.md)
 - [ITag](interfaces/ITag.md)
 - [IHttpRestRouteProcessor](interfaces/IHttpRestRouteProcessor.md)
+- [IMimeTypeProcessor](interfaces/IMimeTypeProcessor.md)
 - [IWebServer](interfaces/IWebServer.md)
 - [IWebServerOptions](interfaces/IWebServerOptions.md)
 - [IHealthInfo](interfaces/IHealthInfo.md)

package/docs/reference/interfaces/IMimeTypeProcessor.md

@@ -0,0 +1,37 @@
+# Interface: IMimeTypeProcessor
+
+The definition for a handler for a specific MIME type.
+
+## Methods
+
+### getTypes()
+
+> **getTypes**(): `string`[]
+
+Get the MIME types that this handler can handle.
+
+#### Returns
+
+`string`[]
+
+The MIME types that this handler can handle.
+
+***
+
+### handle()
+
+> **handle**(`body`): `Promise`\<`unknown`\>
+
+Handle content.
+
+#### Parameters
+
+• **body**: `Uint8Array`
+
+The body to process.
+
+#### Returns
+
+`Promise`\<`unknown`\>
+
+The processed body.

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/api-models",
-	"version": "0.0.1-next.11",
+	"version": "0.0.1-next.12",
 	"description": "Contains models and classes for use with APIs",
 	"repository": {
 		"type": "git",