-
-
Notifications
You must be signed in to change notification settings - Fork 400
/
index.d.ts
96 lines (87 loc) · 2.83 KB
/
index.d.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
/*
* @license Apache-2.0
*
* Copyright (c) 2021 The Stdlib Authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
// TypeScript Version: 2.0
/* tslint:disable:max-line-length */
/* tslint:disable:max-file-line-count */
import fromBinaryStringUint8 = require( '@stdlib/number/uint8/base/from-binary-string' );
import toBinaryStringUint8 = require( '@stdlib/number/uint8/base/to-binary-string' );
/**
* Interface describing the `base` namespace.
*/
interface Namespace {
/**
* Creates an unsigned 8-bit integer from a literal bit representation.
*
* @param bstr - string which is a literal bit representation
* @throws must provide a string with a length equal to `8`
* @returns unsigned 8-bit integer
*
* @example
* var bstr = '01010101';
* var val = ns.fromBinaryStringUint8( bstr );
* // returns 85
*
* @example
* var bstr = '00000000';
* var val = ns.fromBinaryStringUint8( bstr );
* // returns 0
*
* @example
* var bstr = '00000010';
* var val = ns.fromBinaryStringUint8( bstr );
* // returns 2
*
* @example
* var bstr = '11111111';
* var val = ns.fromBinaryStringUint8( bstr );
* // returns 255
*/
fromBinaryStringUint8: typeof fromBinaryStringUint8;
/**
* Returns a string giving the literal bit representation of an unsigned 8-bit integer.
*
* ## Notes
*
* - Except for typed arrays, JavaScript does not provide native user support for unsigned 8-bit integers. According to the ECMAScript standard, `number` values correspond to double-precision floating-point numbers. While this function is intended for unsigned 8-bit integers, the function will accept floating-point values and represent the values as if they are unsigned 8-bit integers. Accordingly, care should be taken to ensure that only nonnegative integer values less than `256` (`2^8`) are provided.
*
* @param x - input value
* @returns bit representation
*
* @example
* var a = new Uint8Array( [ 1 ] );
* var str = ns.toBinaryStringUint8( a[0] );
* // returns '00000001'
*
* @example
* var a = new Uint8Array( [ 4 ] );
* var str = ns.toBinaryStringUint8( a[0] );
* // returns '00000100'
*
* @example
* var a = new Uint8Array( [ 9 ] );
* var str = ns.toBinaryStringUint8( a[0] );
* // returns '00001001'
*/
toBinaryStringUint8: typeof toBinaryStringUint8;
}
/**
* Base utilities for unsigned 8-bit integers.
*/
declare var ns: Namespace;
// EXPORTS //
export = ns;