Skip to content

Commit 34ef986

Browse files
kgrytekgryte
committed
Rename variables
1 parent 7dba744 commit 34ef986

File tree

5 files changed

+32
-36
lines changed

5 files changed

+32
-36
lines changed

‎lib/node_modules/@stdlib/buffer/reviver/README.md‎

Lines changed: 9 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ limitations under the License.
1818
1919
-->
2020

21-
# Reviver
21+
# reviveBuffer
2222

2323
> Revive a JSON-serialized [Buffer][@stdlib/buffer/ctor].
2424
@@ -37,10 +37,10 @@ limitations under the License.
3737
## Usage
3838

3939
```javascript
40-
var reviver = require( '@stdlib/buffer/reviver' );
40+
var reviveBuffer = require( '@stdlib/buffer/reviver' );
4141
```
4242

43-
#### reviver( key, value )
43+
#### reviveBuffer( key, value )
4444

4545
Revives a JSON-serialized [`Buffer`][@stdlib/buffer/ctor].
4646

@@ -49,11 +49,11 @@ var parseJSON = require( '@stdlib/utils/parse-json' );
4949

5050
var str = '{"type":"Buffer","data":[5,3]}';
5151

52-
var buf = parseJSON( str, reviver );
52+
var buf = parseJSON( str, reviveBuffer );
5353
// returns <Buffer>[ 5, 3 ]
5454
```
5555

56-
For details on the JSON serialization format, see [`toJSON()`][@stdlib/buffer/to-json].
56+
For details on the JSON serialization format, see [`@stdlib/buffer/to-json`][@stdlib/buffer/to-json].
5757

5858
</section>
5959

@@ -78,15 +78,15 @@ For details on the JSON serialization format, see [`toJSON()`][@stdlib/buffer/to
7878
```javascript
7979
var array2buffer = require( '@stdlib/buffer/from-array' );
8080
var parseJSON = require( '@stdlib/utils/parse-json' );
81-
var toJSON = require( '@stdlib/buffer/to-json' );
82-
var reviver = require( '@stdlib/buffer/reviver' );
81+
var buffer2json = require( '@stdlib/buffer/to-json' );
82+
var reviveBuffer = require( '@stdlib/buffer/reviver' );
8383

8484
var buf = array2buffer( [ 1, 2 ] );
85-
var str = JSON.stringify( toJSON( buf ) );
85+
var str = JSON.stringify( buffer2json( buf ) );
8686
console.log( str );
8787
// => '{"type":"Buffer","data":[1,2]}'
8888

89-
var out = parseJSON( str, reviver );
89+
var out = parseJSON( str, reviveBuffer );
9090
if ( out instanceof Error ) {
9191
throw out;
9292
}
@@ -126,12 +126,8 @@ console.log( out );
126126

127127
[@stdlib/buffer/ctor]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/buffer/ctor
128128

129-
<!-- <related-links> -->
130-
131129
[@stdlib/buffer/to-json]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/buffer/to-json
132130

133-
<!-- </related-links> -->
134-
135131
</section>
136132

137133
<!-- /.links -->

‎lib/node_modules/@stdlib/buffer/reviver/docs/types/index.d.ts‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -30,12 +30,12 @@
3030
*
3131
* var str = '{"type":"Buffer","data":[5,3]}';
3232
*
33-
* var buf = parseJSON( str, reviver );
33+
* var buf = parseJSON( str, reviveBuffer );
3434
* // returns <Buffer>[ 5, 3 ]
3535
*/
36-
declare function reviver( key: string, value: any ): any;
36+
declare function reviveBuffer( key: string, value: any ): any;
3737

3838

3939
// EXPORTS //
4040

41-
export = reviver;
41+
export = reviveBuffer;

‎lib/node_modules/@stdlib/buffer/reviver/docs/types/test.ts‎

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -16,30 +16,30 @@
1616
* limitations under the License.
1717
*/
1818

