Class MethodDataSource<Data, Parameters>

Type Parameters

Data
Parameters = any

Hierarchy (View Summary)

BaseDataSource<
    Data,
    BaseDataSourceMetadata,
    BaseDataSourceViewer & Parameters
    | BaseDataSourceViewer<Parameters>,
>
- MethodDataSource

Implements

OnInit

Constructors

constructor

new MethodDataSource<Data, Parameters = any>(
method: Method<Data, Parameters>,
withoutParameters?: boolean,
): MethodDataSource<Data, Parameters>
Type Parameters
- Data
- Parameters = any
Parameters
- method: Method<Data, Parameters>
- withoutParameters: boolean = false
Returns MethodDataSource<Data, Parameters>
Overrides BaseDataSource.constructor
- Defined in packages/angular/data-source/src/lib/method.data-source.ts:44

Properties

`Internal`__id

__id: string = ...

unique internal id

`Protected`_connectedViewer

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

`Protected`_connectedViewerTeardown

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

`Protected` `Optional`_data

_data?: Data

`Protected` `Readonly`_data$

_data$: ReplaySubject<Data> = ...

`Protected`_initialised

_initialised: boolean = false

`Protected`_lastRefreshed

_lastRefreshed: null | Date = null

`Protected`_retry$

_retry$: Subject<void> = ...

`Protected`_viewerIds

_viewerIds: Map<
    | BaseDataSourceViewer<any> & Parameters
    | BaseDataSourceViewer<Parameters>,
    string,
> = ...

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

`Readonly`change$

change$: Subject<Data> = ...

`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>

`Readonly`loading$

loading$: ToggleSubject = ...

Indicates weather the data source is currently loading new data

metadata

metadata: BaseDataSourceMetadata

`Protected` `Readonly`method

method: Method<Data, Parameters>

`Protected` `Readonly`withoutParameters

withoutParameters: boolean = false

`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

Methods

`Protected`_connect

_connect(
    viewer:
        | BaseDataSourceViewer<any> & Parameters
        | BaseDataSourceViewer<Parameters>,
): Observable<Data> | [Observable<Data>, TeardownLogic]
Parameters
- viewer: BaseDataSourceViewer<any> & Parameters | BaseDataSourceViewer<Parameters>
Returns Observable<Data> | [Observable<Data>, TeardownLogic]
Overrides BaseDataSource._connect
- Defined in packages/angular/data-source/src/lib/method.data-source.ts:66

`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<Data>
Parameters
- viewerId: string
Returns Observable<Data>
Inherited from BaseDataSource.attach
- Defined in packages/angular/data-source/src/lib/base.data-source.ts:210

connect

connect(
    viewerOrString:
        | string
        | BaseDataSourceViewer<any> & Parameters
        | BaseDataSourceViewer<Parameters>,
): Observable<Data>
Parameters
- viewerOrString:
      | string
      | BaseDataSourceViewer<any> & Parameters
      | BaseDataSourceViewer<Parameters>
Returns Observable<Data>
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> & Parameters
        | BaseDataSourceViewer<Parameters>,
): void
Parameters
- viewerOrId:
      | string
      | BaseDataSourceViewer<any> & Parameters
      | BaseDataSourceViewer<Parameters>
Returns void
Inherited from BaseDataSource.disconnect
- Defined in packages/angular/data-source/src/lib/base.data-source.ts:225

`Protected`execute

execute(parameters?: Parameters): Promise<Data>
Parameters
- Optionalparameters: Parameters
Returns Promise<Data>
- Defined in packages/angular/data-source/src/lib/method.data-source.ts:106

`Protected`executeWithoutParameters

executeWithoutParameters(): Promise<void>
Returns Promise<void>
- Defined in packages/angular/data-source/src/lib/method.data-source.ts:110

`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<any> & Parameters
        | BaseDataSourceViewer<Parameters>,
): string
Parameters
- viewer: BaseDataSourceViewer<any> & Parameters | BaseDataSourceViewer<Parameters>
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

`Protected`handelExecution

handelExecution(): OperatorFunction<Data, Data>
Returns OperatorFunction<Data, Data>
- Defined in packages/angular/data-source/src/lib/method.data-source.ts:90

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> & Parameters
        | BaseDataSourceViewer<Parameters>,
): boolean
Parameters
- viewerOrId:
      | string
      | BaseDataSourceViewer<any> & Parameters
      | BaseDataSourceViewer<Parameters>
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
Inherited from BaseDataSource.ngOnDestroy
- Defined in packages/angular/definition/src/lib/definition.ts:122

ngOnInit

ngOnInit(): void
A callback method that is invoked immediately after the default change detector has checked the directive's data-bound properties for the first time, and before any of the view or content children have been checked. It is invoked only once when the directive is instantiated.

Returns void
Implementation of OnInit.ngOnInit
- Defined in packages/angular/data-source/src/lib/method.data-source.ts:53

toPromise

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

`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 MethodDataSource<Data, Parameters>

Type Parameters

Hierarchy (View Summary)

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns MethodDataSource<Data, Parameters>

Properties

Internal__id

Protected_connectedViewer

Protected_connectedViewerTeardown

Protected Optional_data

Protected Readonly_data$

Protected_initialised

Protected_lastRefreshed

Protected_retry$

Protected_viewerIds

Readonlychange$

Readonlydestroyed$

Readonlyerror$

OptionalhasError

ReadonlyhasError$

Readonlyinitialised$

Readonlyinterceptors

Optionalloading

Readonlyloading$

metadata

Protected Readonlymethod

Protected ReadonlywithoutParameters

Static Readonlydestroyed$

Static Readonlyinitialised$

Static Readonlyinstances

Accessors

data

Returns undefined | Data

hasConnections

Returns boolean

id

Returns string

lastRefreshed

Returns null | Date

Methods

Protected_connect

Parameters

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

Protected_disconnect

Parameters

Returns void

applyMetadata

Parameters

Returns void

attach

Parameters

Returns Observable<Data>

connect

Parameters

Returns Observable<Data>

derive

Parameters

Returns BaseDataSource<any>

destroy

Returns void

Deprecated

disconnect

Parameters

Returns void

Protectedexecute

Parameters

Returns Promise<Data>

ProtectedexecuteWithoutParameters

Returns Promise<void>

ProtectedgenericRetryFunction

Parameters

`Internal`__id

`Protected`_connectedViewer

`Protected`_connectedViewerTeardown

`Protected` `Optional`_data

`Protected` `Readonly`_data$

`Protected`_initialised

`Protected`_lastRefreshed

`Protected`_retry$

`Protected`_viewerIds

`Readonly`change$

`Readonly`destroyed$

`Readonly`error$

`Optional`hasError

`Readonly`hasError$

`Readonly`initialised$

`Readonly`interceptors

`Optional`loading

`Readonly`loading$

`Protected` `Readonly`method

`Protected` `Readonly`withoutParameters

`Static` `Readonly`destroyed$

`Static` `Readonly`initialised$

`Static` `Readonly`instances

`Protected`_connect

`Protected`_disconnect

`Protected`execute

`Protected`executeWithoutParameters

`Protected`genericRetryFunction

`Protected`handelError

`Protected`handelExecution

`Static`add

`Static`remove