Files
common/docs/util/modules/_u8a_fixlength_.md
T
2019-01-11 10:00:17 +00:00

1.1 KiB

Functions

u8aFixLength

▸ u8aFixLength(value: Uint8Array, bitLength?: number, atStart?: boolean): Uint8Array

Defined in u8a/fixLength.ts:22

name: u8aFixLength

signature: u8aFixLength (value: string, bitLength: number = -1, withPadding: boolean = false): string

summary: Shifts a Uint8Array to a specific bitLength

description: Returns a uint8Array with the specified number of bits contained in the return value. (If bitLength is -1, length checking is not done). Values with more bits are trimmed to the specified length.

example:

import { u8aFixLength } from '@polkadot/util';

u8aFixLength('0x12') // => 0x12
u8aFixLength('0x12', 16) // => 0x0012
u8aFixLength('0x1234', 8) // => 0x12

Parameters:

Name Type Default value
value Uint8Array -
Default value bitLength number -1
Default value atStart boolean false

Returns: Uint8Array