Skip to content

Commit

Permalink
REAME updates to include allow and rejecta
Browse files Browse the repository at this point in the history
  • Loading branch information
JasonCorns-Avalara authored and JasonAllenCorns committed Aug 25, 2020
1 parent c171499 commit b70d382
Showing 1 changed file with 1 addition and 3 deletions.
4 changes: 1 addition & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
This is brie [![Build Status](https://travis-ci.org/peopleconnectus/brie.svg?branch=master)](https://travis-ci.org/peopleconnectus/brie)
=============
This Business Rules Integration Engine (B.R.I.E, or "brie") is a transient Feature Flipping Criteria System for Node.
This Business Rules Integration Engine (B.R.E, or "brie") is a transient Feature Flipping Criteria System for Node.

```
npm install brie
Expand Down Expand Up @@ -86,8 +86,6 @@ Provided an object containing a noted trait, brie evaluates the presence of the

The `object.id` is used to calculate a percentage, modified by the salt value. If the resulting, salted, number is within range, returns true; otherwise false.

`salt` is used to allow the same `id` to map to a different boolean amongst the feature flags. Thus you can have one flag with the `{ percentMin: 0, percentMax: 50, salt:0.5 }` return true, and another with `{ percentMin: 0, percentMax: 50, salt: 0.9 }` return false. Conversely you can tie together a booleans using the same salt.

#### has(test data [object], comparison data [object])
The most complex criteria mechanism, `has` will evaluate the test data (first argument) against the trait, comparator and value provided in the second argument. If the test data has the trait and the associated value evaluates properly considering the comparison value, then true is returned.

Expand Down

0 comments on commit b70d382

Please sign in to comment.