Module: "bytes"

Index

Variables

setLength
stripZeros

Functions

addHexPrefix
baToJSON
bufferToHex
bufferToInt
fromSigned
setLengthLeft
setLengthRight
toBuffer
toUnsigned
unpad
zeros

Variables

`Const` setLength

• setLength: setLengthLeft = setLengthLeft

Defined in bytes.ts:37

`Const` stripZeros

• stripZeros: unpad = unpad

Defined in bytes.ts:64

Functions

`Const` addHexPrefix

▸ addHexPrefix(str: string): string

Defined in bytes.ts:135

Adds "0x" to a given String if it does not already start with "0x".

Parameters:

Name	Type
`str`	string

Returns: string

`Const` baToJSON

▸ baToJSON(ba: any): any

Defined in bytes.ts:148

Converts a Buffer or Array to JSON.

Parameters:

Name	Type	Description
`ba`	any	(Buffer

Returns: any

(Array|String|null)

`Const` bufferToHex

▸ bufferToHex(buf: Buffer): string

Defined in bytes.ts:111

Converts a Buffer into a 0x-prefixed hex String.

Parameters:

Name	Type	Description
`buf`	Buffer	`Buffer` object to convert

Returns: string

`Const` bufferToInt

▸ bufferToInt(buf: Buffer): number

Defined in bytes.ts:103

Converts a Buffer to a Number.

Parameters:

Name	Type	Description
`buf`	Buffer	`Buffer` object to convert

Returns: number

`Const` fromSigned

▸ fromSigned(num: Buffer): BN

Defined in bytes.ts:120

Interprets a Buffer as a signed integer and returns a BN. Assumes 256-bit numbers.

Parameters:

Name	Type	Description
`num`	Buffer	Signed integer value

Returns: BN

`Const` setLengthLeft

▸ setLengthLeft(msg: any, length: number, right: boolean): any

Defined in bytes.ts:20

Left Pads an Array or Buffer with leading zeros till it has length bytes. Or it truncates the beginning if it exceeds.

Parameters:

Name	Type	Default	Description
`msg`	any	-	the value to pad (Buffer
`length`	number	-	the number of bytes the output should be
`right`	boolean	false	whether to start padding form the left or right

Returns: any

(Buffer|Array)

`Const` setLengthRight

▸ setLengthRight(msg: any, length: number): any

Defined in bytes.ts:46

Right Pads an Array or Buffer with leading zeros till it has length bytes. Or it truncates the beginning if it exceeds.

Parameters:

Name	Type	Description
`msg`	any	the value to pad (Buffer
`length`	number	the number of bytes the output should be

Returns: any

(Buffer|Array)

`Const` toBuffer

▸ toBuffer(v: any): Buffer

Defined in bytes.ts:70

Attempts to turn a value into a Buffer. As input it supports Buffer, String, Number, null/undefined, BN and other objects with a toArray() method.

Parameters:

Name	Type	Description
`v`	any	the value

Returns: Buffer

`Const` toUnsigned

▸ toUnsigned(num: BN): Buffer

Defined in bytes.ts:128

Converts a BN to an unsigned integer and returns it as a Buffer. Assumes 256-bit numbers.

Parameters:

Name	Type	Description
`num`	BN

Returns: Buffer

`Const` unpad

▸ unpad(a: any): any

Defined in bytes.ts:55

Trims leading zeros from a Buffer or an Array.

Parameters:

Name	Type	Description
`a`	any	(Buffer

Returns: any

(Buffer|Array|String)

`Const` zeros

▸ zeros(bytes: number): Buffer

Defined in bytes.ts:8

Returns a buffer filled with 0s.

Parameters:

Name	Type	Description
`bytes`	number	the number of bytes the buffer should be

Returns: Buffer

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

pFad - (p)hone/(F)rame/(a)nonymizer/(d)eclutterfier! Saves Data!