Improve typings for RequestResult

[adampasc]

Hi elf team,
I think the typings for the RequestResults can be improved when using joinRequestResult, this is what we would do:

getAllFavorites(): RequestResult<any> & { data: Favorite[] } { return this.store.pipe(selectAllEntities(), joinRequestResult(['favorites'])); }
I'm not sure if it is actually necessary to have the additional data type and if so, shouldn't it be exported?

[NetanelBasal]

I am not sure what is the issue

[oschlegel]

Shouldn't SuccessRequestResult be defined like this:

export interface SuccessRequestResult<TData = any> extends BaseRequestResult {
  isLoading: false;
  isSuccess: true;
  isError: false;
  status: 'success';
  data: TData;
  dataUpdatedAt?: number;
}

export type RequestResult<TData = any, TError = any> =
  | LoadingRequestResult
  | SuccessRequestResult<TData>
  | ErrorRequestResult<TError>
  | IdleRequestResult;

This way RequestResult<any> & { data: Favorite[] } could be written RequestResult<Favorite[], any> instead

[oschlegel]

RequestResult is not exported properly from @ngneat/elf-requests

import { getRequestResult, joinRequestResult,} from '@ngneat/elf-requests';
import { RequestResult } from '@ngneat/elf-requests/src/lib/requests-result';

[NetanelBasal]

Why do u need the interface?

[oschlegel]

For example in this scenario for a angular service:

@Injectable({ providedIn: 'root' })
export class ProductsService {
  private store;

  constructor(private productsDataService: ProductsdataService) {
    this.store = createStore(
      { name: products },
      withEntities<Product>()
    );
  }

  load() {
    return this.productsDataService.load().pipe(
      tap(products => this.store.update(upsertEntities(products))),
      trackRequestResult([products])
    );
  }

  selectAllProducts(): Observable<RequestResult<any> & { data: Product[] }> {
    return this.store.pipe(selectAllEntities(), joinRequestResult(['products']));
  }
}

[NetanelBasal]

It'll be typed without the explicit return type