Skip to content

Commit

Permalink
doccomment
Browse files Browse the repository at this point in the history
  • Loading branch information
mitschabaude committed Jun 12, 2023
1 parent 5ba75da commit ad7f597
Showing 1 changed file with 11 additions and 0 deletions.
11 changes: 11 additions & 0 deletions src/lib/core.ts
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,17 @@ export { Field, Bool, Scalar, Group };
const Field = toFunctionConstructor(InternalField);
type Field = InternalField;

/**
* A boolean value. You can use it like this:
*
* ```
* const x = new Bool(true);
* ```
*
* You can also combine multiple booleans via [[`not`]], [[`and`]], [[`or`]].
*
* Use [[assertEquals]] to enforce the value of a Bool.
*/
const Bool = toFunctionConstructor(InternalBool);
type Bool = InternalBool;

Expand Down

0 comments on commit ad7f597

Please sign in to comment.