@@ -85,67 +85,72 @@ export class ActiveState extends BooleanState {
8585``` typescript
8686import { EnumState } from ' @typescript-package/state' ;
8787
88+ // Define example enum.
8889enum Active {
8990 Yes ,
9091 No
9192}
9293
94+ // Use the `EnumState`.
9395export class ActiveEnum extends EnumState <typeof Active , Active > {
9496 constructor (state : Active ) {
9597 super (state , Active );
9698 }
9799
98100}
99101
102+ // Initialize.
100103const activeEnum = new ActiveEnum (Active .No );
101104
102- console .log (activeEnum .is (Active .No ));
105+ // Check whether enum is set to `No`.
106+ activeEnum .is (Active .No )
103107```
104108
105109### ` NullState `
106110
107111``` typescript
108112import { NullState } from ' @typescript-package/state' ;
109113
114+ // Use the `NullState`.
110115export class Nullified extends NullState {}
111116
112- const n = new Nullified ();
117+ // Initialize.
118+ const nullified = new Nullified ();
113119
114- n .set ();
115-
116- console .log (` NullState ` );
117- console .log (n .state );
118-
119- n .unset ();
120- console .log (n .state );
120+ // Sets the state to `null`.
121+ nullified .set ();
121122
123+ // Sets the state to `undefined`.
124+ nullified .unset ();
122125```
123126
124127### ` NumberState `
125128
126129``` typescript
127130import { NumberState } from ' @typescript-package/state' ;
128131
132+ // Use the `NumberState`.
129133export class NumberedState extends NumberState {
130134 public override reset() {
131135 super .reset ();
132136 return this ;
133137 }
134138}
135139
136- const n = new NumberedState ();
137-
140+ // Initialize.
138141const numberedState = new NumberedState ();
139142
140- console . log ( numberedState . state );
143+ // Decrement state by 1.
141144numberedState .decrement ();
142- console .log (numberedState .state );
145+
146+ // Increment state by 1.
143147numberedState .increment ();
144- console .log (numberedState .state );
148+
149+ // Increment state by 5.
145150numberedState .increment (5 );
146- console .log (numberedState .state );
151+
152+ // Reset state to 0..
147153numberedState .reset ();
148- console .log (numberedState .state );
149154```
150155
151156## Immutability
0 commit comments