mutateData

utils

Source Code | Documentation

See also: hooks/transformData transformers

Applies a transformer function to each item in context.data, updating it in place. If the transformer returns a new object, it replaces the original item. Correctly handles both single-item and array data, preserving the original shape.

  import { mutateData } from 'feathers-utils/utils';

Example

import { mutateData } from 'feathers-utils/utils'

await mutateData(context, (item) => { item.name = item.name.trim() })

Type declaration

Show Type Declarations

/**
 * Applies a transformer function to each item in `context.data`, updating it in place.
 * If the transformer returns a new object, it replaces the original item.
 * Correctly handles both single-item and array data, preserving the original shape.
 *
 * @example
 * ```ts
 *
 *
 * await mutateData(context, (item) => { item.name = item.name.trim() })
 * ```
 *
 * @see https://utils.feathersjs.com/utils/mutate-data.html
 */
export declare function mutateData<H extends HookContext = HookContext>(
  context: H,
  transformer: TransformerFn<any, H>,
): Promisable<H>

Argument	Type	Description
context	H
transformer	TransformerFn<any, H>