Class AbstractDataSource<EntityType>`Abstract`

Abstract DataSource class

A DataSource collection is a single source of truth for all types of data. When the DataSource changes it fires an event. All components and stores listen to the 'change' event to update themselves. This approach reduces the amount of code that has to be written and maintained.

Use a {@see DataSourceStore} in components to list data from datasources. The {@see Form} component can also load from a datasource.

Type Parameters

EntityType extends BaseEntity = DefaultEntity

Hierarchy

Observable
- AbstractDataSource
  - RestDataSource

Index

Constructors

constructor

new AbstractDataSource<EntityType>(id): AbstractDataSource<EntityType>
Type Parameters
- EntityType extends BaseEntity = DefaultEntity
Parameters
- id: string
Returns AbstractDataSource<EntityType>
Inherited from Observable.constructor
- Defined in data/AbstractDataSource.ts:297

Properties

`Private` `Optional` _browserStore

_browserStore?: BrowserStore

`Private` _createId

_createId: number = 0

`Private` `Optional` _state

_state?: string

JMAP state

commitBaseParams

commitBaseParams: {} = {}

Extra parameters to send to the Foo/set

Type declaration

`Protected` creates

creates: Record<string, SaveData<EntityType>> = {}

`Protected` data

data: Record<string, EntityType> = {}

`Private` `Readonly` delayedCommit

delayedCommit: ((...args) => void)

Type declaration

- (...args): void
- Parameters
  - Rest ...args: any[]
  Returns void

`Private` `Readonly` delayedGet

delayedGet: ((...args) => void)

Type declaration

- (...args): void
- Parameters
  - Rest ...args: any[]
  Returns void

`Protected` destroys

destroys: Record<string, DestroyData> = {}

`Protected` getIds

getIds: Record<string, GetData> = {}

`Readonly` id

id: string

persist

persist: boolean = true

Store data in the browser storage so it will persist across sessions

setParams

setParams: {
[key: string]: any;
} = {}

Extra /set parameters that will reset after commit

Type declaration

[key: string]: any

`Protected` updates

updates: Record<string, SaveData<EntityType>> = {}

Accessors

`Private` browserStore

get browserStore(): BrowserStore
Private
Get the browser storage object to save state to the browser

Returns BrowserStore
- Defined in data/AbstractDataSource.ts:289

Methods

`Protected` add

add(data): Promise<EntityType>
Parameters
- data: EntityType
Returns Promise<EntityType>
- Defined in data/AbstractDataSource.ts:362

`Private` checkState

checkState<T>(serverState, retVal): Promise<T>
Private
Check's if we are up-to-date with the server and fetches updates if needed.

If no state is returned by the data source this function will ignore states and the data source should then always refresh data.
Type Parameters
- T
Parameters
- serverState: undefined | string
- retVal: T
Returns Promise<T>
- Defined in data/AbstractDataSource.ts:845

clearCache

clearCache(): Promise<null | void>
Returns Promise<null | void>
- Defined in data/AbstractDataSource.ts:280

`Private` commit

commit(): Promise<void>
Commit pending changes to remote

Returns Promise<void>
- Defined in data/AbstractDataSource.ts:714

confirmDestroy

confirmDestroy(ids): Promise<false | unknown[]>

Ask for confirmation and delete entities by ID

Parameters

ids: string[]

The ID's to delete

Returns Promise<false | unknown[]>

Example

const tbl = this.projectTable!,
    ids = tbl.rowSelection!.selected.map(index => tbl.store.get(index)!.id);

const result = await jmapds("Project3")
    .confirmDestroy(ids);

if(result != false) {
    btn.parent!.hide();
}

create

create(data, createId?): Promise<EntityType>
Create entity

Multiple calls will be joined together in a single call on the next event loop
Parameters
- data: Partial<EntityType>
- Optional createId: string
  
  The create ID to use when committing this entity to the server
Returns Promise<EntityType>
- Defined in data/AbstractDataSource.ts:499

`Private` createID

