Skip to content

Commit 77f1be8

Browse files
committed
docs: README updated
1 parent a8c9329 commit 77f1be8

1 file changed

Lines changed: 6 additions & 4 deletions

File tree

‎README.md‎

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
This is a port of Featurevisor [Javascript SDK](https://featurevisor.com/docs/sdks/javascript/) v3.x to Java, providing a way to evaluate feature flags, variations, and variables in your Java applications.
44

5-
This SDK supports Featurevisor v3 behavior and v2 datafiles. Generated datafiles continue to carry `schemaVersion: "2"`.
5+
This SDK supports Featurevisor v3 behaviour and v2 datafiles. Generated datafiles continue to carry `schemaVersion: "2"`.
66

77
## Table of contents <!-- omit in toc -->
88

@@ -526,7 +526,7 @@ loadDatafile("checkout");
526526

527527
### Updating datafile
528528

529-
You can set the datafile as many times as you want in your application, which will result in emitting a [`datafile_set`](#datafile_set) event that you can listen and react to accordingly.
529+
You can set the datafile as many times as you want in your application, which will result in emitting a [`datafile_set`](#datafile-set) event that you can listen and react to accordingly.
530530

531531
The triggers for setting the datafile again can be:
532532

@@ -584,7 +584,7 @@ Featurevisor f = Featurevisor.createFeaturevisor(new Featurevisor.FeaturevisorOp
584584

585585
Every diagnostic has `level`, `code`, `message`, and an object-shaped `details` map. Optional `module`, `moduleName`, and `originalError` fields describe provenance. Evaluation metadata belongs in `details`.
586586

587-
Diagnostic handlers are isolated from SDK behavior. An exception in a handler does not stop other handlers or evaluations.
587+
Diagnostic handlers are isolated from SDK behaviour. An exception in a handler does not stop other handlers or evaluations.
588588

589589

590590
## Events
@@ -709,6 +709,8 @@ Modules allow you to intercept the evaluation process and customize it further a
709709

710710
For feature evaluations, all `before` callbacks run in registration order, followed by all `beforeEvaluation` callbacks. After evaluation and caller defaults, all `afterEvaluation` callbacks run, followed by all `after` callbacks. Global variable evaluations use only `beforeEvaluation` and `afterEvaluation`. Required feature checks run through the complete module pipeline, and transformed defaults are preserved.
711711

712+
`before` and `after` remain available as deprecated feature-only compatibility callbacks. Use `beforeEvaluation` and `afterEvaluation` for new modules so the same callbacks can handle feature and global variable evaluations.
713+
712714
### Defining a module
713715

714716
A module is a `FeaturevisorModule` with a unique `name` and optional lifecycle functions:
@@ -855,7 +857,7 @@ f.close();
855857

856858
This package also provides a CLI tool for running your Featurevisor project's test specs and benchmarking against this Java SDK:
857859

858-
All three commands accept repeatable `--target=<target>` options. `test` builds only the selected Target datafiles and runs untargeted assertions plus assertions for those targets. `benchmark` and `assess-distribution` run independently against every selected Target datafile. Without `--target`, existing project-wide behavior is preserved. Project definitions, test specs, Target discovery, and datafile generation continue to come from the Node.js CLI.
860+
All three commands accept repeatable `--target=<target>` options. `test` builds only the selected Target datafiles and runs untargeted assertions plus assertions for those targets. `benchmark` and `assess-distribution` run independently against every selected Target datafile. Without `--target`, existing project-wide behaviour is preserved. Project definitions, test specs, Target discovery, and datafile generation continue to come from the Node.js CLI.
859861

860862
### Test
861863

0 commit comments

Comments
 (0)