Release v0.1.0

.editorconfig

@@ -179,3 +179,8 @@ indent_size = 2
 [*.gypi]
 indent_style = space
 indent_size = 2
+
+# Set properties for citation files:
+[*.{cff,cff.txt}]
+indent_style = space
+indent_size = 2

.github/workflows/productionize.yml

@@ -81,21 +81,6 @@ jobs:
         id: transform-error-messages
         uses: stdlib-js/transform-errors-action@main
 
-      # Format error messages:
-      - name: 'Replace double quotes with single quotes in rewritten format string error messages'
-        run: |
-          find . -name "*.js" -exec sed -E -i "s/Error\( format\( \"([a-zA-Z0-9]+)\"/Error\( format\( '\1'/g" {} \;
-
-      # Format string literal error messages:
-      - name: 'Replace double quotes with single quotes in rewritten string literal error messages'
-        run: |
-          find . -name "*.js" -exec sed -E -i "s/Error\( format\(\"([a-zA-Z0-9]+)\"\)/Error\( format\( '\1' \)/g" {} \;
-
-      # Format code:
-      - name: 'Replace double quotes with single quotes in inserted `require` calls'
-        run: |
-          find . -name "*.js" -exec sed -E -i "s/require\( ?\"@stdlib\/error-tools-fmtprodmsg\" ?\);/require\( '@stdlib\/error-tools-fmtprodmsg' \);/g" {} \;
-
       # Change `@stdlib/string-format` to `@stdlib/error-tools-fmtprodmsg` in package.json if the former is a dependency, otherwise insert it as a dependency:
       - name: 'Update dependencies in package.json'
         run: |

CITATION.cff

@@ -0,0 +1,30 @@
+cff-version: 1.2.0
+title: stdlib
+message: >-
+  If you use this software, please cite it using the
+  metadata from this file.
+
+type: software
+
+authors:
+  - name: The Stdlib Authors
+    url: https://github.com/stdlib-js/stdlib/graphs/contributors
+
+repository-code: https://github.com/stdlib-js/stdlib
+url: https://stdlib.io
+
+abstract: |
+  Standard library for JavaScript and Node.js.
+
+keywords:
+  - JavaScript
+  - Node.js
+  - TypeScript
+  - standard library
+  - scientific computing
+  - numerical computing
+  - statistical computing
+
+license: Apache-2.0 AND BSL-1.0
+
+date-released: 2016

README.md

