setResult

Source Code | Documentation

hook to set properties on context.result

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

Type declaration

export interface SetResultOptions {
  /**
   * Wether to throw if the context[from] is undefined.
   *
   * @default false
   */
  allowUndefined?: boolean
  /**
   * @default true
   */
  overwrite?: boolean | PredicateItemWithContext
  /**
   * Customize the error that is thrown if the context[from] is not available.
   * If not provided, throws a `Forbidden` error with a message indicating the missing field.
   */
  error?: (context: HookContext, from: PropertyPath) => FeathersError
  dispatch?: DispatchOption
}
/**
 * hook to set properties on `context.result`
 *
 * @see https://utils.feathersjs.com/hooks/set-result.html
 */
export declare function setResult<H extends HookContext = HookContext>(
  /**
   * The property path of the context to set the value from. 'dot.notation' is supported.
   *
   * If the property does not exist, the hook will throw an error unless `allowUndefined` is set to true.
   * If the property exists, it will be set to the value of the `to` property path of the data item.
   *
   * @example 'params.user.id'
   */
  from: PropertyPath,
  /**
   * The property path of the data item to set the value to. 'dot.notation' is supported.
   *
   * If the property does not exist, it will be created.
   * If the property exists, it will be overwritten unless `overwrite` is set to false.
   *
   * @example 'userId'
   */
  to: PropertyPath,
  options?: SetResultOptions,
): (context: H, next?: NextFunction) => H

Argument	Type	Description
from	PropertyPath
to	PropertyPath
options	SetResultOptions

type	methods	multi
after, around	find, get, create, update, patch, remove	yes