Class PipeDataSource<Source, Target>

Type Parameters

Source = any
Target = Source

Hierarchy (View Summary)

BaseDataSource<Target>
- PipeDataSource

Implements

OnDestroy

Constructors

constructor

new PipeDataSource<Source = any, Target = Source>(
    dataSource: BaseDataSource<Source>,
    operation?: null | OperatorFunction<Source, any>,
    ...operations: (PipeDataSourceMetadata | OperatorFunction<any, any>)[],
): PipeDataSource<Source, Target>
Type Parameters
- Source = any
- Target = Source
Parameters
- dataSource: BaseDataSource<Source>
- operation: null | OperatorFunction<Source, any> = null
- ...operations: (PipeDataSourceMetadata | OperatorFunction<any, any>)[]
Returns PipeDataSource<Source, Target>
Overrides BaseDataSource.constructor
- Defined in packages/angular/data-source/src/lib/pipe.data-source.ts:56

Properties

`Internal`__id

__id: string = ...

unique internal id

`Protected`_connectedViewer

_connectedViewer: Map<string, Observable<Target>> = ...

`Protected`_connectedViewerTeardown

_connectedViewerTeardown: Map<string, TeardownLogic> = ...

`Protected` `Optional`_data

_data?: Target

`Protected`_data$

_data$: Observable<Target> = EMPTY

`Protected`_initialised

_initialised: boolean = false

`Protected`_lastRefreshed

_lastRefreshed: null | Date = null

`Protected`_retry$

_retry$: Subject<void> = ...

`Protected`_viewerIds

_viewerIds: Map<BaseDataSourceViewer<any>, string> = ...

a map of viewer to view id. Allows to create a view id from the viewer object reference

`Readonly`change$

change$: Subject<Target> = ...

`Readonly`dataSource

dataSource: BaseDataSource<Source>

`Readonly`destroyed$

destroyed$: undefined | Subject<void> = ...

Emits if the data source is destroyed

`Readonly`error$

error$: ReplaySubject<Error> = ...

`Optional`hasError

hasError?: Signal<boolean>

`Readonly`hasError$

hasError$: ToggleSubject = ...

`Readonly`initialised$

initialised$: undefined | Subject<void> = ...

Emits if the data source is initialised

`Readonly`interceptors

interceptors: undefined | Set<Subject<any>> = ...

`Optional`loading

loading?: Signal<boolean>

loading$

loading$: Observable<boolean> = EMPTY

Indicates weather the data source is currently loading new data

metadata

metadata: BaseDataSourceMetadata

`Static` `Readonly`destroyed$

destroyed$: Subject<BaseDefinition<BaseDefinitionMetadata>> = ...

Emits when a new Definition instance is initialised

`Static` `Readonly`initialised$

initialised$: Subject<BaseDefinition<BaseDefinitionMetadata>> = ...

Emits when a new Definition instance is initialised

`Static` `Readonly`instances

instances: Map<string, BaseDefinition<BaseDefinitionMetadata>> = ...

A map of active Definition instances

Accessors

data

get data(): undefined | Data
Returns undefined | Data
Inherited from BaseDataSource.data
- Defined in packages/angular/data-source/src/lib/base.data-source.ts:106

hasConnections

get hasConnections(): boolean
Returns boolean
Inherited from BaseDataSource.hasConnections
- Defined in packages/angular/data-source/src/lib/base.data-source.ts:110

id

get id(): string
Returns string
Inherited from BaseDataSource.id
- Defined in packages/angular/definition/src/lib/definition.ts:87

lastRefreshed

get lastRefreshed(): null | Date
Returns null | Date
Inherited from BaseDataSource.lastRefreshed
- Defined in packages/angular/data-source/src/lib/base.data-source.ts:74

`Protected`operations

get operations(): OperatorFunction<any, any>[]
Returns OperatorFunction<any, any>[]
- Defined in packages/angular/data-source/src/lib/pipe.data-source.ts:79

Methods

`Protected`_connect

_connect(
viewer: BaseDataSourceViewer,
): Observable<Target> | [Observable<Target>, TeardownLogic]
Parameters
- viewer: BaseDataSourceViewer
Returns Observable<Target> | [Observable<Target>, TeardownLogic]
Overrides BaseDataSource._connect
- Defined in packages/angular/data-source/src/lib/pipe.data-source.ts:124

