@ohos-ports/stdlib-process-read-stdin 0.0.0-stage → 0.2.3-beta.0

package/LICENSE

@@ -0,0 +1,177 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS

package/NOTICE

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

package/README.md

@@ -1,3 +1,243 @@
-# Temporary Holding Version
+<!--
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+@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.
+
+-->
+
+
+<details>
+  <summary>
+    About stdlib...
+  </summary>
+  <p>We believe in a future in which the web is a preferred environment for numerical computation. To help realize this future, we've built stdlib. stdlib is a standard library, with an emphasis on numerical and scientific computation, written in JavaScript (and C) for execution in browsers and in Node.js.</p>
+  <p>The library is fully decomposable, being architected in such a way that you can swap out and mix and match APIs and functionality to cater to your exact preferences and use cases.</p>
+  <p>When you use stdlib, you can be absolutely certain that you are using the most thorough, rigorous, well-written, studied, documented, tested, measured, and high-quality code out there.</p>
+  <p>To join us in bringing numerical computing to the web, get started by checking us out on <a href="https://github.com/stdlib-js/stdlib">GitHub</a>, and please consider <a href="https://opencollective.com/stdlib">financially supporting stdlib</a>. We greatly appreciate your continued support!</p>
+</details>
+
+# stdin
+
+[![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url] <!-- [![dependencies][dependencies-image]][dependencies-url] -->
+
+> Read data from [`stdin`][@stdlib/streams/node/stdin].
+
+<section class="installation">
+
+## Installation
+
+```bash
+npm install @stdlib/process-read-stdin
+```
+
+</section>
+
+<section class="usage">
+
+## Usage
+
+```javascript
+var stdin = require( '@stdlib/process-read-stdin' );
+```
+
+#### stdin( \[encoding,] clbk )
+
+Reads data from [`stdin`][@stdlib/streams/node/stdin].
+
+<!-- run-disable -->
+
+```javascript
+function onRead( error, data ) {
+    if ( error ) {
+        return console.error( 'Error: %s', error.message );
+    }
+    console.log( data.toString() );
+    // => '...'
+}
+
+stdin( onRead );
+```
+
+By default, returned `data` is a [`Buffer`][buffer]. To return a `string` of a specified encoding, provide an `encoding` parameter.
+
+<!-- run-disable -->
+
+```javascript
+function onRead( error, data ) {
+    if ( error ) {
+        return console.error( 'Error: %s', error.message );
+    }
+    console.log( data );
+    // => '...'
+}
+
+stdin( 'utf8', onRead );
+```
+
+When a file's calling Node.js process is running in a [TTY][tty] context (i.e., no [`stdin`][@stdlib/streams/node/stdin]), `data` will either be an empty [`Buffer`][buffer] (no encoding provided) or an empty `string` (encoding provided).
+
+<!-- run-disable -->
+
+```javascript
+var stream = require( '@stdlib/streams-node-stdin' );
+
+function onRead( error, data ) {
+    if ( error ) {
+        return console.error( 'Error: %s', error.message );
+    }
+    console.log( data );
+    // => ''
+}
+
+stream.isTTY = true;
+
+stdin( 'utf8', onRead );
+```
+
+</section>
+
+<!-- /.usage -->
+
+<section class="examples">
+
+## Examples
+
+<!-- run-disable -->
+
+<!-- eslint no-undef: "error" -->
+
+```javascript
+var string2buffer = require( '@stdlib/buffer-from-string' );
+var stream = require( '@stdlib/streams-node-stdin' );
+var stdin = require( '@stdlib/process-read-stdin' );
+
+function onRead( error, data ) {
+    if ( error ) {
+        console.error( 'Error: %s', error.message );
+    } else {
+        console.log( data.toString() );
+        // => 'beep boop'
+    }
+}
+
+// Fake not being in a terminal context:
+stream.isTTY = false;
+
+// Provide a callback to consume all data from `stdin`:
+stdin( onRead );
+
+// Push some data to `stdin`:
+stream.push( string2buffer( 'beep' ) );
+stream.push( string2buffer( ' ' ) );
+stream.push( string2buffer( 'boop' ) );
+
+// End the stream:
+stream.push( null );
+```
+
+</section>
+
+<!-- /.examples -->
+
+<!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. -->
+
+<section class="related">
+
+</section>
+
+<!-- /.related -->
+
+<!-- Section for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
+
+
+<section class="main-repo" >
+
+* * *
+
+## Notice
+
+This package is part of [stdlib][stdlib], a standard library for JavaScript and Node.js, with an emphasis on numerical and scientific computing. The library provides a collection of robust, high performance libraries for mathematics, statistics, streams, utilities, and more.
+
+For more information on the project, filing bug reports and feature requests, and guidance on how to develop [stdlib][stdlib], see the main project [repository][stdlib].
+
+#### Community
+
+[![Chat][chat-image]][chat-url]
+
+---
+
+## License
+
+See [LICENSE][stdlib-license].
+
+
+## Copyright
+
+Copyright &copy; 2016-2026. The Stdlib [Authors][stdlib-authors].
+
+</section>
+
+<!-- /.stdlib -->
+
+<!-- Section for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
+
+<section class="links">
+
+[npm-image]: http://img.shields.io/npm/v/@stdlib/process-read-stdin.svg
+[npm-url]: https://npmjs.org/package/@stdlib/process-read-stdin
+
+[test-image]: https://github.com/stdlib-js/process-read-stdin/actions/workflows/test.yml/badge.svg?branch=v0.2.3
+[test-url]: https://github.com/stdlib-js/process-read-stdin/actions/workflows/test.yml?query=branch:v0.2.3
+
+[coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/process-read-stdin/main.svg
+[coverage-url]: https://codecov.io/github/stdlib-js/process-read-stdin?branch=main
+
+<!--
+
+[dependencies-image]: https://img.shields.io/david/stdlib-js/process-read-stdin.svg
+[dependencies-url]: https://david-dm.org/stdlib-js/process-read-stdin/main
+
+-->
+
+[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
+
+[stdlib-authors]: https://github.com/stdlib-js/stdlib/graphs/contributors
+
+[umd]: https://github.com/umdjs/umd
+[es-module]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules
+
+[deno-url]: https://github.com/stdlib-js/process-read-stdin/tree/deno
+[deno-readme]: https://github.com/stdlib-js/process-read-stdin/blob/deno/README.md
+[umd-url]: https://github.com/stdlib-js/process-read-stdin/tree/umd
+[umd-readme]: https://github.com/stdlib-js/process-read-stdin/blob/umd/README.md
+[esm-url]: https://github.com/stdlib-js/process-read-stdin/tree/esm
+[esm-readme]: https://github.com/stdlib-js/process-read-stdin/blob/esm/README.md
+[branches-url]: https://github.com/stdlib-js/process-read-stdin/blob/main/branches.md
+
+[stdlib-license]: https://raw.githubusercontent.com/stdlib-js/process-read-stdin/main/LICENSE
+
+[buffer]: https://nodejs.org/api/buffer.html
+
+[tty]: https://nodejs.org/api/tty.html#tty_tty
+
+[@stdlib/streams/node/stdin]: https://www.npmjs.com/package/@stdlib/streams-node-stdin
+
+</section>
+
+<!-- /.links -->

package/SECURITY.md

@@ -0,0 +1,5 @@
+# Security
+
+> Policy for reporting security vulnerabilities.
+
+See the security policy [in the main project repository](https://github.com/stdlib-js/stdlib/security).

package/dist/index.d.ts

@@ -0,0 +1,3 @@
+/// <reference path="../docs/types/index.d.ts" />
+import stdin from '../docs/types/index';
+export = stdin;

package/dist/index.js

@@ -0,0 +1,5 @@
+"use strict";var m=function(r,e){return function(){return e||r((e={exports:{}}).exports,e),e.exports}};var l=m(function(T,s){
+var d=require('@stdlib/assert-is-function/dist'),b=require('@stdlib/assert-is-string/dist').isPrimitive,q=require('@stdlib/buffer-ctor/dist'),a=require('@stdlib/buffer-from-string/dist'),t=require('@stdlib/streams-node-stdin/dist'),h=require('@stdlib/utils-next-tick/dist'),o=require('@stdlib/error-tools-fmtprodmsg/dist');function k(){var r,e,i,u;if(arguments.length===1)r=arguments[0];else{if(i=arguments[0],!b(i))throw new TypeError(o('0nj6q',i));r=arguments[1]}if(!d(r))throw new TypeError(o('0nj2b',r));if(i&&t.setEncoding(i),t.isTTY)return h(f);e=[],u=0,t.on("readable",c),t.on("error",g),t.on("end",v);function f(){if(i)return r(null,"");r(null,a(""))}function c(){for(var n;n=t.read(),n!==null;)typeof n=="string"&&(n=a(n)),e.push(n),u+=n.length}function g(n){r(n)}function v(){if(i)return r(null,e.join(""));r(null,q.concat(e,u))}}s.exports=k
+});var p=l();module.exports=p;
+/** @license Apache-2.0 */
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../lib/main.js", "../lib/index.js"],
+  "sourcesContent": ["/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n*    http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nvar isFunction = require( '@stdlib/assert-is-function' );\nvar isString = require( '@stdlib/assert-is-string' ).isPrimitive;\nvar Buffer = require( '@stdlib/buffer-ctor' );\nvar string2buffer = require( '@stdlib/buffer-from-string' );\nvar stream = require( '@stdlib/streams-node-stdin' );\nvar nextTick = require( '@stdlib/utils-next-tick' );\nvar format = require( '@stdlib/string-format' );\n\n\n// MAIN //\n\n/**\n* Reads data from `stdin`.\n*\n* @param {(string|null)} [encoding] - string encoding. If set, data will be returned as an encoded `string`.\n* @param {Function} clbk - callback to be invoked upon reading all data from `stdin`\n* @throws {TypeError} `encoding` argument must be a string\n* @throws {TypeError} callback argument must be a function\n* @returns {void}\n*\n* @example\n* function onRead( error, data ) {\n*     if ( error ) {\n*         throw error;\n*     }\n*     console.log( data.toString() );\n*     // => '...'\n* }\n*\n* stdin( onRead );\n*\n* @example\n* function onRead( error, data ) {\n*     if ( error ) {\n*         throw error;\n*     }\n*     console.log( data );\n*     // => '...'\n* }\n*\n* stdin( 'utf8', onRead );\n*/\nfunction stdin() {\n\tvar clbk;\n\tvar data;\n\tvar enc;\n\tvar len;\n\n\tif ( arguments.length === 1 ) {\n\t\tclbk = arguments[ 0 ];\n\t} else {\n\t\tenc = arguments[ 0 ];\n\t\tif ( !isString( enc ) ) {\n\t\t\tthrow new TypeError( format( 'invalid argument. Encoding argument must be a string. Value: `%s`.', enc ) );\n\t\t}\n\t\tclbk = arguments[ 1 ];\n\t}\n\tif ( !isFunction( clbk ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Callback argument must be a function. Value: `%s`.', clbk ) );\n\t}\n\tif ( enc ) {\n\t\tstream.setEncoding( enc );\n\t}\n\t// If the calling file is being run as a script and not as part of a pipeline, we should not expect to receive anything on `stdin`.\n\tif ( stream.isTTY ) {\n\t\treturn nextTick( onTick );\n\t}\n\tdata = [];\n\tlen = 0;\n\n\tstream.on( 'readable', onReadable );\n\tstream.on( 'error', onError );\n\tstream.on( 'end', onEnd );\n\n\t/**\n\t* Callback invoked after the next tick.\n\t*\n\t* @private\n\t* @returns {void}\n\t*/\n\tfunction onTick() {\n\t\tif ( enc ) {\n\t\t\treturn clbk( null, '' );\n\t\t}\n\t\tclbk( null, string2buffer( '' ) );\n\t}\n\n\t/**\n\t* Callback invoked once the stream has data to consume.\n\t*\n\t* @private\n\t*/\n\tfunction onReadable() {\n\t\tvar chunk;\n\t\twhile ( true ) {\n\t\t\tchunk = stream.read();\n\t\t\tif ( chunk === null ) {\n\t\t\t\tbreak;\n\t\t\t}\n\t\t\tif ( typeof chunk === 'string' ) {\n\t\t\t\tchunk = string2buffer( chunk );\n\t\t\t}\n\t\t\tdata.push( chunk );\n\t\t\tlen += chunk.length;\n\t\t}\n\t}\n\n\t/**\n\t* Callback invoked upon encountering a stream error.\n\t*\n\t* @private\n\t* @param {Error} error - error object\n\t*/\n\tfunction onError( error ) {\n\t\tclbk( error );\n\t}\n\n\t/**\n\t* Callback invoked after all data has been consumed.\n\t*\n\t* @private\n\t* @returns {void}\n\t*/\n\tfunction onEnd() {\n\t\tif ( enc ) {\n\t\t\t// Return a string...\n\t\t\treturn clbk( null, data.join( '' ) );\n\t\t}\n\t\t// Return a buffer...\n\t\tclbk( null, Buffer.concat( data, len ) );\n\t}\n}\n\n\n// EXPORTS //\n\nmodule.exports = stdin;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n*    http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n/**\n* Read data from `stdin`.\n*\n* @module @stdlib/process-read-stdin\n*\n* @example\n* var stdin = require( '@stdlib/process-read-stdin' );\n*\n* function onRead( error, data ) {\n*     if ( error ) {\n*         throw error;\n*     }\n*     console.log( data.toString() );\n*     // returns '...'\n* }\n*\n* stdin( onRead );\n*/\n\n// MODULES //\n\nvar main = require( './main.js' );\n\n\n// EXPORTS //\n\nmodule.exports = main;\n"],
+  "mappings": "uGAAA,IAAAA,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAa,QAAS,4BAA6B,EACnDC,EAAW,QAAS,0BAA2B,EAAE,YACjDC,EAAS,QAAS,qBAAsB,EACxCC,EAAgB,QAAS,4BAA6B,EACtDC,EAAS,QAAS,4BAA6B,EAC/CC,EAAW,QAAS,yBAA0B,EAC9CC,EAAS,QAAS,uBAAwB,EAoC9C,SAASC,GAAQ,CAChB,IAAIC,EACAC,EACAC,EACAC,EAEJ,GAAK,UAAU,SAAW,EACzBH,EAAO,UAAW,CAAE,MACd,CAEN,GADAE,EAAM,UAAW,CAAE,EACd,CAACT,EAAUS,CAAI,EACnB,MAAM,IAAI,UAAWJ,EAAQ,qEAAsEI,CAAI,CAAE,EAE1GF,EAAO,UAAW,CAAE,CACrB,CACA,GAAK,CAACR,EAAYQ,CAAK,EACtB,MAAM,IAAI,UAAWF,EAAQ,uEAAwEE,CAAK,CAAE,EAM7G,GAJKE,GACJN,EAAO,YAAaM,CAAI,EAGpBN,EAAO,MACX,OAAOC,EAAUO,CAAO,EAEzBH,EAAO,CAAC,EACRE,EAAM,EAENP,EAAO,GAAI,WAAYS,CAAW,EAClCT,EAAO,GAAI,QAASU,CAAQ,EAC5BV,EAAO,GAAI,MAAOW,CAAM,EAQxB,SAASH,GAAS,CACjB,GAAKF,EACJ,OAAOF,EAAM,KAAM,EAAG,EAEvBA,EAAM,KAAML,EAAe,EAAG,CAAE,CACjC,CAOA,SAASU,GAAa,CAErB,QADIG,EAEHA,EAAQZ,EAAO,KAAK,EACfY,IAAU,MAGV,OAAOA,GAAU,WACrBA,EAAQb,EAAea,CAAM,GAE9BP,EAAK,KAAMO,CAAM,EACjBL,GAAOK,EAAM,MAEf,CAQA,SAASF,EAASG,EAAQ,CACzBT,EAAMS,CAAM,CACb,CAQA,SAASF,GAAQ,CAChB,GAAKL,EAEJ,OAAOF,EAAM,KAAMC,EAAK,KAAM,EAAG,CAAE,EAGpCD,EAAM,KAAMN,EAAO,OAAQO,EAAME,CAAI,CAAE,CACxC,CACD,CAKAZ,EAAO,QAAUQ,ICrHjB,IAAIW,EAAO,IAKX,OAAO,QAAUA",
+  "names": ["require_main", "__commonJSMin", "exports", "module", "isFunction", "isString", "Buffer", "string2buffer", "stream", "nextTick", "format", "stdin", "clbk", "data", "enc", "len", "onTick", "onReadable", "onError", "onEnd", "chunk", "error", "main"]
+}

package/docs/types/index.d.ts

@@ -0,0 +1,108 @@
+/*
+* @license Apache-2.0
+*
+* Copyright (c) 2021 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.
+*/
+
+// TypeScript Version: 4.1
+
+/// <reference types="node"/>
+
+import { Buffer } from 'buffer';
+
+/**
+* Callback invoked upon reading all data from `stdin`.
+*
+* @param err - error object
+* @param data - data contents
+*/
+type Callback = ( err: Error | null, data: Buffer | string ) => void;
+
+/**
+* Interface for reading from `stdin`.
+*/
+interface StdIn {
+	/**
+	* Reads data from `stdin`.
+	*
+	* @param encoding - string encoding. If set, data will be returned as an encoded `string`
+	* @param clbk - callback to be invoked upon reading all data from `stdin`
+	*
+	* @example
+	* function onRead( error, data ) {
+	*     if ( error ) {
+	*         throw error;
+	*     }
+	*     console.log( data );
+	*     // => '...'
+	* }
+	*
+	* stdin( 'utf8', onRead );
+	*/
+	( encoding: string | null, clbk: Callback ): void;
+
+	/**
+	* Reads data from `stdin`.
+	*
+	* @param clbk - callback to be invoked upon reading all data from `stdin`
+	*
+	* @example
+	* function onRead( error, data ) {
+	*     if ( error ) {
+	*         throw error;
+	*     }
+	*     console.log( data.toString() );
+	*     // => '...'
+	* }
+	*
+	* stdin( onRead );
+	*/
+	( clbk: Callback ): void;
+}
+
+/**
+* Reads data from `stdin`.
+*
+* @param encoding - string encoding. If set, data will be returned as an encoded `string`
+* @param clbk - callback to be invoked upon reading all data from `stdin`
+*
+* @example
+* function onRead( error, data ) {
+*     if ( error ) {
+*         throw error;
+*     }
+*     console.log( data.toString() );
+*     // => '...'
+* }
+*
+* stdin( onRead );
+*
+* @example
+* function onRead( error, data ) {
+*     if ( error ) {
+*         throw error;
+*     }
+*     console.log( data );
+*     // => '...'
+* }
+*
+* stdin( 'utf8', onRead );
+*/
+declare var stdin: StdIn;
+
+
+// EXPORTS //
+
+export = stdin;

package/lib/browser.js

@@ -0,0 +1,66 @@
+/**
+* @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.
+*/
+
+'use strict';
+
+// MODULES //
+
+var isFunction = require( '@stdlib/assert-is-function' );
+var format = require( '@stdlib/string-format' );
+
+
+// MAIN //
+
+/**
+* Browser shim.
+*
+* @private
+* @param {(string|null)} [encoding] - string encoding
+* @param {Callback} clbk - callback to be invoked upon completion
+* @throws {TypeError} callback argument must be a function
+*
+* @example
+* function onRead( error ) {
+*     if ( error ) {
+*         return console.error( error.message );
+*     }
+* }
+*
+* stdin( onRead );
+*/
+function stdin() {
+	var clbk = arguments[ arguments.length-1 ];
+	if ( !isFunction( clbk ) ) {
+		throw new TypeError( format( 'invalid argument. Callback argument must be a function. Value: `%s`.', clbk ) );
+	}
+	setTimeout( onTimeout, 0 );
+
+	/**
+	* Callback invoked upon a timeout.
+	*
+	* @private
+	*/
+	function onTimeout() {
+		clbk( new Error( 'invalid operation. The environment does not support reading from `stdin`.' ) );
+	}
+}
+
+
+// EXPORTS //
+
+module.exports = stdin;

package/lib/index.js

@@ -0,0 +1,47 @@
+/**
+* @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.
+*/
+
+'use strict';
+
+/**
+* Read data from `stdin`.
+*
+* @module @stdlib/process-read-stdin
+*
+* @example
+* var stdin = require( '@stdlib/process-read-stdin' );
+*
+* function onRead( error, data ) {
+*     if ( error ) {
+*         throw error;
+*     }
+*     console.log( data.toString() );
+*     // returns '...'
+* }
+*
+* stdin( onRead );
+*/
+
+// MODULES //
+
+var main = require( './main.js' );
+
+
+// EXPORTS //
+
+module.exports = main;

package/lib/main.js

@@ -0,0 +1,159 @@
+/**
+* @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.
+*/
+
+'use strict';
+
+// MODULES //
+
+var isFunction = require( '@stdlib/assert-is-function' );
+var isString = require( '@stdlib/assert-is-string' ).isPrimitive;
+var Buffer = require( '@stdlib/buffer-ctor' );
+var string2buffer = require( '@stdlib/buffer-from-string' );
+var stream = require( '@stdlib/streams-node-stdin' );
+var nextTick = require( '@stdlib/utils-next-tick' );
+var format = require( '@stdlib/string-format' );
+
+
+// MAIN //
+
+/**
+* Reads data from `stdin`.
+*
+* @param {(string|null)} [encoding] - string encoding. If set, data will be returned as an encoded `string`.
+* @param {Function} clbk - callback to be invoked upon reading all data from `stdin`
+* @throws {TypeError} `encoding` argument must be a string
+* @throws {TypeError} callback argument must be a function
+* @returns {void}
+*
+* @example
+* function onRead( error, data ) {
+*     if ( error ) {
+*         throw error;
+*     }
+*     console.log( data.toString() );
+*     // => '...'
+* }
+*
+* stdin( onRead );
+*
+* @example
+* function onRead( error, data ) {
+*     if ( error ) {
+*         throw error;
+*     }
+*     console.log( data );
+*     // => '...'
+* }
+*
+* stdin( 'utf8', onRead );
+*/
+function stdin() {
+	var clbk;
+	var data;
+	var enc;
+	var len;
+
+	if ( arguments.length === 1 ) {
+		clbk = arguments[ 0 ];
+	} else {
+		enc = arguments[ 0 ];
+		if ( !isString( enc ) ) {
+			throw new TypeError( format( 'invalid argument. Encoding argument must be a string. Value: `%s`.', enc ) );
+		}
+		clbk = arguments[ 1 ];
+	}
+	if ( !isFunction( clbk ) ) {
+		throw new TypeError( format( 'invalid argument. Callback argument must be a function. Value: `%s`.', clbk ) );
+	}
+	if ( enc ) {
+		stream.setEncoding( enc );
+	}
+	// If the calling file is being run as a script and not as part of a pipeline, we should not expect to receive anything on `stdin`.
+	if ( stream.isTTY ) {
+		return nextTick( onTick );
+	}
+	data = [];
+	len = 0;
+
+	stream.on( 'readable', onReadable );
+	stream.on( 'error', onError );
+	stream.on( 'end', onEnd );
+
+	/**
+	* Callback invoked after the next tick.
+	*
+	* @private
+	* @returns {void}
+	*/
+	function onTick() {
+		if ( enc ) {
+			return clbk( null, '' );
+		}
+		clbk( null, string2buffer( '' ) );
+	}
+
+	/**
+	* Callback invoked once the stream has data to consume.
+	*
+	* @private
+	*/
+	function onReadable() {
+		var chunk;
+		while ( true ) {
+			chunk = stream.read();
+			if ( chunk === null ) {
+				break;
+			}
+			if ( typeof chunk === 'string' ) {
+				chunk = string2buffer( chunk );
+			}
+			data.push( chunk );
+			len += chunk.length;
+		}
+	}
+
+	/**
+	* Callback invoked upon encountering a stream error.
+	*
+	* @private
+	* @param {Error} error - error object
+	*/
+	function onError( error ) {
+		clbk( error );
+	}
+
+	/**
+	* Callback invoked after all data has been consumed.
+	*
+	* @private
+	* @returns {void}
+	*/
+	function onEnd() {
+		if ( enc ) {
+			// Return a string...
+			return clbk( null, data.join( '' ) );
+		}
+		// Return a buffer...
+		clbk( null, Buffer.concat( data, len ) );
+	}
+}
+
+
+// EXPORTS //
+
+module.exports = stdin;

package/package.json

@@ -1,6 +1,80 @@
 {
   "name": "@ohos-ports/stdlib-process-read-stdin",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "0.2.3-beta.0",
+  "description": "Read data from stdin.",
+  "license": "Apache-2.0",
+  "author": {
+    "name": "The Stdlib Authors",
+    "url": "https://github.com/stdlib-js/stdlib/graphs/contributors"
+  },
+  "contributors": [
+    {
+      "name": "The Stdlib Authors",
+      "url": "https://github.com/stdlib-js/stdlib/graphs/contributors"
+    }
+  ],
+  "main": "./lib",
+  "browser": "./lib/browser.js",
+  "directories": {
+    "doc": "./docs",
+    "lib": "./lib",
+    "dist": "./dist"
+  },
+  "types": "./docs/types",
+  "scripts": {},
+  "homepage": "https://stdlib.io",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/ohos-ports/ohos-ports.git",
+    "directory": "ports/stdlib-process-read-stdin/0.2.3"
+  },
+  "bugs": {
+    "url": "https://github.com/ohos-ports/ohos-ports/issues"
+  },
+  "dependencies": {
+    "@stdlib/assert-is-function": "^0.2.3",
+    "@stdlib/assert-is-string": "^0.2.3",
+    "@stdlib/buffer-ctor": "^0.2.2",
+    "@stdlib/buffer-from-string": "^0.2.2",
+    "@stdlib/streams-node-stdin": "^0.2.3",
+    "@stdlib/string-format": "^0.2.3",
+    "@stdlib/utils-next-tick": "^0.2.3",
+    "@stdlib/error-tools-fmtprodmsg": "^0.2.3"
+  },
+  "devDependencies": {},
+  "engines": {
+    "node": ">=0.10.0",
+    "npm": ">2.7.0"
+  },
+  "os": [
+    "aix",
+    "darwin",
+    "freebsd",
+    "linux",
+    "macos",
+    "openbsd",
+    "sunos",
+    "win32",
+    "windows",
+    "openharmony"
+  ],
+  "keywords": [
+    "stdlib",
+    "stdutils",
+    "stdutil",
+    "utils",
+    "util",
+    "utilities",
+    "utility",
+    "process",
+    "stdin",
+    "tty",
+    "input",
+    "data",
+    "stream"
+  ],
+  "funding": {
+    "type": "opencollective",
+    "url": "https://opencollective.com/stdlib"
+  }
+}