grule

Ein einfacher und leistungsstarker Mechanismus zur Validierung von Regeln in JSON.

_{Gebaut mit ❤︎ von Hiukky}

Um

Grule ist ein minimaler Mechanismus zum Testen von Bedingungen anhand von Werten mithilfe eines JSON-Schemas. Sein Hauptziel besteht darin, als Rete-Mechanismus zu arbeiten und alle Operationen auf performatische und einfache Weise zu lösen.

Installation

Verwendung von NPM

npm i grule

Verwendung von Garn

yarn add grule

Verwenden

Um Ihr Regelschema einzurichten, befolgen Sie einfach die folgenden Schritte.

Erstellen Sie eine Instanz

Um eine Testinstanz zu erstellen, benötigen Sie eine Menge Fakten, um die Engine anzutreiben.

 // Import Engine
import { Grule } from 'grule'

// Create an type
type IUser = {
  id : number
  name : string
}

// Create metadata
const metadata : IUser = {
  id : 3 ,
  name : 'test' ,
}

// Create instance
const grule = new Grule < IUser > ( metadata )

Abonnementregeln

Nach dem Erstellen einer Instanz der Engine und dem Vorladen mit Fakten besteht der nächste Schritt darin, die Regeln zu registrieren. Um die Regeln zu registrieren, müssen Sie die IRules <T> -Schnittstelle importieren und einen Regelsatz für die in den Fakten deklarierten Attribute erstellen.

Die Regeln orientieren sich an der Struktur der im Sachverhalt deklarierten Daten. Für jedes Attribut wird eine Regel ausgeführt.

Die Regelerstellungsfunktion bietet zwei Argumente, das erste sind die attributes und das zweite die events .

Sie können für jeden Test einen logischen Ausdruck verwenden und eine gewünschte Aktion ausführen, oder Sie können das Ereignis „ when und then verwenden, um zu testen und eine Aktion basierend auf dem Ergebnis auszuführen. Dies ist eine gute Option für dynamische Tests.

Nachdem Sie eine Instanz erstellt und die Regeln registriert haben, können Sie einfach die Ausführungsmethode ausführen, indem Sie die als Parameter definierten Regeln übergeben. Wenn am Ende der Tests kein Fehler vorliegt, der den Testablauf unterbricht, wird ein boolescher Wert zurückgegeben.

• true alle Bedingungen sind erfüllt.
• false eine oder alle Bedingungen sind fehlgeschlagen.

 // ... Previous code

// Create Rules
const rules : IRules < IUser > = ( { id , name } , { when } ) => ( {
  id : when ( id . diff ( 1 ) ) . then ( ( ) => {
    throw new Error ( 'User not allowed.' )
  } ) ,
  name : name . in ( [ 'foo' , 'test' ] ) ,
} )

// Enroll rules
grule . run ( rules )

Sie können den vorherigen Ablauf auch auf sauberere Weise vereinfachen. (Beispiel für endgültigen Code)

 // Import Engine
import { Grule } from 'grule'

// Create an type
type IUser = {
  id : number
  name : string
}

// Create instance
new Grule < IUser > ( {
  id : 3 ,
  name : 'test' ,
} ) . run ( ( { id , name } , { when } ) => ( {
  id : when ( id . diff ( 1 ) ) . then ( ( ) => {
    throw new Error ( 'User not allowed.' )
  } ) ,
  name : name . in ( [ 'foo' , 'test' ] ) ,
} ) ) 

Verfügbare Methoden

Für Attribute

Für jedes Attribut stehen 9 Methoden für die jeweiligen Tests zur Verfügung.

• weniger

 // Type: less(value: ILess): boolean
// Acceptable: ['number', 'bigint']

• lessOrEqual

 // Type: lessOrEqual(value: ILess): boolean
// Acceptable: ['number', 'bigint']

• größer

 // Type: greater(value: IGreater): boolean
// Acceptable: ['number', 'bigint']

• größerOrEqual

 // Type: greaterOrEqual(value: IGreater): boolean
// Acceptable: ['number', 'bigint']

• gleich

 // Type: equal(value: IEqual): boolean
// Acceptable: ['bigint', 'boolean', 'number', 'string', 'date']

• diff

 // Type: diff(value: IEqual): boolean
// Acceptable: ['bigint', 'boolean', 'number', 'string', 'date']

• In

 // Type: in(value: In): boolean
// Acceptable: ['bigint', 'boolean', 'number', 'string', 'array']

• nichtIn

 // Type: notIn(value: In): boolean
// Acceptable: ['bigint', 'boolean', 'number', 'string', 'array']

• evalu

 // Type: eval(operator: IOperatorsList, arg1: A): boolean
// Acceptable: [Idle]

Für Veranstaltungen

Grule hat derzeit nur ein Ereignis als when . Es gibt ein Versprechen mit einem booleschen Ergebnis des durchgeführten Tests zurück.

• Wann

 // Type: when(test: boolean): Promise<boolean>
// Acceptable: ['boolean']

Mitwirken

Grule ist noch in einer ersten Version ohne viele Funktionen, aber Sie können gerne Ihren Vorschlag senden oder eine PR eröffnen.