Skip to content

Commit

Permalink
Deploying to gh-pages from @ 034cab8 🚀
Browse files Browse the repository at this point in the history
  • Loading branch information
@arnegns
arnegns committed Nov 13, 2023
1 parent 42434ea commit e3ac770
Show file tree
Hide file tree
Showing 106 changed files with 4,277 additions and 2,924 deletions.
284 changes: 284 additions & 0 deletions classes/AxiosErrorFactory.html
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,284 @@
<!doctype html>
<html class="no-js" lang="">
<head>
<meta charset="utf-8">
<meta http-equiv="x-ua-compatible" content="ie=edge">
<title>schulcloud-server documentation</title>
<meta name="description" content="">
<meta name="viewport" content="width=device-width, initial-scale=1">

<link rel="icon" type="image/x-icon" href="../images/favicon.ico">
<link rel="stylesheet" href="../styles/style.css">
<link rel="stylesheet" href="../styles/dark.css">
</head>
<body>

<div class="navbar navbar-default navbar-fixed-top d-block d-sm-none">
<a href="../" class="navbar-brand">schulcloud-server documentation</a>
<button type="button" class="btn btn-default btn-menu ion-ios-menu" id="btn-menu"></button>
</div>

<div class="xs-menu menu" id="mobile-menu">
<div id="book-search-input" role="search"><input type="text" placeholder="Type to search"></div> <compodoc-menu></compodoc-menu>
</div>

<div class="container-fluid main">
<div class="row main">
<div class="hidden-xs menu">
<compodoc-menu mode="normal"></compodoc-menu>
</div>
<!-- START CONTENT -->
<div class="content class">
<div class="content-data">












<ol class="breadcrumb">
<li class="breadcrumb-item">Classes</li>
<li class="breadcrumb-item" >AxiosErrorFactory</li>
</ol>

<ul class="nav nav-tabs" role="tablist">
<li class="nav-item">
<a href="#info"
class="nav-link"
class="nav-link active"
role="tab" id="info-tab" data-bs-toggle="tab" data-link="info">Info</a>
</li>
<li class="nav-item">
<a href="#source"
class="nav-link"

role="tab" id="source-tab" data-bs-toggle="tab" data-link="source">Source</a>
</li>
</ul>

<div class="tab-content">
<div class="tab-pane fade active in" id="info">
<p class="comment">
<h3>File</h3>
</p>
<p class="comment">
<code>apps/server/src/shared/testing/factory/axios-error.factory.ts</code>
</p>



<p class="comment">
<h3>Extends</h3>
</p>
<p class="comment">
<code>Factory</code>
</p>



<section data-compodoc="block-index">
<h3 id="index">Index</h3>
<table class="table table-sm table-bordered index-table">
<tbody>

<tr>
<td class="col-md-4">
<h6><b>Methods</b></h6>
</td>
</tr>
<tr>
<td class="col-md-4">
<ul class="index-list">
<li>
<a href="#withError" >withError</a>
</li>
</ul>
</td>
</tr>





</tbody>
</table>
</section>



<section data-compodoc="block-methods">

<h3 id="methods">
Methods
</h3>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="withError"></a>
<span class="name">
<span ><b>withError</b></span>
<a href="#withError"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<code>withError(error)</code>
</td>
</tr>


<tr>
<td class="col-md-4">
<div class="io-line">Defined in <a href="" data-line="7"
class="link-to-prism">apps/server/src/shared/testing/factory/axios-error.factory.ts:7</a></div>
</td>
</tr>


<tr>
<td class="col-md-4">

<div class="io-description">
<b>Parameters :</b>

<table class="params">
<thead>
<tr>
<td>Name</td>
<td>Optional</td>
</tr>
</thead>
<tbody>
<tr>
<td>error</td>

<td>
No
</td>


</tr>
</tbody>
</table>
</div>
</td>
</tr>
</tbody>
</table>
</section>





</div>


<div class="tab-pane fade tab-source-code" id="source">
<pre class="line-numbers compodoc-sourcecode"><code class="language-typescript">import { HttpStatus } from &#x27;@nestjs/common&#x27;;
import { axiosResponseFactory } from &#x27;@shared/testing&#x27;;
import { AxiosError, AxiosHeaders } from &#x27;axios&#x27;;
import { Factory } from &#x27;fishery&#x27;;

class AxiosErrorFactory extends Factory&lt;AxiosError&gt; {
withError(error: unknown): this {
return this.params({
response: axiosResponseFactory.build({ status: HttpStatus.BAD_REQUEST, data: error }),
});
}
}

export const axiosErrorFactory &#x3D; AxiosErrorFactory.define(() &#x3D;&gt; {
return {
status: HttpStatus.BAD_REQUEST,
config: { headers: new AxiosHeaders() },
isAxiosError: true,
code: HttpStatus.BAD_REQUEST.toString(),
message: &#x27;Bad Request&#x27;,
name: &#x27;BadRequest&#x27;,
response: axiosResponseFactory.build({ status: HttpStatus.BAD_REQUEST }),
stack: &#x27;mockStack&#x27;,
toJSON: () &#x3D;&gt; {
return { someJson: &#x27;someJson&#x27; };
},
};
});
</code></pre>
</div>
</div>









</div><div class="search-results">
<div class="has-results">
<h1 class="search-results-title"><span class='search-results-count'></span> results matching "<span class='search-query'></span>"</h1>
<ul class="search-results-list"></ul>
</div>
<div class="no-results">
<h1 class="search-results-title">No results matching "<span class='search-query'></span>"</h1>
</div>
</div>
</div>
<!-- END CONTENT -->
</div>
</div>

<label class="dark-mode-switch">
<input type="checkbox">
<span class="slider">
<svg class="slider-icon" viewBox="0 0 24 24" fill="none" height="20" stroke="#000" stroke-linecap="round" stroke-linejoin="round" stroke-width="2" width="20" xmlns="http://www.w3.org/2000/svg">
<path d="M21 12.79A9 9 0 1111.21 3 7 7 0 0021 12.79z"></path>
</svg>
</span>
</label>

<script>
var COMPODOC_CURRENT_PAGE_DEPTH = 1;
var COMPODOC_CURRENT_PAGE_CONTEXT = 'class';
var COMPODOC_CURRENT_PAGE_URL = 'AxiosErrorFactory.html';
var MAX_SEARCH_RESULTS = 15;
</script>

<script src="../js/libs/custom-elements.min.js"></script>
<script src="../js/libs/lit-html.js"></script>

<script src="../js/menu-wc.js" defer></script>
<script nomodule src="../js/menu-wc_es5.js" defer></script>

<script src="../js/libs/bootstrap-native.js"></script>

<script src="../js/libs/es6-shim.min.js"></script>
<script src="../js/libs/EventDispatcher.js"></script>
<script src="../js/libs/promise.min.js"></script>
<script src="../js/libs/zepto.min.js"></script>

<script src="../js/compodoc.js"></script>

<script src="../js/tabs.js"></script>
<script src="../js/menu.js"></script>
<script src="../js/libs/clipboard.min.js"></script>
<script src="../js/libs/prism.js"></script>
<script src="../js/sourceCode.js"></script>
<script src="../js/search/search.js"></script>
<script src="../js/search/lunr.min.js"></script>
<script src="../js/search/search-lunr.js"></script>
<script src="../js/search/search_index.js"></script>
<script src="../js/lazy-load-graphs.js"></script>


</body>
</html>
Loading

0 comments on commit e3ac770

Please sign in to comment.