@stdlib/buffer/reviver/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 reviveBuffer = require( './index' );


// TESTS //

// The function revives a serialized object...
{
	const o = {
		'type': 'Buffer',
		'data': [ 5, 3 ]
	};
	reviveBuffer( 'foo', o ); // $ExpectType any
}

// The compiler throws an error if the function is provided a first argument that is not a string...
{
	reviveBuffer( true, 1 ); // $ExpectError
	reviveBuffer( false, 1 ); // $ExpectError
	reviveBuffer( null, 1 ); // $ExpectError
	reviveBuffer( undefined, 1 ); // $ExpectError
	reviveBuffer( 5, 1 ); // $ExpectError
	reviveBuffer( [], 1 ); // $ExpectError
	reviveBuffer( {}, 1 ); // $ExpectError
	reviveBuffer( ( x: number ): number => x, 1 ); // $ExpectError
}

// The compiler throws an error if the function is provided insufficient arguments...
{
	reviveBuffer(); // $ExpectError
	reviveBuffer( '{"type":"Buffer","data":[5,3]}' ); // $ExpectError
}