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

  • BaseHelperInterface
    • PostmanHelperInterface

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

  • allowsEmptyValue(): boolean

  • Returns boolean

getAlternatives

getChildren

OptionalgetContentType

  • getContentType(): undefined | string

  • Returns undefined | string

getDefaultValue

  • getDefaultValue(): unknown

  • Returns unknown

getDescription

  • getDescription(): string

  • Returns string

OptionalgetDescriptionType

  • getDescriptionType(): undefined | string

  • Returns undefined | string

getEnum

  • getEnum(): unknown[]

  • Returns unknown[]

getExampleValue

  • getExampleValue(): unknown

  • Returns unknown

getFirstItem

getMax

  • getMax(): undefined | number

  • Returns undefined | number

getMin

  • getMin(): undefined | number

  • Returns undefined | number

getType

  • getType(): string

  • Returns string

getUnit

  • getUnit(): string

  • Returns string

OptionalgetXml

  • getXml(): undefined | XMLObject

  • Returns undefined | XMLObject

OptionalhasContentType

  • hasContentType(): boolean

  • Returns boolean

hasDefaultValue

  • hasDefaultValue(): boolean

  • Returns boolean

OptionalhasDescriptionType

  • hasDescriptionType(): boolean

  • Returns boolean

hasExampleValue

  • hasExampleValue(): boolean

  • Returns boolean

hasMax

  • hasMax(): boolean

  • Returns boolean

hasMin

  • hasMin(): boolean

  • Returns boolean

OptionalhasXml

  • hasXml(): boolean

  • Returns boolean

isDeprecated

  • isDeprecated(): boolean

  • Returns boolean

isRequired

  • isRequired(): boolean

  • Returns boolean

isUnique

  • isUnique(): boolean

  • Returns boolean

isValid

  • isValid(): boolean

  • Returns boolean

Settings

Member Visibility

On This Page

Methods