Class SmallPeerInfo

Indicates whether small peer info collection is currently enabled, defaults to false.

Note: whether the background ingestion process is enabled or not is a separate decision to whether this information is allowed to sync to other peers (including the big peer). This is controlled by getSyncScope() and setSyncScope().

Set whether small peer info collection is enabled.

Throws

when set to a non-boolean value.

The metadata associated with the small peer info.

Small peer info metadata is a free-form, user-provided JSON object that is inserted into the small peer info system document at each collection interval.

Set the metadata associated with the small peer info.

The metadata must be a JSON-serializable object that conforms to the following constraints:

• Must be a JSON object (not an array, string, number, etc.)
• The size when encoded as JSON must be less than 128 KB
• May only be nested up to 2 levels deep

Example

Valid metadata

ditto.smallPeerInfo.metadata = {
 "foo": "bar",
 "nested": {
   "inner": "value"
  }
}
Copy

Example

Invalid metadata

// This is invalid and results in an error.
ditto.smallPeerInfo.metadata = {
  "foo": "bar",
  "nested": {
    "illegal": {
      "inner": "value"
    }
  }
}
Copy

Throws

when set to a value that violates any of the constraints listed above.

The metadata associated with the small peer info, as a JSON string.

Set the metadata associated with the small peer info, as a JSON string.

See

metadata for more information on valid values.

Throws

when set to a value that violates any of the constraints listed in metadata.

Determines which "kind" of peers the small peer info will be replicated to.

Defaults to LocalPeerOnly, which means no replication. Set this to BigPeerOnly to replicate collected info to the Big Peer.

Set the sync scope.

See getSyncScope for more information.

Throws

when set to a value other than BigPeerOnly or LocalPeerOnly.