Class: BaseStringBlock<T, J>
Type parameters
Name | Type |
---|---|
T | extends LocalStringValueBlock = LocalStringValueBlock |
J | extends BaseStringBlockJson = BaseStringBlockJson |
Hierarchy
-
BaseBlock
<T
,J
>↳
BaseStringBlock
Implements
Constructors
constructor
• new BaseStringBlock<T
, J
>(«destructured»?
, stringValueBlockType
): BaseStringBlock
<T
, J
>
Type parameters
Name | Type |
---|---|
T | extends LocalStringValueBlock = LocalStringValueBlock |
J | extends LocalStringValueBlockJson = LocalStringValueBlockJson |
Parameters
Name | Type |
---|---|
«destructured» | BaseStringBlockParams |
stringValueBlockType | () => T |
Returns
BaseStringBlock
<T
, J
>
Overrides
Properties
blockLength
• blockLength: number
Inherited from
error
• error: string
Inherited from
idBlock
• idBlock: LocalIdentificationBlock
Inherited from
lenBlock
• lenBlock: LocalLengthBlock
Inherited from
name
• name: string
Inherited from
optional
• optional: boolean
Inherited from
primitiveSchema
• Optional
primitiveSchema: BaseBlock
<ValueBlock
, LocalBaseBlockJson
>
Inherited from
valueBeforeDecodeView
• valueBeforeDecodeView: Uint8Array
Since
3.0.0
Inherited from
BaseBlock.valueBeforeDecodeView
valueBlock
• valueBlock: T
Inherited from
warnings
• warnings: string
[]
Inherited from
NAME
▪ Static
NAME: string
= "BaseStringBlock"
Overrides
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
fromBuffer
▸ fromBuffer(inputBuffer
): void
Function converting ArrayBuffer into ASN.1 internal string
Parameters
Name | Type | Description |
---|---|---|
inputBuffer | Uint8Array | ArrayBuffer | ASN.1 BER encoded array |
Returns
void
fromString
▸ fromString(inputString
): void
Creates a class object from the string
Parameters
Name | Type | Description |
---|---|---|
inputString | string | Input string to convert from |
Returns
void
Implementation of
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
Name | Type | Description |
---|---|---|
other | unknown | Object to compare with the current object |
Returns
other is BaseStringBlock<T, J>
Inherited from
onAsciiEncoding
▸ onAsciiEncoding(): string
Returns
string
Overrides
setValue
▸ setValue(value
): void
String value
Parameters
Name | Type | Description |
---|---|---|
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
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
toJSON
▸ toJSON(): BaseBlockJson
<J
>
Returns
Inherited from
toString
▸ toString(encoding?
): string
Returns a string representation of an object
Parameters
Name | Type | Default value |
---|---|---|
encoding | StringEncoding | "ascii" |
Returns
string
String representation of the class object
Implementation of
Inherited from
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