Skip to content

Commit

Permalink
Release v0.1.0
Browse files Browse the repository at this point in the history
  • Loading branch information
stdlib-bot committed Sep 22, 2023
1 parent 0178e38 commit 93f0d4b
Show file tree
Hide file tree
Showing 11 changed files with 110 additions and 29 deletions.
5 changes: 5 additions & 0 deletions .editorconfig
Original file line number Diff line number Diff line change
Expand Up @@ -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
15 changes: 0 additions & 15 deletions .github/workflows/productionize.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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: |
Expand Down
30 changes: 30 additions & 0 deletions CITATION.cff
Original file line number Diff line number Diff line change
@@ -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
15 changes: 13 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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>

# Typed Signature

[![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url] <!-- [![dependencies][dependencies-image]][dependencies-url] -->
Expand Down Expand Up @@ -249,8 +260,8 @@ Copyright &copy; 2016-2023. The Stdlib [Authors][stdlib-authors].
[npm-image]: http://img.shields.io/npm/v/@stdlib/repl-typed-signature.svg
[npm-url]: https://npmjs.org/package/@stdlib/repl-typed-signature

[test-image]: https://github.com/stdlib-js/repl-typed-signature/actions/workflows/test.yml/badge.svg?branch=main
[test-url]: https://github.com/stdlib-js/repl-typed-signature/actions/workflows/test.yml?query=branch:main
[test-image]: https://github.com/stdlib-js/repl-typed-signature/actions/workflows/test.yml/badge.svg?branch=v0.1.0
[test-url]: https://github.com/stdlib-js/repl-typed-signature/actions/workflows/test.yml?query=branch:v0.1.0

[coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/repl-typed-signature/main.svg
[coverage-url]: https://codecov.io/github/stdlib-js/repl-typed-signature?branch=main
Expand Down
41 changes: 38 additions & 3 deletions data/data.csv
Original file line number Diff line number Diff line change
Expand Up @@ -145,9 +145,10 @@ base.coth,"base.coth( x:number )"
base.covercos,"base.covercos( x:number )"
base.coversin,"base.coversin( x:number )"
base.cphase,"base.cphase( z:Complex128 )"
base.cpolar,"base.cpolar( [out:Array|TypedArray|Object,] re:number, im:number )"
base.cpolar,"base.cpolar( z:Complex128 )"
base.cpolar.assign,"base.cpolar.assign( z:Complex128, out:Array|TypedArray|Object, stride:integer, offset:integer )"
base.cround,"base.cround( z:Complex128 )"
base.croundn,"base.croundn( [out:Array|TypedArray|Object,] re:number, im:number, n:integer )"
base.croundn,"base.croundn( z:Complex128, n:integer )"
base.csch,"base.csch( x:number )"
base.csignum,"base.csignum( z:Complex128 )"
base.csub,"base.csub( z1:Complex128, z2:Complex128 )"
Expand Down Expand Up @@ -934,6 +935,7 @@ base.log,"base.log( x:number, b:number )"
base.log1mexp,"base.log1mexp( x:number )"
base.log1p,"base.log1p( x:number )"
base.log1pexp,"base.log1pexp( x:number )"
base.log1pmx,"base.log1pmx( x:number )"
base.log2,"base.log2( x:number )"
base.log10,"base.log10( x:number )"
base.logaddexp,"base.logaddexp( x:number, y:number )"
Expand Down Expand Up @@ -2492,6 +2494,24 @@ exists.sync,"exists.sync( path:string|Buffer )"
expandAcronyms,"expandAcronyms( str:string )"
expandContractions,"expandContractions( str:string )"
extname,"extname( filename:string )"
FancyArray,"FancyArray( dtype:string, buffer:ArrayLikeObject|TypedArray|Buffer, shape:ArrayLikeObject<integer>, strides:ArrayLikeObject<integer>, offset:integer, order:string[, options:Object] )"
FancyArray.prototype.byteLength,"FancyArray.prototype.byteLength"
FancyArray.prototype.BYTES_PER_ELEMENT,"FancyArray.prototype.BYTES_PER_ELEMENT"
FancyArray.prototype.data,"FancyArray.prototype.data"
FancyArray.prototype.dtype,"FancyArray.prototype.dtype"
FancyArray.prototype.flags,"FancyArray.prototype.flags"
FancyArray.prototype.length,"FancyArray.prototype.length"
FancyArray.prototype.ndims,"FancyArray.prototype.ndims"
FancyArray.prototype.offset,"FancyArray.prototype.offset"
FancyArray.prototype.order,"FancyArray.prototype.order"
FancyArray.prototype.shape,"FancyArray.prototype.shape"
FancyArray.prototype.strides,"FancyArray.prototype.strides"
FancyArray.prototype.get,"FancyArray.prototype.get( ...idx:integer )"
FancyArray.prototype.iget,"FancyArray.prototype.iget( idx:integer )"
FancyArray.prototype.set,"FancyArray.prototype.set( ...idx:integer, v:any )"
FancyArray.prototype.iset,"FancyArray.prototype.iset( idx:integer, v:any )"
FancyArray.prototype.toString,"FancyArray.prototype.toString()"
FancyArray.prototype.toJSON,"FancyArray.prototype.toJSON()"
fastmath.abs,"fastmath.abs( x:number )"
fastmath.acosh,"fastmath.acosh( x:number )"
fastmath.ampbm,"fastmath.ampbm( x:number, y:number )"
Expand Down Expand Up @@ -3147,6 +3167,7 @@ isLowercase,"isLowercase( value:any )"
isMatrixLike,"isMatrixLike( value:any )"
isMethod,"isMethod( value:any, property:any )"
isMethodIn,"isMethodIn( value:any, property:any )"
isMultiSlice,"isMultiSlice( value:any )"
isNamedTypedTupleLike,"isNamedTypedTupleLike( value:any )"
isnan,"isnan( value:any )"
isnan.isPrimitive,"isnan.isPrimitive( value:any )"
Expand Down Expand Up @@ -3282,6 +3303,7 @@ isSharedArrayBuffer,"isSharedArrayBuffer( value:any )"
isSkewCentrosymmetricMatrix,"isSkewCentrosymmetricMatrix( value:any )"
isSkewPersymmetricMatrix,"isSkewPersymmetricMatrix( value:any )"
isSkewSymmetricMatrix,"isSkewSymmetricMatrix( value:any )"
isSlice,"isSlice( value:any )"
isSquareMatrix,"isSquareMatrix( value:any )"
isSquareNumber,"isSquareNumber( value:any )"
isSquareNumber.isPrimitive,"isSquareNumber.isPrimitive( value:any )"
Expand Down Expand Up @@ -3653,6 +3675,11 @@ MOBY_DICK,"MOBY_DICK()"
MONTH_NAMES_EN,"MONTH_NAMES_EN()"
MONTHS_IN_YEAR,"MONTHS_IN_YEAR"
moveProperty,"moveProperty( source:Object, prop:string, target:Object )"
MultiSlice,"MultiSlice( ...slice )"
MultiSlice.prototype.ndims,"MultiSlice.prototype.ndims"
MultiSlice.prototype.data,"MultiSlice.prototype.data"
MultiSlice.prototype.toString,"MultiSlice.prototype.toString()"
MultiSlice.prototype.toJSON,"MultiSlice.prototype.toJSON()"
namedtypedtuple,"namedtypedtuple( fields:Array<string>[, options:Object] )"
naryFunction,"naryFunction( fcn:Function, arity:integer[, thisArg:any] )"
nativeClass,"nativeClass( value:any )"
Expand Down Expand Up @@ -4210,7 +4237,7 @@ reim,"reim( z:Complex128 )"
reimf,"reimf( z:Complex64 )"
rejectArguments,"rejectArguments( fcn:Function, predicate:Function[, thisArg:any] )"
removeFirst,"removeFirst( str:string[, n:integer][, options:Object] )"
removeLast,"removeLast( str:string[, n:integer] )"
removeLast,"removeLast( str:string[, n:integer][, options:Object] )"
removePunctuation,"removePunctuation( str:string )"
removeUTF8BOM,"removeUTF8BOM( str:string )"
removeWords,"removeWords( str:string, words:Array<string>[, ignoreCase:boolean] )"
Expand Down Expand Up @@ -4270,6 +4297,7 @@ SECONDS_IN_MINUTE,"SECONDS_IN_MINUTE"
SECONDS_IN_WEEK,"SECONDS_IN_WEEK"
secondsInMonth,"secondsInMonth( [month:string|Date|integer[, year:integer]] )"
secondsInYear,"secondsInYear( [value:integer|Date] )"
seq2slice,"seq2slice( str:string, len:integer, strict:boolean )"
setConfigurableReadOnly,"setConfigurableReadOnly( obj:Object, prop:string|symbol, value:any )"
setConfigurableReadOnlyAccessor,"setConfigurableReadOnlyAccessor( obj:Object, prop:string|symbol, getter:Function )"
setConfigurableReadWriteAccessor,"setConfigurableReadWriteAccessor( obj:Object, prop:string|symbol, getter:Function, setter:Function )"
Expand All @@ -4293,6 +4321,13 @@ shift,"shift( collection:Array|TypedArray|Object )"
shuffle,"shuffle( arr:ArrayLike[, options:Object] )"
shuffle.factory,"shuffle.factory( [options:Object] )"
sizeOf,"sizeOf( dtype:string )"
Slice,"Slice( [stop:integer|null|undefined] )"
Slice,"Slice( start:integer|null|undefined, stop:integer|null|undefined[, step:integer|null|undefined] )"
Slice.prototype.start,"Slice.prototype.start"
Slice.prototype.stop,"Slice.prototype.stop"
Slice.prototype.step,"Slice.prototype.step"
Slice.prototype.toString,"Slice.prototype.toString()"
Slice.prototype.toJSON,"Slice.prototype.toJSON()"
snakecase,"snakecase( str:string )"
some,"some( collection:Array|TypedArray|Object, n:number )"
someBy,"someBy( collection:Array|TypedArray|Object, n:number, predicate:Function[, thisArg:any ] )"
Expand Down
2 changes: 1 addition & 1 deletion data/data.json

Large diffs are not rendered by default.

3 changes: 3 additions & 0 deletions dist/index.d.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
/// <reference path="../docs/types/index.d.ts" />
import typedSignature from '../docs/types/index';
export = typedSignature;
5 changes: 5 additions & 0 deletions dist/index.js

Large diffs are not rendered by default.

7 changes: 7 additions & 0 deletions dist/index.js.map

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/types/index.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
* limitations under the License.
*/

// TypeScript Version: 2.0
// TypeScript Version: 4.1

/**
* Returns the typed signature(s) associated with a specified alias.
Expand Down
14 changes: 7 additions & 7 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@stdlib/repl-typed-signature",
"version": "0.0.8",
"version": "0.1.0",
"description": "Return the typed signature(s) associated with a provided alias.",
"license": "Apache-2.0",
"author": {
Expand Down Expand Up @@ -42,17 +42,17 @@
"url": "https://github.com/stdlib-js/stdlib/issues"
},
"dependencies": {
"@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-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-contains": "^0.0.7",
"@stdlib/assert-is-browser": "^0.0.8",
"@stdlib/assert-is-string-array": "^0.0.9",
"@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",
Expand Down

0 comments on commit 93f0d4b

Please sign in to comment.