quikify

Quikify

Quikify is a lightweight and high-performance API management toolkit designed for React Native applications. It simplifies HTTP requests using Axios, providing a seamless and efficient way to handle data fetching in your projects.

Installation

Install Quikify using npm:

npm install quikify axios

Import Quikify

import { Quikify } from "quikify";

Set Global Dispatch (One-time setup)

import { Quikify } from "quikify";

const initialState = {};
const middleware = [thunk];

const store = createStore(
  mainReducer,
  initialState,
  compose(applyMiddleware(...middleware))
);
Quikify.setGlobalDispatch(store.dispatch); // add this line
export default store;

Configure baseUrl

import { Quikify } from "quikify";

const App = () => {
  Quikify.configure({ baseURL: "http://192.168.100.127:3000/api/" });
  // Your app components
};

Features

• Swift Integration: Designed for React Native with a focus on speed and efficiency.
• Axios Under the Hood: Utilizes Axios for robust and reliable HTTP requests.
• Global Dispatch: Set it once and forget it – Quikify seamlessly integrates with your Redux store.

Quikify API Reference

Quikify provides a set of methods for managing API requests in your React Native application. Below is the reference for the available methods:

Quikify.get(path, type)

Parameters

• path (string): The API endpoint path.
• type (string): The Redux action type to dispatch upon a successful API call.

Returns

A Promise that resolves to the response data from the API.

Example

//to use Users endpoint kindly connect firebase auth token to axios header.

// Get Single Document by id
Quikify.get("table/eUQJpfG9bGdI3W54Jd", GET_ERRORS)
  .then((response) => {
    console.log("GET Response:", response);
  })
  .catch((error) => {
    console.error("GET Error:", error);
  });

Quikify.post(path, data, type,config)

Parameters

• path (string): The API endpoint path.
• data (object): The data to be sent in the POST request.
• type (string): The Redux action type to dispatch upon a successful API call.
• config (object) (optional): {return : "table","current"} it returns updated data as current or complete table

Returns

A Promise that resolves to the response data from the API.

Example

const postData = { key: "value" };
// Create Document with auto id
Quikify.create("table", { body }, "REDUX_STATE", { return: "table" })
  .then((response) => {
    console.log("Response:", response);
  })
  .catch((error) => {
    console.error("Error:", error);
  });

// Create Document with custom id
Quikify.create("table/cutomsID", { body }, "REDUX_STATE", {
  return: "table",
})
  .then((response) => {
    console.log("Response:", response);
  })
  .catch((error) => {
    console.error("Error:", error);
  });

Quikify.put(path, data, type,config)

Parameters

• path (string): The API endpoint path.
• data (object): The data to be sent in the POST request.
• type (string): The Redux action type to dispatch upon a successful API call.
• config (object) (optional): {return : "table","current"} it returns updated data as current or complete table

Returns

A Promise that resolves to the response data from the API.

Example

const postData = { key: "value" };
// Update Document by id
Quikify.update("table/eUQJpfG9bGdI3W54Jd", { body }, "REDUX_STATE")
  .then((response) => {
    console.log("GET Response:", response);
  })
  .catch((error) => {
    console.error("GET Error:", error);
  });

Quikify.delete(path, type,config)

Parameters

• path (string): The API endpoint path.
• type (string): The Redux action type to dispatch upon a successful API call.
• config (object) (optional): {return : "table","current"} it returns updated data as current or complete table

Returns

A Promise that resolves to the response data from the API.

Example

// Delete Document by id

Quikify.delete("table/12", "REDUX_STATE")
  .then((response) => {
    console.log("GET Response:", response);
  })
  .catch((error) => {
    console.error("GET Error:", error);
  });

License

Quikify is released under the Adlerware License