refactor: isOk method add params to documentation and tests messages to better readable

Author: helderberto

src/is-ok.js

@@ -1,5 +1,14 @@
-function isOk(status) {
-  return status === 200;
+import validateHttpStatus from './utils/validate-http-status';
+
+/**
+ * Validate HTTP Status code 200 type SUCCESS
+ *
+ * @param {integer} statusCode - The HTTP Status code
+ * @throws {HTTPStatusError} Will throw an error if the @param {statusCode} is different then 200
+ * @return {boolean}
+ */
+function isOk(statusCode) {
+  return validateHttpStatus(statusCode, 200);
 }
 
 export default isOk;

tests/is-ok.test.js

@@ -1,11 +1,12 @@
 import { isOk } from '../src';
 
 describe('isOk', () => {
-  test('it should test isOk status equal 200', () => {
+  test('it should receive true when pass status 200', () => {
     expect(isOk(200)).toBeTruthy();
   });
 
-  test('it should test isOk status different then 201', () => {
-    expect(isOk(201)).toBeFalsy();
+  test('it should throw Error when pass status different than 200', () => {
+    const received = isOk(300);
+    expect(received.message).toBe('Expected a 200 response.');
   });
 });