8000 fix(core): Add PaginationParams to general find method of 'FeathersService' by fratzinger · Pull Request #3095 · feathersjs/feathers · GitHub
[go: up one dir, main page]
Skip to content

fix(core): Add PaginationParams to general find method of 'FeathersService' #3095

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.

Sign up for GitHub

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

Merged
daffl merged 1 commit into from
Mar 10, 2023
Merged

fix(core): Add PaginationParams to general find method of 'FeathersService' #3095

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
10 changes: 3 additions & 7 deletions packages/adapter-commons/src/declarations.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import { Query, Params, Paginated, Id } from '@feathersjs/feathers'
import { Query, Params, Paginated, Id, PaginationParams, PaginationOptions } from '@feathersjs/feathers'

export type FilterQueryOptions = {
filters?: FilterSettings
Expand All @@ -12,12 +12,8 @@ export type FilterSettings = {
[key: string]: QueryFilter | true
}

export interface PaginationOptions {
default?: number
max?: number
}

export type PaginationParams = false | PaginationOptions
// re-export from @feathersjs/feathers to prevent breaking changes
export { PaginationOptions, PaginationParams }

export interface AdapterServiceOptions {
/**
Expand Down
11 changes: 9 additions & 2 deletions packages/feathers/src/declarations.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ export interface ServiceMethods<
ServiceParams = Params,
PatchData = Partial<Data>
> {
find(params?: ServiceParams): Promise<Result | Result[]>
find(params?: ServiceParams & { paginate?: PaginationParams }): Promise<Result | Result[]>

get(id: Id, params?: ServiceParams): Promise<Result>

Expand Down Expand Up @@ -137,7 +137,7 @@ export interface ServiceAddons<A = Application, S = Service> extends EventEmitte
}

export interface ServiceHookOverloads<S, P = Params> {
find(params: P, context: HookContext): Promise<HookContext>
find(params: P & { paginate?: PaginationParams }, context: HookContext): Promise<HookContext>

get(id: Id, params: P, context: HookContext): Promise<HookContext>

Expand Down Expand Up @@ -331,6 +331,13 @@ export interface Params<Q = Query> {
headers?: { [key: string]: any }
}

export interface PaginationOptions {
default?: number
max?: number
}

export type PaginationParams = false | PaginationOptions

export interface Http {
/**
* A writeable, optional property with status code override.
Expand Down
0