Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix(akita): restrict usage of sortByOrder to valid usages in type system #667

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 13 additions & 4 deletions libs/akita/src/lib/queryConfig.ts
Original file line number Diff line number Diff line change
@@ -1,13 +1,22 @@
import { Order } from './sort';

export type SortBy<E, S = any> = ((a: E, b: E, state?: S) => number) | keyof E;
type SortByFunction<E, S = any> = (a: E, b: E, state?: S) => number;
type SortByKey<E> = keyof E;
export type SortBy<E, S = any> = SortByFunction<E, S> | SortByKey<E>;

export interface SortByOptions<E> {
sortBy?: SortBy<E>;
interface SortByFunctionOptions<E> {
sortBy?: SortByFunction<E>;
sortByOrder?: undefined;
}

interface SortByKeyOptions<E> {
sortBy?: SortByKey<E>;
sortByOrder?: Order;
}

export interface QueryConfigOptions<E = any> extends SortByOptions<E> {}
export type SortByOptions<E> = SortByFunctionOptions<E> | SortByKeyOptions<E>;

export type QueryConfigOptions<E = any> = SortByOptions<E>;

export const queryConfigKey = 'akitaQueryConfig';

Expand Down
9 changes: 4 additions & 5 deletions libs/akita/src/lib/selectAllOverloads.ts
Original file line number Diff line number Diff line change
@@ -1,9 +1,8 @@
import { SelectOptions } from './types';
import { SortBy } from './queryConfig';
import { Order } from './sort';
import { SortByOptions } from './queryConfig';

export type SelectAllOptionsA<E> = { asObject: true; filterBy?: SelectOptions<E>['filterBy']; limitTo?: number; sortBy?: undefined; sortByOrder?: undefined };
export type SelectAllOptionsB<E> = { filterBy: SelectOptions<E>['filterBy']; limitTo?: number; sortBy?: SortBy<E>; sortByOrder?: Order };
export type SelectAllOptionsB<E> = { filterBy: SelectOptions<E>['filterBy']; limitTo?: number; } & SortByOptions<E>
export type SelectAllOptionsC<E> = { asObject: true; limitTo?: number; sortBy?: undefined; sortByOrder?: undefined };
export type SelectAllOptionsD<E> = { limitTo?: number; sortBy?: SortBy<E>; sortByOrder?: Order };
export type SelectAllOptionsE<E> = { asObject: false; filterBy?: SelectOptions<E>['filterBy']; limitTo?: number; sortBy?: SortBy<E>; sortByOrder?: Order };
export type SelectAllOptionsD<E> = { limitTo?: number; } & SortByOptions<E>
export type SelectAllOptionsE<E> = { asObject: false; filterBy?: SelectOptions<E>['filterBy']; limitTo?: number; } & SortByOptions<E>
2 changes: 1 addition & 1 deletion libs/akita/src/lib/types.ts
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ export interface MultiActiveState<T = ID> {
active: T[];
}

export interface SelectOptions<E> extends SortByOptions<E> {
export type SelectOptions<E> = SortByOptions<E> & {
asObject?: boolean;
filterBy?: ((entity: E, index?: number) => boolean) | ((entity: E, index?: number) => boolean)[] | undefined;
limitTo?: number;
Expand Down