createID(): string
Returns string
- Defined in data/AbstractDataSource.ts:555

destroy

destroy(id): Promise<unknown>
Destroy an entity

Multiple calls will be joined together in a single call on the next event loop
Parameters
- id: string
Returns Promise<unknown>
- Defined in data/AbstractDataSource.ts:566

`Protected` doGet

doGet(): Promise<void>
Protected
Does the actual getting of entities. First checks if present in this onbject, otherwise it will be requested from the remote source.

Returns Promise<void>
- Defined in data/AbstractDataSource.ts:427

fire

fire<K>(eventName, ...args): boolean
Fire an event

When a listener returns false this function will return false too.
Type Parameters
- K extends "change"
Parameters
- eventName: K
- Rest ...args: Parameters<DataSourceEventMap<AbstractDataSource<EntityType>>[K]>
Returns boolean
Overrides Observable.fire
- Defined in data/AbstractDataSource.ts:196

get

get(ids?): Promise<GetResponse<EntityType>>
Get entities from the store

It will return a list of entities ordered by the requested ID's
Parameters
- Optional ids: string[]
Returns Promise<GetResponse<EntityType>>
- Defined in data/AbstractDataSource.ts:323

`Protected` getState

getState(): Promise<undefined | string>
Protected
Get the local server state ID of the store

Returns Promise<undefined | string>
- Defined in data/AbstractDataSource.ts:256

`Protected` `Abstract` internalCommit

internalCommit(params): Promise<CommitResponse<EntityType>>
Protected
Implements commit (save and destroy) to the remote source
Parameters
- params: SetRequest<EntityType>
Returns Promise<CommitResponse<EntityType>>
- Defined in data/AbstractDataSource.ts:821

`Protected` `Abstract` internalGet

internalGet(ids): Promise<GetResponse<EntityType>>
Protected
Implements getting entities from a remote source
Parameters
- ids: string[]
Returns Promise<GetResponse<EntityType>>
- Defined in data/AbstractDataSource.ts:489

`Protected` `Abstract` internalQuery

internalQuery(params): Promise<QueryResponse>
Handle the query to the remote
Parameters
- params: QueryParams
Returns Promise<QueryResponse>
- Defined in data/AbstractDataSource.ts:869

`Protected` `Abstract` internalRemoteChanges

internalRemoteChanges(state): Promise<Changes>
Protected
Implements fetching updates from remote
Parameters
- state: undefined | string
Returns Promise<Changes>
- Defined in data/AbstractDataSource.ts:709

on

on<K>(eventName, listener, options?): DataSourceEventMap<AbstractDataSource<EntityType>>[K]
Add a listener
Type Parameters
- K extends "change"
Parameters
- eventName: K
- listener: DataSourceEventMap<AbstractDataSource<EntityType>>[K]
- Optional options: ObservableListenerOpts
Returns DataSourceEventMap<AbstractDataSource<EntityType>>[K]
Overrides Observable.on
- Defined in data/AbstractDataSource.ts:194

`Protected` onFirstListenerAdded

onFirstListenerAdded(eventName): void
Protected
Override this function to lazily initialize events
Parameters
- eventName: string
Returns void
Inherited from Observable.onFirstListenerAdded
- Defined in component/Observable.ts:133

query

query(params?): Promise<QueryResponse>
Query the server for a list of entity ID's

It takes filters and sort parameters.
Parameters
- params: QueryParams = {}
Returns Promise<QueryResponse>

Link
https://jmap.io/spec-core.html#query
- Defined in data/AbstractDataSource.ts:830

`Protected` relayEvent

relayEvent(comp, type): void
Parameters
- comp: Observable
- type: any
Returns void
Inherited from Observable.relayEvent
- Defined in component/Observable.ts:199

`Protected` remove

remove(id): Promise<string>
Parameters
- id: string
Returns Promise<string>
- Defined in data/AbstractDataSource.ts:373

reset

reset(): Promise<undefined | boolean>
Reset the data source.

Clears all data and will resync