@@ -18,6 +18,17 @@ 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>
+
 # Abbreviated Help
 
 [![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url] <!-- [![dependencies][dependencies-image]][dependencies-url] -->
@@ -245,8 +256,8 @@ Copyright &copy; 2016-2023. The Stdlib [Authors][stdlib-authors].
 [npm-image]: http://img.shields.io/npm/v/@stdlib/repl-info.svg
 [npm-url]: https://npmjs.org/package/@stdlib/repl-info
 
-[test-image]: https://github.com/stdlib-js/repl-info/actions/workflows/test.yml/badge.svg?branch=main
-[test-url]: https://github.com/stdlib-js/repl-info/actions/workflows/test.yml?query=branch:main
+[test-image]: https://github.com/stdlib-js/repl-info/actions/workflows/test.yml/badge.svg?branch=v0.1.0
+[test-url]: https://github.com/stdlib-js/repl-info/actions/workflows/test.yml?query=branch:v0.1.0
 
 [coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/repl-info/main.svg
 [coverage-url]: https://codecov.io/github/stdlib-js/repl-info?branch=main

data/data.csv

@@ -145,9 +145,10 @@ base.coth,"\nbase.coth( x:number )\n    Computes the hyperbolic cotangent of a n
 base.covercos,"\nbase.covercos( x:number )\n    Computes the coversed cosine.\n"
 base.coversin,"\nbase.coversin( x:number )\n    Computes the coversed sine.\n"
 base.cphase,"\nbase.cphase( z:Complex128 )\n    Computes the argument of a double-precision complex floating-point number\n    in radians.\n"
-base.cpolar,"\nbase.cpolar( [out:Array|TypedArray|Object,] re:number, im:number )\n    Returns the absolute value and phase of a complex number.\n"
+base.cpolar,"\nbase.cpolar( z:Complex128 )\n    Returns the absolute value and phase of a double-precision complex\n    floating-point number.\n"
+base.cpolar.assign,"\nbase.cpolar.assign( z:Complex128, out:Array|TypedArray|Object, stride:integer, \n  offset:integer )\n    Returns the absolute value and phase of a double-precision complex\n    floating-point number and assigns results to a provided output array.\n"
 base.cround,"\nbase.cround( z:Complex128 )\n    Rounds each component of a double-precision complex floating-point number\n    to the nearest integer.\n"
-base.croundn,"\nbase.croundn( [out:Array|TypedArray|Object,] re:number, im:number, n:integer )\n    Rounds a complex number to the nearest multiple of `10^n`.\n"
+base.croundn,"\nbase.croundn( z:Complex128, n:integer )\n    Rounds each component of a double-precision complex floating-point number\n    to the nearest multiple of `10^n`.\n"
 base.csch,"\nbase.csch( x:number )\n    Computes the hyperbolic cosecant of a number.\n"
 base.csignum,"\nbase.csignum( z:Complex128 )\n    Evaluates the signum function of a double-precision complex floating-point\n    number.\n"
 base.csub,"\nbase.csub( z1:Complex128, z2:Complex128 )\n    Subtracts two double-precision complex floating-point numbers.\n"
@@ -934,6 +935,7 @@ base.log,"\nbase.log( x:number, b:number )\n    Computes the base `b` logarithm
 base.log1mexp,"\nbase.log1mexp( x:number )\n    Evaluates the natural logarithm of `1-exp(-|x|)`.\n"
 base.log1p,"\nbase.log1p( x:number )\n    Evaluates the natural logarithm of `1+x`.\n"
 base.log1pexp,"\nbase.log1pexp( x:number )\n    Evaluates the natural logarithm of `1+exp(x)`.\n"
+base.log1pmx,"\nbase.log1pmx( x:number )\n    Evaluates `ln(1+x) - x`.\n"
 base.log2,"\nbase.log2( x:number )\n    Evaluates the binary logarithm (base two).\n"
 base.log10,"\nbase.log10( x:number )\n    Evaluates the common logarithm (base 10).\n"
 base.logaddexp,"\nbase.logaddexp( x:number, y:number )\n    Computes the natural logarithm of `exp(x) + exp(y)`.\n"
@@ -2483,6 +2485,24 @@ exists.sync,"\nexists.sync( path:string|Buffer )\n    Synchronously tests whethe
 expandAcronyms,"\nexpandAcronyms( str:string )\n    Expands acronyms in a string.\n"
 expandContractions,"\nexpandContractions( str:string )\n    Expands all contractions to their formal equivalents.\n"
 extname,"\nextname( filename:string )\n    Returns a filename extension.\n"
+FancyArray,"\nFancyArray( dtype:string, buffer:ArrayLikeObject|TypedArray|Buffer, \n  shape:ArrayLikeObject<integer>, strides:ArrayLikeObject<integer>, \n  offset:integer, order:string[, options:Object] )\n    Returns a FancyArray instance.\n"
+FancyArray.prototype.byteLength,"\nFancyArray.prototype.byteLength\n    Size (in bytes) of the array (if known).\n"
+FancyArray.prototype.BYTES_PER_ELEMENT,"\nFancyArray.prototype.BYTES_PER_ELEMENT\n    Size (in bytes) of each array element (if known).\n"
+FancyArray.prototype.data,"\nFancyArray.prototype.data\n    Pointer to the underlying data buffer.\n"
+FancyArray.prototype.dtype,"\nFancyArray.prototype.dtype\n    Underlying data type.\n"
+FancyArray.prototype.flags,"\nFancyArray.prototype.flags\n    Meta information, such as information concerning the memory layout of the\n    array.\n"
+FancyArray.prototype.length,"\nFancyArray.prototype.length\n    Length of the array (i.e., number of elements).\n"
+FancyArray.prototype.ndims,"\nFancyArray.prototype.ndims\n    Number of dimensions.\n"
+FancyArray.prototype.offset,"\nFancyArray.prototype.offset\n    Index offset which specifies the buffer index at which to start iterating\n    over array elements.\n"
+FancyArray.prototype.order,"\nFancyArray.prototype.order\n    Array order.\n"
+FancyArray.prototype.shape,"\nFancyArray.prototype.shape\n    Array shape.\n"
+FancyArray.prototype.strides,"\nFancyArray.prototype.strides\n    Index strides which specify how to access data along corresponding array\n    dimensions.\n"
+FancyArray.prototype.get,"\nFancyArray.prototype.get( ...idx:integer )\n    Returns an array element specified according to provided subscripts.\n"
+FancyArray.prototype.iget,"\nFancyArray.prototype.iget( idx:integer )\n    Returns an array element located at a specified linear index.\n"
+FancyArray.prototype.set,"\nFancyArray.prototype.set( ...idx:integer, v:any )\n    Sets an array element specified according to provided subscripts.\n"
+FancyArray.prototype.iset,"\nFancyArray.prototype.iset( idx:integer, v:any )\n    Sets an array element located at a specified linear index.\n"
+FancyArray.prototype.toString,"\nFancyArray.prototype.toString()\n    Serializes a FancyArray as a string.\n"
+FancyArray.prototype.toJSON,"\nFancyArray.prototype.toJSON()\n    Serializes a FancyArray as a JSON object.\n"
 fastmath.abs,"\nfastmath.abs( x:number )\n    Computes an absolute value.\n"
 fastmath.acosh,"\nfastmath.acosh( x:number )\n    Computes the hyperbolic arccosine of a number.\n"
 fastmath.ampbm,"\nfastmath.ampbm( x:number, y:number )\n    Computes the hypotenuse using the alpha max plus beta min algorithm.\n"
@@ -3110,6 +3130,7 @@ isLowercase,"\nisLowercase( value:any )\n    Tests if a value is a lowercase str
 isMatrixLike,"\nisMatrixLike( value:any )\n    Tests if a value is a 2-dimensional ndarray-like object.\n"
 isMethod,"\nisMethod( value:any, property:any )\n    Tests if an object has a specified method name.\n"
 isMethodIn,"\nisMethodIn( value:any, property:any )\n    Tests if an object has a specified method name, either own or inherited.\n"
+isMultiSlice,"\nisMultiSlice( value:any )\n    Tests if a value is a MultiSlice object.\n"
 isNamedTypedTupleLike,"\nisNamedTypedTupleLike( value:any )\n    Tests if a value is named typed tuple-like.\n"
 isnan,"\nisnan( value:any )\n    Tests if a value is NaN.\n"
 isnan.isPrimitive,"\nisnan.isPrimitive( value:any )\n    Tests if a value is a NaN number primitive.\n"
@@ -3245,6 +3266,7 @@ isSharedArrayBuffer,"\nisSharedArrayBuffer( value:any )\n    Tests if a value is
 isSkewCentrosymmetricMatrix,"\nisSkewCentrosymmetricMatrix( value:any )\n    Tests if a value is a skew-centrosymmetric matrix.\n"
 isSkewPersymmetricMatrix,"\nisSkewPersymmetricMatrix( value:any )\n    Tests if a value is a skew-persymmetric matrix.\n"
 isSkewSymmetricMatrix,"\nisSkewSymmetricMatrix( value:any )\n    Tests if a value is a skew-symmetric (or antisymmetric) matrix.\n"
+isSlice,"\nisSlice( value:any )\n    Tests if a value is a Slice object.\n"
 isSquareMatrix,"\nisSquareMatrix( value:any )\n    Tests if a value is a 2-dimensional ndarray-like object having equal\n    dimensions.\n"
 isSquareNumber,"\nisSquareNumber( value:any )\n    Tests if a value is a square number.\n"
 isSquareNumber.isPrimitive,"\nisSquareNumber.isPrimitive( value:any )\n    Tests if a value is a number primitive which is a square number.\n"
@@ -3616,6 +3638,11 @@ MOBY_DICK,"\nMOBY_DICK()\n    Returns the text of Moby Dick by Herman Melville.\
 MONTH_NAMES_EN,"\nMONTH_NAMES_EN()\n    Returns a list of month names (English).\n"
 MONTHS_IN_YEAR,"\nMONTHS_IN_YEAR\n    Number of months in a year.\n"
 moveProperty,"\nmoveProperty( source:Object, prop:string, target:Object )\n    Moves a property from one object to another object.\n"
+MultiSlice,"\nMultiSlice( ...slice )\n    Returns a multi-slice.\n"
+MultiSlice.prototype.ndims,"\nMultiSlice.prototype.ndims\n    Read-only property returning the number of slice dimensions.\n"
+MultiSlice.prototype.data,"\nMultiSlice.prototype.data\n    Read-only property returning the slice data.\n"
+MultiSlice.prototype.toString,"\nMultiSlice.prototype.toString()\n    Serializes a multi-slice as a string.\n"
+MultiSlice.prototype.toJSON,"\nMultiSlice.prototype.toJSON()\n    Serializes a multi-slice as a JSON object.\n"
 namedtypedtuple,"\nnamedtypedtuple( fields:Array<string>[, options:Object] )\n    Returns a named typed tuple factory.\n"
 naryFunction,"\nnaryFunction( fcn:Function, arity:integer[, thisArg:any] )\n    Returns a function that applies a specified number of arguments to a\n    provided function.\n"
 nativeClass,"\nnativeClass( value:any )\n    Returns a string value indicating a specification defined classification of\n    an object.\n"
@@ -4169,7 +4196,7 @@ reim,"\nreim( z:Complex128 )\n    Returns the real and imaginary components of a
 reimf,"\nreimf( z:Complex64 )\n    Returns the real and imaginary components of a single-precision complex\n    floating-point number.\n"
 rejectArguments,"\nrejectArguments( fcn:Function, predicate:Function[, thisArg:any] )\n    Returns a function that applies arguments to a provided function according\n    to a predicate function.\n"
 removeFirst,"\nremoveFirst( str:string[, n:integer][, options:Object] )\n    Removes the first character(s) of a `string`.\n"
-removeLast,"\nremoveLast( str:string[, n:integer] )\n    Removes the last character(s) of a `string`.\n"
+removeLast,"\nremoveLast( str:string[, n:integer][, options:Object] )\n    Removes the last character(s) of a `string`.\n"
 removePunctuation,"\nremovePunctuation( str:string )\n    Removes punctuation characters from a `string`.\n"
 removeUTF8BOM,"\nremoveUTF8BOM( str:string )\n    Removes a UTF-8 byte order mark (BOM) from the beginning of a `string`.\n"
 removeWords,"\nremoveWords( str:string, words:Array<string>[, ignoreCase:boolean] )\n    Removes all occurrences of the given words from a `string`.\n"
@@ -4229,6 +4256,7 @@ SECONDS_IN_MINUTE,"\nSECONDS_IN_MINUTE\n    Number of seconds in a minute.\n"
 SECONDS_IN_WEEK,"\nSECONDS_IN_WEEK\n    Number of seconds in a week.\n"
 secondsInMonth,"\nsecondsInMonth( [month:string|Date|integer[, year:integer]] )\n    Returns the number of seconds in a month.\n"
 secondsInYear,"\nsecondsInYear( [value:integer|Date] )\n    Returns the number of seconds in a year according to the Gregorian calendar.\n"
+seq2slice,"\nseq2slice( str:string, len:integer, strict:boolean )\n    Converts a subsequence string to a Slice object.\n"
 setConfigurableReadOnly,"\nsetConfigurableReadOnly( obj:Object, prop:string|symbol, value:any )\n    Defines a configurable read-only property.\n"
 setConfigurableReadOnlyAccessor,"\nsetConfigurableReadOnlyAccessor( obj:Object, prop:string|symbol, \n  getter:Function )\n    Defines a configurable read-only accessor.\n"
 setConfigurableReadWriteAccessor,"\nsetConfigurableReadWriteAccessor( obj:Object, prop:string|symbol, \n  getter:Function, setter:Function )\n    Defines a configurable property having read-write accessors.\n"
@@ -4252,6 +4280,12 @@ shift,"\nshift( collection:Array|TypedArray|Object )\n    Removes and returns th
 shuffle,"\nshuffle( arr:ArrayLike[, options:Object] )\n    Shuffles elements of an array-like object.\n"
 shuffle.factory,"\nshuffle.factory( [options:Object] )\n    Returns a function to shuffle elements of array-like objects.\n"
 sizeOf,"\nsizeOf( dtype:string )\n    Returns the size (in bytes) of the canonical binary representation of a\n    specified numeric type.\n"
+Slice,"\nSlice( [stop:integer|null|undefined] )\n    Returns a Slice.\n\nSlice( start:integer|null|undefined, stop:integer|null|undefined[, \n  step:integer|null|undefined] )\n    Returns a Slice.\n"
+Slice.prototype.start,"\nSlice.prototype.start\n    Read-only property returning the starting slice index.\n"
+Slice.prototype.stop,"\nSlice.prototype.stop\n    Read-only property returning the ending slice index.\n"
+Slice.prototype.step,"\nSlice.prototype.step\n    Read-only property returning the index increment.\n"
+Slice.prototype.toString,"\nSlice.prototype.toString()\n    Serializes a Slice as a string.\n"
+Slice.prototype.toJSON,"\nSlice.prototype.toJSON()\n    Serializes a Slice as a JSON object.\n"
 snakecase,"\nsnakecase( str:string )\n    Converts a string to snake case.\n"
 some,"\nsome( collection:Array|TypedArray|Object, n:number )\n    Tests whether at least `n` elements in a collection are truthy.\n"
 someBy,"\nsomeBy( collection:Array|TypedArray|Object, n:number, predicate:Function[, \n  thisArg:any ] )\n    Tests whether a collection contains at least `n` elements which pass a test\n    implemented by a predicate function.\n"

dist/index.d.ts

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

docs/types/index.d.ts

@@ -16,7 +16,7 @@
 * limitations under the License.
 */
 
-// TypeScript Version: 2.0
+// TypeScript Version: 4.1
 
 /**
 * Returns abbreviated help text associated with a specified alias.

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stdlib/repl-info",
-  "version": "0.0.8",
+  "version": "0.1.0",
   "description": "Return abbreviated help text associated with a provided alias.",
   "license": "Apache-2.0",
   "author": {
@@ -42,16 +42,16 @@
     "url": "https://github.com/stdlib-js/stdlib/issues"
   },
   "dependencies": {
-    "@stdlib/assert-has-own-property": "^0.0.7",
-    "@stdlib/assert-is-string": "^0.0.8",
-    "@stdlib/cli-ctor": "^0.0.3",
-    "@stdlib/fs-read-file": "^0.0.8",
-    "@stdlib/string-format": "^0.0.3"
+    "@stdlib/assert-has-own-property": "^0.1.0",
+    "@stdlib/assert-is-string": "^0.1.0",
+    "@stdlib/cli-ctor": "^0.1.0",
+    "@stdlib/fs-read-file": "^0.1.0",
+    "@stdlib/string-format": "^0.1.0"
   },
   "devDependencies": {
     "@stdlib/assert-is-browser": "^0.0.8",
-    "@stdlib/assert-is-windows": "^0.0.7",
-    "@stdlib/bench": "^0.0.12",
+    "@stdlib/assert-is-windows": "^0.1.0",
+    "@stdlib/bench": "^0.1.0",
     "@stdlib/fs-write-file": "^0.0.8",
     "@stdlib/namespace-aliases": "^0.0.8",
     "@stdlib/process-exec-path": "^0.0.7",