loopbackio / loopbackio/loopback-next

Filter/Where as a standalone concept

Ouverte
#5,957 4 commentaires 3 réactions 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

epic feature
Langage dominant
TypeScript
Étoiles
5.1k
Forks
1.1k
Merge moyen
2 j 21 h
PR mergées (30 j)
27

Description

Refactor the current implementation of LoopBack's Filter to allow other packages to leverage the filtering implementation and/or support LoopBack's Filter syntax.

  1. The syntax of Filter/Where objects should be well defined and properly documented, to allow 3rd-party implementations to understand all possible values.

  2. There should be TypeScript typings describing Filter, Where, etc., these typings must be accessible independently on @loopback/repository (e.g. via a new package).

  3. The implementation used by our memory connector should be refactored/extracted into a package that can be used independently from juggler (something like https://www.npmjs.com/package/loopback-filters). It's important to update the connector to use that new package, to ensure there is only single reference implementation.

Nice to have:

  • JSON Schema describing Filter syntax
  • Some sort of a test suite to allow 3rd-party implementations to verify conformance

Guide de contribution

Ouvrir le guide de contribution

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Piste de recherche

Commencez par localiser l’implémentation existante de Filter/Where de LoopBack et le connecteur mémoire dans juggler, puis examinez comment @loopback/repository expose ses types. Le travail est considéré comme terminé lorsque la syntaxe est documentée, que des définitions de types TypeScript indépendantes et un package de filtrage réutilisable existent, que le connecteur mémoire utilise l’implémentation partagée et que les tests proposés de JSON Schema ou de conformité sont pris en compte.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Évaluation

Stack technique
typescript
Domaine
backend-api-design, documentation
Type d'issue
Refactorisation
Difficulté
5/5
Temps estimé
Plus d'une semaine
Activité
À l'abandon
Clarté
Plutôt claire
Accessibilité débutants
25/100

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.