Skip to main content

BaseStringBlock<T, J>

Extends​

Type Parameters​

T​

T extends LocalStringValueBlock = LocalStringValueBlock

J​

J extends BaseStringBlockJson = BaseStringBlockJson

Implements​

Constructors​

Constructor​

new BaseStringBlock<T, J>(__namedParameters, stringValueBlockType): BaseStringBlock<T, J>

Parameters​

__namedParameters​

BaseStringBlockParams = {}

stringValueBlockType​

() => T

Returns​

BaseStringBlock<T, J>

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: T

Inherited from​

BaseBlock.valueBlock

warnings​

warnings: string[]

Inherited from​

BaseBlock.warnings

NAME​

static NAME: string = "BaseStringBlock"

Name of the block

Overrides​

BaseBlock.NAME

Accessors​

valueBeforeDecode​

Get Signature​

get valueBeforeDecode(): ArrayBuffer

Deprecated​

since version 3.0.0

Returns​

ArrayBuffer

Set Signature​

set valueBeforeDecode(value): void

Deprecated​

since version 3.0.0

Parameters​
value​

ArrayBuffer

Returns​

void

Inherited from​

BaseBlock.valueBeforeDecode

Methods​

fromBER()​

fromBER(inputBuffer, inputOffset, inputLength): number

Base function for converting block from BER encoded array of bytes

Parameters​

inputBuffer​

ASN.1 BER encoded array

ArrayBuffer | Uint8Array

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

fromBuffer()​

abstract fromBuffer(inputBuffer): void

Function converting ArrayBuffer into ASN.1 internal string

Parameters​

inputBuffer​

ASN.1 BER encoded array

ArrayBuffer | Uint8Array

Returns​

void

fromString()​

abstract fromString(inputString): void

Creates a class object from the string

Parameters​

inputString​

string

Returns​

void

Implementation of​

IStringConvertible.fromString

getValue()​

getValue(): string

String value

Returns​

string

Since​

3.0.0

isEqual()​

isEqual(other): other is BaseStringBlock<T, J>

Determines whether two object instances are equal

Parameters​

other​

unknown

Object to compare with the current object

Returns​

other is BaseStringBlock<T, J>

Inherited from​

BaseBlock.isEqual

onAsciiEncoding()​

protected onAsciiEncoding(): string

Returns​

string

Overrides​

BaseBlock.onAsciiEncoding

setValue()​

setValue(value): void

String value

Parameters​

value​

string

String value

Returns​

void

Since​

3.0.0

toBER()​

toBER(sizeOnly?, writer?): ArrayBuffer

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

Parameters​

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<J>

Returns a JSON representation of an object

Returns​

BaseBlockJson<J>

JSON object

Inherited from​

BaseBlock.toJSON

toString()​

toString(encoding): string

Returns a string representation of an object.

Parameters​

encoding​

StringEncoding = "ascii"

Returns​

string

Implementation of​

IStringConvertible.toString

Inherited from​

BaseBlock.toString

blockName()​

static 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