main.js (1488B)
1 /** 2 * @license Apache-2.0 3 * 4 * Copyright (c) 2018 The Stdlib Authors. 5 * 6 * Licensed under the Apache License, Version 2.0 (the "License"); 7 * you may not use this file except in compliance with the License. 8 * You may obtain a copy of the License at 9 * 10 * http://www.apache.org/licenses/LICENSE-2.0 11 * 12 * Unless required by applicable law or agreed to in writing, software 13 * distributed under the License is distributed on an "AS IS" BASIS, 14 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 15 * See the License for the specific language governing permissions and 16 * limitations under the License. 17 */ 18 19 'use strict'; 20 21 // MODULES // 22 23 var isBuffer = require( '@stdlib/assert/is-buffer' ); 24 25 26 // MAIN // 27 28 /** 29 * Returns a JSON representation of a `Buffer`. 30 * 31 * @param {Buffer} buffer - buffer to serialize 32 * @throws {TypeError} first argument must be a `Buffer` 33 * @returns {Object} JSON representation 34 * 35 * @example 36 * var array2buffer = require( '@stdlib/buffer/from-array' ); 37 * 38 * var buf = array2buffer( [ 1, 2 ] ); 39 * // returns <Buffer> 40 * 41 * var json = toJSON( buf ); 42 * // returns { 'type': 'Buffer', 'data': [ 1, 2 ] } 43 */ 44 function toJSON( buffer ) { 45 var out; 46 var i; 47 if ( !isBuffer( buffer ) ) { 48 throw new TypeError( 'invalid argument. Must provide a Buffer. Value: `' + buffer + '`.' ); 49 } 50 out = {}; 51 out.type = 'Buffer'; 52 out.data = []; 53 for ( i = 0; i < buffer.length; i++ ) { 54 out.data.push( buffer[ i ] ); 55 } 56 return out; 57 } 58 59 60 // EXPORTS // 61 62 module.exports = toJSON;