Rename 'fetch' to 'acquire' to avoid conflict with built-in fetch function

master
Tudor Stanciu 2024-03-31 00:01:38 +02:00
parent 002327836f
commit 79ce2f5356
7 changed files with 14 additions and 15 deletions

View File

@ -14,13 +14,13 @@ The package installation can be done in two ways:
## How to use the package ## How to use the package
```javascript! ```javascript!
const { TuitioClient, fetch } = require("@flare/tuitio-client"); const { TuitioClient, acquire } = require("@flare/tuitio-client");
const TuitioClient = require("@flare/tuitio-client"); const TuitioClient = require("@flare/tuitio-client");
const type { TuitioLoginResponse, TuitioLogoutResponse, TuitioState } = require("@flare/tuitio-client"); const type { TuitioLoginResponse, TuitioLogoutResponse, TuitioState } = require("@flare/tuitio-client");
``` ```
```javascript! ```javascript!
import { TuitioClient, fetch } from "@flare/tuitio-client"; import { TuitioClient, acquire } from "@flare/tuitio-client";
import TuitioClient from "@flare/tuitio-client"; import TuitioClient from "@flare/tuitio-client";
import type { TuitioLoginResponse, TuitioLogoutResponse, TuitioState } from "@flare/tuitio-client"; import type { TuitioLoginResponse, TuitioLogoutResponse, TuitioState } from "@flare/tuitio-client";
``` ```

View File

@ -6,7 +6,7 @@
import axios from "axios"; import axios from "axios";
import { TuitioClient } from "../client"; import { TuitioClient } from "../client";
import { fetch } from "../state"; import { acquire } from "../state";
jest.mock("axios"); jest.mock("axios");
@ -40,7 +40,7 @@ test.each([240, 100, 20, 10, 5])("Tuitio client: successfully account login", as
} }
expect(loginResult.error).toBeNull(); expect(loginResult.error).toBeNull();
const storage = fetch(); const storage = acquire();
expect(storage).toBeDefined(); expect(storage).toBeDefined();
expect(storage?.token).toBe(mock.result.token); expect(storage?.token).toBe(mock.result.token);
expect(storage?.userName).toBe("user"); expect(storage?.userName).toBe("user");

View File

@ -6,7 +6,7 @@
import axios from "axios"; import axios from "axios";
import { TuitioClient } from "../client"; import { TuitioClient } from "../client";
import { fetch } from "../state"; import { acquire } from "../state";
import { localStorage } from "@flare/js-utils"; import { localStorage } from "@flare/js-utils";
import { storageKeys } from "../constants"; import { storageKeys } from "../constants";
@ -46,7 +46,7 @@ test("Tuitio client: successfully account logout", async () => {
expect(logoutResult.result?.userName).toBe("tuitio.user"); expect(logoutResult.result?.userName).toBe("tuitio.user");
expect(logoutResult.error).toBeNull(); expect(logoutResult.error).toBeNull();
const storage = fetch(); const storage = acquire();
expect(storage).toBeDefined(); expect(storage).toBeDefined();
expect(storage.token).toBeNull(); expect(storage.token).toBeNull();
expect(storage.validUntil).toBeNull(); expect(storage.validUntil).toBeNull();

View File

@ -4,10 +4,10 @@
// Copyright (c) 2023 Tudor Stanciu // Copyright (c) 2023 Tudor Stanciu
import { fetch } from "../state"; import { acquire } from "../state";
test("Tuitio empty storage", () => { test("Tuitio empty storage", () => {
const result = fetch(); const result = acquire();
expect(result.token).toBeNull(); expect(result.token).toBeNull();
expect(result.validUntil).toBeNull(); expect(result.validUntil).toBeNull();
expect(result.userName).toBeNull(); expect(result.userName).toBeNull();

View File

@ -1,10 +1,10 @@
// Copyright (c) 2023 Tudor Stanciu // Copyright (c) 2023 Tudor Stanciu
import { TuitioClient } from "./client"; import { TuitioClient } from "./client";
import { fetch } from "./state"; import { acquire } from "./state";
import { decodeToken } from "./token"; import { decodeToken } from "./token";
export * from "./types"; export * from "./types";
export { TuitioClient, fetch, decodeToken }; export { TuitioClient, acquire, decodeToken };
export default TuitioClient; export default TuitioClient;

View File

@ -8,7 +8,7 @@ const { getItem } = localStorage;
const defaultTuitioState: TuitioState = { token: null, validUntil: null, userName: null }; const defaultTuitioState: TuitioState = { token: null, validUntil: null, userName: null };
const fetch = (): TuitioState => { const acquire = (): TuitioState => {
const authData = getItem(storageKeys.AUTH_DATA); const authData = getItem(storageKeys.AUTH_DATA);
if (!authData) return defaultTuitioState; if (!authData) return defaultTuitioState;
const { token, validUntil, userName } = authData; const { token, validUntil, userName } = authData;
@ -20,4 +20,4 @@ const fetch = (): TuitioState => {
return data; return data;
}; };
export { fetch }; export { acquire };

View File

@ -1,12 +1,11 @@
// Copyright (c) 2023 Tudor Stanciu // Copyright (c) 2023 Tudor Stanciu
import axios from "axios"; import { acquire } from "../state";
import { fetch } from "../state";
type Headers = { [key: string]: string }; type Headers = { [key: string]: string };
function getHeaders(): Headers { function getHeaders(): Headers {
const { token } = fetch(); const { token } = acquire();
const headers: Headers = { const headers: Headers = {
"Content-Type": "application/json" "Content-Type": "application/json"
}; };