Small update

README.md

@@ -111,6 +111,7 @@ MailTM.setConfig({
 #### Available props
 
 - **mailService** _[Optional & 'mail.tm' | 'mail.gw']_ **=** 'mail.tm': Change mail service
+- **axiosOptions** _[Optional & Object]_ **=** {}: Axios request options
 
 ### Emails
 

package.json

@@ -1,6 +1,6 @@
 {
 	"name": "mail.tm-api",
-	"version": "3.0.0",
+	"version": "3.0.1",
 	"description": "A powerful library to use the Mail.TM api and Mail.GW to receive emails",
 	"main": "./dist/index.js",
 	"homepage": "https://github.com/XielQs/mail.tm-api#readme",

src/index.ts

@@ -9,7 +9,8 @@ import Account from './classes/Account'
 import request from './utils/request'
 
 const CONFIG: IConfig = {
-  mailService: 'mail.tm'
+  mailService: 'mail.tm',
+  axiosOptions: {}
 }
 
 let domains: IDomain[] = []
@@ -41,8 +42,8 @@ export async function fetchDomains<Random extends boolean = false> ({ page = 1,
 /**
  * Creates an account
  * @example
- * const account = await createAccount();
- * console.log(account.email);
+ * const account = await createAccount()
+ * console.log(account.email)
  */
 export async function createAccount (address?: string, password?: string): Promise<Account> {
   return await new Promise(async (resolve, reject) => {
@@ -84,11 +85,11 @@ export async function loginAccount (token: string): Promise<Account>
 /**
  * Logs into an existing account
  * @example
- * const account = await loginAccount("mySuperSecretToken"); // Login with account token
- * console.log(account.email);
+ * const account = await loginAccount("mySuperSecretToken") // Login with account token
+ * console.log(account.email)
  * // Or
- * const account = await loginAccount("myEmail@domain.com", "mySuperSecretPassword");
- * console.log(account.email);
+ * const account = await loginAccount("myEmail@domain.com", "mySuperSecretPassword")
+ * console.log(account.email)
  */
 export async function loginAccount (...args: [string, string] | [string]): Promise<Account> {
   return await new Promise(async (resolve, reject) => {
@@ -136,6 +137,6 @@ export async function loginAccount (...args: [string, string] | [string]): Promi
 }
 
 export function setConfig (config: IConfig): void {
-  request(config.mailService)
+  request(config.mailService, config.axiosOptions)
   Object.assign(CONFIG, config)
 }

src/types/IConfig.d.ts

@@ -1,3 +1,6 @@
+import type { CreateAxiosDefaults } from 'axios'
+
 export default interface IConfig {
   mailService?: 'mail.tm' | 'mail.gw'
+  axiosOptions?: CreateAxiosDefaults
 }

src/utils/request.ts

@@ -1,15 +1,21 @@
-import axios, { type AxiosInstance } from 'axios'
+import axios, { type CreateAxiosDefaults, type AxiosInstance } from 'axios'
 
 let endpoint = 'https://api.mail.tm'
+let options: CreateAxiosDefaults = {}
 
-export default function request (service?: 'mail.tm' | 'mail.gw'): AxiosInstance {
+export default function request (service?: 'mail.tm' | 'mail.gw', axiosOptions?: CreateAxiosDefaults): AxiosInstance {
   if (service !== undefined && ['mail.tm', 'mail.gw'].includes(service)) {
     endpoint = `https://api.${service}`
   }
+  if (axiosOptions !== undefined) {
+    options = axiosOptions
+  }
 
   const instance = axios.create({
+    ...options,
     baseURL: endpoint,
     headers: {
+      ...options?.headers,
       'Content-Type': 'application/json',
       Accept: 'application/json',
       Connection: 'close',
@@ -18,4 +24,4 @@ export default function request (service?: 'mail.tm' | 'mail.gw'): AxiosInstance
   })
 
   return instance
-};
+}