@oino-ts/types 0.17.5 → 0.18.1

package/common/src/OINORequest.d.ts

@@ -23,7 +23,7 @@ export interface OINOHttpRequestInit extends OINORequestInit {
     url?: URL;
     method?: string;
     headers?: OINOHeadersInit;
-    data?: string | Buffer | Uint8Array | object | null;
+    body?: string | Buffer | Uint8Array | object | null | undefined;
     requestType?: OINOContentType;
     responseType?: OINOContentType;
     multipartBoundary?: string;
@@ -36,7 +36,7 @@ export declare class OINOHttpRequest extends OINORequest {
     readonly url?: URL;
     readonly method: string;
     readonly headers: OINOHeaders;
-    readonly data: string | Buffer | Uint8Array | object | null;
+    readonly body: string | Buffer | Uint8Array | object | null | undefined;
     readonly requestType: OINOContentType;
     readonly responseType: OINOContentType;
     readonly multipartBoundary?: string;
@@ -49,9 +49,31 @@ export declare class OINOHttpRequest extends OINORequest {
      *
      */
     constructor(init: OINOHttpRequestInit);
+    /**
+     * Creates a `OINOHttpRequest` from a Fetch API `Request` object.
+     *
+     * @param request Fetch request
+     *
+     */
     static fromFetchRequest(request: Request): Promise<OINOHttpRequest>;
-    dataAsText(): string;
-    dataAsParsedJson(): any;
-    dataAsFormData(): URLSearchParams;
-    dataAsBuffer(): Buffer;
+    /**
+     * Returns the request data as a text string.
+     *
+     */
+    bodyAsText(): string;
+    /**
+     * Returns the request data parsed as JSON object.
+     *
+     */
+    bodyAsParsedJson(): any;
+    /**
+     * Returns the request data as URLSearchParams (form data).
+     *
+     */
+    bodyAsFormData(): URLSearchParams;
+    /**
+     * Returns the request data as Buffer.
+     *
+     */
+    bodyAsBuffer(): Buffer;
 }

package/common/src/OINOResult.d.ts

@@ -127,4 +127,31 @@ export declare class OINOHttpResult extends OINOResult {
      * @param headers HTTP headers (overrides existing values)
      */
     getFetchResponse(headers?: OINOHeadersInit): Response;
+    /**
+     * Create from a Response object from the result values.
+     *
+     * @param response fetch Response object
+     *
+     */
+    static fromFetchResponse(response: Response): Promise<OINOHttpResult>;
+    /**
+     * Returns the request body as a text string.
+     *
+     */
+    bodyAsText(): string;
+    /**
+     * Returns the request body parsed as JSON object.
+     *
+     */
+    bodyAsParsedJson(): any;
+    /**
+     * Returns the request body as URLSearchParams (form body).
+     *
+     */
+    bodyAsFormData(): URLSearchParams;
+    /**
+     * Returns the request body as Buffer.
+     *
+     */
+    bodyAsBuffer(): Buffer;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@oino-ts/types",
-  "version": "0.17.5",
+  "version": "0.18.1",
   "description": "OINO TS package for types.",
   "author": "Matias Kiviniemi (pragmatta)",
   "license": "MPL-2.0",