ng-xtend API documentation
    Preparing search index...

    Function withXtStoreProvider

    • Enables SignalStore to manipulate ManagedData entities through one provider or more. If given the typeRegistry, it uses the information in it to manage references

      Type Parameters

      Parameters

      Returns SignalStoreFeature<
          EmptyFeatureResult,
          {
              methods: {
                  _applyReferences(newValue: T, references: ManagedData): Promise<T>;
                  _callProviderSearchEntities(): Observable<T[]>;
                  _clearReferences(toClear: T): Promise<{ newValue: T; references: any }>;
                  _isPassingFilter(
                      element: T,
                      applyFilters?: boolean,
                      criteria?: XtStoreCriteria<T>[],
                  ): boolean;
                  _patchStateSetEntity(stored: T): void;
                  _resolveReferences(values: T[]): Promise<T[]>;
                  _safeFilter(): XtStoreCriteria<T>[];
                  _safeSort(): XtSortBy<T>[];
                  deleteEntity(id: string): Promise<boolean>;
                  fetchEntities(): Promise<void>;
                  loadEntity(id: string): Promise<T | undefined>;
                  safeLoadEntity(id: string): Promise<T>;
                  searchEntities(...criteria: XtStoreCriteria<T>[]): Observable<T[]>;
                  storeEntity(toStore: T): Promise<T>;
                  updateStoreOptions(
                      option: XtStoreEntityFeatureOptions<T> | undefined,
                  ): Promise<void>;
              };
              props: {
                  _entityConfig: { entity: T; selectId: SelectEntityId<NoInfer<T>> };
                  _storeMgr: XtStoreManager | undefined;
                  _storeProvider: XtStoreProvider<T>;
                  _typeResolver: XtTypeResolver | undefined;
                  entities: Signal<T[]>;
              };
              state: {
                  entityMap: EntityMap<Entity>;
                  entityName: string;
                  filter?: XtStoreCriteria<T>[];
                  ids: EntityId[];
                  loading: boolean;
                  sort?: XtSortBy<T>[];
              };
          },
      >