@rxap/data-source
Version:
Provides a set of classes and decorators for creating and managing data sources in Angular applications, including base classes, static data sources, observable data sources, and method data sources. It also includes a component for displaying data source
457 lines (378 loc) • 16 kB
HTML
<html class="no-js" lang="">
<head>
<meta charset="utf-8">
<meta http-equiv="x-ua-compatible" content="ie=edge">
<title>angular-data-source</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>
<script>
// Blocking script to avoid flickering dark mode
// Dark mode toggle button
var useDark = window.matchMedia('(prefers-color-scheme: dark)');
var darkModeState = useDark.matches;
var $darkModeToggleSwitchers = document.querySelectorAll('.dark-mode-switch input');
var $darkModeToggles = document.querySelectorAll('.dark-mode-switch');
var darkModeStateLocal = localStorage.getItem('compodoc_darkmode-state');
function checkToggle(check) {
for (var i = 0; i < $darkModeToggleSwitchers.length; i++) {
$darkModeToggleSwitchers[i].checked = check;
}
}
function toggleDarkMode(state) {
if (window.localStorage) {
localStorage.setItem('compodoc_darkmode-state', state);
}
checkToggle(state);
const hasClass = document.body.classList.contains('dark');
if (state) {
for (var i = 0; i < $darkModeToggles.length; i++) {
$darkModeToggles[i].classList.add('dark');
}
if (!hasClass) {
document.body.classList.add('dark');
}
} else {
for (var i = 0; i < $darkModeToggles.length; i++) {
$darkModeToggles[i].classList.remove('dark');
}
if (hasClass) {
document.body.classList.remove('dark');
}
}
}
useDark.addEventListener('change', function (evt) {
toggleDarkMode(evt.matches);
});
if (darkModeStateLocal) {
darkModeState = darkModeStateLocal === 'true';
}
toggleDarkMode(darkModeState);
</script>
<div class="navbar navbar-default navbar-fixed-top d-md-none p-0">
<div class="d-flex">
<a href="../" class="navbar-brand">angular-data-source</a>
<button type="button" class="btn btn-default btn-menu ion-ios-menu" id="btn-menu"></button>
</div>
</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="d-none d-md-block menu">
<compodoc-menu mode="normal"></compodoc-menu>
</div>
<!-- START CONTENT -->
<div class="content interface">
<div class="content-data">
<ol class="breadcrumb">
<li class="breadcrumb-item">Interfaces</li>
<li class="breadcrumb-item"
>
PipeDataSourceMetadata</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>src/lib/pipe.data-source.ts</code>
</p>
<p class="comment">
<h3>Extends</h3>
</p>
<p class="comment">
<code><a href="../interfaces/BaseDataSourceMetadata.html" target="_self" >BaseDataSourceMetadata</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="#refreshParent"
>
refreshParent
</a>
</li>
</ul>
</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="refreshParent"></a>
<span class="name "><b>refreshParent</b>
<a href="#refreshParent">
<span class="icon ion-ios-link"></span>
</a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<code>refreshParent: <code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/boolean" target="_blank" >boolean</a></code>
</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Default value : </i><code>false
</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Type : </i> <code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/boolean" target="_blank" >boolean</a></code>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Optional</i>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-description"><p>If true the parent data source will be refreshed when the pipe data source is refreshed</p>
</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 {
Inject,
Injectable,
OnDestroy,
Optional,
} from '@angular/core';
import { Constructor } from '@rxap/utilities';
import {
Observable,
OperatorFunction,
Subject,
TeardownLogic,
} from 'rxjs';
import {
map,
startWith,
switchMap,
} from 'rxjs/operators';
import {
BaseDataSource,
BaseDataSourceMetadata,
BaseDataSourceViewer,
RxapDataSource,
} from './base.data-source';
import { RxapDataSourceError } from './error';
import {
RXAP_DATA_SOURCE,
RXAP_PIPE_DATA_SOURCE_OPERATOR,
} from './tokens';
export interface PipeDataSourceMetadata extends BaseDataSourceMetadata {
/**
* If true the parent data source will be refreshed when the pipe data source is refreshed
* @default false
*/
refreshParent?: boolean;
}
export function RxapPipeDataSource(
metadata: PipeDataSourceMetadata,
className = 'PipeDataSource',
packageName = '@rxap/data-source',
) {
return function (target: Constructor<PipeDataSource>) {
RxapDataSource(metadata, className, packageName)(target);
};
}
@Injectable()
export class PipeDataSource<Source = any, Target = Source>
extends BaseDataSource<Target>
implements OnDestroy {
private readonly _refresh = new Subject<void>();
constructor(
@Inject(RXAP_DATA_SOURCE) public readonly dataSource: BaseDataSource<Source>,
@Optional() @Inject(RXAP_PIPE_DATA_SOURCE_OPERATOR) operation: OperatorFunction<Source, any> | null = null,
...operations: Array<OperatorFunction<any, any> | PipeDataSourceMetadata>
) {
super(dataSource.metadata);
this.loading$ = this.dataSource.loading$;
if (operation) {
this.setOperations(
operation,
...operations.filter(op => typeof op === 'function') as Array<OperatorFunction<any, any>>,
);
if (operations.some(op => typeof op !== 'function')) {
this.metadata = {
...this.metadata,
...operations.find(op => typeof op !== 'function'),
};
}
}
}
private _operations: Array<OperatorFunction<any, any>> = [];
protected get operations(): Array<OperatorFunction<any, any>> {
return this._operations;
}
public setOperations(
operation: OperatorFunction<Source, any>,
...operations: Array<OperatorFunction<any, any>>
): void {
if (this._initialised) {
throw new RxapDataSourceError(
'Can not set operations after the data source is initialised',
'',
'PipeDataSource',
);
}
this._operations = [ operation, ...operations ];
}
public override ngOnDestroy() {
super.ngOnDestroy();
this.dataSource.disconnect(this.metadata);
}
/**
* @param parent true - call the refresh method of the parent data source
*/
public override refresh(parent: boolean = this.metadata['refreshParent'] ?? false): any {
if (parent) {
this.dataSource.refresh();
} else {
this._refresh.next();
}
}
public override reset(): any {
return this.dataSource.reset();
}
public override toJSON(): object {
return {
...super.toJSON(),
dataSource: this.dataSource,
};
}
protected override _connect(viewer: BaseDataSourceViewer): [ Observable<Target>, TeardownLogic ] | Observable<Target> {
this.init();
return [
this.dataSource.connect(viewer).pipe(
switchMap(data => this._refresh.pipe(
startWith(null),
map(() => data),
)),
// eslint-disable-next-line @typescript-eslint/ban-ts-comment
// @ts-ignore
...this.viewerToOperations(viewer),
),
() => this.dataSource.disconnect(viewer),
];
}
protected viewerToOperations(viewer: BaseDataSourceViewer): Array<OperatorFunction<any, any>> {
return this.operations;
}
}
export function pipeDataSource<Source, Target>(
dataSource: BaseDataSource<Source>,
operation: OperatorFunction<Source, any>,
...operations: Array<OperatorFunction<any, any> | PipeDataSourceMetadata>
): PipeDataSource<Source, Target> {
return new PipeDataSource<Source, Target>(dataSource, operation, ...operations);
}
</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 = 'interface';
var COMPODOC_CURRENT_PAGE_URL = 'PipeDataSourceMetadata.html';
var MAX_SEARCH_RESULTS = 15;
</script>
<script>
$darkModeToggleSwitchers = document.querySelectorAll('.dark-mode-switch input');
checkToggle(darkModeState);
if ($darkModeToggleSwitchers.length > 0) {
for (var i = 0; i < $darkModeToggleSwitchers.length; i++) {
$darkModeToggleSwitchers[i].addEventListener('change', function (event) {
darkModeState = !darkModeState;
toggleDarkMode(darkModeState);
});
}
}
</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>