isSuccessStatus.ts

import { HttpSuccessStatusCodes } from '../HttpStatusCodes';
import { HttpSuccessReasonPhrases } from '../HttpReasonPhrases';

/**
 * Checks whether the status code belongs to `HttpSuccessStatusCodes` enum.
 * The range is all standard code between [200 - 299]
 *
 * To check the entire 2xx range use `is2xxSuccessStatusCode(code: number)` instead.
 * @param statusCode - The integer status code. e.g. 100
 * @returns `true` if matches `false` otherwise
 */
export const isSuccessStatusCode = (statusCode: number): boolean =>
    HttpSuccessStatusCodes[statusCode] !== undefined;

/**
 * Checks whether the status code belongs to 2xx family of status codes.
 *
 * @param statusCode - The integer status code. e.g. 100
 * @returns `true` if matches `false` otherwise
 */
export const is2xxSuccessStatusCode = (statusCode: number): boolean =>
    statusCode >= 200 && statusCode <= 299;

/**
 * Checks whether the input string belongs to `HttpSuccessReasonPhrases` enum.
 *
 * The match is case sensitive
 *
 * @param reasonPhrase - The reason phrase. e.g. 'OK'
 * @returns `true` if matches `false` otherwise
 */
export const isSuccessReasonPhrase = (reasonPhrase: string): boolean =>
    (Object.values(HttpSuccessReasonPhrases) as string[]).includes(
        reasonPhrase
    ) === true;

/**
 * Checks whether the input integer or string belongs to
 * `HttpSuccessStatusCodes` or `HttpSuccessReasonPhrases` enum.
 * For integer input, the range is all standard code between [200 - 299].
 * For string input, the match is case sensitive.
 *
 * To check the entire 2xx range use `is2xxSuccessStatusCode(code: number)` instead.
 * @param status - e.g. 'Ok' or 200
 * @returns `true` if matches `false` otherwise
 */
export const isSuccessStatus = (status: string | number): boolean =>
    isSuccessStatusCode(status as number) ||
    isSuccessReasonPhrase(status as string);

export default isSuccessStatus;