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 23, 2023
1 parent 2ef9465 commit d188a1d
Show file tree
Hide file tree
Showing 5 changed files with 66 additions and 20 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
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>

# someByRight

[![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 @@ -269,8 +280,8 @@ Copyright &copy; 2016-2023. The Stdlib [Authors][stdlib-authors].
[npm-image]: http://img.shields.io/npm/v/@stdlib/utils-some-by-right.svg
[npm-url]: https://npmjs.org/package/@stdlib/utils-some-by-right

[test-image]: https://github.com/stdlib-js/utils-some-by-right/actions/workflows/test.yml/badge.svg?branch=main
[test-url]: https://github.com/stdlib-js/utils-some-by-right/actions/workflows/test.yml?query=branch:main
[test-image]: https://github.com/stdlib-js/utils-some-by-right/actions/workflows/test.yml/badge.svg?branch=v0.1.0
[test-url]: https://github.com/stdlib-js/utils-some-by-right/actions/workflows/test.yml?query=branch:v0.1.0

[coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/utils-some-by-right/main.svg
[coverage-url]: https://codecov.io/github/stdlib-js/utils-some-by-right?branch=main
Expand Down
14 changes: 7 additions & 7 deletions 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

/// <reference types="@stdlib/types"/>

Expand All @@ -27,15 +27,15 @@ import { Collection } from '@stdlib/types/array';
*
* @returns boolean indicating whether an element in a collection passes a test
*/
type Nullary = () => boolean;
type Nullary<U> = ( this: U ) => boolean;

/**
* Checks whether an element in a collection passes a test.
*
* @param value - collection value
* @returns boolean indicating whether an element in a collection passes a test
*/
type Unary<T> = ( value: T ) => boolean;
type Unary<T, U> = ( this: U, value: T ) => boolean;

/**
* Checks whether an element in a collection passes a test.
Expand All @@ -44,7 +44,7 @@ type Unary<T> = ( value: T ) => boolean;
* @param index - collection index
* @returns boolean indicating whether an element in a collection passes a test
*/
type Binary<T> = ( value: T, index: number ) => boolean;
type Binary<T, U> = ( this: U, value: T, index: number ) => boolean;

/**
* Checks whether an element in a collection passes a test.
Expand All @@ -54,7 +54,7 @@ type Binary<T> = ( value: T, index: number ) => boolean;
* @param collection - input collection
* @returns boolean indicating whether an element in a collection passes a test
*/
type Ternary<T> = ( value: T, index: number, collection: Collection<T> ) => boolean;
type Ternary<T, U> = ( this: U, value: T, index: number, collection: Collection<T> ) => boolean;

/**
* Checks whether an element in a collection passes a test.
Expand All @@ -64,7 +64,7 @@ type Ternary<T> = ( value: T, index: number, collection: Collection<T> ) => bool
* @param collection - input collection
* @returns boolean indicating whether an element in a collection passes a test
*/
type Predicate<T> = Nullary | Unary<T> | Binary<T> | Ternary<T>;
type Predicate<T, U> = Nullary<U> | Unary<T, U> | Binary<T, U> | Ternary<T, U>;

/**
* Tests whether a collection contains at least `n` elements which pass a test implemented by a predicate function, iterating from right to left.
Expand Down Expand Up @@ -98,7 +98,7 @@ type Predicate<T> = Nullary | Unary<T> | Binary<T> | Ternary<T>;
* var bool = someByRight( arr, 2, isNegative );
* // returns true
*/
declare function someByRight<T = unknown>( collection: Collection<T>, n: number, predicate: Predicate<T>, thisArg?: ThisParameterType<Predicate<T>> ): boolean;
declare function someByRight<T = unknown, U = unknown>( collection: Collection<T>, n: number, predicate: Predicate<T, U>, thisArg?: ThisParameterType<Predicate<T, U>> ): boolean;


// EXPORTS //
Expand Down
22 changes: 11 additions & 11 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@stdlib/utils-some-by-right",
"version": "0.0.8",
"version": "0.1.0",
"description": "Test whether a collection contains at least `n` elements which pass a test implemented by a predicate function, iterating from right to left.",
"license": "Apache-2.0",
"author": {
Expand Down Expand Up @@ -37,19 +37,19 @@
"url": "https://github.com/stdlib-js/stdlib/issues"
},
"dependencies": {
"@stdlib/assert-is-collection": "^0.0.8",
"@stdlib/assert-is-function": "^0.0.8",
"@stdlib/assert-is-positive-integer": "^0.0.7",
"@stdlib/string-format": "^0.0.3",
"@stdlib/types": "^0.0.14"
"@stdlib/assert-is-collection": "^0.1.0",
"@stdlib/assert-is-function": "^0.1.0",
"@stdlib/assert-is-positive-integer": "^0.1.0",
"@stdlib/string-format": "^0.1.0",
"@stdlib/types": "^0.1.0"
},
"devDependencies": {
"@stdlib/array-float64": "^0.0.6",
"@stdlib/assert-is-boolean": "^0.0.8",
"@stdlib/bench": "^0.0.12",
"@stdlib/math-base-assert-is-nan": "^0.0.8",
"@stdlib/array-float64": "^0.1.0",
"@stdlib/assert-is-boolean": "^0.1.0",
"@stdlib/bench": "^0.1.0",
"@stdlib/math-base-assert-is-nan": "^0.1.0",
"@stdlib/random-base-randu": "^0.0.8",
"@stdlib/utils-noop": "^0.0.14",
"@stdlib/utils-noop": "^0.1.0",
"tape": "git+https://github.com/kgryte/tape.git#fix/globby",
"istanbul": "^0.4.1",
"tap-min": "git+https://github.com/Planeshifter/tap-min.git"
Expand Down

0 comments on commit d188a1d

Please sign in to comment.