Class CborInitialByte

Represents a CBOR initial byte.

Hierarchy

CborInitialByte

Index

Constructors

Properties

#initialByte AdditionalInformationMask IndefiniteLengthBreakByte

Methods

CborInitialByte getAdditionalInfo getInitialByte getMajorType from

Constructors

constructor

new CborInitialByte(): CborInitialByte
Returns CborInitialByte

Properties

`Private` #initialByte

#initialByte: number

`Static` `Readonly` AdditionalInformationMask

AdditionalInformationMask: 31 = 0b0001_1111

`Static` `Readonly` IndefiniteLengthBreakByte

IndefiniteLengthBreakByte: 255 = 0xff

Methods

CborInitialByte

CborInitialByte(majorType: CborMajorType, additionalInfo: Serialization.CborAdditionalInfo): void
Initializes a new instance of the CborInitialByte class.
Parameters
- majorType: CborMajorType
  
  The initial byte major type.
- additionalInfo: Serialization.CborAdditionalInfo
  
  The initial byte additional info.
Returns void
- Defined in packages/core/src/Serialization/CBOR/CborInitialByte.ts:19

getAdditionalInfo

getAdditionalInfo(): Serialization.CborAdditionalInfo
Gets initial type the additional info.

Returns
The additional info.

Returns Serialization.CborAdditionalInfo
- Defined in packages/core/src/Serialization/CBOR/CborInitialByte.ts:58

getInitialByte

getInitialByte(): number
Gets the packed initial byte.

Returns
The packed initial byte.

Returns number
- Defined in packages/core/src/Serialization/CBOR/CborInitialByte.ts:40

getMajorType

getMajorType(): CborMajorType
Gets the initial type major type.

Returns
The major type.

Returns CborMajorType
- Defined in packages/core/src/Serialization/CBOR/CborInitialByte.ts:49

`Static` from

from(initialByte: number): CborInitialByte
Creates a CborInitialByte class from a packed initialByte.
Parameters
- initialByte: number
  
  The initial.
Returns CborInitialByte
- Defined in packages/core/src/Serialization/CBOR/CborInitialByte.ts:28

Generated using TypeDoc