Auto-generated commit

CHANGELOG.md

@@ -4,7 +4,7 @@
 
 <section class="release" id="unreleased">
 
-## Unreleased (2024-09-14)
+## Unreleased (2024-09-19)
 
 <section class="packages">
 
@@ -20,6 +20,7 @@
 
 ##### Features
 
+-   [`2eded73`](https://github.com/stdlib-js/stdlib/commit/2eded73655c7d803cdbdce88d38af9bc5aab42b0) - add `base64ToUint8Array` to namespace
 -   [`095449b`](https://github.com/stdlib-js/stdlib/commit/095449bc5f6084b363a5b1dc1deb040fd029b76b) - add `atob` to namespace
 
 </section>
@@ -54,6 +55,28 @@
 
 <!-- /.package -->
 
+<section class="package" id="string-base-base64-to-uint8array-unreleased">
+
+#### [@stdlib/string/base/base64-to-uint8array](https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/string/base/base64-to-uint8array)
+
+<details>
+
+<section class="features">
+
+##### Features
+
+-   [`09e7120`](https://github.com/stdlib-js/stdlib/commit/09e71201868eaa8fb1c003c4de270b4002fa900c) - add `string/base/base64-to-uint8array`
+
+</section>
+
+<!-- /.features -->
+
+</details>
+
+</section>
+
+<!-- /.package -->
+
 </section>
 
 <!-- /.packages -->
@@ -76,6 +99,8 @@ A total of 1 person contributed to this release. Thank you to this contributor:
 
 <details>
 
+-   [`2eded73`](https://github.com/stdlib-js/stdlib/commit/2eded73655c7d803cdbdce88d38af9bc5aab42b0) - **feat:** add `base64ToUint8Array` to namespace _(by Athan Reines)_
+-   [`09e7120`](https://github.com/stdlib-js/stdlib/commit/09e71201868eaa8fb1c003c4de270b4002fa900c) - **feat:** add `string/base/base64-to-uint8array` _(by Athan Reines)_
 -   [`f200857`](https://github.com/stdlib-js/stdlib/commit/f2008570f57d9bdaec78ec212fe91858f68cf3ac) - **chore:** fix copyright year _(by Athan Reines)_
 -   [`1c44dbd`](https://github.com/stdlib-js/stdlib/commit/1c44dbd95fa65436eb96e8dfc312d4d08df6c018) - **chore:** add browser entry point _(by Athan Reines)_
 -   [`095449b`](https://github.com/stdlib-js/stdlib/commit/095449bc5f6084b363a5b1dc1deb040fd029b76b) - **feat:** add `atob` to namespace _(by Athan Reines)_

CONTRIBUTORS

@@ -2,6 +2,7 @@
 #
 # Contributors listed in alphabetical order.
 
+Aayush Khanna <[email protected]>
 Adarsh Palaskar <[email protected]>
 Aditya Sapra <[email protected]>
 AgPriyanshu18 <[email protected]>
@@ -39,6 +40,7 @@ Joey Reed <[email protected]>
 Jordan Gallivan <[email protected]>
 Joris Labie <[email protected]>
 Justin Dennison <[email protected]>
+Kaif Mohd <[email protected]>
 Karthik Prakash <[email protected]>
 Khaldon <[email protected]>
 Krishnendu Das <[email protected]>

base/base64-to-uint8array/README.md

@@ -0,0 +1,118 @@
+<!--
+
+@license Apache-2.0
+
+Copyright (c) 2024 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.
+
+-->
+
+# base64ToUint8Array
+
+> Convert a Base64-encoded string to a [Uint8Array][@stdlib/array/uint8].
+
+<!-- Package usage documentation. -->
+
+<section class="usage">
+
+## Usage
+
+<!-- eslint-disable stdlib/no-redeclare -->
+
+```javascript
+var base64ToUint8Array = require( '@stdlib/string/base/base64-to-uint8array' );
+```
+
+#### base64ToUint8Array( str )
+
+Converts a base64-encoded string to a [Uint8Array][@stdlib/array/uint8].
+
+```javascript
+var string2buffer = require( '@stdlib/buffer/from-string' );
+
+var str = string2buffer( 'Hello World!' ).toString( 'base64' );
+// returns 'SGVsbG8gV29ybGQh'
+
+var out = base64ToUint8Array( str );
+// returns <Uint8Array>[ 72, 101, ... ]
+```
+
+</section>
+
+<!-- /.usage -->
+
+<section class="notes">
+
+## Notes
+
+-   The function returns `null` when provided a string containing non-ASCII characters.
+
+</section>
+
+<!-- /.notes -->
+
+<!-- Package usage examples. -->
+
+<section class="examples">
+
+## Examples
+
+```javascript
+var string2buffer = require( '@stdlib/buffer/from-string' );
+var base64ToUint8Array = require( '@stdlib/string/base/base64-to-uint8array' );
+
+var buf = string2buffer( 'Hello World!' ).toString( 'base64' );
+// returns 'SGVsbG8gV29ybGQh'
+
+var arr = base64ToUint8Array( buf );
+// returns <Uint8Array>
+
+buf = string2buffer( 'HELLO WORLD!' ).toString( 'base64' );
+// returns 'SEVMTE8gV09STEQh'
+
+arr = base64ToUint8Array( buf );
+// returns <Uint8Array>
+
+buf = string2buffer( 'To be, or not to be: that is the question.' ).toString( 'base64' );
+// returns 'VG8gYmUsIG9yIG5vdCB0byBiZTogdGhhdCBpcyB0aGUgcXVlc3Rpb24u'
+
+arr = base64ToUint8Array( buf );
+// returns <Uint8Array>
+```
+
+</section>
+
+<!-- /.examples -->
+
+<!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. -->
+
+<section class="related">
+
+</section>
+
+<!-- /.related -->
+
+<!-- Section for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
+
+<section class="links">
+
+[@stdlib/array/uint8]: https://github.com/stdlib-js/array-uint8
+
+<!-- <related-links> -->
+
+<!-- </related-links> -->
+
+</section>
+
+<!-- /.links -->

base/base64-to-uint8array/benchmark/benchmark.js

@@ -0,0 +1,55 @@
+/**
+* @license Apache-2.0
+*
+* Copyright (c) 2024 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.
+*/
+
+'use strict';
+
+// MODULES //
+
+var bench = require( '@stdlib/bench' );
+var isUint8Array = require( '@stdlib/assert/is-uint8array' );
+var pkg = require( './../package.json' ).name;
+var base64ToUint8Array = require( './../lib' );
+
+
+// MAIN //
+
+bench( pkg, function benchmark( b ) {
+	var values;
+	var out;
+	var i;
+
+	values = [
+		'SGVsbG8gV29ybGQh',
+		'VG8gYmUsIG9yIG5vdCB0byBiZTogdGhhdCBpcyB0aGUgcXVlc3Rpb24u',
+		'SEVMTE8gV09STEQh'
+	];
+
+	b.tic();
+	for ( i = 0; i < b.iterations; i++ ) {
+		out = base64ToUint8Array( values[ i%values.length ] );
+		if ( typeof out !== 'object' ) {
+			b.fail( 'should return a Uint8Array' );
+		}
+	}
+	b.toc();
+	if ( !isUint8Array( out ) ) {
+		b.fail( 'should return a Uint8Array' );
+	}
+	b.pass( 'benchmark finished' );
+	b.end();
+});

base/base64-to-uint8array/docs/repl.txt

@@ -0,0 +1,25 @@
+
+{{alias}}( str )
+    Converts a base64-encoded string to a Uint8Array.
+
+    If provided a string containing non-ASCII characters, the function returns
+    `null`.
+
+    Parameters
+    ----------
+    str: string
+        Base64-encoded string.
+
+    Returns
+    -------
+    out: Uint8Array|null
+        Output array.
+
+    Examples
+    --------
+    > var out = {{alias}}( 'SGVsbG8gV29ybGQh' )
+    <Uint8Array>
+
+    See Also
+    --------
+

base/base64-to-uint8array/docs/types/index.d.ts

@@ -0,0 +1,45 @@
+/*
+* @license Apache-2.0
+*
+* Copyright (c) 2024 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: 4.1
+
+/**
+* Converts a base64-encoded string to a Uint8Array.
+*
+* ## Notes
+*
+* -   If provided a string containing non-ASCII characters, the function returns `null`.
+*
+* @param str - base64-encoded string
+* @returns output array
+*
+* @example
+* var string2buffer = require( '@stdlib/buffer/from-string' );
+*
+* var str = string2buffer( 'Hello World!' ).toString( 'base64' );
+* // returns 'SGVsbG8gV29ybGQh'
+*
+* var out = base64ToUint8Array( str );
+* // returns <Uint8Array>[ 72, 101, 108, 108, 111, 32, 87, 111, 114, 108, 100, 33 ]
+*/
+declare function base64ToUint8Array( str: string ): Uint8Array | null;
+
+
+// EXPORTS //
+
+export = base64ToUint8Array;

base/base64-to-uint8array/docs/types/test.ts

@@ -0,0 +1,44 @@
+/*
+* @license Apache-2.0
+*
+* Copyright (c) 2024 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.
+*/
+
+import base64ToUint8Array = require( './index' );
+
+
+// TESTS //
+
+// The function returns a Uint8Array (or null)...
+{
+	base64ToUint8Array( 'Hello World!' ); // $ExpectType Uint8Array | null
+}
+
+// The compiler throws an error if the function is provided a value other than a string...
+{
+	base64ToUint8Array( true ); // $ExpectError
+	base64ToUint8Array( false ); // $ExpectError
+	base64ToUint8Array( null ); // $ExpectError
+	base64ToUint8Array( undefined ); // $ExpectError
+	base64ToUint8Array( 5 ); // $ExpectError
+	base64ToUint8Array( [] ); // $ExpectError
+	base64ToUint8Array( {} ); // $ExpectError
+	base64ToUint8Array( ( x: number ): number => x ); // $ExpectError
+}
+
+// The compiler throws an error if the function is provided insufficient arguments...
+{
+	base64ToUint8Array(); // $ExpectError
+}