Interface Options

Hierarchy

  • Options

Properties

describe?: string

Description for debugging purpose.

endpoint?: Endpoint

Endpoint for communication.

filterPubs?: FilterPubsCallback

Callback to decide what publications to be included in a response. Default is: respond nothing if there's no own publication; otherwise, prioritize own publications over others, and prioritize later timestamp.

isExpired?: IsExpiredCallback

Callback to determine if a publication is expired. Default is interpreting the last component as TimestampNameComponent; if the last component is not a TimestampNameComponent, it is seen as expired.

maxClockSkew?: number

Maximum clock skew, for calculating timers.

Default

1000
maxPubLifetime?: number

Publication lifetime.

Default

1000
modifyPublication?: ModifyPublicationCallback

Callback to modify publication before it's signed. Default is appending a TimestampNameComponent to the name.

Algorithm parameters. They must be the same on every peer.

pubSigner?: Signer

Signer of publications. Default is digest signing.

pubVerifier?: Verifier

Verifier of publications. Default is no verification.

syncDataPubSize?: number

Advisory maximum size for publications included in a sync reply Data packet.

Default

1300
syncInterestLifetime?: number

Sync Interest lifetime in milliseconds.

Default

4000
syncPrefix: Name

Sync group prefix.

syncSigner?: Signer

Signer of sync reply Data packets. Default is digest signing.

syncVerifier?: Verifier

Verifier of sync reply Data packets. Default is no verification.

Generated using TypeDoc