All files / src/api FactorSets.ts

100% Statements 7/7
100% Branches 0/0
100% Functions 1/1
100% Lines 7/7

Press n or j to go to the next uncovered block, b, p or k for the previous block.

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 251x 1x   1x                       1x   1x 1x   1x        
import { Client } from "../Client";
import { FACTOR_SET_API_PATH, GET } from "../Constants";
import { FactorSetResponse } from "../interfaces/response/FactorSetResponse";
import { makeApiRequest } from "../request";
 
/**
 * Retrieves factor sets by making a GET request to the factor set API endpoint.
 * 
 * @export
 * @return {Promise<FactorSetResponse>} A promise that resolves to the  FactorSetResponse returned by the API
 * @throws {Error} May throw an error if the API request fails
 * 
 * @example
 * const factorSets = await get();
 */
export async function get(
): Promise<FactorSetResponse> {
const client = Client.getInstance();
  const url = client.getDomain() + FACTOR_SET_API_PATH;
 
  return makeApiRequest<FactorSetResponse>({
    method: GET,
    url
  });
}