refactor: all methods removed @module

helderberto · helderberto · commit 656566fbe1df · 2019-10-25T13:41:16.000-03:00
diff --git a/src/errors/http-status-error.js b/src/errors/http-status-error.js
@@ -1,3 +1,9 @@
+/** * @category Errors
+ * @description
+ * Throw exception type HTTPStatusError
+ *
+ * @param {String} message - Status error message
+ */
 class HTTPStatusError extends Error {
   constructor(message) {
     super(message);
diff --git a/src/utils/find-status/find-status-by-code.js b/src/utils/find-status/find-status-by-code.js
@@ -1,5 +1,12 @@
 import findStatus from '.';
 
+/**
+ * @description
+ * This method finds HTTP status by code
+ *
+ * @param {Integer} statusCode - The HTTP Status code
+ * @return {Object}
+ */
 function findStatusByCode(statusCode) {
   return findStatus(statusCode);
 }
diff --git a/src/utils/find-status/find-status-by-key.js b/src/utils/find-status/find-status-by-key.js
@@ -1,5 +1,12 @@
 import findStatus from '.';
 
+/**
+ * @description
+ * This method finds HTTP status by key
+ *
+ * @param {String} statusKey - The HTTP Status key
+ * @return {Object}
+ */
 function findStatusByKey(statusKey) {
   return findStatus(statusKey, 'key');
 }
diff --git a/src/utils/find-status/index.js b/src/utils/find-status/index.js
@@ -1,5 +1,13 @@
 import HTTP_STATUSES from '../../constants/http-statuses';
 
+/**
+ * @description
+ * This method finds HTTP status by specified field
+ *
+ * @param {String/Integer} value - The HTTP Status value to filter
+ * @param {String} field - Find by "code" or "key"
+ * @return {Object}
+ */
 function findHttpStatus(value, field = 'code') {
   return HTTP_STATUSES.find(httpStatus => httpStatus[field] === value);
 }
diff --git a/src/validators/client-error/is-bad-request.js b/src/validators/client-error/is-bad-request.js
@@ -1,7 +1,6 @@
 import validateHttpStatus from '../validate-http-status';
 
 /**
- * @module isBadRequest
  * @description
  * Validate HTTP Status code 400 type CLIENT ERROR
  *
diff --git a/src/validators/client-error/is-client-closed-request.js b/src/validators/client-error/is-client-closed-request.js
@@ -1,7 +1,6 @@
 import validateHttpStatus from '../validate-http-status';
 
 /**
- * @module isClientClosedRequest
  * @description
  * Validate HTTP Status code 499 type CLIENT ERROR
  *
diff --git a/src/validators/client-error/is-conflict.js b/src/validators/client-error/is-conflict.js
@@ -1,7 +1,6 @@
 import validateHttpStatus from '../validate-http-status';
 
 /**
- * @module isConflict
  * @description
  * Validate HTTP Status code 409 type CLIENT ERROR
  *
diff --git a/src/validators/client-error/is-connection-closed-without-response.js b/src/validators/client-error/is-connection-closed-without-response.js
@@ -1,7 +1,6 @@
 import validateHttpStatus from '../validate-http-status';
 
 /**
- * @module isConnectionClosedWithoutResponse
  * @description
  * Validate HTTP Status code 444 type CLIENT ERROR
  *
diff --git a/src/validators/client-error/is-expectation-failed.js b/src/validators/client-error/is-expectation-failed.js
@@ -1,7 +1,6 @@
 import validateHttpStatus from '../validate-http-status';
 
 /**
- * @module isExpectationFailed
  * @description
  * Validate HTTP Status code 417 type CLIENT ERROR
  *
diff --git a/src/validators/client-error/is-failed-dependency.js b/src/validators/client-error/is-failed-dependency.js
@@ -1,7 +1,6 @@
 import validateHttpStatus from '../validate-http-status';
 
 /**
- * @module isFailedDependency
  * @description
  * Validate HTTP Status code 424 type CLIENT ERROR
  *
diff --git a/src/validators/client-error/is-forbidden.js b/src/validators/client-error/is-forbidden.js
@@ -1,7 +1,6 @@
 import validateHttpStatus from '../validate-http-status';
 
 /**
- * @module isForbidden
  * @description
  * Validate HTTP Status code 403 type CLIENT ERROR
  *
diff --git a/src/validators/client-error/is-gone.js b/src/validators/client-error/is-gone.js
@@ -1,7 +1,6 @@
 import validateHttpStatus from '../validate-http-status';
 
 /**
- * @module isGone
  * @description
  * Validate HTTP Status code 410 type CLIENT ERROR
  *
diff --git a/src/validators/client-error/is-im-teapot.js b/src/validators/client-error/is-im-teapot.js
@@ -1,7 +1,6 @@
 import validateHttpStatus from '../validate-http-status';
 
 /**
- * @module isImTeapot
  * @description
  * Validate HTTP Status code 418 type CLIENT ERROR
  *
diff --git a/src/validators/client-error/is-length-required.js b/src/validators/client-error/is-length-required.js
@@ -1,7 +1,6 @@
 import validateHttpStatus from '../validate-http-status';
 
 /**
- * @module isLengthRequired
  * @description
  * Validate HTTP Status code 411 type CLIENT ERROR
  *
diff --git a/src/validators/client-error/is-locked.js b/src/validators/client-error/is-locked.js
@@ -1,7 +1,6 @@
 import validateHttpStatus from '../validate-http-status';
 
 /**
- * @module isLocked
  * @description
  * Validate HTTP Status code 423 type CLIENT ERROR
  *
diff --git a/src/validators/client-error/is-method-not-allowed.js b/src/validators/client-error/is-method-not-allowed.js
@@ -1,7 +1,6 @@
 import validateHttpStatus from '../validate-http-status';
 
 /**
- * @module isMethodNotAllowed
  * @description
  * Validate HTTP Status code 405 type CLIENT ERROR
  *
diff --git a/src/validators/client-error/is-misdirected-request.js b/src/validators/client-error/is-misdirected-request.js
@@ -1,7 +1,6 @@
 import validateHttpStatus from '../validate-http-status';
 
 /**
- * @module isMisdirectedRequest
  * @description
  * Validate HTTP Status code 421 type CLIENT ERROR
  *
diff --git a/src/validators/client-error/is-not-acceptable.js b/src/validators/client-error/is-not-acceptable.js
@@ -1,7 +1,6 @@
 import validateHttpStatus from '../validate-http-status';
 
 /**
- * @module isNotAcceptable
  * @description
  * Validate HTTP Status code 406 type CLIENT ERROR
  *
diff --git a/src/validators/client-error/is-not-found.js b/src/validators/client-error/is-not-found.js
@@ -1,7 +1,6 @@
 import validateHttpStatus from '../validate-http-status';
 
 /**
- * @module isNotFound
  * @description
  * Validate HTTP Status code 404 type CLIENT ERROR
  *
diff --git a/src/validators/client-error/is-payload-too-large.js b/src/validators/client-error/is-payload-too-large.js
@@ -1,7 +1,6 @@
 import validateHttpStatus from '../validate-http-status';
 
 /**
- * @module isPayloadTooLarge
  * @description
  * Validate HTTP Status code 413 type CLIENT ERROR
  *
diff --git a/src/validators/client-error/is-payment-required.js b/src/validators/client-error/is-payment-required.js
@@ -1,7 +1,6 @@
 import validateHttpStatus from '../validate-http-status';
 
 /**
- * @module isPaymentRequired
  * @description
  * Validate HTTP Status code 402 type CLIENT ERROR
  *
diff --git a/src/validators/client-error/is-precondition-failed.js b/src/validators/client-error/is-precondition-failed.js
@@ -1,7 +1,6 @@
 import validateHttpStatus from '../validate-http-status';
 
 /**
- * @module isPreconditionFailed
  * @description
  * Validate HTTP Status code 412 type CLIENT ERROR
  *
diff --git a/src/validators/client-error/is-precondition-required.js b/src/validators/client-error/is-precondition-required.js
@@ -1,7 +1,6 @@
 import validateHttpStatus from '../validate-http-status';
 
 /**
- * @module isPreconditionRequired
  * @description
  * Validate HTTP Status code 428 type CLIENT ERROR
  *
diff --git a/src/validators/client-error/is-proxy-authentication-required.js b/src/validators/client-error/is-proxy-authentication-required.js
@@ -1,7 +1,6 @@
 import validateHttpStatus from '../validate-http-status';
 
 /**
- * @module isProxyAuthenticationRequired
  * @description
  * Validate HTTP Status code 407 type CLIENT ERROR
  *
diff --git a/src/validators/client-error/is-request-header-fields-too-large.js b/src/validators/client-error/is-request-header-fields-too-large.js
@@ -1,7 +1,6 @@
 import validateHttpStatus from '../validate-http-status';
 
 /**
- * @module isRequestHeaderFieldsTooLarge
  * @description
  * Validate HTTP Status code 431 type CLIENT ERROR
  *
diff --git a/src/validators/client-error/is-request-timeout.js b/src/validators/client-error/is-request-timeout.js
@@ -1,7 +1,6 @@
 import validateHttpStatus from '../validate-http-status';
 
 /**
- * @module isRequestTimeout
  * @description
  * Validate HTTP Status code 408 type CLIENT ERROR
  *
diff --git a/src/validators/client-error/is-request-uri-too-long.js b/src/validators/client-error/is-request-uri-too-long.js
@@ -1,7 +1,6 @@
 import validateHttpStatus from '../validate-http-status';
 
 /**
- * @module isRequestUriTooLong
  * @description
  * Validate HTTP Status code 414 type CLIENT ERROR
  *
diff --git a/src/validators/client-error/is-requested-range-not-satisfiable.js b/src/validators/client-error/is-requested-range-not-satisfiable.js
@@ -1,7 +1,6 @@
 import validateHttpStatus from '../validate-http-status';
 
 /**
- * @module isRequestedRangeNotSatisfiable
  * @description
  * Validate HTTP Status code 416 type CLIENT ERROR
  *
diff --git a/src/validators/client-error/is-too-many-requests.js b/src/validators/client-error/is-too-many-requests.js
@@ -1,7 +1,6 @@
 import validateHttpStatus from '../validate-http-status';
 
 /**
- * @module isTooManyRequests
  * @description
  * Validate HTTP Status code 429 type CLIENT ERROR
  *
diff --git a/src/validators/client-error/is-unauthorized.js b/src/validators/client-error/is-unauthorized.js
@@ -1,7 +1,6 @@
 import validateHttpStatus from '../validate-http-status';
 
 /**
- * @module isUnauthorized
  * @description
  * Validate HTTP Status code 401 type CLIENT ERROR
  *
diff --git a/src/validators/client-error/is-unavailable-for-legal-reasons.js b/src/validators/client-error/is-unavailable-for-legal-reasons.js
@@ -1,7 +1,6 @@
 import validateHttpStatus from '../validate-http-status';
 
 /**
- * @module isUnavailableForLegalReasons
  * @description
  * Validate HTTP Status code 451 type CLIENT ERROR
  *
diff --git a/src/validators/client-error/is-unprocessable-entity.js b/src/validators/client-error/is-unprocessable-entity.js
@@ -1,7 +1,6 @@
 import validateHttpStatus from '../validate-http-status';
 
 /**
- * @module isUnprocessableEntity
  * @description
  * Validate HTTP Status code 422 type CLIENT ERROR
  *
diff --git a/src/validators/client-error/is-unsupported-media-type.js b/src/validators/client-error/is-unsupported-media-type.js
@@ -1,7 +1,6 @@
 import validateHttpStatus from '../validate-http-status';
 
 /**
- * @module isUnsupportedMediaType
  * @description
  * Validate HTTP Status code 415 type CLIENT ERROR
  *
diff --git a/src/validators/client-error/is-upgrade-required.js b/src/validators/client-error/is-upgrade-required.js
@@ -1,7 +1,6 @@
 import validateHttpStatus from '../validate-http-status';
 
 /**
- * @module isUpgradeRequired
  * @description
  * Validate HTTP Status code 426 type CLIENT ERROR
  *
diff --git a/src/validators/informational/is-continue.js b/src/validators/informational/is-continue.js
@@ -1,7 +1,6 @@
 import validateHttpStatus from '../validate-http-status';
 
 /**
- * @module isContinue
  * @description
  * Validate HTTP Status code 100 type INFORMATIONAL
  *
diff --git a/src/validators/informational/is-processing.js b/src/validators/informational/is-processing.js
@@ -1,7 +1,6 @@
 import validateHttpStatus from '../validate-http-status';
 
 /**
- * @module isProcessing
  * @description
  * Validate HTTP Status code 102 type INFORMATIONAL
  *
diff --git a/src/validators/informational/is-switching-protocols.js b/src/validators/informational/is-switching-protocols.js
@@ -1,7 +1,6 @@
 import validateHttpStatus from '../validate-http-status';
 
 /**
- * @module isSwitchingProtocols
  * @description
  * Validate HTTP Status code 101 type INFORMATIONAL
  *
diff --git a/src/validators/redirection/is-found.js b/src/validators/redirection/is-found.js
@@ -1,7 +1,6 @@
 import validateHttpStatus from '../validate-http-status';
 
 /**
- * @module isFound
  * @description
  * Validate HTTP Status code 302 type REDIRECTION
  *
diff --git a/src/validators/redirection/is-moved-permanently.js b/src/validators/redirection/is-moved-permanently.js
@@ -1,7 +1,6 @@
 import validateHttpStatus from '../validate-http-status';
 
 /**
- * @module isMovedPermanently
  * @description
  * Validate HTTP Status code 301 type REDIRECTION
  *
diff --git a/src/validators/redirection/is-multiple-choices.js b/src/validators/redirection/is-multiple-choices.js
@@ -1,7 +1,6 @@
 import validateHttpStatus from '../validate-http-status';
 
 /**
- * @module isMultipleChoices
  * @description
  * Validate HTTP Status code 300 type REDIRECTION
  *
diff --git a/src/validators/redirection/is-not-modified.js b/src/validators/redirection/is-not-modified.js
@@ -1,7 +1,6 @@
 import validateHttpStatus from '../validate-http-status';
 
 /**
- * @module isNotModified
  * @description
  * Validate HTTP Status code 304 type REDIRECTION
  *
diff --git a/src/validators/redirection/is-permanent-redirect.js b/src/validators/redirection/is-permanent-redirect.js
@@ -1,7 +1,6 @@
 import validateHttpStatus from '../validate-http-status';
 
 /**
- * @module isPermanentRedirect
  * @description
  * Validate HTTP Status code 308 type REDIRECTION
  *
diff --git a/src/validators/redirection/is-see-other.js b/src/validators/redirection/is-see-other.js
@@ -1,7 +1,6 @@
 import validateHttpStatus from '../validate-http-status';
 
 /**
- * @module isSeeOther
  * @description
  * Validate HTTP Status code 303 type REDIRECTION
  *
diff --git a/src/validators/redirection/is-temporary-redirect.js b/src/validators/redirection/is-temporary-redirect.js
@@ -1,7 +1,6 @@
 import validateHttpStatus from '../validate-http-status';
 
 /**
- * @module isTemporaryRedirect
  * @description
  * Validate HTTP Status code 307 type REDIRECTION
  *
diff --git a/src/validators/redirection/is-use-proxy.js b/src/validators/redirection/is-use-proxy.js
@@ -1,7 +1,6 @@
 import validateHttpStatus from '../validate-http-status';
 
 /**
- * @module isUseproxy
  * @description
  * Validate HTTP Status code 305 type REDIRECTION
  *
diff --git a/src/validators/server-error/is-bad-gateway.js b/src/validators/server-error/is-bad-gateway.js
@@ -1,7 +1,6 @@
 import validateHttpStatus from '../validate-http-status';
 
 /**
- * @module isBadGateway
  * @description
  * Validate HTTP Status code 502 type SERVER ERROR
  *
diff --git a/src/validators/server-error/is-gateway-timeout.js b/src/validators/server-error/is-gateway-timeout.js
@@ -1,7 +1,6 @@
 import validateHttpStatus from '../validate-http-status';
 
 /**
- * @module isGatewayTimeout
  * @description
  * Validate HTTP Status code 504 type SERVER ERROR
  *
diff --git a/src/validators/server-error/is-http-version-not-supported.js b/src/validators/server-error/is-http-version-not-supported.js
diff --git a/src/validators/server-error/is-insufficient-storage.js b/src/validators/server-error/is-insufficient-storage.js
diff --git a/src/validators/server-error/is-internal-server-error.js b/src/validators/server-error/is-internal-server-error.js
diff --git a/src/validators/server-error/is-loop-detected.js b/src/validators/server-error/is-loop-detected.js
diff --git a/src/validators/server-error/is-network-authentication-required.js b/src/validators/server-error/is-network-authentication-required.js
diff --git a/src/validators/server-error/is-network-connect-timeout-error.js b/src/validators/server-error/is-network-connect-timeout-error.js
diff --git a/src/validators/server-error/is-not-extended.js b/src/validators/server-error/is-not-extended.js
diff --git a/src/validators/server-error/is-not-implemented.js b/src/validators/server-error/is-not-implemented.js
diff --git a/src/validators/server-error/is-service-unavailable.js b/src/validators/server-error/is-service-unavailable.js
diff --git a/src/validators/server-error/is-variant-also-negotiates.js b/src/validators/server-error/is-variant-also-negotiates.js
diff --git a/src/validators/success/is-accepted.js b/src/validators/success/is-accepted.js
diff --git a/src/validators/success/is-already-reported.js b/src/validators/success/is-already-reported.js
diff --git a/src/validators/success/is-created.js b/src/validators/success/is-created.js
diff --git a/src/validators/success/is-im-used.js b/src/validators/success/is-im-used.js
diff --git a/src/validators/success/is-multi-status.js b/src/validators/success/is-multi-status.js
diff --git a/src/validators/success/is-no-content.js b/src/validators/success/is-no-content.js
diff --git a/src/validators/success/is-non-authoritative-information.js b/src/validators/success/is-non-authoritative-information.js
diff --git a/src/validators/success/is-ok.js b/src/validators/success/is-ok.js
diff --git a/src/validators/success/is-partial-content.js b/src/validators/success/is-partial-content.js
diff --git a/src/validators/success/is-reset-content.js b/src/validators/success/is-reset-content.js

Original file line number	Diff line number	Diff line change
`@@ -1,7 +1,6 @@`
`1`	`1`	`import validateHttpStatus from '../validate-http-status';`
`2`	`2`
`3`	`3`	`/**`
`4`		`- * @module isBadRequest`
`5`	`4`	`* @description`
`6`	`5`	`* Validate HTTP Status code 400 type CLIENT ERROR`
`7`	`6`	`*`