@forklaunch/core 0.1.2 → 0.1.5

package/dist/http/httpStatusCodes.d.ts

@@ -0,0 +1,74 @@
+/**
+ * Object-map of the HTTP Status Codes. Maps from the status code, to the
+ * textual name. The key is the HTTP Status Code number, and the resulting
+ * value will be the textual name for that Status Code.
+ *
+ * The comments for each item are taken from httpstatuses.com and the RFC-7231
+ * document.
+ *
+ * @see https://httpstatuses.com
+ * @see https://datatracker.ietf.org/doc/html/rfc7231
+ */
+export declare const HTTPStatuses: Readonly<{
+    [key: number]: string;
+}>;
+/**
+ * Numerical HTTP status code.
+ */
+export type StatusCode = keyof typeof HTTPStatuses;
+/**
+ * Checks if the given numerical status code is in the known HTTP status codes
+ * list.
+ *
+ * @param code HTTP Status code
+ * @returns True if the code is a valid HTTP status code
+ */
+export declare const isValidStatusCode: (code: number) => boolean;
+/**
+ * Checks if the given status code is in the informational range (1XX).
+ *
+ * @param code HTTP Status code
+ * @returns True if the code is in the "informational" range.
+ */
+export declare const isInformational: (code: StatusCode) => boolean;
+/**
+ * Checks if the given status code is in the successful range (2XX).
+ *
+ * @param code HTTP Status code
+ * @returns True if the code is in the "success" range.
+ */
+export declare const isSuccessful: (code: StatusCode) => boolean;
+/**
+ * Checks if the given status code is in the redirection range (3XX).
+ *
+ * @param code HTTP Status code
+ * @returns True if the code is in the "redirection" range.
+ */
+export declare const isRedirection: (code: StatusCode) => boolean;
+/**
+ * Checks if the given status code is in the client error range (4XX).
+ *
+ * @param code HTTP Status code
+ * @returns True if the code is in the "client error" range.
+ */
+export declare const isClientError: (code: StatusCode) => boolean;
+/**
+ * Checks if the given status code is in the server error range (5XX).
+ *
+ * @param code HTTP Status code
+ * @returns True if the code is in the "server error" range.
+ */
+export declare const isServerError: (code: StatusCode) => boolean;
+/**
+ * Searches the list of HTTP statuses for a matching textual name to the one
+ * provided. If a match is found, then the numerical status code is returned,
+ * otherwise `null`.
+ *
+ * Internally, the parameter and the status names are normalized by lower-casing
+ * the strings and trimming space.
+ *
+ * @param status HTTP Status textual name
+ * @returns The numerical status code, or null if not found
+ */
+export declare const getCodeForStatus: (status: string) => null | StatusCode;
+export default HTTPStatuses;