Returns Promise<undefined | boolean>
- Defined in data/AbstractDataSource.ts:525

`Private` returnGet

returnGet(id): void
Parameters
- id: string
Returns void
- Defined in data/AbstractDataSource.ts:409

`Protected` setState

setState(state): Promise<undefined | boolean>
Protected
Set's the local server state ID

Setting it to undefined will reset the store.
Parameters
- state: undefined | string
Returns Promise<undefined | boolean>
- Defined in data/AbstractDataSource.ts:272

single

single(id): Promise<undefined | EntityType>
Get a single entity.

Multiple calls will be buffered and returned together on the next event loop. This way multiple calls can be joined together in a single HTTP request to the server.
Parameters
- id: string
Returns Promise<undefined | EntityType>
- Defined in data/AbstractDataSource.ts:393

un

un<K>(eventName, listener): boolean
Remove listener
Type Parameters
- K extends "change"
Parameters
- eventName: K
- listener: RouterEventMap<AbstractDataSource<EntityType>>[K]
Returns boolean
Overrides Observable.un
- Defined in data/AbstractDataSource.ts:195

update

update(id, data): Promise<EntityType>
Update an entity

Multiple calls will be joined together in a single call on the next event loop
Parameters
- id: string
- data: Partial<EntityType>
Returns Promise<EntityType>
- Defined in data/AbstractDataSource.ts:537

updateFromServer

updateFromServer(): Promise<void>
Fetch updates from remote

Returns Promise<void>
- Defined in data/AbstractDataSource.ts:632

Class AbstractDataSource<EntityType>Abstract

Type Parameters

EntityType extends BaseEntity = DefaultEntity

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

EntityType extends BaseEntity = DefaultEntity

Parameters

id: string

Returns AbstractDataSource<EntityType>

Properties

Private Optional _browserStore

Private _createId

Private Optional _state

commitBaseParams

Type declaration

Protected creates

Protected data

Private Readonly delayedCommit

Type declaration

Parameters

Rest ...args: any[]

Returns void

Private Readonly delayedGet

Type declaration

Parameters

Rest ...args: any[]

Returns void

Protected destroys

Protected getIds

Readonly id

persist

setParams

Type declaration

[key: string]: any

Protected updates

Accessors

Private browserStore

Returns BrowserStore

Methods

Protected add

Parameters

data: EntityType

Returns Promise<EntityType>

Private checkState

Type Parameters

T

Parameters

serverState: undefined | string

retVal: T

Returns Promise<T>

clearCache

Returns Promise<null | void>

Private commit

Returns Promise<void>

confirmDestroy

Parameters

ids: string[]

Returns Promise<false | unknown[]>

Example

create

Parameters

data: Partial<EntityType>

Optional createId: string

Returns Promise<EntityType>

Private createID

Returns string

destroy

Parameters

id: string

Returns Promise<unknown>

Protected doGet

Returns Promise<void>

fire

Class AbstractDataSource<EntityType>`Abstract`

`Private` `Optional` _browserStore

`Private` _createId

`Private` `Optional` _state

`Protected` creates

`Protected` data

`Private` `Readonly` delayedCommit

`Rest` ...args: any[]

`Private` `Readonly` delayedGet

`Rest` ...args: any[]

`Protected` destroys

`Protected` getIds

`Readonly` id

`Protected` updates

`Private` browserStore

`Protected` add

`Private` checkState

`Private` commit

`Optional` createId: string

`Private` createID

`Protected` doGet

`Rest` ...args: Parameters<DataSourceEventMap<AbstractDataSource<EntityType>>[K]>

`Optional` ids: string[]

`Protected` getState

`Protected` `Abstract` internalCommit

`Protected` `Abstract` internalGet

`Protected` `Abstract` internalQuery

`Protected` `Abstract` internalRemoteChanges

`Optional` options: ObservableListenerOpts

`Protected` onFirstListenerAdded

`Protected` relayEvent

`Protected` remove

`Private` returnGet

`Protected` setState