UNPKG

@polkadot/util/buffer/toU8a.d.ts

Version:

490 BTypeScriptView Raw

1/**
* @name bufferToU8a
* @summary Creates a Uint8Array value from a Buffer object.
* @description
* `null` inputs returns an empty result, `Buffer` values return the actual value as a `Uint8Array`. Anything that is not a `Buffer` object throws an error.
* @example
* <BR>
*
* ```javascript
* import { bufferToU8a } from '@polkadot/util';
*
* bufferToU8a(Buffer.from([1, 2, 3]));
* ```
*/
15export declare function bufferToU8a(buffer?: Uint8Array | number[] | null): Uint8Array;

1	`/**`
2	`* @name bufferToU8a`
3	`* @summary Creates a Uint8Array value from a Buffer object.`
4	`* @description`
5	* `null` inputs returns an empty result, `Buffer` values return the actual value as a `Uint8Array`. Anything that is not a `Buffer` object throws an error.
6	`* @example`
7	`* <BR>`
8	`*`
9	* ```javascript
10	`* import { bufferToU8a } from '@polkadot/util';`
11	`*`
12	`* bufferToU8a(Buffer.from([1, 2, 3]));`
13	* ```
14	`*/`
15	`export declare function bufferToU8a(buffer?: Uint8Array \| number[] \| null): Uint8Array;`