-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathsuccess_is-created.js.html
117 lines (91 loc) · 8.37 KB
/
success_is-created.js.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>JSDoc: success/is-created.js</title>
<script src="https://cdn.jsdelivr.net/gh/google/code-prettify@master/loader/run_prettify.js"></script>
<script src="https://unpkg.com/@babel/standalone/babel.min.js"></script>
<script src="./build/entry.js"></script>
<script src="https://ajax.googleapis.com/ajax/libs/jquery/3.3.1/jquery.min.js"></script>
<!--[if lt IE 9]>
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
<link href="https://fonts.googleapis.com/css?family=Muli:100,400,700|Oswald:300|Inconsolata,700" rel="stylesheet">
<link rel="stylesheet" href="https://use.fontawesome.com/releases/v5.6.3/css/all.css" integrity="sha384-UHRtZLI+pbxtHCWp1t77Bi1L4ZtiqrqD80Kn4Z8NTSRyMA2Fd33n5dQ8lWUE00s/" crossorigin="anonymous">
<link type="text/css" rel="stylesheet" href="https://jmblog.github.io/color-themes-for-google-code-prettify/themes/tomorrow-night.min.css">
<link type="text/css" rel="stylesheet" href="styles/app.min.css">
<link type="text/css" rel="stylesheet" href="styles/iframe.css">
</head>
<body>
<div id="stickyNavbarOverlay"></div>
<div class="top-navbar">
<div class="container">
<nav class="navbar" role="navigation" aria-label="main navigation">
<div class="navbar-brand">
<h1 class="navbar-item">Documentation: JS HTTP Status</h1>
<a id="hamburger" role="button" class="navbar-burger" aria-label="menu" aria-expanded="false">
<span aria-hidden="true"></span>
<span aria-hidden="true"></span>
<span aria-hidden="true"></span>
</a>
</div>
<div class="navbar-menu">
<div class="navbar-end">
<div class="navbar-item">
<a href="https://github.com/codevor/js-http-status" target="_blank">Github</a>
</div>
</div>
</div>
</nav>
</div>
</div>
<div class="container">
<div class="columns">
<div class="column is-3" id="sidebarNav">
<div class="sidebar">
<nav>
<h2><a href="index.html">Home</a></h2><div class="category"></div><div class="category"><h2>Validators</h2><h3>Global</h3><ul><li><a href="global.html#isAccepted">isAccepted</a></li><li><a href="global.html#isAlreadyReported">isAlreadyReported</a></li><li><a href="global.html#isBadGateway">isBadGateway</a></li><li><a href="global.html#isBadRequest">isBadRequest</a></li><li><a href="global.html#isClientClosedRequest">isClientClosedRequest</a></li><li><a href="global.html#isConflict">isConflict</a></li><li><a href="global.html#isConnectionClosedWithoutResponse">isConnectionClosedWithoutResponse</a></li><li><a href="global.html#isContinue">isContinue</a></li><li><a href="global.html#isCreated">isCreated</a></li><li><a href="global.html#isExpectationFailed">isExpectationFailed</a></li><li><a href="global.html#isFailedDependency">isFailedDependency</a></li><li><a href="global.html#isForbidden">isForbidden</a></li><li><a href="global.html#isFound">isFound</a></li><li><a href="global.html#isGatewayTimeout">isGatewayTimeout</a></li><li><a href="global.html#isGone">isGone</a></li><li><a href="global.html#isHttpVersionNotSupported">isHttpVersionNotSupported</a></li><li><a href="global.html#isImTeapot">isImTeapot</a></li><li><a href="global.html#isImUsed">isImUsed</a></li><li><a href="global.html#isInsufficientStorage">isInsufficientStorage</a></li><li><a href="global.html#isInternalServerError">isInternalServerError</a></li><li><a href="global.html#isLengthRequired">isLengthRequired</a></li><li><a href="global.html#isLocked">isLocked</a></li><li><a href="global.html#isLoopDetected">isLoopDetected</a></li><li><a href="global.html#isMethodNotAllowed">isMethodNotAllowed</a></li><li><a href="global.html#isMisdirectedRequest">isMisdirectedRequest</a></li><li><a href="global.html#isMovedPermanently">isMovedPermanently</a></li><li><a href="global.html#isMultipleChoices">isMultipleChoices</a></li><li><a href="global.html#isMultiStatus">isMultiStatus</a></li><li><a href="global.html#isNetworkAuthenticationRequired">isNetworkAuthenticationRequired</a></li><li><a href="global.html#isNetworkConnectTimeoutError">isNetworkConnectTimeoutError</a></li><li><a href="global.html#isNoContent">isNoContent</a></li><li><a href="global.html#isNonAuthoritativeInformation">isNonAuthoritativeInformation</a></li><li><a href="global.html#isNotAcceptable">isNotAcceptable</a></li><li><a href="global.html#isNotExtended">isNotExtended</a></li><li><a href="global.html#isNotFound">isNotFound</a></li><li><a href="global.html#isNotImplemented">isNotImplemented</a></li><li><a href="global.html#isNotModified">isNotModified</a></li><li><a href="global.html#isOk">isOk</a></li><li><a href="global.html#isPartialContent">isPartialContent</a></li><li><a href="global.html#isPayloadTooLarge">isPayloadTooLarge</a></li><li><a href="global.html#isPaymentRequired">isPaymentRequired</a></li><li><a href="global.html#isPermanentRedirect">isPermanentRedirect</a></li><li><a href="global.html#isPreconditionFailed">isPreconditionFailed</a></li><li><a href="global.html#isPreconditionRequired">isPreconditionRequired</a></li><li><a href="global.html#isProcessing">isProcessing</a></li><li><a href="global.html#isProxyAuthenticationRequired">isProxyAuthenticationRequired</a></li><li><a href="global.html#isRequestedRangeNotSatisfiable">isRequestedRangeNotSatisfiable</a></li><li><a href="global.html#isRequestHeaderFieldsTooLarge">isRequestHeaderFieldsTooLarge</a></li><li><a href="global.html#isRequestTimeout">isRequestTimeout</a></li><li><a href="global.html#isRequestUriTooLong">isRequestUriTooLong</a></li><li><a href="global.html#isResetContent">isResetContent</a></li><li><a href="global.html#isSeeOther">isSeeOther</a></li><li><a href="global.html#isServiceUnavailable">isServiceUnavailable</a></li><li><a href="global.html#isSwitchingProtocols">isSwitchingProtocols</a></li><li><a href="global.html#isTemporaryRedirect">isTemporaryRedirect</a></li><li><a href="global.html#isTooManyRequests">isTooManyRequests</a></li><li><a href="global.html#isUnauthorized">isUnauthorized</a></li><li><a href="global.html#isUnavailableForLegalReasons">isUnavailableForLegalReasons</a></li><li><a href="global.html#isUnprocessableEntity">isUnprocessableEntity</a></li><li><a href="global.html#isUnsupportedMediaType">isUnsupportedMediaType</a></li><li><a href="global.html#isUpgradeRequired">isUpgradeRequired</a></li><li><a href="global.html#isUseproxy">isUseproxy</a></li><li><a href="global.html#isVariantAlsoNegotiates">isVariantAlsoNegotiates</a></li></ul></div>
</nav>
</div>
</div>
<div class="column is-9-desktop">
<div class="content" id="main-content-wrapper">
<header class="page-title">
<p>Source</p>
<h1>success/is-created.js</h1>
</header>
<section>
<article>
<pre class="prettyprint source linenums"><code>import validateHttpStatus from '../validate-http-status';
/**
* @description
* Validate HTTP Status code 201 type SUCCESS
*
* @param {Integer} statusCode - The HTTP Status code
* @return {Boolean}
* @throws {HTTPStatusError} When the statusCode is different then 201
*/
function isCreated(statusCode) {
return validateHttpStatus(statusCode, 201);
}
export default isCreated;
</code></pre>
</article>
</section>
</div>
</div>
</div>
</div>
<footer class="footer">
<div class="content has-text-centered">
<p>Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a> on Fri Oct 25 2019 13:03:41 GMT-0300 (Brasilia Standard Time)</p>
<p class="sidebar-created-by">
<a href="https://github.com/SoftwareBrothers/better-docs" target="_blank">BetterDocs theme</a> provided with <i class="fas fa-heart"></i> by
<a href="http://softwarebrothers.co" target="_blank">SoftwareBrothers - JavaScript Development Agency</a>
</p>
</div>
</footer>
<script src="scripts/app.min.js"></script>
<script src="scripts/linenumber.js"> </script>
</body>
</html>