setResult

Category

hooks

Source Code | Documentation

Tags

result

Export size

min 8.02 kB · gzip 3.44 kB

Sets a property on each item in context.result from another property on the hook context. Supports dot-notation paths for both source and target, and can optionally operate on context.dispatch as well.

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

Example

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

app.service('posts').hooks({
  after: { all: [setResult('params.user.id', 'currentUserId')] }
})

Options

allowUndefinedbooleandefaultfalse

Whether a missing from on the context is allowed. With false, an external call (one with a params.provider) that misses it is rejected — an internal call never is.

overwriteboolean | PredicateItemWithContextdefaulttrue

Whether a value already present at to is overwritten.

Pass a (item, context) => boolean predicate to decide per item — items it returns false for keep the value they came in with.

error(context: HookContext, from: PropertyPath) => FeathersError

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.

dispatchDispatchOptiondefaultfalse

Which of context.result and context.dispatch the property is set on. true targets dispatch (seeded from result when it is still empty), 'both' targets each of them.

Type declaration

Show Type Declarations

export interface SetResultOptions {
  /**
   * Whether a missing `from` on the context is allowed. With `false`, an
   * external call (one with a `params.provider`) that misses it is rejected —
   * an internal call never is.
   *
   * @default false
   */
  allowUndefined?: boolean
  /**
   * Whether a value already present at `to` is overwritten.
   *
   * Pass a `(item, context) => boolean` predicate to decide per item — items it
   * returns `false` for keep the value they came in with.
   *
   * @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
  /**
   * Which of `context.result` and `context.dispatch` the property is set on.
   * `true` targets `dispatch` (seeded from `result` when it is still empty),
   * `'both'` targets each of them.
   *
   * @default false
   */
  dispatch?: DispatchOption
}
/**
 * Sets a property on each item in `context.result` from another property on the hook context.
 * Supports dot-notation paths for both source and target, and can optionally
 * operate on `context.dispatch` as well.
 *
 * @example
 * ```ts
 *
 *
 * app.service('posts').hooks({
 *   after: { all: [setResult('params.user.id', 'currentUserId')] }
 * })
 * ```
 *
 * @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): void
  (context: H, next: NextFunction): Promise<void>
}

Argument	Type	Description
from	PropertyPath
to	PropertyPath
options	SetResultOptions

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