Interface Options

interface Options {
    cpOpts?: ConsumerOptions & ProducerOptions;
    endpoint?: Endpoint;
    notifyInterestLifetime?: number;
    pubAnnouncement?: false | Name;
    pubFwHint?: Name;
    pubPrefix?: Name;
    pubSigner?: Signer;
}

Hierarchy (view full)

Properties

cpOpts? endpoint? notifyInterestLifetime? pubAnnouncement? pubFwHint? pubPrefix? pubSigner?

Properties

Optional cpOpts

cpOpts?: ConsumerOptions & ProducerOptions

Consumer and producer options.

Remarks

  • .fw may be specified.
  • Most other fields are overridden.

Optional endpoint

endpoint?: Endpoint

Endpoint for communication.

Deprecated

Specify .cpOpts.

Optional notifyInterestLifetime

notifyInterestLifetime?: number

InterestLifetime of notify Interests.

Optional pubAnnouncement

pubAnnouncement?: false | Name

Prefix announcement to receive msg Interests.

Default Value

.pubFwHint ?? .pubPrefix

Optional pubFwHint

pubFwHint?: Name

Forwarding hint of the local application.

Optional pubPrefix

pubPrefix?: Name

Name prefix of the local application.

Default Value

"/localhost" + random-suffix

Optional pubSigner

pubSigner?: Signer

Key to sign publications.

Default Value

digestSigning

Remarks

This key should be trusted to sign objects under pubPrefix. This may overridden on a per-publication basis by PublicationCallback returning Data.

Settings

Member Visibility

Theme

On This Page

cpOptsendpointnotifyInterestLifetimepubAnnouncementpubFwHintpubPrefixpubSigner