Class ContextResponseShape

[[include:responses/contextResponseUtil.md]]

Hierarchy (view full)

ContextResponseUtil
- ContextResponseShape

Index

Constructors

constructor

new ContextResponseShape(responseUtil): ContextResponseShape
Parameters
- responseUtil: BaseResponseUtil
Returns ContextResponseShape
Inherited from ContextResponseUtil.constructor
- Defined in node_modules/@novice1/api-doc-generator/lib/utils/responses/contextResponseUtils.d.ts:13

Properties

`Protected` `Optional`code

code?: number

`Protected` `Optional`default

default?: boolean

`Protected` `Optional`links

links?: Record<string, ReferenceObject | LinkObject>

`Protected` `Optional`ref

ref?: string

`Protected`responseUtil

responseUtil: BaseResponseUtil

Methods

addLink

addLink(key, link): ContextResponseUtil
Parameters
- key: string
- link: LinkObject
Returns ContextResponseUtil
Inherited from ContextResponseUtil.addLink
- Defined in node_modules/@novice1/api-doc-generator/lib/utils/responses/contextResponseUtils.d.ts:23
addLink(key, link): ContextResponseUtil
Parameters
- key: string
- link: ReferenceObject
Returns ContextResponseUtil
Inherited from ContextResponseUtil.addLink
- Defined in node_modules/@novice1/api-doc-generator/lib/utils/responses/contextResponseUtils.d.ts:24
addLink(key): ContextResponseUtil
Parameters
- key: string
Returns ContextResponseUtil
Inherited from ContextResponseUtil.addLink
- Defined in node_modules/@novice1/api-doc-generator/lib/utils/responses/contextResponseUtils.d.ts:25

getCode

getCode(): undefined | number
Returns undefined | number
Inherited from ContextResponseUtil.getCode
- Defined in node_modules/@novice1/api-doc-generator/lib/utils/responses/contextResponseUtils.d.ts:17

getRef

getRef(): undefined | string
Returns undefined | string
Inherited from ContextResponseUtil.getRef
- Defined in node_modules/@novice1/api-doc-generator/lib/utils/responses/contextResponseUtils.d.ts:20

isDefault

isDefault(): boolean
Returns boolean
Inherited from ContextResponseUtil.isDefault
- Defined in node_modules/@novice1/api-doc-generator/lib/utils/responses/contextResponseUtils.d.ts:15

removeCode

removeCode(): undefined | number
Returns undefined | number
Inherited from ContextResponseUtil.removeCode
- Defined in node_modules/@novice1/api-doc-generator/lib/utils/responses/contextResponseUtils.d.ts:18

removeLink

removeLink(key): undefined | ReferenceObject | LinkObject
Parameters
- key: string
Returns undefined | ReferenceObject | LinkObject
Inherited from ContextResponseUtil.removeLink
- Defined in node_modules/@novice1/api-doc-generator/lib/utils/responses/contextResponseUtils.d.ts:27

removeLinks

removeLinks(): undefined | Record<string, ReferenceObject | LinkObject>
Returns undefined | Record<string, ReferenceObject | LinkObject>
Inherited from ContextResponseUtil.removeLinks
- Defined in node_modules/@novice1/api-doc-generator/lib/utils/responses/contextResponseUtils.d.ts:26

removeRef

removeRef(): undefined | string
Returns undefined | string
Inherited from ContextResponseUtil.removeRef
- Defined in node_modules/@novice1/api-doc-generator/lib/utils/responses/contextResponseUtils.d.ts:21

setCode

setCode(code): ContextResponseUtil
Parameters
- code: number
Returns ContextResponseUtil
Inherited from ContextResponseUtil.setCode
- Defined in node_modules/@novice1/api-doc-generator/lib/utils/responses/contextResponseUtils.d.ts:16

setDefault

setDefault(isDefault): ContextResponseUtil
Parameters
- isDefault: boolean
Returns ContextResponseUtil
Inherited from ContextResponseUtil.setDefault
- Defined in node_modules/@novice1/api-doc-generator/lib/utils/responses/contextResponseUtils.d.ts:14

setLinks

setLinks(links): ContextResponseUtil
Parameters
- links: Record<string, ReferenceObject | LinkObject>
Returns ContextResponseUtil
Inherited from ContextResponseUtil.setLinks
- Defined in node_modules/@novice1/api-doc-generator/lib/utils/responses/contextResponseUtils.d.ts:22

setRef

setRef(ref): ContextResponseUtil
Parameters
- ref: string
Returns ContextResponseUtil
Inherited from ContextResponseUtil.setRef
- Defined in node_modules/@novice1/api-doc-generator/lib/utils/responses/contextResponseUtils.d.ts:19

toOpenAPI

toOpenAPI(): Record<string, ReferenceObject | ResponseObject>
Returns Record<string, ReferenceObject | ResponseObject>
Overrides ContextResponseUtil.toOpenAPI
- Defined in src/responses/classes/ContextResponseShape.ts:6

toPostman

toPostman(): ResponseObject[]
Returns ResponseObject[]
Inherited from ContextResponseUtil.toPostman
- Defined in node_modules/@novice1/api-doc-generator/lib/utils/responses/contextResponseUtils.d.ts:28

Class ContextResponseShape

Hierarchy (view full)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns ContextResponseShape

Properties

Protected Optionalcode

Protected Optionaldefault

Protected Optionallinks

Protected Optionalref

ProtectedresponseUtil

Methods

addLink

Parameters

Returns ContextResponseUtil

Parameters

Returns ContextResponseUtil

Parameters

Returns ContextResponseUtil

getCode

Returns undefined | number

getRef

Returns undefined | string

isDefault

Returns boolean

removeCode

Returns undefined | number

removeLink

Parameters

Returns undefined | ReferenceObject | LinkObject

removeLinks

Returns undefined | Record<string, ReferenceObject | LinkObject>

removeRef

Returns undefined | string

setCode

Parameters

Returns ContextResponseUtil

setDefault

Parameters

Returns ContextResponseUtil

setLinks

Parameters

Returns ContextResponseUtil

setRef

Parameters

Returns ContextResponseUtil

toOpenAPI

Returns Record<string, ReferenceObject | ResponseObject>

toPostman

Returns ResponseObject[]

Settings

On This Page

`Protected` `Optional`code

`Protected` `Optional`default

`Protected` `Optional`links

`Protected` `Optional`ref

`Protected`responseUtil