paramsForServer

Source Code | Documentation

See also: paramsFromClient

a hook to move params to query.$client the server only receives 'query' from params. All other params are ignored. So, to use $populateParams on the server, we need to move the params to query.$client the server will move them back to params

  import { paramsForServer } from 'feathers-utils/hooks';

Type declaration

export type ParamsForServerOptions = {
  /**
   * @default '_$client'
   */
  keyToHide?: string
}
/**
 * a hook to move params to query._$client
 * the server only receives 'query' from params. All other params are ignored.
 * So, to use `$populateParams` on the server, we need to move the params to query._$client
 * the server will move them back to params
 *
 * @see https://utils.feathersjs.com/hooks/params-for-server.html
 */
export declare const paramsForServer: (
  whitelist: MaybeArray<string>,
  options?: ParamsForServerOptions,
) => <H extends HookContext>(context: H, next?: NextFunction) => any

Argument	Type	Description
whitelist	MaybeArray<string>
options	ParamsForServerOptions

type	methods	multi
before, around	create, update, patch	yes