added types

Author: MrGriefs

src/Base.ts

@@ -12,7 +12,7 @@ interface BundleOptions {
     default?: (name: string) => Function;
 }
 
-export type QueryReturns = Promise<Record<string, unknown>|Error|null>;
+export type APIResponse = Promise<Record<string, unknown>|Error|null>;
 
 export default class Base {
     options: Options;
@@ -30,22 +30,23 @@ export default class Base {
         return this.options.agent || Base.defaultAgent;
     }
 
-    async query(url: string, cb?: ((r: AxiosResponse) => Promise<Record<string, unknown>>)): QueryReturns {
+    async query(url: string, cb?: ((r: AxiosResponse) => Promise<Record<string, unknown>>)): APIResponse {
         if (!cb) cb = r => r.data;
         const ops: AxiosRequestConfig = this.options?.axiosOptions || {};
         if (!ops.headers) ops.headers = {}
         ops.headers['User-Agent'] = this.options?.agent || Base.defaultAgent
+        if (!ops.timeout) ops.timeout = 10000;
         if (this.token) ops.headers['Authorization'] = `Bearer ${this.token}`
         return await axios.get(url, ops)
             .then(cb)
             .catch(e => e)
     }
 
     /* eslint-disable @typescript-eslint/ban-types */
-    static bundle(base: Function, items: Record<string, string>, options?: BundleOptions): (options?: Options) => QueryReturns {
+    static bundle(base: Function, items: Record<string, string>, options?: BundleOptions): (options?: Options) => APIResponse {
         const bundler: Record<string, Record<string, Function>> = {};
         Object.keys(items).forEach((name) => {
-            bundler[name] = { value: options?.default ? options.default(items[name]) : (async function (options?: Options): QueryReturns {
+            bundler[name] = { value: options?.default ? options.default(items[name]) : (async function (options?: Options): APIResponse {
                 return await base(items[name], options)
             }) }
         })

src/e6.ts

@@ -1,4 +1,4 @@
-import Base, { Options, QueryReturns } from './Base';
+import Base, { Options, APIResponse } from './Base';
 
 export type Query = Array<string> | string;
 
@@ -7,7 +7,7 @@ export interface E6Options extends Options {
     overrideTags?: string;
 }
 
-async function E6Base(endpoint: string, query?: Query, options?: E6Options): QueryReturns {
+async function E6Base(endpoint: string, query?: Query, options?: E6Options): APIResponse {
     if (typeof query === 'undefined') query = '';
     if (Array.isArray(query)) query = query.join(' ')
     const base = new Base(options);
@@ -19,12 +19,37 @@ async function E6Base(endpoint: string, query?: Query, options?: E6Options): Que
     return await base.query(url, r => r.data?.posts[0]);
 }
 
-export default Base.bundle(E6Base, {
+/**
+* Uses the E621 API to retrieve data of a random post {@link https://e621.net}
+* @param options - Library options
+* @returns - The response from the API
+*/
+declare function E621(options?: Options): APIResponse;
+
+/**
+* Uses the E926 API to retrieve data of a random post {@link https://e926.net}
+* @param options - Library options
+* @returns - The response from the API
+*/
+declare function E926(options?: Options): APIResponse;
+
+export declare interface E6 {
+    /**
+* Uses the E621 API to retrieve data of a random post {@link https://e621.net}
+* @param options - Library options
+* @returns - The response from the API
+*/
+    (options?: Options): APIResponse;
+    nsfw: typeof E621;
+    sfw: typeof E926;
+}
+
+export default <E6>Base.bundle(E6Base, {
     nsfw: 'e621',
     sfw: 'e926'
 }, {
     default: (name) => {
-        return async function (query: Query, options?: E6Options): QueryReturns {
+        return async function (query: Query, options?: E6Options): APIResponse {
             return await E6Base(name, query, options)
         }
     }

src/fox.ts

@@ -1,6 +1,11 @@
-import Base, { Options, QueryReturns } from './Base';
+import Base, { Options, APIResponse } from './Base';
 
-async function Fox(options?: Options): QueryReturns {
+/**
+ * Uses the RandomFox API to retrieve an image of a fox {@link https://randomfox.ca}
+ * @param options - Library options
+ * @returns - A random fox image
+ */
+async function Fox(options?: Options): APIResponse {
     const base = new Base(options);
 
     return await base.query('https://randomfox.ca/floof');