Skip to main content

BmpString

Extends​

  • LocalBmpStringValueBlock

Constructors​

new BmpString()​

new BmpString(__namedParameters): BmpString

Parameters​

• __namedParameters: LocalSimpleStringBlockParams = {}

Returns​

BmpString

Overrides​

LocalBmpStringValueBlock.constructor

Properties​

blockLength​

blockLength: number

Inherited from​

LocalBmpStringValueBlock.blockLength

error​

error: string

Inherited from​

LocalBmpStringValueBlock.error

idBlock​

idBlock: LocalIdentificationBlock

Inherited from​

LocalBmpStringValueBlock.idBlock

lenBlock​

lenBlock: LocalLengthBlock

Inherited from​

LocalBmpStringValueBlock.lenBlock

name​

name: string

Inherited from​

LocalBmpStringValueBlock.name

optional​

optional: boolean

Inherited from​

LocalBmpStringValueBlock.optional

primitiveSchema?​

optional primitiveSchema: BaseBlock<ValueBlock, LocalBaseBlockJson>

Inherited from​

LocalBmpStringValueBlock.primitiveSchema

valueBeforeDecodeView​

valueBeforeDecodeView: Uint8Array

Since​

3.0.0

Inherited from​

LocalBmpStringValueBlock.valueBeforeDecodeView

valueBlock​

valueBlock: LocalSimpleStringValueBlock

Inherited from​

LocalBmpStringValueBlock.valueBlock

warnings​

warnings: string[]

Inherited from​

LocalBmpStringValueBlock.warnings

NAME​

static NAME: string = "BMPString"

Overrides​

LocalBmpStringValueBlock.NAME

Accessors​

valueBeforeDecode​

get valueBeforeDecode(): ArrayBuffer

Deprecated​

since version 3.0.0

set valueBeforeDecode(value): void

Deprecated​

since version 3.0.0

Parameters​

• value: ArrayBuffer

Returns​

ArrayBuffer

Inherited from​

LocalBmpStringValueBlock.valueBeforeDecode

Methods​

fromBER()​

fromBER(inputBuffer, inputOffset, inputLength): number

Parameters​

• inputBuffer: Uint8Array | ArrayBuffer

• inputOffset: number

• inputLength: number

Returns​

number

Inherited from​

LocalBmpStringValueBlock.fromBER

fromBuffer()​

fromBuffer(inputBuffer): void

Parameters​

• inputBuffer: Uint8Array | ArrayBuffer

Returns​

void

Inherited from​

LocalBmpStringValueBlock.fromBuffer

fromString()​

fromString(inputString): void

Parameters​

• inputString: string

Returns​

void

Inherited from​

LocalBmpStringValueBlock.fromString

getValue()​

getValue(): string

String value

Returns​

string

Since​

3.0.0

Inherited from​

LocalBmpStringValueBlock.getValue

isEqual()​

isEqual(other): other is BmpString

Determines whether two object instances are equal

Parameters​

• other: unknown

Object to compare with the current object

Returns​

other is BmpString

Inherited from​

LocalBmpStringValueBlock.isEqual

onAsciiEncoding()​

protected onAsciiEncoding(): string

Returns​

string

Inherited from​

LocalBmpStringValueBlock.onAsciiEncoding

setValue()​

setValue(value): void

String value

Parameters​

• value: string

String value

Returns​

void

Since​

3.0.0

Inherited from​

LocalBmpStringValueBlock.setValue

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​

LocalBmpStringValueBlock.toBER

toJSON()​

toJSON(): BaseBlockJson<LocalStringValueBlockJson>

Returns a JSON representation of an object

Returns​

BaseBlockJson<LocalStringValueBlockJson>

JSON object

Inherited from​

LocalBmpStringValueBlock.toJSON

toString()​

toString(encoding): string

Returns a string representation of an object.

Parameters​

• encoding: StringEncoding = "ascii"

Returns​

string

Inherited from​

LocalBmpStringValueBlock.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​

LocalBmpStringValueBlock.blockName