Interface Options

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

Properties

conventions? cOpts? expectedSuffixLen? segmentNumConvention? versionConvention?

Properties

Optionalconventions

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.

OptionalcOpts

cOpts?: ConsumerOptions

Consumer options.

Remarks

  • .describe defaults to "discoverVersion" + name.
  • .retx defaults to 2.
  • .verifier is recommended.

OptionalexpectedSuffixLen

expectedSuffixLen?: Arrayable<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.

OptionalsegmentNumConvention

segmentNumConvention?: SegmentConvention

Choose a segment number naming convention.

Default Value

Segment3

OptionalversionConvention

versionConvention?: VersionConvention

Choose a version naming convention.

Default Value

Version3

Settings

Member Visibility

On This Page

Properties