Interface PostmanHelperInterface

interface PostmanHelperInterface {
    allowsEmptyValue(): boolean;
    getAlternatives(): PostmanHelperInterface[];
    getChildren(): Record<string, PostmanHelperInterface>;
    getContentType?(): undefined | string;
    getDefaultValue(): unknown;
    getDescription(): string;
    getDescriptionType?(): undefined | string;
    getEnum(): unknown[];
    getExampleValue(): unknown;
    getFirstItem(): undefined | PostmanHelperInterface;
    getMax(): undefined | number;
    getMin(): undefined | number;
    getType(): string;
    getUnit(): string;
    getXml?(): undefined | XMLObject;
    hasContentType?(): boolean;
    hasDefaultValue(): boolean;
    hasDescriptionType?(): boolean;
    hasExampleValue(): boolean;
    hasMax(): boolean;
    hasMin(): boolean;
    hasXml?(): boolean;
    isDeprecated(): boolean;
    isRequired(): boolean;
    isUnique(): boolean;
    isValid(): boolean;
}

Hierarchy (view full)

Implemented by

Methods

allowsEmptyValue getAlternatives getChildren getContentType? getDefaultValue getDescription getDescriptionType? getEnum getExampleValue getFirstItem getMax getMin getType getUnit getXml? hasContentType? hasDefaultValue hasDescriptionType? hasExampleValue hasMax hasMin hasXml? isDeprecated isRequired isUnique isValid

Methods

allowsEmptyValue

getAlternatives

getChildren

Optional getContentType

getDefaultValue

getDescription

Optional getDescriptionType

getEnum

getExampleValue

getFirstItem

getMax

getMin

getType

getUnit

Optional getXml

Optional hasContentType

hasDefaultValue

Optional hasDescriptionType

hasExampleValue

hasMax

hasMin

Optional hasXml

isDeprecated

isRequired

isUnique

isValid

Settings

Member Visibility

Theme

On This Page

allowsEmptyValuegetAlternativesgetChildrengetContentTypegetDefaultValuegetDescriptiongetDescriptionTypegetEnumgetExampleValuegetFirstItemgetMaxgetMingetTypegetUnitgetXmlhasContentTypehasDefaultValuehasDescriptionTypehasExampleValuehasMaxhasMinhasXmlisDeprecatedisRequiredisUniqueisValid