defineHooks

utils

Source Code | Documentation

TypeScript helper that provides full type inference and autocompletion when defining service hooks. It is an identity function that simply returns its input, but enables your IDE to infer the correct hook context types.

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

Example

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

export const userHooks = defineHooks({
  before: { create: [validateUser()] },
  after: { all: [sanitizeResult()] }
})

Type declaration

Show Type Declarations

/**
 * TypeScript helper that provides full type inference and autocompletion when defining
 * service hooks. It is an identity function that simply returns its input,
 * but enables your IDE to infer the correct hook context types.
 *
 * @example
 * ```ts
 *
 *
 * export const userHooks = defineHooks({
 *   before: { create: [validateUser()] },
 *   after: { all: [sanitizeResult()] }
 * })
 * ```
 *
 * @see https://utils.feathersjs.com/utils/define-hooks.html
 */
export declare function defineHooks<
  A extends Application = Application,
  S = {
    find: any
    get: any
    create: any
    update: any
    patch: any
    remove: any
  },
  Options = HookOptions<A, S>,
>(hooks: Options): Options

Argument	Type	Description
hooks	Options

When you define hooks in feathers like this:

export default {
  before: {
    // ...
  },
  // ...
};

you don't have autocompletion. Instead, you can use defineHooks to define type-safe hooks:

import { defineHooks } from "feathers-utils/utils";
export default defineHooks({
  before: {
    // ...
  },
  // ...
});