Class: OctetString

Hierarchy

• BaseBlock<LocalOctetStringValueBlock, LocalOctetStringValueBlockJson>

  ↳ OctetString

Constructors

constructor

• new OctetString(«destructured»?): OctetString

Parameters

Name	Type
«destructured»	OctetStringParams

Returns

OctetString

Overrides

BaseBlock.constructor

Properties

blockLength

• blockLength: number

Inherited from

BaseBlock.blockLength

---

error

• error: string

Inherited from

BaseBlock.error

---

idBlock

• idBlock: LocalIdentificationBlock

Inherited from

BaseBlock.idBlock

---

lenBlock

• lenBlock: LocalLengthBlock

Inherited from

BaseBlock.lenBlock

---

name

• name: string

Inherited from

BaseBlock.name

---

optional

• optional: boolean

Inherited from

BaseBlock.optional

---

primitiveSchema

• Optional primitiveSchema: BaseBlock<ValueBlock, LocalBaseBlockJson>

Inherited from

BaseBlock.primitiveSchema

---

valueBeforeDecodeView

• valueBeforeDecodeView: Uint8Array

Since

3.0.0

Inherited from

BaseBlock.valueBeforeDecodeView

---

valueBlock

• valueBlock: LocalOctetStringValueBlock

Inherited from

BaseBlock.valueBlock

---

warnings

• warnings: string[]

Inherited from

BaseBlock.warnings

---

NAME

▪ Static NAME: string = OCTET_STRING_NAME

Overrides

BaseBlock.NAME

Accessors

valueBeforeDecode

• get valueBeforeDecode(): ArrayBuffer

Returns

ArrayBuffer

Deprecated

since version 3.0.0

Inherited from

BaseBlock.valueBeforeDecode

• set valueBeforeDecode(value): void

Parameters

Name	Type
value	ArrayBuffer

Returns

void

Deprecated

since version 3.0.0

Inherited from

BaseBlock.valueBeforeDecode

Methods

fromBER

▸ fromBER(inputBuffer, inputOffset, inputLength): number

Base function for converting block from BER encoded array of bytes

Parameters

Name	Type	Description
inputBuffer	Uint8Array | ArrayBuffer	ASN.1 BER encoded array
inputOffset	number	Offset in ASN.1 BER encoded array where decoding should be started
inputLength	number	Maximum length of array of bytes which can be using in this function

Returns

number

Offset after least decoded byte

Overrides

BaseBlock.fromBER

---

getValue

▸ getValue(): ArrayBuffer

Returns OctetString value. If OctetString is constructed, returns concatenated internal OctetString values

Returns

ArrayBuffer

Array buffer

Since

3.0.0

---

isEqual

▸ isEqual(other): other is OctetString

Determines whether two object instances are equal

Parameters

Name	Type	Description
other	unknown	Object to compare with the current object

Returns

other is OctetString

Inherited from

BaseBlock.isEqual

---

onAsciiEncoding

▸ onAsciiEncoding(): string

Returns

string

Overrides

BaseBlock.onAsciiEncoding

---

toBER

▸ toBER(sizeOnly?, writer?): ArrayBuffer

Encoding of current ASN.1 block into ASN.1 encoded array (BER rules)

Parameters

Name	Type	Description
sizeOnly?	boolean	Flag that we need only a size of encoding, not a real array of bytes
writer?	ViewWriter	-

Returns

ArrayBuffer

ASN.1 BER encoded array

Inherited from

BaseBlock.toBER

---

toJSON

▸ toJSON(): BaseBlockJson<LocalOctetStringValueBlockJson>

Returns

BaseBlockJson<LocalOctetStringValueBlockJson>

Inherited from

BaseBlock.toJSON

---

toString

▸ toString(encoding?): string

Parameters

Name	Type	Default value
encoding	StringEncoding	"ascii"

Returns

string

Inherited from

BaseBlock.toString

---

blockName

▸ blockName(): string

Aux function, need to get a block name. Need to have it here for inheritance

Returns

string

Returns name of the block

Inherited from

BaseBlock.blockName