Skip to main content
@tevm/voltaire
@tevm/voltaire / index / BrandedBytes2

​
BrandedBytes2

​
Variables

​
BytesType2

const BytesType2: object
Defined in: src/primitives/Bytes/Bytes2/index.ts:16

​
Type Declaration

clone()
clone: (bytes) => Bytes2Type
Clone Bytes2
Parameters
bytes
Bytes2Type Bytes2 to clone
Returns
Bytes2Type Cloned Bytes2
Example
const copy = Bytes2.clone(bytes);
compare()
compare: (a, b) => -1 | 0 | 1
Parameters
a
Bytes2Type
b
Bytes2Type
Returns
-1 | 0 | 1
equals()
equals: (a, b) => boolean
Parameters
a
Bytes2Type
b
Bytes2Type
Returns
boolean
from()
from: (value) => Bytes2Type
Parameters
value
string | Uint8Array<ArrayBufferLike>
Returns
Bytes2Type
fromHex()
fromHex: (hex) => Bytes2Type
Parameters
hex
HexType
Returns
Bytes2Type
size()
size: (_bytes) => 2
Get size of Bytes2 (always 2)
Parameters
_bytes
Bytes2Type Bytes2
Returns
2 Size (always 2)
Example
const size = Bytes2.size(bytes); // 2
toBytes()
toBytes: (bytes) => BytesType
Convert Bytes2 to generic Bytes
Parameters
bytes
Bytes2Type Bytes2 to convert
Returns
BytesType Generic Bytes
Example
const genericBytes = Bytes2.toBytes(bytes);
toHex()
toHex: (bytes) => HexType
Convert Bytes2 to hex string
Parameters
bytes
Bytes2Type Bytes2 to convert
Returns
HexType Hex string
Example
const hex = Bytes2.toHex(bytes);

​
Functions

​
clone()

clone(bytes): Bytes2Type
Defined in: src/primitives/Bytes/Bytes2/clone.js:12 Clone Bytes2

​
Parameters

bytes
Bytes2Type Bytes2 to clone

​
Returns

Bytes2Type Cloned Bytes2

​
Example

const copy = Bytes2.clone(bytes);

​
compare()

compare(a, b): -1 | 0 | 1
Defined in: src/primitives/Bytes/Bytes2/compare.js:6

​
Parameters

a
Bytes2Type
b
Bytes2Type

​
Returns

-1 | 0 | 1

​
equals()

equals(a, b): boolean
Defined in: src/primitives/Bytes/Bytes2/equals.js:6

​
Parameters

a
Bytes2Type
b
Bytes2Type

​
Returns

boolean

​
from()

from(value): Bytes2Type
Defined in: src/primitives/Bytes/Bytes2/from.js:8

​
Parameters

value
string | Uint8Array<ArrayBufferLike>

​
Returns

Bytes2Type

​
fromHex()

fromHex(hex): Bytes2Type
Defined in: src/primitives/Bytes/Bytes2/fromHex.js:8

​
Parameters

hex
HexType

​
Returns

Bytes2Type

​
size()

size(_bytes): 2
Defined in: src/primitives/Bytes/Bytes2/size.js:12 Get size of Bytes2 (always 2)

​
Parameters

_bytes
Bytes2Type Bytes2

​
Returns

2 Size (always 2)

​
Example

const size = Bytes2.size(bytes); // 2

​
toBytes()

toBytes(bytes): BytesType
Defined in: src/primitives/Bytes/Bytes2/toBytes.js:12 Convert Bytes2 to generic Bytes

​
Parameters

bytes
Bytes2Type Bytes2 to convert

​
Returns

BytesType Generic Bytes

​
Example

const genericBytes = Bytes2.toBytes(bytes);

​
toHex()

toHex(bytes): HexType
Defined in: src/primitives/Bytes/Bytes2/toHex.js:12 Convert Bytes2 to hex string

​
Parameters

bytes
Bytes2Type Bytes2 to convert

​
Returns

HexType Hex string

​
Example

const hex = Bytes2.toHex(bytes);

​
References

​
Bytes2Type

Re-exports Bytes2Type