@stdlib/buffer/from-buffer/docs/types/test.ts

Buffer.

/*
* @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.
*/

import fromArray = require( './../../../from-array' );
import fromBuffer = require( './index' );

// TESTS //

// The function returns a buffer...
{
	const buf = fromArray( [ 1, 2, 3, 4 ] );
	fromBuffer( buf ); // $ExpectType Buffer
}

// The compiler throws an error if the function is provided a first argument which is not a buffer...
{
	fromBuffer( 'abc' ); // $ExpectError
	fromBuffer( 123 ); // $ExpectError
	fromBuffer( false ); // $ExpectError
	fromBuffer( true ); // $ExpectError
	fromBuffer( null ); // $ExpectError
	fromBuffer( {} ); // $ExpectError
	fromBuffer( [] ); // $ExpectError
	fromBuffer( ( x: number ): number => x ); // $ExpectError
}

// The compiler throws an error if the function is provided an invalid number of arguments...
{
	const buf = fromArray( [ 1, 2, 3, 4 ] );
	fromBuffer(); // $ExpectError
	fromBuffer( buf, 4 ); // $ExpectError
}