Interface FilterRepository

Hierarchy

StateRepository
- FilterRepository

Index

Methods

delete save subscribe

Methods

delete

delete(filter: Filter): Promise<void>
Deletes the filter

Returns
a promise that will be resolved when the filter is deleted
Parameters
- filter: Filter
  
  a filter to delete
Returns Promise<void>

save

save(filter: Filter): Promise<void>
Saves the new filter to the database

Returns
a promise that will be resolved when the filter is saved
Parameters
- filter: Filter
  
  a filter to save
Returns Promise<void>

subscribe

subscribe(callback: ((...args: unknown[]) => void), options?: StateOptions): (() => void)
Subscribe to state changes with optional transformation and filtering.

The subscription will immediately invoke the callback with the current state (if any), then continue to call it whenever the state changes. The map and filter options allow you to transform and selectively receive updates.

Returns
Unsubscribe function - call this to stop receiving updates

Remarks
- Map functions are applied sequentially to transform the state
- Filter functions must all return true for the callback to be invoked
- Functions in map/filter arrays are bound to the component instance
- Always store and call the unsubscribe function when component is destroyed
Example
```
// Basic subscription
const unsubscribe = repository.subscribe((state) => {
    console.log('State updated:', state);
});

// With transformations
const unsubscribe = repository.subscribe(
    (userName) => console.log('User:', userName),
    { map: [(state) => state.user?.name] }
);
```
Parameters
- callback: ((...args: unknown[]) => void)
  
  Function called with state updates (after map/filter applied)
  - - (...args: unknown[]): void
    - Parameters
      
      Rest ...args: unknown[]
      
      Returns void
- Optional options: StateOptions
  
  Optional transformations and filters for the subscription
Returns (() => void)
- - (): void
  - Subscribe to state changes with optional transformation and filtering.
    
    The subscription will immediately invoke the callback with the current state (if any), then continue to call it whenever the state changes. The map and filter options allow you to transform and selectively receive updates.
    
    Returns
    Unsubscribe function - call this to stop receiving updates
    
    Remarks
    - Map functions are applied sequentially to transform the state
    - Filter functions must all return true for the callback to be invoked
    - Functions in map/filter arrays are bound to the component instance
    - Always store and call the unsubscribe function when component is destroyed
    Example
```
// Basic subscription
const unsubscribe = repository.subscribe((state) => {
    console.log('State updated:', state);
});

// With transformations
const unsubscribe = repository.subscribe(
    (userName) => console.log('User:', userName),
    { map: [(state) => state.user?.name] }
);
```
    Returns void
Inherited from StateRepository.subscribe