+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Constructor
+ + + +(protected) new Actor()
+ + + + + + + + + + + + + + + + + + +Properties:
+ + + +| Name | + + +Type | + + + + + +Description | +
|---|---|---|
id |
+
+
+ + + + String + + + + | + + + + + +64-char hex: SHA256 of the 32-byte digest represented by Actor#preimage. | +
preimage |
+
+
+ + + + String + + + + | + + + + + +64-char hex: SHA256 of UTF-8 pretty JSON of Actor#toGenericMessage. | +
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
-
+
-
+
- + types/actor.js, line 40 + +
+
+
+
+
+
+
+
+
Fires:
+-
+
- Actor#event:commit + +
- message Emits structured objects; on Actor#commit,event:
type: 'ActorMessage'with patch metadata (not necessarily a Message AMP instance).
+
Extends
+ + + + +-
+
- EventEmitter +
Methods
+ + + + + + + +_readObject(input) → {Object}
+ + + + + + +
+ Parse an Object into a corresponding Fabric state.
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+ + +| Name | + + +Type | + + + + + +Description | +
|---|---|---|
input |
+
+
+ + + + Object + + + + | + + + + + +Object to read as input. | +
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
-
+
-
+
- + types/actor.js, line 499 + +
+
+
+
+
+
+
+
+
Returns:
+ + +
+ Fabric state.
+
+
+
+
+ -
+
- + Type + +
- + + Object + + + +
adopt(changes) → {Actor}
+ + + + + + +
+ Explicitly adopt a set of JSONPatch-encoded changes.
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+ + +| Name | + + +Type | + + + + + +Description | +
|---|---|---|
changes |
+
+
+ + + + Array + + + + | + + + + + +List of JSONPatch operations to apply. | +
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
-
+
-
+
- + types/actor.js, line 209 + +
+
+
+
+
+
+
+
+
Returns:
+ + +
+ Instance of the Actor.
+
+
+
+
+ -
+
- + Type + +
- + + Actor + + + +
commit() → {String}
+ + + + + + +
+ Resolve the current state to a commitment.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
-
+
-
+
- + types/actor.js, line 224 + +
+
+
+
+
+
+
+
+
Returns:
+ + +
+ 32-byte ID
+
+
+
+
+ -
+
- + Type + +
- + + String + + + +
export() → {Object}
+ + + + + + +
+ Export the Actor's state to a standard Object.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
-
+
-
+
- + types/actor.js, line 259 + +
+
+
+
+
+
+
+
+
Returns:
+ + +
+ Standard object.
+
+
+
+
+ -
+
- + Type + +
- + + Object + + + +
get(path) → {Object}
+ + + + + + +
+ Retrieve a value from the Actor's state by JSONPointer path.
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+ + +| Name | + + +Type | + + + + + +Description | +
|---|---|---|
path |
+
+
+ + + + String + + + + | + + + + + +Path to retrieve using JSONPointer. | +
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
-
+
-
+
- + types/actor.js, line 273 + +
+
+
+
+
+
+
+
+
Returns:
+ + +
+ Value of the path in the Actor's state.
+
+
+
+
+ -
+
- + Type + +
- + + Object + + + +
pause() → {Actor}
+ + + + + + +
+ Toggles `status` property to paused.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
-
+
-
+
- + types/actor.js, line 395 + +
+
+
+
+
+
+
+
+
Returns:
+ + +
+ Instance of the Actor.
+
+
+
+
+ -
+
- + Type + +
- + + Actor + + + +
serialize() → {String}
+ + + + + + +
+ Serialize the Actor's current state into a JSON-formatted string.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
-
+
-
+
- + types/actor.js, line 410 + +
+
+
+
+
+
+
+
+
Returns:
+ + + + +-
+
- + Type + +
- + + String + + + +
set(path, value) → {Object}
+ + + + + + +
+ Set a value in the Actor's state by JSONPointer path.
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+ + +| Name | + + +Type | + + + + + +Description | +
|---|---|---|
path |
+
+
+ + + + String + + + + | + + + + + +Path to set using JSONPointer. | +
value |
+
+
+ + + + Object + + + + | + + + + + +Value to set. | +
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
-
+
-
+
- + types/actor.js, line 300 + +
+
+
+
+
+
+
+
+
Returns:
+ + +
+ Value of the path in the Actor's state.
+
+
+
+
+ -
+
- + Type + +
- + + Object + + + +
sign() → {Actor}
+ + + + + + +
+ Signs the Actor.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
-
+
-
+
- + types/actor.js, line 433 + +
+
+
+
+
+
+
+
+
Returns:
+ + + + +-
+
- + Type + +
- + + Actor + + + +
stream(pipeopt) → {TransformStream}
+ + + + + + +
+ Returns a new output stream for the Actor.
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+ + +| Name | + + +Type | + + +Attributes | + + + + +Description | +
|---|---|---|---|
pipe |
+
+
+ + + + TransformStream + + + + | + + +
+
+ <optional> + + + + + + |
+
+
+
+
+ Pipe to stream to. | +
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
-
+
-
+
- + types/actor.js, line 316 + +
+
+
+
+
+
+
+
+
Returns:
+ + +
+ New output stream for the Actor.
+
+
+
+
+ -
+
- + Type + +
- + + TransformStream + + + +
toBuffer() → {Buffer}
+ + + + + + +
+ Casts the Actor to a normalized Buffer.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
-
+
-
+
- + types/actor.js, line 344 + +
+
+
+
+
+
+
+
+
Returns:
+ + + + +-
+
- + Type + +
- + + Buffer + + + +
toGenericMessage(typeopt) → {Object}
+ + + + + + +
+ Casts the Actor to a generic message envelope for state announcements and history.
+ Shape is stable: `{ type, object }` where `object` is sorted-key state (Actor#toObject).
+ Actor#id derives from a digest of the pretty-printed generic message; extending this
+ envelope requires a format/version migration across the network.
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+ + +| Name | + + +Type | + + +Attributes | + + + +Default | + + +Description | +
|---|---|---|---|---|
type |
+
+
+ + + + String + + + + | + + +
+
+ <optional> + + + + + + |
+
+
+
+ + + 'FabricActorState' + + | + + +Logical message type string. | +
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
-
+
-
+
- + types/actor.js, line 358 + +
+
+
+
+
+
+ - See: +
- + + + + + +
Returns:
+ + +
+ `{ type, object }`
+
+
+
+
+ -
+
- + Type + +
- + + Object + + + +
toObject() → {Object}
+ + + + + + +
+ Returns the Actor's current state as an Object.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
-
+
-
+
- + types/actor.js, line 377 + +
+
+
+
+
+
+
+
+
Returns:
+ + + + +-
+
- + Type + +
- + + Object + + + +
unpause() → {Actor}
+ + + + + + +
+ Toggles `status` property to unpaused.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
-
+
-
+
- + types/actor.js, line 444 + +
+
+
+
+
+
+
+
+
Returns:
+ + +
+ Instance of the Actor.
+
+
+
+
+ -
+
- + Type + +
- + + Actor + + + +
value(formatopt) → {Object}
+ + + + + + +
+ Get the inner value of the Actor with an optional cast type.
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+ + +| Name | + + +Type | + + +Attributes | + + + +Default | + + +Description | +
|---|---|---|---|---|
format |
+
+
+ + + + String + + + + | + + +
+
+ <optional> + + + + + + |
+
+
+
+ + + object + + | + + +Cast the value to one of: `buffer, hex, json, string` | +
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
-
+
-
+
- + types/actor.js, line 462 + +
+
+
+
+
+
+
+
+
Returns:
+ + +
+ Inner value of the Actor as an Object, or cast to the requested `format`.
+
+
+
+
+ -
+
- + Type + +
- + + Object + + + +
(static) fromAny(input) → {Actor}
+ + + + + + +
+ Create an Actor from a variety of formats.
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+ + +| Name | + + +Type | + + + + + +Description | +
|---|---|---|
input |
+
+
+ + + + Object + + + + | + + + + + +Target Object to create. | +
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
-
+
-
+
- + types/actor.js, line 122 + +
+
+
+
+
+
+
+
+
Returns:
+ + +
+ Instance of the Actor.
+
+
+
+
+ -
+
- + Type + +
- + + Actor + + + +
(static) randomBytes(countopt) → {Buffer}
+ + + + + + +
+ Get a number of random bytes from the runtime environment.
+
+
+
+
+
+
+
+
+
+
+ Parameters:
-Generic Fabric Actor.
+
+ | Name | + + +Type | + + +Attributes | + + + +Default | + + +Description | +
|---|---|---|---|---|
count |
+
+
+ + + + Number + + + + | + + +
+
+ <optional> + + + + + + |
+
+
+
+ + + 32 + + | + + +Number of random bytes to retrieve. | +
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
-
+
-
+
- + types/actor.js, line 152 + +
+
+
+
+
+
+
+
+
Returns:
+ + +
+ The random bytes.
+
+
+
+
+ -
+
- + Type + +
- + + Buffer + + + +