NDNts

    Interface Options

    interface Options {
        conventions?: readonly [VersionConvention, SegmentConvention][];
        cOpts?: ConsumerOptions;
        expectedSuffixLen?: Arrayable<number> | typeof ANY_SUFFIX_LEN;
        segmentNumConvention?: SegmentConvention;
        versionConvention?: VersionConvention;
    }
    Index

    Properties

    conventions? cOpts? expectedSuffixLen? segmentNumConvention? versionConvention?

    Properties

    conventions?: readonly [VersionConvention, SegmentConvention][]

    List of acceptable version+segment naming convention combinations.

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

    cOpts?: ConsumerOptions

    Consumer options.

    • .describe defaults to "discoverVersion" + name.
    • .retx defaults to 2.
    • .verifier is recommended.
    expectedSuffixLen?: Arrayable<number> | typeof ANY_SUFFIX_LEN

    Expected number of suffix components, including Version and Segment.

    2

    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.

    segmentNumConvention?: SegmentConvention

    Choose a segment number naming convention.

    Segment3

    versionConvention?: VersionConvention

    Choose a version naming convention.

    Version3

    Settings

    Member Visibility

    On This Page

    Properties
    MMNEPVFCICPMFPCPTTAAATR