Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ConstantStatusCode

  subscribe now with sterfive to access the online-user manual

Hierarchy

Index

Constructors

Accessors

Methods

Constructors

constructor

  • new ConstantStatusCode(options: { description: string; name: string; value: number }): ConstantStatusCode

  • Parameters

    • options: { description: string; name: string; value: number }
      • description: string
      • name: string
      • value: number

    Returns ConstantStatusCode

Accessors

description

  • get description(): string

  • return the long description of the status code

    Returns string

hasOverflowBit

  • get hasOverflowBit(): boolean

  • returns true if the overflow bit is set

    Returns boolean

hasSemanticChangedBit

  • get hasSemanticChangedBit(): boolean

  • returns true if the semanticChange bit is set

    Returns boolean

hasStructureChangedBit

  • get hasStructureChangedBit(): boolean

  • returns true if the structureChange bit is set

    Returns boolean

name

  • get name(): string

  • status code by name, (including extra bits in textual forms)

    Returns string

value

  • get value(): number

  • returns status code value in numerical form, including extra bits

    Returns number

Methods

checkBit

  • checkBit(mask: number): boolean

  • Parameters

    • mask: number

    Returns boolean

equals

  • Parameters

    Returns boolean

isNot

  • Parameters

    Returns boolean

toJSON

  • toJSON(): any

  • Returns any

toJSONFull

  • toJSONFull(): any

  • Returns any

toString

  • toString(): string

  • Returns string

valueOf

  • valueOf(): number

  • Returns number

Static makeStatusCode

  • returns a status code that can be modified

    Parameters

    • statusCode: string | StatusCode
    • optionalBits: string | number

    Returns StatusCode

Generated using TypeDoc