refactor(project): adjust interface naming and other things

Author: olavoparno

src/index.ts

@@ -1,10 +1,10 @@
 import { useCallback, useMemo, useRef, useState } from 'react';
 import {
   DownloadFunction,
-  IResolverProps,
-  IUseDownloader,
-  IWindowDownloaderEmbedded,
-  TError,
+  ResolverProps,
+  UseDownloader,
+  WindowDownloaderEmbedded,
+  ErrorMessage,
   UseDownloaderOptions,
 } from './types';
 
@@ -14,7 +14,7 @@ export const resolver =
     setControllerCallback,
     setPercentageCallback,
     setErrorCallback,
-  }: IResolverProps) =>
+  }: ResolverProps) =>
   (response: Response): Response => {
     if (!response.ok) {
       throw Error(`${response.status} ${response.type} ${response.statusText}`);
@@ -87,12 +87,13 @@ export const jsDownload = (
   });
 
   if (
-    typeof (window as unknown as IWindowDownloaderEmbedded).navigator
+    typeof (window as unknown as WindowDownloaderEmbedded).navigator
       .msSaveBlob !== 'undefined'
   ) {
-    return (
-      window as unknown as IWindowDownloaderEmbedded
-    ).navigator.msSaveBlob(blob, filename);
+    return (window as unknown as WindowDownloaderEmbedded).navigator.msSaveBlob(
+      blob,
+      filename
+    );
   }
 
   const blobURL =
@@ -119,13 +120,13 @@ export const jsDownload = (
 
 export default function useDownloader(
   options: UseDownloaderOptions = {}
-): IUseDownloader {
+): UseDownloader {
   const debugMode = process.env.REACT_APP_DEBUG_MODE;
 
   const [elapsed, setElapsed] = useState(0);
   const [percentage, setPercentage] = useState(0);
   const [size, setSize] = useState(0);
-  const [error, setError] = useState<TError>(null);
+  const [error, setError] = useState<ErrorMessage>(null);
   const [isInProgress, setIsInProgress] = useState(false);
 
   const controllerRef = useRef<null | ReadableStreamController<Uint8Array>>(

src/types.ts

@@ -1,6 +1,6 @@
 import { SetStateAction } from 'react';
 
-export type TError = {
+export type ErrorMessage = {
   errorMessage: string;
 } | null;
 
@@ -17,7 +17,7 @@ export type DownloadFunction = (
   timeout?: number
 ) => Promise<void | null>;
 
-export interface IUseDownloader {
+export interface UseDownloader {
   /** Size in bytes */
   size: number;
   /**	Elapsed time in seconds */
@@ -33,12 +33,12 @@ export interface IUseDownloader {
   /** Cancel function handler */
   cancel: () => void;
   /** Error object from the request */
-  error: TError;
+  error: ErrorMessage;
   /** Boolean denoting download status */
   isInProgress: boolean;
 }
 
-export interface IResolverProps {
+export interface ResolverProps {
   setSize: (value: SetStateAction<number>) => void;
   setControllerCallback: (
     controller: ReadableStreamController<Uint8Array>
@@ -57,7 +57,7 @@ interface CustomNavigator extends Navigator {
   msSaveBlob: (blob?: Blob, filename?: string) => boolean | NodeJS.Timeout;
 }
 
-export interface IWindowDownloaderEmbedded extends Window {
+export interface WindowDownloaderEmbedded extends Window {
   navigator: CustomNavigator;
 }