setField

Category

hooks

Source Code | Documentation

Tags

querydataauthorization

Export size

min 7.53 kB · gzip 3.19 kB

Sets a field on the hook context (e.g. params.query) based on the value of another context field (e.g. params.user.id). Useful for scoping queries to the authenticated user. Throws a Forbidden error if the source field is missing (unless allowUndefined is true).

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

Example

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

app.service('posts').hooks({
  before: { all: [setField({ from: 'params.user.id', as: 'params.query.userId' })] }
})

Options

asstring | string[]required

The target path(s) to set. Pass an array to write the same value to several paths (e.g. multiple query keys).

Example 1

'params.query.userId'

Example 2

['params.query.userId', 'params.query.ownerId']

fromstring | ((context: H) => unknown)required

The source of the value: a dot.notation path on the context, or a function that derives the value from the context.

Example 1

'params.user.id'

Example 2

(context) => context.params.user?.id

allowUndefinedbooleandefaultfalse

If set to true, allows the field to be undefined. If the field is not available and this is true, the hook will not throw an error.

If set to false, the hook will throw an error if the field is not available.

error(context: H, from: string | ((context: H) => unknown)) => FeathersError

Customize the error that is thrown if the field is not available.

If not provided, throws a Forbidden error with a message indicating the missing field.

Type declaration

Show Type Declarations

export interface SetFieldOptions<H extends HookContext = HookContext> {
  /**
   * The target path(s) to set. Pass an array to write the same value to several
   * paths (e.g. multiple query keys).
   *
   * @example 'params.query.userId'
   * @example ['params.query.userId', 'params.query.ownerId']
   */
  as: string | string[]
  /**
   * The source of the value: a `dot.notation` path on the context, or a function
   * that derives the value from the context.
   *
   * @example 'params.user.id'
   * @example (context) => context.params.user?.id
   */
  from: string | ((context: H) => unknown)
  /**
   * If set to `true`, allows the field to be undefined.
   * If the field is not available and this is `true`, the hook will not throw an error.
   *
   * If set to `false`, the hook will throw an error if the field is not available.
   *
   * @default false
   */
  allowUndefined?: boolean
  /**
   * Customize the error that is thrown if the field is not available.
   *
   * If not provided, throws a `Forbidden` error with a message indicating the missing field.
   */
  error?: (
    context: H,
    from: string | ((context: H) => unknown),
  ) => FeathersError
}
/**
 * Sets a field on the hook context (e.g. `params.query`) based on the value of another
 * context field (e.g. `params.user.id`). Useful for scoping queries to the authenticated user.
 * Throws a `Forbidden` error if the source field is missing (unless `allowUndefined` is `true`).
 *
 * @example
 * ```ts
 *
 *
 * app.service('posts').hooks({
 *   before: { all: [setField({ from: 'params.user.id', as: 'params.query.userId' })] }
 * })
 * ```
 *
 * @see https://utils.feathersjs.com/hooks/set-field.html
 */
export declare const setField: <H extends HookContext = HookContext>({
  as,
  from,
  allowUndefined,
  error,
}: SetFieldOptions<H>) => {
  (context: H): void
  (context: H, next: NextFunction): Promise<void>
}

Argument	Type	Description
{ as, from, allowUndefined = false, error, }	SetFieldOptions<H>

type	methods	multi
before, after, around	all	yes