@stdlib/fs-read-json 0.2.2 → 0.2.3

package/NOTICE

@@ -1 +1 @@
-Copyright (c) 2016-2024 The Stdlib Authors.
+Copyright (c) 2016-2026 The Stdlib Authors.

package/README.md

@@ -206,7 +206,7 @@ See [LICENSE][stdlib-license].
 
 ## Copyright
 
-Copyright © 2016-2024. The Stdlib [Authors][stdlib-authors].
+Copyright © 2016-2026. The Stdlib [Authors][stdlib-authors].
 
 </section>
 
@@ -219,8 +219,8 @@ Copyright &copy; 2016-2024. The Stdlib [Authors][stdlib-authors].
 [npm-image]: http://img.shields.io/npm/v/@stdlib/fs-read-json.svg
 [npm-url]: https://npmjs.org/package/@stdlib/fs-read-json
 
-[test-image]: https://github.com/stdlib-js/fs-read-json/actions/workflows/test.yml/badge.svg?branch=v0.2.2
-[test-url]: https://github.com/stdlib-js/fs-read-json/actions/workflows/test.yml?query=branch:v0.2.2
+[test-image]: https://github.com/stdlib-js/fs-read-json/actions/workflows/test.yml/badge.svg?branch=v0.2.3
+[test-url]: https://github.com/stdlib-js/fs-read-json/actions/workflows/test.yml?query=branch:v0.2.3
 
 [coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/fs-read-json/main.svg
 [coverage-url]: https://codecov.io/github/stdlib-js/fs-read-json?branch=main
@@ -232,8 +232,8 @@ Copyright &copy; 2016-2024. The Stdlib [Authors][stdlib-authors].
 
 -->
 
-[chat-image]: https://img.shields.io/gitter/room/stdlib-js/stdlib.svg
-[chat-url]: https://app.gitter.im/#/room/#stdlib-js_stdlib:gitter.im
+[chat-image]: https://img.shields.io/badge/zulip-join_chat-brightgreen.svg
+[chat-url]: https://stdlib.zulipchat.com
 
 [stdlib]: https://github.com/stdlib-js/stdlib
 

package/docs/types/index.d.ts

@@ -55,9 +55,9 @@ type Reviver = ( key: string, value: any ) => any;
 * Callback invoked upon reading a file.
 *
 * @param err - error object
-* @param file - file contents
+* @param data - file contents
 */
-type Callback = ( err: Error | null, file: Buffer | string ) => void;
+type Callback<T> = ( err: Error | null, data: T ) => void;
 
 /**
 * Interface for reading a file as JSON.
@@ -85,7 +85,7 @@ interface ReadJSON {
 	*     console.dir( data );
 	* }
 	*/
-	( file: string | Buffer | number, options: Options | string, clbk: Callback ): void;
+	<T = unknown>( file: string | Buffer | number, options: Options | string, clbk: Callback<T> ): void;
 
 	/**
 	* Asynchronously reads a file as JSON.
@@ -105,7 +105,7 @@ interface ReadJSON {
 	*     console.dir( data );
 	* }
 	*/
-	( file: string | Buffer | number, clbk: Callback ): void;
+	<T = unknown>( file: string | Buffer | number, clbk: Callback<T> ): void;
 
 	/**
 	* Synchronously reads a file as JSON.
@@ -127,7 +127,7 @@ interface ReadJSON {
 	* }
 	* console.dir( out );
 	*/
-	sync( file: string | Buffer | number, options?: Options | string ): string | Error;
+	sync<T = unknown>( file: string | Buffer | number, options?: Options | string ): T | Error;
 }
 
 /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stdlib/fs-read-json",
-  "version": "0.2.2",
+  "version": "0.2.3",
   "description": "Read a file as JSON.",
   "license": "Apache-2.0",
   "author": {
@@ -30,13 +30,13 @@
     "url": "https://github.com/stdlib-js/stdlib/issues"
   },
   "dependencies": {
-    "@stdlib/assert-instance-of": "^0.2.2",
+    "@stdlib/assert-instance-of": "^0.3.0",
     "@stdlib/assert-is-function": "^0.2.2",
     "@stdlib/assert-is-plain-object": "^0.2.2",
     "@stdlib/assert-is-string": "^0.2.2",
     "@stdlib/fs-read-file": "^0.2.2",
     "@stdlib/string-format": "^0.2.2",
-    "@stdlib/string-remove-utf8-bom": "^0.2.1",
+    "@stdlib/string-remove-utf8-bom": "^0.2.2",
     "@stdlib/utils-define-nonenumerable-read-only-property": "^0.2.2",
     "@stdlib/utils-parse-json": "^0.2.2",
     "@stdlib/error-tools-fmtprodmsg": "^0.2.2"