`Protected`_disconnect

_disconnect(viewerId: string): void
Parameters
- viewerId: string
Returns void
Inherited from BaseDataSource._disconnect
- Defined in packages/angular/data-source/src/lib/base.data-source.ts:308

applyMetadata

applyMetadata(partialMetadata: Partial<BaseDataSourceMetadata>): void
Parameters
- partialMetadata: Partial<BaseDataSourceMetadata>
Returns void
Inherited from BaseDataSource.applyMetadata
- Defined in packages/angular/definition/src/lib/definition.ts:111

attach

attach(viewerId: string): Observable<Target>
Parameters
- viewerId: string
Returns Observable<Target>
Inherited from BaseDataSource.attach
- Defined in packages/angular/data-source/src/lib/base.data-source.ts:210

connect

connect(viewerOrString: string | BaseDataSourceViewer<any>): Observable<Target>
Parameters
- viewerOrString: string | BaseDataSourceViewer<any>
Returns Observable<Target>
Inherited from BaseDataSource.connect
- Defined in packages/angular/data-source/src/lib/base.data-source.ts:124

derive

derive(
id: string,
metadata?: Partial<BaseDataSourceMetadata>,
): BaseDataSource<any>
Parameters
- id: string
- metadata: Partial<BaseDataSourceMetadata> = ...
Returns BaseDataSource<any>
Inherited from BaseDataSource.derive
- Defined in packages/angular/data-source/src/lib/base.data-source.ts:270

destroy

destroy(): void
Returns void
Deprecated
use ngOnDestroy instead
Inherited from BaseDataSource.destroy
- Defined in packages/angular/definition/src/lib/definition.ts:118

disconnect

disconnect(viewerOrId: string | BaseDataSourceViewer<any>): void
Parameters
- viewerOrId: string | BaseDataSourceViewer<any>
Returns void
Inherited from BaseDataSource.disconnect
- Defined in packages/angular/data-source/src/lib/base.data-source.ts:225

`Protected`genericRetryFunction

genericRetryFunction(error: any, retryCount: number): Observable<any>
Parameters
- error: any
- retryCount: number
Returns Observable<any>
Inherited from BaseDataSource.genericRetryFunction
- Defined in packages/angular/data-source/src/lib/base.data-source.ts:311

getMetadata

getMetadata(): null | BaseDataSourceMetadata
Returns null | BaseDataSourceMetadata
Inherited from BaseDataSource.getMetadata
- Defined in packages/angular/definition/src/lib/definition.ts:107

getViewerId

getViewerId(viewer: BaseDataSourceViewer): string
Parameters
- viewer: BaseDataSourceViewer
Returns string
Inherited from BaseDataSource.getViewerId
- Defined in packages/angular/data-source/src/lib/base.data-source.ts:114

`Protected`handelError

handelError(error: any): void
Parameters
- error: any
Returns void
Inherited from BaseDataSource.handelError
- Defined in packages/angular/data-source/src/lib/base.data-source.ts:317

init

init(): void
Returns void
Inherited from BaseDataSource.init
- Defined in packages/angular/definition/src/lib/definition.ts:127

isConnected

isConnected(viewerOrId: string | BaseDataSourceViewer<any>): boolean
Parameters
- viewerOrId: string | BaseDataSourceViewer<any>
Returns boolean
Inherited from BaseDataSource.isConnected
- Defined in packages/angular/data-source/src/lib/base.data-source.ts:217

ngOnDestroy

ngOnDestroy(): void
A callback method that performs custom clean-up, invoked immediately before a directive, pipe, or service instance is destroyed.

Returns void
Implementation of OnDestroy.ngOnDestroy
Overrides BaseDataSource.ngOnDestroy
- Defined in packages/angular/data-source/src/lib/pipe.data-source.ts:97

refresh

refresh(parent?: boolean): any
Parameters
- parent: boolean = ...
  true - call the refresh method of the parent data source
Returns any
Overrides BaseDataSource.refresh
- Defined in packages/angular/data-source/src/lib/pipe.data-source.ts:105

reset

