Class OpenAPIJoiHelper

Types:

'alternatives', 'any', 'array', 'boolean', 'date', 'function', 'link', 'number', 'object', 'string', 'symbol', 'binary'

Hierarchy (View Summary)

JoiHelper
- OpenAPIJoiHelper

Implements

OpenAPIHelperInterface

Constructors

constructor

new OpenAPIJoiHelper(
__namedParameters: { isRoot?: boolean; value?: unknown },
): OpenAPIJoiHelper
Parameters
- __namedParameters: { isRoot?: boolean; value?: unknown }
Returns OpenAPIJoiHelper
Inherited from JoiHelper.constructor
- Defined in helpers/joiHelper.ts:47

Properties

`Protected`_joi

_joi: JoiSchema

`Protected`isRoot

isRoot: boolean

Methods

allowsEmptyValue

allowsEmptyValue(): boolean
Returns boolean
Implementation of OpenAPIHelperInterface.allowsEmptyValue
Inherited from JoiHelper.allowsEmptyValue
- Defined in helpers/joiHelper.ts:190

getAdditionalProperties

getAdditionalProperties(): AdditionalProperties
Returns AdditionalProperties
Implementation of OpenAPIHelperInterface.getAdditionalProperties
- Defined in generators/openapi/helpers/joiHelper.ts:85

getAlternatives

getAlternatives(): OpenAPIJoiHelper[]
Returns OpenAPIJoiHelper[]
Implementation of OpenAPIHelperInterface.getAlternatives
- Defined in generators/openapi/helpers/joiHelper.ts:33

getChildren

getChildren(): Record<string, OpenAPIJoiHelper>
Returns Record<string, OpenAPIJoiHelper>
Implementation of OpenAPIHelperInterface.getChildren
- Defined in generators/openapi/helpers/joiHelper.ts:20

getDefaultValue

getDefaultValue(): unknown
Returns unknown
Implementation of OpenAPIHelperInterface.getDefaultValue
Inherited from JoiHelper.getDefaultValue
- Defined in helpers/joiHelper.ts:149

getDescription

getDescription(): string
Returns string
Implementation of OpenAPIHelperInterface.getDescription
Inherited from JoiHelper.getDescription
- Defined in helpers/joiHelper.ts:105

getDiscriminator

getDiscriminator(): undefined | DiscriminatorObject
Returns undefined | DiscriminatorObject
Implementation of OpenAPIHelperInterface.getDiscriminator
- Defined in generators/openapi/helpers/joiHelper.ts:127

getEncoding

getEncoding(): undefined | Record<string, EncodingObject>
Returns undefined | Record<string, EncodingObject>
Implementation of OpenAPIHelperInterface.getEncoding
- Defined in generators/openapi/helpers/joiHelper.ts:190

getEnum

getEnum(): unknown[]
Returns unknown[]
Implementation of OpenAPIHelperInterface.getEnum
Inherited from JoiHelper.getEnum
- Defined in helpers/joiHelper.ts:203

getExamples

getExamples(): undefined | Record<string, ReferenceObject | ExampleObject>
Returns undefined | Record<string, ReferenceObject | ExampleObject>
Implementation of OpenAPIHelperInterface.getExamples
- Defined in generators/openapi/helpers/joiHelper.ts:169

getExampleValue

getExampleValue(): unknown
Returns unknown
Implementation of OpenAPIHelperInterface.getExampleValue
Inherited from JoiHelper.getExampleValue
- Defined in helpers/joiHelper.ts:169

getFirstItem

getFirstItem(): undefined | OpenAPIJoiHelper
Returns undefined | OpenAPIJoiHelper
Implementation of OpenAPIHelperInterface.getFirstItem
- Defined in generators/openapi/helpers/joiHelper.ts:6

getMax

getMax(): undefined | number
Returns undefined | number
Implementation of OpenAPIHelperInterface.getMax
Inherited from JoiHelper.getMax
- Defined in helpers/joiHelper.ts:255

`Protected`getMeta

getMeta(v: string): unknown
Parameters
- v: string
Returns unknown
Inherited from JoiHelper.getMeta
- Defined in helpers/joiHelper.ts:67

getMin

getMin(): undefined | number
Returns undefined | number
Implementation of OpenAPIHelperInterface.getMin
Inherited from JoiHelper.getMin
- Defined in helpers/joiHelper.ts:241

getRef

