124 lines
2.8 KiB
Markdown
124 lines
2.8 KiB
Markdown
|
<!--
|
||
|
|
|
||
|
|
@license Apache-2.0
|
||
|
|
|
||
|
|
Copyright (c) 2018 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.
|
||
|
|
|
||
|
|
-->
|
||
|
|
|
||
|
|
# toJSON
|
||
|
|
|
||
|
|
> Return a [JSON][json] representation of a [Buffer][@stdlib/buffer/ctor].
|
||
|
|
|
||
|
|
<!-- Section to include introductory text. Make sure to keep an empty line after the intro `section` element and another before the `/section` close. -->
|
||
|
|
|
||
|
|
<section class="intro">
|
||
|
|
|
||
|
|
</section>
|
||
|
|
|
||
|
|
<!-- /.intro -->
|
||
|
|
|
||
|
|
<!-- Package usage documentation. -->
|
||
|
|
|
||
|
|
<section class="usage">
|
||
|
|
|
||
|
|
## Usage
|
||
|
|
|
||
|
|
```javascript
|
||
|
|
var toJSON = require( '@stdlib/buffer/to-json' );
|
||
|
|
```
|
||
|
|
|
||
|
|
#### toJSON( buffer )
|
||
|
|
|
||
|
|
Returns a [JSON][json] representation of a [`Buffer`][@stdlib/buffer/ctor].
|
||
|
|
|
||
|
|
```javascript
|
||
|
|
var array2buffer = require( '@stdlib/buffer/from-array' );
|
||
|
|
|
||
|
|
var buf = array2buffer( [ 1, 2 ] );
|
||
|
|
|
||
|
|
var json = toJSON( buf );
|
||
|
|
/* returns
|
||
|
|
{
|
||
|
|
'type': 'Buffer',
|
||
|
|
'data': [ 1, 2 ]
|
||
|
|
}
|
||
|
|
*/
|
||
|
|
```
|
||
|
|
|
||
|
|
For guidance on reviving a JSON-serialized [`Buffer`][@stdlib/buffer/ctor], see [`reviver()`][@stdlib/buffer/reviver].
|
||
|
|
|
||
|
|
</section>
|
||
|
|
|
||
|
|
<!-- /.usage -->
|
||
|
|
|
||
|
|
<!-- Package usage notes. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
|
||
|
|
|
||
|
|
<section class="notes">
|
||
|
|
|
||
|
|
</section>
|
||
|
|
|
||
|
|
<!-- /.notes -->
|
||
|
|
|
||
|
|
<!-- Package usage examples. -->
|
||
|
|
|
||
|
|
<section class="examples">
|
||
|
|
|
||
|
|
## Examples
|
||
|
|
|
||
|
|
<!-- eslint no-undef: "error" -->
|
||
|
|
|
||
|
|
```javascript
|
||
|
|
var allocUnsafe = require( '@stdlib/buffer/alloc-unsafe' );
|
||
|
|
var randint = require( '@stdlib/random/base/discrete-uniform' );
|
||
|
|
var toJSON = require( '@stdlib/buffer/to-json' );
|
||
|
|
|
||
|
|
var buf;
|
||
|
|
var i;
|
||
|
|
|
||
|
|
buf = allocUnsafe( 100 );
|
||
|
|
for ( i = 0; i < buf.length; i++ ) {
|
||
|
|
buf[ i ] = randint( 0, 255 );
|
||
|
|
}
|
||
|
|
|
||
|
|
console.log( toJSON( buf ) );
|
||
|
|
```
|
||
|
|
|
||
|
|
</section>
|
||
|
|
|
||
|
|
<!-- /.examples -->
|
||
|
|
|
||
|
|
<!-- Section to include cited references. If references are included, add a horizontal rule *before* the section. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
|
||
|
|
|
||
|
|
<section class="references">
|
||
|
|
|
||
|
|
</section>
|
||
|
|
|
||
|
|
<!-- /.references -->
|
||
|
|
|
||
|
|
<!-- Section for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
|
||
|
|
|
||
|
|
<section class="links">
|
||
|
|
|
||
|
|
[json]: http://www.json.org/
|
||
|
|
|
||
|
|
[@stdlib/buffer/ctor]: https://www.npmjs.com/package/@stdlib/buffer/tree/main/ctor
|
||
|
|
|
||
|
|
[@stdlib/buffer/reviver]: https://www.npmjs.com/package/@stdlib/buffer/tree/main/reviver
|
||
|
|
|
||
|
|
</section>
|
||
|
|
|
||
|
|
<!-- /.links -->
|