Class: Utf8String
Hierarchy
Constructors
constructor
• new Utf8String(parameters?
): Utf8String
Parameters
Name | Type |
---|---|
parameters | Utf8StringParams |
Returns
Overrides
LocalUtf8StringValueBlock.constructor
Properties
blockLength
• blockLength: number
Inherited from
LocalUtf8StringValueBlock.blockLength
error
• error: string
Inherited from
LocalUtf8StringValueBlock.error
idBlock
• idBlock: LocalIdentificationBlock
Inherited from
LocalUtf8StringValueBlock.idBlock
lenBlock
• lenBlock: LocalLengthBlock
Inherited from
LocalUtf8StringValueBlock.lenBlock
name
• name: string
Inherited from
LocalUtf8StringValueBlock.name
optional
• optional: boolean
Inherited from
LocalUtf8StringValueBlock.optional
primitiveSchema
• Optional
primitiveSchema: BaseBlock
<ValueBlock
, LocalBaseBlockJson
>
Inherited from
LocalUtf8StringValueBlock.primitiveSchema
valueBeforeDecodeView
• valueBeforeDecodeView: Uint8Array
Since
3.0.0
Inherited from
LocalUtf8StringValueBlock.valueBeforeDecodeView
valueBlock
• valueBlock: LocalSimpleStringValueBlock
Inherited from
LocalUtf8StringValueBlock.valueBlock
warnings
• warnings: string
[]
Inherited from
LocalUtf8StringValueBlock.warnings
NAME
▪ Static
NAME: string
= "UTF8String"
Overrides
LocalUtf8StringValueBlock.NAME
Accessors
valueBeforeDecode
• get
valueBeforeDecode(): ArrayBuffer
Returns
ArrayBuffer
Deprecated
since version 3.0.0
Inherited from
LocalUtf8StringValueBlock.valueBeforeDecode
• set
valueBeforeDecode(value
): void
Parameters
Name | Type |
---|---|
value | ArrayBuffer |
Returns
void
Deprecated
since version 3.0.0
Inherited from
LocalUtf8StringValueBlock.valueBeforeDecode
Methods
fromBER
▸ fromBER(inputBuffer
, inputOffset
, inputLength
): number
Parameters
Name | Type |
---|---|
inputBuffer | Uint8Array | ArrayBuffer |
inputOffset | number |
inputLength | number |
Returns
number
Inherited from
LocalUtf8StringValueBlock.fromBER
fromBuffer
▸ fromBuffer(inputBuffer
): void
Parameters
Name | Type |
---|---|
inputBuffer | Uint8Array | ArrayBuffer |
Returns
void
Inherited from
LocalUtf8StringValueBlock.fromBuffer
fromString
▸ fromString(inputString
): void
Parameters
Name | Type |
---|---|
inputString | string |
Returns
void
Inherited from
LocalUtf8StringValueBlock.fromString
getValue
▸ getValue(): string
String value
Returns
string
Since
3.0.0
Inherited from
LocalUtf8StringValueBlock.getValue
isEqual
▸ isEqual(other
): other is Utf8String
Determines whether two object instances are equal
Parameters
Name | Type | Description |
---|---|---|
other | unknown | Object to compare with the current object |
Returns
other is Utf8String
Inherited from
LocalUtf8StringValueBlock.isEqual
onAsciiEncoding
▸ onAsciiEncoding(): string
Returns
string
Inherited from
LocalUtf8StringValueBlock.onAsciiEncoding
setValue
▸ setValue(value
): void
String value
Parameters
Name | Type | Description |
---|---|---|
value | string | String value |
Returns
void
Since
3.0.0
Inherited from
LocalUtf8StringValueBlock.setValue
toBER
▸ toBER(sizeOnly?
, writer?
): ArrayBuffer
Parameters
Name | Type |
---|---|
sizeOnly? | boolean |
writer? | ViewWriter |
Returns
ArrayBuffer
Inherited from
LocalUtf8StringValueBlock.toBER
toJSON
▸ toJSON(): BaseBlockJson
<LocalStringValueBlockJson
>
Returns
BaseBlockJson
<LocalStringValueBlockJson
>
Inherited from
LocalUtf8StringValueBlock.toJSON
toString
▸ toString(encoding?
): string
Parameters
Name | Type | Default value |
---|---|---|
encoding | StringEncoding | "ascii" |
Returns
string
Inherited from
LocalUtf8StringValueBlock.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
LocalUtf8StringValueBlock.blockName