-
Notifications
You must be signed in to change notification settings - Fork 17
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Deploying to gh-pages from @ 4d4041d 🚀
- Loading branch information
1 parent
8a3266d
commit 089ea10
Showing
113 changed files
with
9,442 additions
and
9,332 deletions.
There are no files selected for viewing
146 changes: 146 additions & 0 deletions
146
additional-documentation/nestjs-application/s3clientmodule.html
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,146 @@ | ||
| <!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 additional-page"> | ||
| <div class="content-data"> | ||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
| <h1>S3 client module</h1> | ||
| <p>This module allows to connect to the S3 storage with our abstraction layer.</p> | ||
| <h2>how to use</h2> | ||
| <p>You need to create a unique connection token and set it as the connection name in S3 configuration. And you must use this token, when injecting the S3 client into your service. This is <strong>very important</strong>, because multiple modules could potentially use the S3 client with different configurations.</p> | ||
| <p>The S3ClientModule.register method awaits an array of S3 configurations. Also you can create many connections to different S3 providers and buckets.</p> | ||
| <div><pre class="line-numbers"><code class="language-ts">// your.config.ts | ||
| export const YOUR_S3_UNIQ_CONNECTION_TOKEN = "YOUR_S3_UNIQ_CONNECTION_TOKEN"; | ||
|
|
||
| const s3Config: S3Config = { | ||
| connectionName: YOUR_S3_UNIQ_CONNECTION_TOKEN, // Important! | ||
| endpoint: "", | ||
| region: "", | ||
| bucket: "", | ||
| accessKeyId: "", | ||
| secretAccessKey: "", | ||
| }; | ||
|
|
||
| // your.service.ts | ||
|
|
||
| @Injectable() | ||
| export class FilesStorageService { | ||
| constructor( | ||
| @Inject(YOUR_S3_UNIQ_CONNECTION_TOKEN) // Important! | ||
| private readonly storageClient: S3ClientAdapter) | ||
| } | ||
|
|
||
| // your.module.ts | ||
| @Module({ | ||
| imports: [S3ClientModule.register([s3Config]),] | ||
| providers: [YourService] | ||
| }) | ||
|
|
||
| export class YourModule {} | ||
| </code></pre></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 = 2; | ||
| var COMPODOC_CURRENT_PAGE_CONTEXT = 'additional-page'; | ||
| var COMPODOC_CURRENT_PAGE_URL = 's3clientmodule.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> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.