Files
common/docs/util/modules/_compact_fromu8a_.md
T
2019-02-26 15:09:10 +00:00

38 lines
938 B
Markdown

# Functions
<a id="compactfromu8a"></a>
## compactFromU8a
▸ **compactFromU8a**(_input: *`Uint8Array` \| `string`*, bitLength?: *[BitLength](_compact_types_.md#bitlength)*): [`number`, `BN`]
*Defined in [compact/fromU8a.ts:26](https://github.com/polkadot-js/common/blob/6506c10/packages/util/src/compact/fromU8a.ts#L26)*
*__name__*: compactFromU8a
*__description__*: Retrievs the offset and encoded length from a compact-prefixed value
*__example__*:
```javascript
import { compactFromU8a } from '@polkadot/util';
const [offset, length] = compactFromU8a(new Uint8Array([254, 255, 3, 0]), 32));
console.log('value offset=', offset, 'length=', length); // 4, 0xffff
```
**Parameters:**
| Name | Type | Default value |
| ------ | ------ | ------ |
| _input | `Uint8Array` \| `string` | - |
| `Default value` bitLength | [BitLength](_compact_types_.md#bitlength) | DEFAULT_BITLENGTH |
**Returns:** [`number`, `BN`]
___