@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
420 lines (346 loc) • 14.4 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"
>
StaticDataSourceMetadata</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/static.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="#data"
>
data
</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="data"></a>
<span class="name "><b>data</b>
<a href="#data">
<span class="icon ion-ios-link"></span>
</a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<code>data: <code><a href="../injectables/StaticDataSource.html" target="_self" >StaticDataSourceData<Data></a></code>
</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Type : </i> <code><a href="../injectables/StaticDataSource.html" target="_self" >StaticDataSourceData<Data></a></code>
</td>
</tr>
<tr>
<td class="col-md-4">
<i>Optional</i>
</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 {
clone,
Constructor,
isPromise,
isPromiseLike,
} from '@rxap/utilities';
import {
isObservable,
Observable,
ReplaySubject,
Subscription,
} from 'rxjs';
import {
Inject,
Injectable,
OnDestroy,
Optional,
} from '@angular/core';
import {
RXAP_DATA_SOURCE_METADATA,
RXAP_STATIC_DATA_SOURCE_DATA,
} from './tokens';
import {
BaseDataSource,
BaseDataSourceMetadata,
RxapDataSource,
} from './base.data-source';
import { RxapDataSourceError } from './error';
import { tap } from 'rxjs/operators';
export type StaticDataSourceData<Data = any> =
| Data
| Promise<Data>
| Observable<Data>
| (() => Data);
export interface StaticDataSourceMetadata<Data = any>
extends BaseDataSourceMetadata {
data?: StaticDataSourceData<Data>;
}
@Injectable()
export class StaticDataSource<Data = any>
extends BaseDataSource<Data, StaticDataSourceMetadata<Data>>
implements OnDestroy {
protected override _data$ = new ReplaySubject<Data>(1);
private _dataSubscription?: Subscription;
constructor(
@Optional()
@Inject(RXAP_STATIC_DATA_SOURCE_DATA)
data: any | null,
@Optional()
@Inject(RXAP_DATA_SOURCE_METADATA)
metadata: StaticDataSourceMetadata | null,
) {
super(metadata);
if ((data === undefined || data === null) && this.metadata.data !== undefined) {
data = this.metadata.data;
}
if (data === undefined) {
throw new RxapDataSourceError(
`Can not create static data source '${ this.id }' with undefined as data`,
'',
);
}
if (isObservable(data)) {
this._dataSubscription = (
data as Observable<any>
).pipe(
tap({
next: data => this._data$.next(data),
error: error => this.error$.next(error),
}),
).subscribe();
} else if (isPromiseLike(data)) {
if (isPromise(data)) {
data.then(data => this._data$.next(data)).catch((error) => this.error$.next(error));
} else {
data.then(data => this._data$.next(data));
}
} else if (typeof data === 'function') {
// TODO : fix typeof function cast
this._data$.next((this._data = (data as any)()));
} else {
this._data$.next((this._data = data));
}
}
public override get data(): Data {
return clone<Data>(this._data!);
}
public override set data(value: Data) {
const data = clone(value);
this._data = data;
this._data$.next(data);
}
public override ngOnDestroy(): void {
super.ngOnDestroy();
this._dataSubscription?.unsubscribe();
}
protected override _connect(): Observable<Data> {
this.init();
return this._data$.asObservable();
}
}
export function RxapStaticDataSource<Data>(
metadata: StaticDataSourceMetadata<Data>,
className = 'StaticDataSource',
packageName = '@rxap/data-source',
) {
return function (target: Constructor<StaticDataSource<Data>>) {
RxapDataSource(metadata, className, packageName)(target);
};
}
export function staticDataSource<Data>(
data: StaticDataSourceData<Data>,
metadata: StaticDataSourceMetadata<Data> = { id: 'static' },
): StaticDataSource<Data> {
return new StaticDataSource(data, metadata);
}
</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 = 'StaticDataSourceMetadata.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>