Type Alias XtStoreProvider<T>

The standard interface for any store provider

type XtStoreProvider<T extends ManagedData = ManagedData> = {
    canStoreDocument(): boolean;
    deleteEntity(name: string, key: any): Promise<boolean>;
    loadEntity(name: string, key: any): Promise<T | undefined>;
    safeLoadEntity(name: string, key: any): Promise<T>;
    searchAndPrepareEntities(
        name: string,
        sort?: XtSortBy<T>[],
        groupBy?: XtGroupBy<T>,
        transformer?: XtDataTransformer<T>,
        ...criteria: XtStoreCriteria<T>[],
    ): Observable<DontCodeStorePreparedEntities<T>>;
    searchEntities(
        name: string,
        ...criteria: XtStoreCriteria<T>[],
    ): Observable<T[]>;
    storeDocument(toStore: File): Promise<UploadedDocumentInfo>;
    storeDocuments(toStore: File[]): Observable<UploadedDocumentInfo>;
    storeEntity(name: string, entity: T): Promise<T>;
}

Type Parameters

T extends ManagedData = ManagedData

Implemented by

AbstractXtStoreProvider

Index

Methods

canStoreDocument deleteEntity loadEntity safeLoadEntity searchAndPrepareEntities searchEntities storeDocument storeDocuments storeEntity

Methods

canStoreDocument

canStoreDocument(): boolean
Checks whether the provider supports document storage.

Returns boolean
True if document storage is supported
- Defined in libs/xt-store/projects/store/src/store-provider/xt-store-provider.ts:82

deleteEntity

deleteEntity(name: string, key: any): Promise<boolean>
Deletes an entity by its key.
Parameters
- name: string
  The entity name
- key: any
  The entity identifier
Returns Promise<boolean>
A promise resolving to true if deletion succeeded
- Defined in libs/xt-store/projects/store/src/store-provider/xt-store-provider.ts:48

loadEntity

loadEntity(name: string, key: any): Promise<T | undefined>
Loads an entity by its key, returning undefined if not found.
Parameters
- name: string
  The entity name
- key: any
  The entity identifier
Returns Promise<T | undefined>
A promise resolving to the entity or undefined
- Defined in libs/xt-store/projects/store/src/store-provider/xt-store-provider.ts:40

safeLoadEntity

safeLoadEntity(name: string, key: any): Promise<T>
Loads an entity by its key, rejecting if not found.
Parameters
- name: string
  The entity name
- key: any
  The entity identifier
Returns Promise<T>
A promise resolving to the entity
- Defined in libs/xt-store/projects/store/src/store-provider/xt-store-provider.ts:32

searchAndPrepareEntities

searchAndPrepareEntities(
    name: string,
    sort?: XtSortBy<T>[],
    groupBy?: XtGroupBy<T>,
    transformer?: XtDataTransformer<T>,
    ...criteria: XtStoreCriteria<T>[],
): Observable<DontCodeStorePreparedEntities<T>>
Searches entities and applies sorting, grouping, and transformation.
Parameters
- name: string
  The entity name
- Optionalsort: XtSortBy<T>[]
  Optional sort specifications
- OptionalgroupBy: XtGroupBy<T>
  Optional grouping configuration
- Optionaltransformer: XtDataTransformer<T>
  Optional data transformer
- ...criteria: XtStoreCriteria<T>[]
  Filter criteria to apply
Returns Observable<DontCodeStorePreparedEntities<T>>
An observable emitting the prepared entities
- Defined in libs/xt-store/projects/store/src/store-provider/xt-store-provider.ts:70

searchEntities

searchEntities(name: string, ...criteria: XtStoreCriteria<T>[]): Observable<T[]>
Searches entities matching the given criteria.
Parameters
- name: string
  The entity name
- ...criteria: XtStoreCriteria<T>[]
  Filter criteria to apply
Returns Observable<T[]>
An observable emitting the matching entities
- Defined in libs/xt-store/projects/store/src/store-provider/xt-store-provider.ts:56

storeDocument

storeDocument(toStore: File): Promise<UploadedDocumentInfo>
Upload one document to a server store and returns the url or the id needed to retrieve them.
Parameters
- toStore: File
  The file to upload
Returns Promise<UploadedDocumentInfo>
- Defined in libs/xt-store/projects/store/src/store-provider/xt-store-provider.ts:88

storeDocuments

storeDocuments(toStore: File[]): Observable<UploadedDocumentInfo>
Upload documents to a server store and returns the url or the id needed to retrieve them.
Parameters
- toStore: File[]
  The files to upload
Returns Observable<UploadedDocumentInfo>
- Defined in libs/xt-store/projects/store/src/store-provider/xt-store-provider.ts:96

storeEntity

storeEntity(name: string, entity: T): Promise<T>
Stores (creates or updates) an entity.
Parameters
- name: string
  The entity name
- entity: T
  The entity data to store
Returns Promise<T>
A promise resolving to the stored entity
- Defined in libs/xt-store/projects/store/src/store-provider/xt-store-provider.ts:24

Type Alias XtStoreProvider<T>

Type Parameters

Implemented by

Index

Methods

Methods

canStoreDocument

Returns boolean

deleteEntity

Parameters

Returns Promise<boolean>

loadEntity

Parameters

Returns Promise<T | undefined>

safeLoadEntity

Parameters

Returns Promise<T>

searchAndPrepareEntities

Parameters

Returns Observable<DontCodeStorePreparedEntities<T>>

searchEntities

Parameters

Returns Observable<T[]>

storeDocument

Parameters

Returns Promise<UploadedDocumentInfo>

storeDocuments

Parameters

Returns Observable<UploadedDocumentInfo>

storeEntity

Parameters

Returns Promise<T>

Settings

On This Page