Interface FormatsQueryParameters

Interface prescribing the expected signature of the query parameter formatting function.

Hierarchy

  • FormatsQueryParameters

Properties

formatQueryParameters: ((parameters: Partial<{ columns: string[]; distinct: string[]; limit: number; offset: number; orders: Order[]; page: number; relationsExists: string[]; scopes: string[]; wheres: WhereDescription[]; with: string[] }> & Record<string, any>) => Record<string, any>)

Type declaration

    • (parameters: Partial<{ columns: string[]; distinct: string[]; limit: number; offset: number; orders: Order[]; page: number; relationsExists: string[]; scopes: string[]; wheres: WhereDescription[]; with: string[] }> & Record<string, any>): Record<string, any>
    • The method that customises the outgoing query parameter keys.

      Parameters

      • parameters: Partial<{ columns: string[]; distinct: string[]; limit: number; offset: number; orders: Order[]; page: number; relationsExists: string[]; scopes: string[]; wheres: WhereDescription[]; with: string[] }> & Record<string, any>

      Returns Record<string, any>

Generated using TypeDoc