getRef(): undefined | string
Returns undefined | string
Implementation of OpenAPIHelperInterface.getRef
- Defined in generators/openapi/helpers/joiHelper.ts:106

getStyle

getStyle(): string
Returns string
Implementation of OpenAPIHelperInterface.getStyle
- Defined in generators/openapi/helpers/joiHelper.ts:62

getType

getType(): string
Returns string
Implementation of OpenAPIHelperInterface.getType
Inherited from JoiHelper.getType
- Defined in helpers/joiHelper.ts:78

getUnit

getUnit(): string
Returns string
Implementation of OpenAPIHelperInterface.getUnit
Inherited from JoiHelper.getUnit
- Defined in helpers/joiHelper.ts:269

getXml

getXml(): undefined | XMLObject
Returns undefined | XMLObject
Implementation of OpenAPIHelperInterface.getXml
- Defined in generators/openapi/helpers/joiHelper.ts:148

hasAdditionalProperties

hasAdditionalProperties(): boolean
Returns boolean
Implementation of OpenAPIHelperInterface.hasAdditionalProperties
- Defined in generators/openapi/helpers/joiHelper.ts:72

hasDefaultValue

hasDefaultValue(): boolean
Returns boolean
Implementation of OpenAPIHelperInterface.hasDefaultValue
Inherited from JoiHelper.hasDefaultValue
- Defined in helpers/joiHelper.ts:141

hasDiscriminator

hasDiscriminator(): boolean
Returns boolean
Implementation of OpenAPIHelperInterface.hasDiscriminator
- Defined in generators/openapi/helpers/joiHelper.ts:116

hasEncoding

hasEncoding(): boolean
Returns boolean
Implementation of OpenAPIHelperInterface.hasEncoding
- Defined in generators/openapi/helpers/joiHelper.ts:179

hasExamples

hasExamples(): boolean
Returns boolean
Implementation of OpenAPIHelperInterface.hasExamples
- Defined in generators/openapi/helpers/joiHelper.ts:158

hasExampleValue

hasExampleValue(): boolean
Returns boolean
Implementation of OpenAPIHelperInterface.hasExampleValue
Inherited from JoiHelper.hasExampleValue
- Defined in helpers/joiHelper.ts:160

hasMax

hasMax(): boolean
Returns boolean
Implementation of OpenAPIHelperInterface.hasMax
Inherited from JoiHelper.hasMax
- Defined in helpers/joiHelper.ts:230

`Protected`hasMeta

hasMeta(v: string): boolean
Parameters
- v: string
Returns boolean
Inherited from JoiHelper.hasMeta
- Defined in helpers/joiHelper.ts:59

hasMin

hasMin(): boolean
Returns boolean
Implementation of OpenAPIHelperInterface.hasMin
Inherited from JoiHelper.hasMin
- Defined in helpers/joiHelper.ts:219

hasRef

hasRef(): boolean
Returns boolean
Implementation of OpenAPIHelperInterface.hasRef
- Defined in generators/openapi/helpers/joiHelper.ts:95

hasStyle

hasStyle(): boolean
Returns boolean
Implementation of OpenAPIHelperInterface.hasStyle
- Defined in generators/openapi/helpers/joiHelper.ts:51

hasXml

hasXml(): boolean
Returns boolean
Implementation of OpenAPIHelperInterface.hasXml
- Defined in generators/openapi/helpers/joiHelper.ts:137

isDeprecated

isDeprecated(): boolean
Returns boolean
Implementation of OpenAPIHelperInterface.isDeprecated
Inherited from JoiHelper.isDeprecated
- Defined in helpers/joiHelper.ts:180

`Protected`isJoi

isJoi(): boolean
Returns boolean
Inherited from JoiHelper.isJoi
- Defined in helpers/joiHelper.ts:52

isRequired

isRequired(): boolean
Returns boolean
Implementation of OpenAPIHelperInterface.isRequired
Inherited from JoiHelper.isRequired
- Defined in helpers/joiHelper.ts:117

isUnique

isUnique(): boolean
Returns boolean
Implementation of OpenAPIHelperInterface.isUnique
Inherited from JoiHelper.isUnique
- Defined in helpers/joiHelper.ts:129

isValid

isValid(): boolean
Returns boolean
Implementation of OpenAPIHelperInterface.isValid
Inherited from JoiHelper.isValid
- Defined in helpers/joiHelper.ts:74