`HttpStatusCodeAbstractSubclass`

An abstract Typescript class to facilitate the creation of a concrete class targeted to a specific HTTP API.

HttpStatusCodeAbstractSubclass extends IanaHttpStatusCodes for its initial dataset that is then customizable by calling protected methods.

Hierarchy

IanaHttpStatusCodes
- HttpStatusCodeAbstractSubclass
  - PostmanEchoHttpStatusCodes

Index

Constructors

constructor

Public Methods

Protected Methods

Constructors

Protected constructor

new HttpStatusCodeAbstractSubclass(): HttpStatusCodeAbstractSubclass

- Defined in HttpStatusCodeAbstractSubclass.ts:25
Returns HttpStatusCodeAbstractSubclass

Public Methods

getDataset

getDataset(): Dataset

Inherited from IanaHttpStatusCodes.getDataset
- Defined in IanaHttpStatusCodes.ts:107
Get a copy of the entire status code dataset.

Returns Dataset

getReasonPhrase

getReasonPhrase(statusCode: number): ReasonPhrase

Inherited from IanaHttpStatusCodes.getReasonPhrase
- Defined in IanaHttpStatusCodes.ts:148
Get the reason phrase for the specified status code.

When a status code has multiple records, returns the first reason phrase.

Parameters
- statusCode: number
Returns ReasonPhrase

getReasonPhrases

getReasonPhrases(statusCode: number): ReasonPhrase[]

- Defined in HttpStatusCodeAbstractSubclass.ts:63
Get all reason phrases for the specified status code.

Parameters
- statusCode: number
Returns ReasonPhrase[]

getRecord

getRecord(statusCode: number): Record

Inherited from IanaHttpStatusCodes.getRecord
- Defined in IanaHttpStatusCodes.ts:130
Get a copy of the record for the specified status code.

When a status code has multiple records, returns the first record.

Parameters
- statusCode: number
Returns Record

getRecordForReasonPhrase

getRecordForReasonPhrase(statusCode: number, reasonPhrase: ReasonPhrase): Record

- Defined in HttpStatusCodeAbstractSubclass.ts:93
Get a status code's record that has the specified reason phrase.

Parameters
- statusCode: number
- reasonPhrase: ReasonPhrase
Returns Record

getRecords

getRecords(statusCode: number): RecordSet

- Defined in HttpStatusCodeAbstractSubclass.ts:48
Get all records for the specified status code.

Parameters
- statusCode: number
Returns RecordSet

getReference

getReference(statusCode: number): Reference

Inherited from IanaHttpStatusCodes.getReference
- Defined in IanaHttpStatusCodes.ts:166
Get the reference for the specified status code.

When a status code has multiple records, returns the first reference.

Parameters
- statusCode: number
Returns Reference

getReferenceForReasonPhrase

getReferenceForReasonPhrase(statusCode: number, reasonPhrase: ReasonPhrase): Reference

- Defined in HttpStatusCodeAbstractSubclass.ts:116
Get a status code's reference that has the specified reason phrase.

Parameters
- statusCode: number
- reasonPhrase: ReasonPhrase
Returns Reference

getReferences

getReferences(statusCode: number): Reference[]

- Defined in HttpStatusCodeAbstractSubclass.ts:78
Get all references for the specified status code regardless of reason phrase.

Parameters
- statusCode: number
Returns Reference[]

getStatusCodes

getStatusCodes(): number[]

Inherited from IanaHttpStatusCodes.getStatusCodes
- Defined in IanaHttpStatusCodes.ts:117
Get a list of all status codes in the dataset.

Returns number[]

hasAlternatives

hasAlternatives(statusCode: number): boolean

- Defined in HttpStatusCodeAbstractSubclass.ts:36
Determine if the specified status code has multiple records.

Parameters
- statusCode: number
Returns boolean

Protected Methods

Protected addRecord

addRecord(statusCode: number, record: Record): this

- Defined in HttpStatusCodeAbstractSubclass.ts:139
Add an alternative record for the specified status code.

Parameters
- statusCode: number
- record: Record
Returns this

Protected deleteRecord

deleteRecord(statusCode: number, reasonPhrase: ReasonPhrase): this

- Defined in HttpStatusCodeAbstractSubclass.ts:175
Delete the specified status code's record for the specified reason phrase.

Parameters
- statusCode: number
- reasonPhrase: ReasonPhrase
Returns this

Protected deleteStatusCode

deleteStatusCode(statusCode: number): this

- Defined in HttpStatusCodeAbstractSubclass.ts:159
Delete the specified status code from the dataset.

Parameters
- statusCode: number
Returns this

Protected replaceReasonPhrase

replaceReasonPhrase(statusCode: number, oldReasonPhrase: ReasonPhrase, newReasonPhrase: ReasonPhrase): this

- Defined in HttpStatusCodeAbstractSubclass.ts:220
Replace the specified status code's reason phrase.

Parameters
- statusCode: number
- oldReasonPhrase: ReasonPhrase
- newReasonPhrase: ReasonPhrase
Returns this

Protected replaceRecord

replaceRecord(statusCode: number, reasonPhrase: ReasonPhrase, newRecord: Record): this

- Defined in HttpStatusCodeAbstractSubclass.ts:203
Replace the specified status code's record for the specified reason phrase.

Parameters
- statusCode: number
- reasonPhrase: ReasonPhrase
- newRecord: Record
Returns this

Protected replaceReference

replaceReference(statusCode: number, reasonPhrase: ReasonPhrase, newReference: Reference): this

- Defined in HttpStatusCodeAbstractSubclass.ts:249
Replace the specified status code's reference associated with the specified reason phrase.

Parameters
- statusCode: number
- reasonPhrase: ReasonPhrase
- newReference: Reference
Returns this

Generated using TypeDoc