queryHasProperty

Category

utils

Source Code | Documentation

Export size

min 1.39 kB · gzip 0.67 kB

See also

utils/walk-query

Checks whether a Feathers query contains one or more properties — including properties nested inside $and/$or/$nor arrays. Returns true as soon as any of the given property names is found. The query is not mutated.

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

Example

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

queryHasProperty({ isTemplate: true }, 'isTemplate') // true
queryHasProperty({ $or: [{ isTemplate: true }] }, 'isTemplate') // true
queryHasProperty({ age: { $gt: 18 } }, ['isTemplate', 'status']) // false

Type declaration

Show Type Declarations

/**
 * Checks whether a Feathers query contains one or more properties — including
 * properties nested inside `$and`/`$or`/`$nor` arrays. Returns `true` as soon as
 * any of the given property names is found. The query is not mutated.
 *
 * @example
 * ```ts
 *
 *
 * queryHasProperty({ isTemplate: true }, 'isTemplate') // true
 * queryHasProperty({ $or: [{ isTemplate: true }] }, 'isTemplate') // true
 * queryHasProperty({ age: { $gt: 18 } }, ['isTemplate', 'status']) // false
 * ```
 *
 * @see https://utils.feathersjs.com/utils/query-has-property.html
 */
export declare const queryHasProperty: (
  query: Query,
  property: MaybeArray<string>,
) => boolean

Argument	Type	Description
query	Query
property	MaybeArray<string>