@eliseubatista99/react-scaffold-core 0.2.19 → 1.1.0

package/README.md

@@ -10,6 +10,20 @@ A library which provides basic components, hooks, helpers and providers to easil
 npm i @eliseubatista99/react-scaffold-core
 ```
 
+@eliseubatista99/react-scaffold-core is a React library that provides basic components, hooks, helpers and providers to easily build a React application and avoid repeating the usual code.
+
+It helps you write applications that behave consistently and are easy to test.
+
+You can use this library together with any other library.
+
+## Installation
+
+The recommended way is to install this package as soon as you start a new application with React.
+
+```
+npm i @eliseubatista99/react-scaffold-core
+```
+
 ## Content
 
 - [Providers](https://github.com/eliseubatista99/react-scaffold/tree/main/src/packages/core/src/providers): Useful providers to handle complex actions like navigation and showing, hiding and managing feedback components;
@@ -19,3 +33,7 @@ npm i @eliseubatista99/react-scaffold-core
 - [Helpers](https://github.com/eliseubatista99/react-scaffold/tree/main/src/packages/core/src/helpers): Classes to help with generic repetitive tasks, like transforming a string into Pascal Case.
 
 - [Components](https://github.com/eliseubatista99/react-scaffold/tree/main/src/packages/core/src/components): Basic, customizable components with pre-configured styles and behaviors.
+
+## Change Log
+
+Every release, along with the migration instructions, is documented on the GitHub [Releases](https://github.com/eliseubatista99/react-scaffold/releases) page.

package/dist/hooks/useFetch/useFetch.d.ts

@@ -1,9 +1,13 @@
 type runFetchOptions = Record<string, any>;
+type FetchOutput<TOut> = {
+    result: TOut;
+    statusCode: number;
+};
 export declare const useFetch: () => {
-    get: <OutputType>(endpointUrl: string, options?: runFetchOptions, headers?: HeadersInit) => Promise<OutputType>;
-    post: <OutputType>(endpointUrl: string, options?: runFetchOptions, headers?: HeadersInit) => Promise<OutputType>;
-    put: <OutputType>(endpointUrl: string, options?: runFetchOptions, headers?: HeadersInit) => Promise<OutputType>;
-    patch: <OutputType>(endpointUrl: string, options?: runFetchOptions, headers?: HeadersInit) => Promise<OutputType>;
-    delete: <OutputType>(endpointUrl: string, options?: runFetchOptions, headers?: HeadersInit) => Promise<OutputType>;
+    get: <OutputType>(endpointUrl: string, options?: runFetchOptions, headers?: HeadersInit) => Promise<FetchOutput<OutputType>>;
+    post: <OutputType>(endpointUrl: string, options?: runFetchOptions, headers?: HeadersInit) => Promise<FetchOutput<OutputType>>;
+    put: <OutputType>(endpointUrl: string, options?: runFetchOptions, headers?: HeadersInit) => Promise<FetchOutput<OutputType>>;
+    patch: <OutputType>(endpointUrl: string, options?: runFetchOptions, headers?: HeadersInit) => Promise<FetchOutput<OutputType>>;
+    delete: <OutputType>(endpointUrl: string, options?: runFetchOptions, headers?: HeadersInit) => Promise<FetchOutput<OutputType>>;
 };
 export {};