reset(): any
Returns any
Overrides BaseDataSource.reset
- Defined in packages/angular/data-source/src/lib/pipe.data-source.ts:113

retry

retry(): any
Returns any
Inherited from BaseDataSource.retry
- Defined in packages/angular/data-source/src/lib/base.data-source.ts:293

setOperations

setOperations(
operation: OperatorFunction<Source, any>,
...operations: OperatorFunction<any, any>[],
): void
Parameters
- operation: OperatorFunction<Source, any>
- ...operations: OperatorFunction<any, any>[]
Returns void
- Defined in packages/angular/data-source/src/lib/pipe.data-source.ts:83

toJSON

toJSON(): object
Returns object
Overrides BaseDataSource.toJSON
- Defined in packages/angular/data-source/src/lib/pipe.data-source.ts:117

toPromise

toPromise(viewer: BaseDataSourceViewer): Promise<Target>
Creates a connection to tha data source and converts the Observable into a promise and then disconnects the viewer
Parameters
- viewer: BaseDataSourceViewer
Returns Promise<Target>
Inherited from BaseDataSource.toPromise
- Defined in packages/angular/data-source/src/lib/base.data-source.ts:264

`Protected`viewerToOperations

viewerToOperations(viewer: BaseDataSourceViewer): OperatorFunction<any, any>[]
Parameters
- viewer: BaseDataSourceViewer
Returns OperatorFunction<any, any>[]
- Defined in packages/angular/data-source/src/lib/pipe.data-source.ts:140

`Static`add

add(definition: BaseDefinition): void
Parameters
- definition: BaseDefinition
Returns void
Inherited from BaseDataSource.add
- Defined in packages/angular/definition/src/lib/definition.ts:94

`Static`remove

remove(definition: BaseDefinition): void
Parameters
- definition: BaseDefinition
Returns void
Inherited from BaseDataSource.remove
- Defined in packages/angular/definition/src/lib/definition.ts:102

Class PipeDataSource<Source, Target>

Type Parameters

Hierarchy (View Summary)

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns PipeDataSource<Source, Target>

Properties

Internal__id

Protected_connectedViewer

Protected_connectedViewerTeardown

Protected Optional_data

Protected_data$

Protected_initialised

Protected_lastRefreshed

Protected_retry$

Protected_viewerIds

Readonlychange$

ReadonlydataSource

Readonlydestroyed$

Readonlyerror$

OptionalhasError

ReadonlyhasError$

Readonlyinitialised$

Readonlyinterceptors

Optionalloading

loading$

metadata

Static Readonlydestroyed$

Static Readonlyinitialised$

Static Readonlyinstances

Accessors

data

Returns undefined | Data

hasConnections

Returns boolean

id

Returns string

lastRefreshed

Returns null | Date

Protectedoperations

Returns OperatorFunction<any, any>[]

Methods

Protected_connect

Parameters

Returns Observable<Target> | [Observable<Target>, TeardownLogic]

Protected_disconnect

Parameters

Returns void

applyMetadata

Parameters

Returns void

attach

Parameters

Returns Observable<Target>

connect

Parameters

Returns Observable<Target>

derive

Parameters

Returns BaseDataSource<any>

destroy

Returns void

Deprecated

disconnect

Parameters

Returns void

ProtectedgenericRetryFunction

Parameters

Returns Observable<any>

getMetadata

Returns null | BaseDataSourceMetadata

getViewerId

`Internal`__id

`Protected`_connectedViewer

`Protected`_connectedViewerTeardown

`Protected` `Optional`_data

`Protected`_data$

`Protected`_initialised

`Protected`_lastRefreshed

`Protected`_retry$

`Protected`_viewerIds

`Readonly`change$

`Readonly`dataSource

`Readonly`destroyed$

`Readonly`error$

`Optional`hasError

`Readonly`hasError$

`Readonly`initialised$

`Readonly`interceptors

`Optional`loading

`Static` `Readonly`destroyed$

`Static` `Readonly`initialised$

`Static` `Readonly`instances

`Protected`operations

`Protected`_connect

`Protected`_disconnect

`Protected`genericRetryFunction

`Protected`handelError

`Protected`viewerToOperations

`Static`add

`Static`remove