set appropriate return type in client.ts

Author: musou1500

lib/client.ts

@@ -91,7 +91,7 @@ export default class Client {
     return load();
   }
 
-  public getMessageContent(messageId: string): Promise<NodeJS.ReadableStream> {
+  public getMessageContent(messageId: string): Promise<Readable> {
     return this.stream(URL.content(messageId));
   }
 
@@ -103,22 +103,25 @@ export default class Client {
     return this.post(URL.leaveRoom(roomId));
   }
 
-  public getRichMenu(richMenuId: string): Promise<any> {
+  public getRichMenu(
+    richMenuId: string,
+  ): Promise<Types.RichMenuId & Types.RichMenu> {
     return this.get(URL.richMenu(richMenuId));
   }
 
-  public createRichMenu(richMenu: Types.RichMenu): Promise<any> {
+  public createRichMenu(richMenu: Types.RichMenu): Promise<Types.RichMenuId> {
     return this.post(URL.richMenu(), richMenu);
   }
 
   public deleteRichMenu(richMenuId: string): Promise<any> {
     return this.delete(URL.richMenu(richMenuId));
   }
 
-  public getUserRichMenuIds(userId: string): Promise<any> {
+  public getUserRichMenuIds(userId: string): Promise<Types.RichMenuId> {
     return this.get(URL.userRichMenu(userId));
   }
 
+  // TODO: change return type to appropriate one
   public linkRichMenuToUser(userId: string, richMenuId: string): Promise<any> {
     return this.post(URL.userRichMenu(userId, richMenuId));
   }
@@ -130,7 +133,7 @@ export default class Client {
     return this.delete(URL.userRichMenu(userId, richMenuId));
   }
 
-  public getRichMenuImage(richMenuId: string): Promise<any> {
+  public getRichMenuImage(richMenuId: string): Promise<Readable> {
     return this.stream(URL.richMenuContent(richMenuId));
   }
 
@@ -170,7 +173,7 @@ export default class Client {
     return postBinary(url, this.authHeader(), data, contentType);
   }
 
-  private stream(url: string): Promise<NodeJS.ReadableStream> {
+  private stream(url: string): Promise<Readable> {
     return stream(url, this.authHeader());
   }
 }

lib/http.ts

@@ -39,14 +39,11 @@ function wrapError(err: AxiosError) {
 
 const userAgent = `${pkg.name}/${pkg.version}`;
 
-export function stream(
-  url: string,
-  headers: any,
-): Promise<NodeJS.ReadableStream> {
+export function stream(url: string, headers: any): Promise<Readable> {
   headers["User-Agent"] = userAgent;
   return axios
     .get(url, { headers, responseType: "stream" })
-    .then(res => res.data as NodeJS.ReadableStream);
+    .then(res => res.data as Readable);
 }
 
 export function get(url: string, headers: any): Promise<any> {
@@ -72,24 +69,24 @@ export function postBinary(
   headers: any,
   data: Buffer | Readable,
   contentType?: string,
-): Promise<Readable> {
+): Promise<any> {
   return new Promise(resolve => {
     return resolve(contentType ? contentType : detectContentType(data));
   }).then((contentType: string) => {
     headers["Content-Type"] = contentType;
     headers["User-Agent"] = userAgent;
-    const responseType = "stream";
     return axios
-      .post(url, data, { headers, responseType })
-      .then(res => res.data);
+      .post(url, data, { headers, responseType: "text" })
+      .then(res => res.data)
+      .catch(wrapError);
   });
 }
 
 export function del(url: string, headers: any): Promise<any> {
   headers["User-Agent"] = userAgent;
 
   return axios
-    .delete(url, { headers })
-    .then(res => checkJSON(res.data))
+    .delete(url, { headers, responseType: "text" })
+    .then(res => res.data)
     .catch(wrapError);
 }

test/client.spec.ts

@@ -1,6 +1,7 @@
 import { readFileSync } from "fs";
 import { join } from "path";
 import { deepEqual, equal } from "assert";
+import { Readable } from "stream";
 import Client from "../lib/client";
 import * as Types from "../lib/types";
 import { getStreamData } from "./helpers/stream";
@@ -144,7 +145,7 @@ describe("client", () => {
   it("getMessageContent", () => {
     return client
       .getMessageContent("test_message_id")
-      .then((s: NodeJS.ReadableStream) => getStreamData(s))
+      .then((s: Readable) => getStreamData(s))
       .then((data: string) => {
         const res = JSON.parse(data);
         equal(res.headers.authorization, "Bearer test_channel_access_token");
@@ -226,9 +227,7 @@ describe("client", () => {
     const buffer = readFileSync(filepath);
     return client
       .setRichMenuImage("test_rich_menu_id", buffer)
-      .then(s => getStreamData(s))
-      .then((data: string) => {
-        const res = JSON.parse(data);
+      .then((res: any) => {
         equal(res.headers.authorization, "Bearer test_channel_access_token");
         equal(res.path, "/richmenu/test_rich_menu_id/content");
         equal(res.method, "POST");
@@ -238,7 +237,7 @@ describe("client", () => {
   it("getRichMenuImage", () => {
     return client
       .getRichMenuImage("test_rich_menu_id")
-      .then((s: NodeJS.ReadableStream) => getStreamData(s))
+      .then((s: Readable) => getStreamData(s))
       .then((data: string) => {
         const res = JSON.parse(data);
         equal(res.headers.authorization, "Bearer test_channel_access_token");

test/helpers/stream.ts

@@ -1,4 +1,6 @@
-export function getStreamData(stream: NodeJS.ReadableStream): Promise<string> {
+import { Readable } from "stream";
+
+export function getStreamData(stream: Readable): Promise<string> {
   return new Promise(resolve => {
     let result: string = "";
     stream.on("data", (chunk: Buffer) => {

test/http.spec.ts

@@ -97,16 +97,17 @@ describe("http", () => {
 
     const filepath = join(__dirname, "/helpers/LINE_Icon.png");
     const buffer = readFileSync(filepath);
-    return postBinary(`${TEST_URL}/post`, testHeaders, buffer)
-      .then(s => getStreamData(s))
-      .then((data: string) => {
-        const res = JSON.parse(data);
-        equal(res.method, "POST");
-        equal(res.path, "/post");
-        equal(res.headers["test-header-key"], testHeaders["test-header-key"]);
-        equal(res.headers["user-agent"], `${pkg.name}/${pkg.version}`);
-        equal(res.headers["content-type"], "image/png");
-      });
+    return postBinary(
+      `${TEST_URL}/post`,
+      testHeaders,
+      buffer,
+    ).then((res: any) => {
+      equal(res.method, "POST");
+      equal(res.path, "/post");
+      equal(res.headers["test-header-key"], testHeaders["test-header-key"]);
+      equal(res.headers["user-agent"], `${pkg.name}/${pkg.version}`);
+      equal(res.headers["content-type"], "image/png");
+    });
   });
 
   it("fail to parse json", () => {