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

​
BrandedBytes5

​
Variables

​
BytesType5

const BytesType5: object
Defined in: src/primitives/Bytes/Bytes5/index.ts:16

​
Type Declaration

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

​
Functions

​
clone()

clone(bytes): Bytes5Type
Defined in: src/primitives/Bytes/Bytes5/clone.js:12 Clone Bytes5

​
Parameters

bytes
Bytes5Type Bytes5 to clone

​
Returns

Bytes5Type Cloned Bytes5

​
Example

const copy = Bytes5.clone(bytes);

​
compare()

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

​
Parameters

a
Uint8Array<ArrayBufferLike>
b
Uint8Array<ArrayBufferLike>

​
Returns

-1 | 0 | 1

​
equals()

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

​
Parameters

a
Uint8Array<ArrayBufferLike>
b
Uint8Array<ArrayBufferLike>

​
Returns

boolean

​
from()

from(value): Bytes5Type
Defined in: src/primitives/Bytes/Bytes5/from.js:8

​
Parameters

value
string | Uint8Array<ArrayBufferLike>

​
Returns

Bytes5Type

​
fromHex()

fromHex(hex): Bytes5Type
Defined in: src/primitives/Bytes/Bytes5/fromHex.js:8

​
Parameters

hex
HexType

​
Returns

Bytes5Type

​
size()

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

​
Parameters

_bytes
Bytes5Type Bytes5

​
Returns

5 Size (always 5)

​
Example

const size = Bytes5.size(bytes); // 5

​
toBytes()

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

​
Parameters

bytes
Bytes5Type Bytes5 to convert

​
Returns

BytesType Generic Bytes

​
Example

const genericBytes = Bytes5.toBytes(bytes);

​
toHex()

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

​
Parameters

bytes
Bytes5Type Bytes5 to convert

​
Returns

HexType Hex string

​
Example

const hex = Bytes5.toHex(bytes);

​
References

​
Bytes5Type

Re-exports Bytes5Type