Class BasicAuthUtil

[[include:auth/basicAuthUtil.md]]

Hierarchy

FullAuthUtil
- BasicAuthUtil

Index

Constructors

Properties

description? password? securitySchemeName username?

Methods

getDescription getPassword getSecuritySchemeName getUsername removeDescription removePassword removeUsername setDescription setPassword setUsername toOpenAPI toOpenAPISecurity toPostman

Constructors

constructor

new BasicAuthUtil(securitySchemeName): BasicAuthUtil
Parameters
- securitySchemeName: string
Returns BasicAuthUtil
Inherited from FullAuthUtil.constructor
- Defined in node_modules/@novice1/api-doc-generator/lib/utils/auth/baseAuthUtils.d.ts:45

Properties

`Protected` `Optional`description

description?: string

`Protected` `Optional`password

password?: string

`Protected`securitySchemeName

securitySchemeName: string

`Protected` `Optional`username

username?: string

Methods

getDescription

getDescription(): undefined | string
Returns undefined | string
Inherited from FullAuthUtil.getDescription
- Defined in node_modules/@novice1/api-doc-generator/lib/utils/auth/baseAuthUtils.d.ts:47

getPassword

getPassword(): undefined | string
Returns undefined | string
- Defined in node_modules/@novice1/api-doc-generator/lib/utils/auth/basicAuthUtil.d.ts:12

getSecuritySchemeName

getSecuritySchemeName(): string
Returns string
Inherited from FullAuthUtil.getSecuritySchemeName
- Defined in node_modules/@novice1/api-doc-generator/lib/utils/auth/baseAuthUtils.d.ts:46

getUsername

getUsername(): undefined | string
Returns undefined | string
- Defined in node_modules/@novice1/api-doc-generator/lib/utils/auth/basicAuthUtil.d.ts:15

removeDescription

removeDescription(): undefined | string
Returns undefined | string
Inherited from FullAuthUtil.removeDescription
- Defined in node_modules/@novice1/api-doc-generator/lib/utils/auth/baseAuthUtils.d.ts:48

removePassword

removePassword(): undefined | string
Returns undefined | string
- Defined in node_modules/@novice1/api-doc-generator/lib/utils/auth/basicAuthUtil.d.ts:13

removeUsername

removeUsername(): undefined | string
Returns undefined | string
- Defined in node_modules/@novice1/api-doc-generator/lib/utils/auth/basicAuthUtil.d.ts:16

setDescription

setDescription(description): BasicAuthUtil
Parameters
- description: string
  A short description for security scheme. CommonMark syntax MAY be used for rich text representation.
Returns BasicAuthUtil
Overrides FullAuthUtil.setDescription
- Defined in node_modules/@novice1/api-doc-generator/lib/utils/auth/basicAuthUtil.d.ts:10

setPassword

setPassword(password): BasicAuthUtil
Parameters
- password: string
Returns BasicAuthUtil
- Defined in node_modules/@novice1/api-doc-generator/lib/utils/auth/basicAuthUtil.d.ts:11

setUsername

setUsername(username): BasicAuthUtil
Parameters
- username: string
Returns BasicAuthUtil
- Defined in node_modules/@novice1/api-doc-generator/lib/utils/auth/basicAuthUtil.d.ts:14

toOpenAPI

toOpenAPI(): Record<string, SecuritySchemeObject>
Returns Record<string, SecuritySchemeObject>
Overrides FullAuthUtil.toOpenAPI
- Defined in node_modules/@novice1/api-doc-generator/lib/utils/auth/basicAuthUtil.d.ts:18

toOpenAPISecurity

toOpenAPISecurity(scopes?): SecurityRequirementObject[]
Parameters
- Optionalscopes: string[]
Returns SecurityRequirementObject[]
Inherited from FullAuthUtil.toOpenAPISecurity
- Defined in node_modules/@novice1/api-doc-generator/lib/utils/auth/baseAuthUtils.d.ts:49

toPostman

toPostman(): Auth
Returns Auth
Overrides FullAuthUtil.toPostman
- Defined in node_modules/@novice1/api-doc-generator/lib/utils/auth/basicAuthUtil.d.ts:17