Merge pull request #59 from jaxx2104/fix-type-custom-headers

FreeeAPIClient の型情報を更新
freee · Jun 12, 2023 · 0f815bb · 0f815bb
2 parents 3dec4a9 + 5286436
commit 0f815bb
Show file tree

Hide file tree

Showing 4 changed files with 51 additions and 19 deletions.
diff --git a/lib/index.d.ts b/lib/index.d.ts
@@ -1,7 +1,7 @@
-import { AxiosPromise } from 'axios';
-import * as express from 'express';
-import * as admin from 'firebase-admin';
-import { ParamJSON, SDKConfig } from '../src/sdk/const/types';
+import { AxiosPromise } from 'axios'
+import * as express from 'express'
+import * as admin from 'firebase-admin'
+import { CustomHeaders, ParamJSON, SDKConfig } from '../src/sdk/const/types'
 
 declare module 'freee-firebase-sdk' {
   /**
@@ -30,11 +30,27 @@ declare module 'freee-firebase-sdk' {
     get<T = any>(
       url: string,
       params: ParamJSON,
-      userId: string
+      userId: string,
+      customHeaders?: CustomHeaders
     ): AxiosPromise<T>
-    post<T = any>(url: string, data: ParamJSON, userId: string): AxiosPromise<T>
-    put<T = any>(url: string, data: ParamJSON, userId: string): AxiosPromise<T>
-    delete(url: string, data: ParamJSON, userId: string): AxiosPromise
+    post<T = any>(
+      url: string,
+      data: ParamJSON,
+      userId: string,
+      customHeaders?: CustomHeaders
+    ): AxiosPromise<T>
+    put<T = any>(
+      url: string,
+      data: ParamJSON,
+      userId: string,
+      customHeaders?: CustomHeaders
+    ): AxiosPromise<T>
+    delete(
+      url: string,
+      data: ParamJSON,
+      userId: string,
+      customHeaders?: CustomHeaders
+    ): AxiosPromise
   }
 
   class FreeeFirebaseAuthClient {

diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "freee-firebase-sdk",
-  "version": "2.2.0",
+  "version": "2.2.1",
   "license": "MIT",
   "homepage": "https://github.com/freee/firebase-sdk-js",
   "repository": {

diff --git a/typings/index.d.ts b/typings/index.d.ts
@@ -1,7 +1,7 @@
-import { AxiosPromise } from 'axios';
-import * as express from 'express';
-import * as admin from 'firebase-admin';
-import { ParamJSON, SDKConfig } from '../src/sdk/const/types';
+import { AxiosPromise } from 'axios'
+import * as express from 'express'
+import * as admin from 'firebase-admin'
+import { CustomHeaders, ParamJSON, SDKConfig } from '../src/sdk/const/types'
 
 declare module 'freee-firebase-sdk' {
   /**
@@ -30,11 +30,27 @@ declare module 'freee-firebase-sdk' {
     get<T = any>(
       url: string,
       params: ParamJSON,
-      userId: string
+      userId: string,
+      customHeaders?: CustomHeaders
     ): AxiosPromise<T>
-    post<T = any>(url: string, data: ParamJSON, userId: string): AxiosPromise<T>
-    put<T = any>(url: string, data: ParamJSON, userId: string): AxiosPromise<T>
-    delete(url: string, data: ParamJSON, userId: string): AxiosPromise
+    post<T = any>(
+      url: string,
+      data: ParamJSON,
+      userId: string,
+      customHeaders?: CustomHeaders
+    ): AxiosPromise<T>
+    put<T = any>(
+      url: string,
+      data: ParamJSON,
+      userId: string,
+      customHeaders?: CustomHeaders
+    ): AxiosPromise<T>
+    delete(
+      url: string,
+      data: ParamJSON,
+      userId: string,
+      customHeaders?: CustomHeaders
+    ): AxiosPromise
   }
 
   class FreeeFirebaseAuthClient {