@stdlib/buffer/to-json/docs/types/index.d.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.
*/

// TypeScript Version: 4.1

/// <reference types="node"/>

import { Buffer } from 'buffer';

/**
* Returns a JSON representation of a `Buffer`.
*
* @param buffer - buffer to serialize
* @throws first argument must be a `Buffer`
* @returns JSON representation
*
* @example
* var array2buffer = require( '@stdlib/buffer/from-array' );
*
* var buf = array2buffer( [ 1, 2 ] );
* // returns <Buffer>
*
* var json = buffer2json( buf );
* // returns { 'type': 'Buffer', 'data': [ 1, 2 ] }
*/
declare function buffer2json( buffer: Buffer ): any;


// EXPORTS //

export = buffer2json;