feathers-utils

KO | EN

gitlite — search

#javascript #python #hacktoberfest #llm #machine-learning #deep-learning #nodejs #java #windows #awesome #kubernetes #awesome-list #pytorch #ios

(★ 11)

utils for feathers.js

feathers-utils Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# feathers-utils

[![npm](https://img.shields.io/npm/v/feathers-utils)](https://www.npmjs.com/package/feathers-utils)
[![NPM Version](https://img.shields.io/npm/v/%40fratzinger%2Ffeathers-utils)](https://www.npmjs.com/package/@fratzinger/feathers-utils)
[![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/fratzinger/feathers-utils/node.js.yaml?branch=main)](https://github.com/fratzinger/feathers-utils/actions/workflows/node.js.yaml?query=branch%3Amain)
[![Maintainability](https://qlty.sh/gh/fratzinger/projects/feathers-utils/maintainability.svg)](https://qlty.sh/gh/fratzinger/projects/feathers-utils)
[![Code Coverage](https://qlty.sh/gh/fratzinger/projects/feathers-utils/coverage.svg)](https://qlty.sh/gh/fratzinger/projects/feathers-utils)
[![npm](https://img.shields.io/npm/dm/%40fratzinger%2Ffeathers-utils)](https://www.npmjs.com/package/@fratzinger/feathers-utils)
[![GitHub license](https://img.shields.io/github/license/fratzinger/feathers-utils)](https://github.com/fratzinger/feathers-utils/blob/main/LICENSE.md)

> NOTE: This package was previously named `feathers-utils`. The ownership of the package name was transferred to feathers. The new package name is `@fratzinger/feathers-utils`. Starting from version 7.0.1 the package is published under the new name. Please update your dependencies accordingly.

## Installation

```shell
npm i @fratzinger/feathers-utils
```

## Usage

### Hooks

- `checkMulti`: throws if the request is **multi** data, but the services `allowsMulti(method)` returns `false`
- `createRelated`: simply create related items from a hook.
- `forEach`
- `onDelete`: simply remove/set null related items from a hook.
- `paramsForServer`
- `paramsFromClient`
- `parseFields`
- `removeRelated`: simple remove related items from a hook. Basically `cascade` at feathers level.
- `runPerItem`: run a function for every item. Meant for `multi:true`.
- `setData`: map properties from `context` to `data`. Something like `userId: context.params.user.id`

### Mixins

- `mixins/debounceMixin` & `mixins/DebouncedStore`

### Utils

- `defineHooks`
- `filterQuery`
- `flattenQuery`
- `deflattenQuery`
- `getItemsIsArray(context)`: returns `{ items: any[], isArray: boolean }`
- `getPaginate`
- `isMulti(context) => Boolean`: returns true, if `find`, `create/patch/remove`: multi
- `isPaginated`
- `markHookForSkip`: add hookName to `context.params.skipHooks` - also see `shouldSkip`
- `mergeQuery`: deeply merges queries
- `mergeArrays`: merges arrays with intersection options
- `pushSet`: if existing array: _push_, else _set_
- `setQueryKeySafely`
- `setResultEmpty`
- `shouldSkip`: checks `context.params.skipHooks` for `'all' | '${hookName}' | '${type}:${hookName}'` - also see `markHookForSkip`

feathers-utils

feathers-utils Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

feathers-utils

feathers-utils Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README