Skip to content

Commit

Permalink
Deploying to gh-pages from @ e33f7e5 🚀
Browse files Browse the repository at this point in the history
  • Loading branch information
@bischofmax
bischofmax committed Sep 20, 2023
1 parent d8d43ac commit f9a9adc
Show file tree
Hide file tree
Showing 98 changed files with 2,796 additions and 2,396 deletions.
316 changes: 316 additions & 0 deletions classes/ReadableStreamWithFileTypeImp.html
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,316 @@
<!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" >ReadableStreamWithFileTypeImp</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/readable-stream-with-file-type.factory.ts</code>
</p>



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

<p class="comment">
<h3>Implements</h3>
</p>
<p class="comment">
<code><a href="../interfaces/File.html" target="_self" >ReadableStreamWithFileType</a></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>Properties</b></h6>
</td>
</tr>
<tr>
<td class="col-md-4">
<ul class="index-list">
<li>
<span class="modifier">Optional</span>
<a href="#fileType" >fileType</a>
</li>
</ul>
</td>
</tr>






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

<section data-compodoc="block-constructor">
<h3 id="constructor">Constructor</h3>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<code>constructor(props: <a href="../undefineds/ReadableStreamWithFileTypeProps.html" target="_self">ReadableStreamWithFileTypeProps</a>)</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-line">Defined in <a href="" data-line="11" class="link-to-prism">apps/server/src/shared/testing/factory/readable-stream-with-file-type.factory.ts:11</a></div>
</td>
</tr>

<tr>
<td class="col-md-4">
<div>
<b>Parameters :</b>
<table class="params">
<thead>
<tr>
<td>Name</td>
<td>Type</td>
<td>Optional</td>
</tr>
</thead>
<tbody>
<tr>
<td>props</td>

<td>
<code><a href="../miscellaneous/typealiases.html#ReadableStreamWithFileTypeProps" target="_self" >ReadableStreamWithFileTypeProps</a></code>
</td>

<td>
No
</td>

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

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

<h3 id="inputs">
Properties
</h3>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="fileType"></a>
<span class="name">
<span class="modifier">Optional</span>
<span ><b>fileType</b></span>
<a href="#fileType"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Type : </i> <code><a href="../interfaces/File.html" target="_self" >FileTypeResult</a></code>

</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-line">Defined in <a href="" data-line="11" class="link-to-prism">apps/server/src/shared/testing/factory/readable-stream-with-file-type.factory.ts:11</a></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 { FileTypeResult, ReadableStreamWithFileType } from &#x27;file-type&#x27;;
import { Readable } from &#x27;stream&#x27;;
import { BaseFactory } from &#x27;./base.factory&#x27;;

type ReadableStreamWithFileTypeProps &#x3D; {
fileType?: FileTypeResult;
readable: Readable;
};

class ReadableStreamWithFileTypeImp extends Readable implements ReadableStreamWithFileType {
fileType?: FileTypeResult;

constructor(props: ReadableStreamWithFileTypeProps) {
super();
this.fileType &#x3D; props.fileType;
}
}

// eslint-disable-next-line @typescript-eslint/no-explicit-any
export const readableStreamWithFileTypeFactory &#x3D; BaseFactory.define&lt;
ReadableStreamWithFileTypeImp,
ReadableStreamWithFileTypeProps
&gt;(ReadableStreamWithFileTypeImp, () &#x3D;&gt; {
const readable &#x3D; Readable.from(&#x27;abc&#x27;);

return {
fileType: {
ext: &#x27;png&#x27;,
mime: &#x27;image/png&#x27;,
},
readable,
};
});
</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 = 'ReadableStreamWithFileTypeImp.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>
24 changes: 24 additions & 0 deletions coverage.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -16471,6 +16471,30 @@
<span class="coverage-count">(0/1)</span>
</td>
</tr>
<tr class="low">
<td>
<!-- miscellaneous -->
<a href="./classes/ReadableStreamWithFileTypeImp.html">apps/server/src/shared/testing/factory/readable-stream-with-file-type.factory.ts</a>
</td>
<td>class</td>
<td>ReadableStreamWithFileTypeImp</td>
<td align="right" data-sort="0">
<span class="coverage-percent">0 %</span>
<span class="coverage-count">(0/3)</span>
</td>
</tr>
<tr class="low">
<td>
<!-- miscellaneous -->
<a href="./miscellaneous/variables.html#readableStreamWithFileTypeFactory">apps/server/src/shared/testing/factory/readable-stream-with-file-type.factory.ts</a>
</td>
<td>variable</td>
<td>readableStreamWithFileTypeFactory</td>
<td align="right" data-sort="0">
<span class="coverage-percent">0 %</span>
<span class="coverage-count">(0/1)</span>
</td>
</tr>
<tr class="low">
<td>
<!-- miscellaneous -->
Expand Down
4 changes: 2 additions & 2 deletions dependencies.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -185,6 +185,8 @@
<b>feathers-mongoose</b> : ^6.3.0</li>
<li>
<b>feathers-swagger</b> : ^3.0.0</li>
<li>
<b>file-type</b> : ^18.5.0</li>
<li>
<b>freeport</b> : ^1.0.5</li>
<li>
Expand Down Expand Up @@ -273,8 +275,6 @@
<b>socketio-file-upload</b> : ^0.7.0</li>
<li>
<b>source-map-support</b> : ^0.5.19</li>
<li>
<b>stream-mime-type</b> : ^2.0.0</li>
<li>
<b>strip-bom</b> : ^4.0.0</li>
<li>
Expand Down
Loading

0 comments on commit f9a9adc

Please sign in to comment.