Marmelator/common-ui
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

update listing providers factory description

Browse Source
This commit is contained in:
Dan Percic 2022-12-22 16:26:03 +02:00
parent bf325c2c09
commit 36c74bd8a2
1 changed files with 35 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

38
src/lib/listing/utils.ts
View File

@ -48,17 +48,49 @@ function getComponent(component: Type<unknown>) {
/**
* This is equivalent to
* @example <code>[FilterService, SearchService, SortingService, ListingService, EntitiesService]</code>
* @example
* [
* FilterService,
* SearchService,
* SortingService,
* ListingService,
* EntitiesService
* ]
*/
export function listingProvidersFactory(): Provider[];
/**
* This is equivalent to
* @example <code>[{provide: ListingComponent, useExisting: forwardRef(() => component)}, EntitiesService, FilterService, SearchService, SortingService, ListingService]</code>
* @example
* [
* {
* provide: ListingComponent,
* useExisting: forwardRef(() => component)
* },
* EntitiesService,
* FilterService,
* SearchService,
* SortingService,
* ListingService
* ]
*/
export function listingProvidersFactory(component: Type<unknown>): Provider[];
/**
* This is equivalent to
* @example <code>[{provide: EntitiesService, useExisting: entitiesService}, {provide: ListingComponent, useExisting: forwardRef(() => component)}, FilterService, SearchService, SortingService, ListingService]</code>
* @example
* [
* {
* provide: EntitiesService,
* useExisting: entitiesService
* },
* {
* provide: ListingComponent,
* useExisting: forwardRef(() => component)
* },
* FilterService,
* SearchService,
* SortingService,
* ListingService
* ]
*/
export function listingProvidersFactory<T extends IListable<PrimaryKey>, PrimaryKey extends Id = T['id']>(
options: IListingServiceFactoryOptions<T>,