index.js (1086B)
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 /** 22 * Return a JSON representation of a `Buffer`. 23 * 24 * @module @stdlib/buffer/to-json 25 * 26 * @example 27 * var array2buffer = require( '@stdlib/buffer/from-array' ); 28 * var toJSON = require( '@stdlib/buffer/to-json' ); 29 * 30 * var buf = array2buffer( [ 1, 2 ] ); 31 * // returns <Buffer> 32 * 33 * var json = toJSON( buf ); 34 * // returns { 'type': 'Buffer', 'data': [ 1, 2 ] } 35 */ 36 37 // MODULES // 38 39 var toJSON = require( './main.js' ); 40 41 42 // EXPORTS // 43 44 module.exports = toJSON;