19-
import reviver = require( './index' );
19+
import reviveBuffer = require( './index' );
2020

2121

2222
// TESTS //
2323

2424
// The function can be used to revive a serialized object...
2525
{
26-
JSON.parse( '{"type":"Buffer","data":[5,3]}', reviver ); // $ExpectType any
26+
JSON.parse( '{"type":"Buffer","data":[5,3]}', reviveBuffer ); // $ExpectType any
2727
}
2828

2929
// The function does not compile if provided a first argument that is not a string...
3030
{
31-
reviver( true, 1 ); // $ExpectError
32-
reviver( false, 1 ); // $ExpectError
33-
reviver( null, 1 ); // $ExpectError
34-
reviver( undefined, 1 ); // $ExpectError
35-
reviver( 5, 1 ); // $ExpectError
36-
reviver( [], 1 ); // $ExpectError
37-
reviver( {}, 1 ); // $ExpectError
38-
reviver( ( x: number ): number => x, 1 ); // $ExpectError
31+
reviveBuffer( true, 1 ); // $ExpectError
32+
reviveBuffer( false, 1 ); // $ExpectError
33+
reviveBuffer( null, 1 ); // $ExpectError
34+
reviveBuffer( undefined, 1 ); // $ExpectError
35+
reviveBuffer( 5, 1 ); // $ExpectError
36+
reviveBuffer( [], 1 ); // $ExpectError
37+
reviveBuffer( {}, 1 ); // $ExpectError
38+
reviveBuffer( ( x: number ): number => x, 1 ); // $ExpectError
3939
}
4040

4141
// The function does not compile if provided insufficient arguments...
4242
{
43-
reviver(); // $ExpectError
44-
reviver( '{"type":"Buffer","data":[5,3]}' ); // $ExpectError
43+
reviveBuffer(); // $ExpectError
44+
reviveBuffer( '{"type":"Buffer","data":[5,3]}' ); // $ExpectError
4545
}

‎lib/node_modules/@stdlib/buffer/reviver/examples/index.js‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -20,15 +20,15 @@
2020

2121
var array2buffer = require( '@stdlib/buffer/from-array' );
2222
var parseJSON = require( '@stdlib/utils/parse-json' );
23-
var toJSON = require( '@stdlib/buffer/to-json' );
24-
var reviver = require( './../lib' );
23+
var buffer2json = require( '@stdlib/buffer/to-json' );
24+
var revivebuffer = require( './../lib' );
2525

2626
var buf = array2buffer( [ 1, 2 ] );
27-
var str = JSON.stringify( toJSON( buf ) );
27+
var str = JSON.stringify( buffer2json( buf ) );
2828
console.log( str );
2929
// => '{"type":"Buffer","data":[1,2]}'
3030

31-
var out = parseJSON( str, reviver );
31+
var out = parseJSON( str, revivebuffer );
3232
if ( out instanceof Error ) {
3333
throw out;
3434
}

‎lib/node_modules/@stdlib/buffer/reviver/lib/index.js‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -25,19 +25,19 @@
2525
*
2626
* @example
2727
* var parseJSON = require( '@stdlib/utils/parse-json' );
28-
* var reviver = require( '@stdlib/buffer/reviver' );
28+
* var reviveBuffer = require( '@stdlib/buffer/reviver' );
2929
*
3030
* var str = '{"type":"Buffer","data":[5,3]}';
3131
*
32-
* var buf = parseJSON( str, reviver );
32+
* var buf = parseJSON( str, reviveBuffer );
3333
* // returns <Buffer>[ 5, 3 ]
3434
*/
3535

3636
// MODULES //
3737

38-
var reviver = require( './main.js' );
38+
var main = require( './main.js' );
3939

4040

4141
// EXPORTS //
4242

43-
module.exports = reviver;
43+
module.exports = main;

0 commit comments

Comments
 (0)