ng-xtend API documentation
    Preparing search index...

    Interface IStoreProvider<T>

    Interface for a store provider that handles CRUD operations on entities

    interface IStoreProvider<T> {
        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?: ISortBy<T>,
            groupBy?: any,
            transformer?: IDataTransformer<T>,
            ...criteria: any[],
        ): Observable<any>;
        searchEntities(
            name: string,
            ...criteria: IStoreCriteria<T>[],
        ): Observable<T[]>;
        storeDocument(toStore: File): Promise<IDocumentInfo>;
        storeDocuments(toStore: File[]): Observable<IDocumentInfo>;
        storeEntity(name: string, entity: T): Promise<T>;
    }

    Type Parameters

    • T

    Implemented by

    Index

    Methods

    canStoreDocument deleteEntity loadEntity safeLoadEntity searchAndPrepareEntities searchEntities storeDocument storeDocuments storeEntity

    Methods

    • Searches for entities and optionally sorts, groups, and transforms the results

      Parameters

      • name: string

        The entity/collection name

      • Optionalsort: ISortBy<T>

        Optional sort criteria

      • OptionalgroupBy: any

        Optional grouping configuration

      • Optionaltransformer: IDataTransformer<T>

        Optional data transformer

      • ...criteria: any[]

        Additional filter criteria

      Returns Observable<any>

      An observable emitting the processed results

    Settings

    Member Visibility

    On This Page

    Methods