unless

Category

hooks

Source Code | Documentation

Export size

min 0.97 kB · gzip 0.52 kB

See also

hooks/iff hooks/iffElse predicates

Executes a series of hooks when the predicate is falsy --- the inverse of iff. The predicate can be a boolean or a sync/async function. Useful for applying hooks to all contexts except those matching a condition.

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

Example

import { unless, isProvider } from 'feathers-utils/predicates'

app.service('users').hooks({
  before: { all: [unless(isProvider('server'), authenticate('jwt'))] }
})

Type declaration

Show Type Declarations

/**
 * Executes a series of hooks when the predicate is falsy --- the inverse of `iff`.
 * The predicate can be a boolean or a sync/async function.
 * Useful for applying hooks to all contexts except those matching a condition.
 *
 * @example
 * ```ts
 *
 *
 * app.service('users').hooks({
 *   before: { all: [unless(isProvider('server'), authenticate('jwt'))] }
 * })
 * ```
 *
 * @see https://utils.feathersjs.com/hooks/unless.html
 */
export declare function unless<H extends HookContext = HookContext>(
  predicate: boolean | PredicateFn,
  ...hooks: HookFunction<H>[]
): (this: any, ctx: HookContext, next?: HookContext) => any

Argument	Type	Description
predicate	boolean | PredicateFn
hooks	HookFunction<H>[]

type	methods	multi
before, after	all	yes