fix(all): fix bugs added in prior commit

XIVStats · Jan 9, 2022 · 0cc3d3e · 0cc3d3e
1 parent 87b4ba0
commit 0cc3d3e
Show file tree

Hide file tree

Showing 5 changed files with 37 additions and 5 deletions.
diff --git a/docs/api/classes/client_LodestoneClient.default.md b/docs/api/classes/client_LodestoneClient.default.md
@@ -32,7 +32,7 @@ Client for interfacing with the Final Fantasy XIV Lodestone.
 
 #### Defined in
 
-[client/LodestoneClient.ts:59](https://github.com/XIVStats/lodestone/blob/e81c3ec/src/client/LodestoneClient.ts#L59)
+[client/LodestoneClient.ts:59](https://github.com/XIVStats/lodestone/blob/87b4ba0/src/client/LodestoneClient.ts#L59)
 
 ## Properties
 
@@ -46,4 +46,4 @@ IClientProps.axiosInstance
 
 #### Defined in
 
-[client/LodestoneClient.ts:49](https://github.com/XIVStats/lodestone/blob/e81c3ec/src/client/LodestoneClient.ts#L49)
+[client/LodestoneClient.ts:49](https://github.com/XIVStats/lodestone/blob/87b4ba0/src/client/LodestoneClient.ts#L49)
diff --git a/docs/api/modules/locale.md b/docs/api/modules/locale.md
@@ -0,0 +1,31 @@
+# Module: locale
+
+## Table of contents
+
+### Type aliases
+
+- [OptionalPerLanguageMapping](locale.md#optionalperlanguagemapping)
+
+## Type aliases
+
+### OptionalPerLanguageMapping
+
+Ƭ **OptionalPerLanguageMapping**<`Type`\>: { [key in Language]?: Type}
+
+Supported languages for localized text.
+
+Corresponding to ISO 639-1:2002.
+
+These do not correspond to:
+Country code (ISO-3166) - e.g. Japan would be JP not ja.
+Square Enix labelling - eu=en, na=enUs, de=de, fr=fr, jp=ja
+
+#### Type parameters
+
+| Name |
+| :------ |
+| `Type` |
+
+#### Defined in
+
+[locale/type/OptionalPerLanguageMapping.ts:37](https://github.com/XIVStats/lodestone/blob/87b4ba0/src/locale/type/OptionalPerLanguageMapping.ts#L37)
diff --git a/src/client/RequestStatus.ts b/src/client/RequestStatus.ts
@@ -30,3 +30,5 @@ const enum RequestStatus {
   Throttled = 'THROTTLED',
   OtherError = 'OTHER_ERROR_ENCOUNTERED',
 }
+
+export default RequestStatus
diff --git a/src/client/interface/IClientProps.ts b/src/client/interface/IClientProps.ts
@@ -25,8 +25,8 @@
 
 import { AxiosInstance } from 'axios'
 import { CheerioAPI } from 'cheerio'
-import { RegionalAxiosInstances } from '../../interface/RegionalAxiosInstances'
 import Language from '../../locale/Language'
+import OptionalPerLanguageMapping from '../../locale/type/OptionalPerLanguageMapping'
 
 export default interface IClientProps {
   /**
@@ -38,7 +38,7 @@ export default interface IClientProps {
 
   cheerioInstance?: CheerioAPI
 
-  regionalAxiosInstances?: RegionalAxiosInstances
+  regionalAxiosInstances?: OptionalPerLanguageMapping<AxiosInstance>
 
   parallelismLimit?: number
 

diff --git a/src/locale/LocalizedClientFactory.ts b/src/locale/LocalizedClientFactory.ts
@@ -26,7 +26,6 @@
 import Axios, { AxiosInstance } from 'axios'
 import PerLanguageMapping from './type/PerLanguageMapping'
 import Language from './Language'
-import { RegionalAxiosInstances } from '../../lib/interface/RegionalAxiosInstances'
 import OptionalPerLanguageMapping from './type/OptionalPerLanguageMapping'
 
 export default class LocalizedClientFactory {