interface Options {
    cOpts?: ConsumerOptions;
    conventions?: readonly [VersionConvention, SegmentConvention][];
    describe?: string;
    endpoint?: Endpoint;
    expectedSuffixLen?: number | readonly number[] | typeof ANY_SUFFIX_LEN;
    fw?: Forwarder;
    modifyInterest?: Modify;
    retxLimit?: number;
    segmentNumConvention?: SegmentConvention;
    signal?: AbortSignal;
    verifier?: Verifier;
    versionConvention?: VersionConvention;
}

Properties

Consumer options.

Remarks

  • .describe defaults to "discoverVersion" + name.
  • .retx defaults to 2.
  • .verifier is recommended.
conventions?: readonly [VersionConvention, SegmentConvention][]

List of acceptable version+segment naming convention combinations.

Remarks

If this is specified and non-empty, it overrides .versionConvention and .segmentNumConvention.

describe?: string

FwFace description.

Deprecated

Specify in .cOpts.describe.

endpoint?: Endpoint

Endpoint for communication.

Deprecated

Specify .cOpts.

expectedSuffixLen?: number | readonly number[] | typeof ANY_SUFFIX_LEN

Expected number of suffix components, including Version and Segment.

Default Value

2

Remarks

Minimum and default are 2, i.e. Version and Segment components. This can be a single number or an array of acceptable numbers. ANY_SUFFIX_LEN allows any suffix length.

Use the specified logical forwarder.

Deprecated

Specify in .cOpts.fw.

modifyInterest?: Modify

Interest modification.

Deprecated

Specify in .cOpts.modifyInterest.

retxLimit?: number

Maximum number of retransmissions, excluding initial Interest.

Deprecated

Specify in .cOpts.retx.

segmentNumConvention?: SegmentConvention

Choose a segment number naming convention.

Default Value

Segment3

signal?: AbortSignal

AbortSignal that allows canceling the Interest via AbortController.

Deprecated

Specify in .cOpts.signal.

verifier?: Verifier

Data verifier.

Deprecated

Specify in .cOpts.verifier.

versionConvention?: VersionConvention

Choose a version naming convention.

Default Value

Version3

Generated using TypeDoc