From 1fff3735b27f239509ef0be474f6b2d6495a7290 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sat, 20 Jan 2024 08:18:49 +0000 Subject: [PATCH 01/40] Transform error messages --- package.json | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/package.json b/package.json index 4a058cd..40b4c23 100644 --- a/package.json +++ b/package.json @@ -38,7 +38,8 @@ }, "dependencies": { "@stdlib/array-base-arraylike2object": "^0.1.0", - "@stdlib/types": "^0.2.0" + "@stdlib/types": "^0.2.0", + "@stdlib/error-tools-fmtprodmsg": "^0.1.1" }, "devDependencies": { "@stdlib/array-base-accessor": "^0.1.0", @@ -90,4 +91,4 @@ "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} +} \ No newline at end of file From d41183d60ee2e06db13a6fe5a805e1e5e5fd3109 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sat, 20 Jan 2024 08:20:14 +0000 Subject: [PATCH 02/40] Auto-generated commit --- .editorconfig | 181 - .eslintrc.js | 1 - .gitattributes | 49 - .github/PULL_REQUEST_TEMPLATE.md | 7 - .github/workflows/benchmark.yml | 64 - .github/workflows/cancel.yml | 57 - .github/workflows/close_pull_requests.yml | 54 - .github/workflows/examples.yml | 64 - .github/workflows/npm_downloads.yml | 112 - .github/workflows/productionize.yml | 797 --- .github/workflows/publish.yml | 255 - .github/workflows/test.yml | 100 - .github/workflows/test_bundles.yml | 189 - .github/workflows/test_coverage.yml | 128 - .github/workflows/test_install.yml | 86 - .gitignore | 188 - .npmignore | 228 - .npmrc | 28 - CHANGELOG.md | 5 - CITATION.cff | 30 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 -- README.md | 39 +- SECURITY.md | 5 - benchmark/benchmark.length.js | 97 - branches.md | 53 - dist/index.d.ts | 3 - dist/index.js | 5 - dist/index.js.map | 7 - docs/repl.txt | 46 - docs/types/test.ts | 101 - examples/index.js | 35 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/index.js | 46 - lib/main.js | 160 - package.json | 65 +- stats.html | 6177 +++++++++++++++++++++ test/dist/test.js | 33 - test/test.js | 251 - 42 files changed, 6202 insertions(+), 4091 deletions(-) delete mode 100644 .editorconfig delete mode 100644 .eslintrc.js delete mode 100644 .gitattributes delete mode 100644 .github/PULL_REQUEST_TEMPLATE.md delete mode 100644 .github/workflows/benchmark.yml delete mode 100644 .github/workflows/cancel.yml delete mode 100644 .github/workflows/close_pull_requests.yml delete mode 100644 .github/workflows/examples.yml delete mode 100644 .github/workflows/npm_downloads.yml delete mode 100644 .github/workflows/productionize.yml delete mode 100644 .github/workflows/publish.yml delete mode 100644 .github/workflows/test.yml delete mode 100644 .github/workflows/test_bundles.yml delete mode 100644 .github/workflows/test_coverage.yml delete mode 100644 .github/workflows/test_install.yml delete mode 100644 .gitignore delete mode 100644 .npmignore delete mode 100644 .npmrc delete mode 100644 CHANGELOG.md delete mode 100644 CITATION.cff delete mode 100644 CODE_OF_CONDUCT.md delete mode 100644 CONTRIBUTING.md delete mode 100644 Makefile delete mode 100644 SECURITY.md delete mode 100644 benchmark/benchmark.length.js delete mode 100644 branches.md delete mode 100644 dist/index.d.ts delete mode 100644 dist/index.js delete mode 100644 dist/index.js.map delete mode 100644 docs/repl.txt delete mode 100644 docs/types/test.ts delete mode 100644 examples/index.js rename docs/types/index.d.ts => index.d.ts (99%) create mode 100644 index.mjs create mode 100644 index.mjs.map delete mode 100644 lib/index.js delete mode 100644 lib/main.js create mode 100644 stats.html delete mode 100644 test/dist/test.js delete mode 100644 test/test.js diff --git a/.editorconfig b/.editorconfig deleted file mode 100644 index 60d743f..0000000 --- a/.editorconfig +++ /dev/null @@ -1,181 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 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. -#/ - -# EditorConfig configuration file (see ). - -# Indicate that this file is a root-level configuration file: -root = true - -# Set properties for all files: -[*] -end_of_line = lf -charset = utf-8 -trim_trailing_whitespace = true -insert_final_newline = true - -# Set properties for JavaScript files: -[*.{js,js.txt}] -indent_style = tab - -# Set properties for JavaScript ES module files: -[*.{mjs,mjs.txt}] -indent_style = tab - -# Set properties for JavaScript CommonJS files: -[*.{cjs,cjs.txt}] -indent_style = tab - -# Set properties for JSON files: -[*.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `cli_opts.json` files: -[cli_opts.json] -indent_style = tab - -# Set properties for TypeScript files: -[*.ts] -indent_style = tab - -# Set properties for Python files: -[*.{py,py.txt}] -indent_style = space -indent_size = 4 - -# Set properties for Julia files: -[*.{jl,jl.txt}] -indent_style = tab - -# Set properties for R files: -[*.{R,R.txt}] -indent_style = tab - -# Set properties for C files: -[*.{c,c.txt}] -indent_style = tab - -# Set properties for C header files: -[*.{h,h.txt}] -indent_style = tab - -# Set properties for C++ files: -[*.{cpp,cpp.txt}] -indent_style = tab - -# Set properties for C++ header files: -[*.{hpp,hpp.txt}] -indent_style = tab - -# Set properties for Fortran files: -[*.{f,f.txt}] -indent_style = space -indent_size = 2 -insert_final_newline = false - -# Set properties for shell files: -[*.{sh,sh.txt}] -indent_style = tab - -# Set properties for AWK files: -[*.{awk,awk.txt}] -indent_style = tab - -# Set properties for HTML files: -[*.{html,html.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for XML files: -[*.{xml,xml.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for CSS files: -[*.{css,css.txt}] -indent_style = tab - -# Set properties for Makefiles: -[Makefile] -indent_style = tab - -[*.{mk,mk.txt}] -indent_style = tab - -# Set properties for Markdown files: -[*.{md,md.txt}] -indent_style = space -indent_size = 4 -trim_trailing_whitespace = false - -# Set properties for `usage.txt` files: -[usage.txt] -indent_style = space -indent_size = 2 - -# Set properties for `repl.txt` files: -[repl.txt] -indent_style = space -indent_size = 4 - -# Set properties for `package.json` files: -[package.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `datapackage.json` files: -[datapackage.json] -indent_style = space -indent_size = 2 - -# Set properties for `manifest.json` files: -[manifest.json] -indent_style = space -indent_size = 2 - -# Set properties for `tsconfig.json` files: -[tsconfig.json] -indent_style = space -indent_size = 2 - -# Set properties for LaTeX files: -[*.{tex,tex.txt}] -indent_style = tab - -# Set properties for LaTeX Bibliography files: -[*.{bib,bib.txt}] -indent_style = tab - -# Set properties for YAML files: -[*.{yml,yml.txt}] -indent_style = space -indent_size = 2 - -# Set properties for GYP files: -[binding.gyp] -indent_style = space -indent_size = 2 - -[*.gypi] -indent_style = space -indent_size = 2 - -# Set properties for citation files: -[*.{cff,cff.txt}] -indent_style = space -indent_size = 2 diff --git a/.eslintrc.js b/.eslintrc.js deleted file mode 100644 index 5f30286..0000000 --- a/.eslintrc.js +++ /dev/null @@ -1 +0,0 @@ -/* For the `eslint` rules of this project, consult the main repository at https://github.com/stdlib-js/stdlib */ diff --git a/.gitattributes b/.gitattributes deleted file mode 100644 index 10a16e6..0000000 --- a/.gitattributes +++ /dev/null @@ -1,49 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 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. -#/ - -# Configuration file which assigns attributes to pathnames. -# -# [1]: https://git-scm.com/docs/gitattributes - -# Automatically normalize the line endings of any committed text files: -* text=auto - -# Override line endings for certain files on checkout: -*.crlf.csv text eol=crlf - -# Denote that certain files are binary and should not be modified: -*.png binary -*.jpg binary -*.jpeg binary -*.gif binary -*.ico binary -*.gz binary -*.zip binary -*.7z binary -*.mp3 binary -*.mp4 binary -*.mov binary - -# Override what is considered "vendored" by GitHub's linguist: -/deps/** linguist-vendored=false -/lib/node_modules/** linguist-vendored=false linguist-generated=false -test/fixtures/** linguist-vendored=false -tools/** linguist-vendored=false - -# Override what is considered "documentation" by GitHub's linguist: -examples/** linguist-documentation=false diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index 6559bc7..0000000 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ /dev/null @@ -1,7 +0,0 @@ - - -We are excited about your pull request, but unfortunately we are not accepting pull requests against this repository, as all development happens on the [main project repository](https://github.com/stdlib-js/stdlib). We kindly request that you submit this pull request against the [respective directory](https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/filter) of the main repository where we’ll review and provide feedback. - -If this is your first stdlib contribution, be sure to read the [contributing guide](https://github.com/stdlib-js/stdlib/blob/develop/CONTRIBUTING.md) which provides guidelines and instructions for submitting contributions. You may also consult the [development guide](https://github.com/stdlib-js/stdlib/blob/develop/docs/development.md) for help on developing stdlib. - -We look forward to receiving your contribution! :smiley: \ No newline at end of file diff --git a/.github/workflows/benchmark.yml b/.github/workflows/benchmark.yml deleted file mode 100644 index 30656c4..0000000 --- a/.github/workflows/benchmark.yml +++ /dev/null @@ -1,64 +0,0 @@ -#/ -# @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. -#/ - -# Workflow name: -name: benchmark - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to run benchmarks: - benchmark: - - # Define a display name: - name: 'Run benchmarks' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA corresponding to v3.8.1 - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Run benchmarks: - - name: 'Run benchmarks' - run: | - npm run benchmark diff --git a/.github/workflows/cancel.yml b/.github/workflows/cancel.yml deleted file mode 100644 index 3acd3a9..0000000 --- a/.github/workflows/cancel.yml +++ /dev/null @@ -1,57 +0,0 @@ -#/ -# @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. -#/ - -# Workflow name: -name: cancel - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to cancel existing workflow runs: - cancel: - - # Define a display name: - name: 'Cancel workflow runs' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Time limit: - timeout-minutes: 3 - - # Define the sequence of job steps... - steps: - - # Cancel existing workflow runs: - - name: 'Cancel existing workflow runs' - # Pin action to full length commit SHA corresponding to v0.11.0 - uses: styfle/cancel-workflow-action@b173b6ec0100793626c2d9e6b90435061f4fc3e5 - with: - workflow_id: >- - benchmark.yml, - examples.yml, - test.yml, - test_coverage.yml, - test_install.yml, - publish.yml - access_token: ${{ github.token }} diff --git a/.github/workflows/close_pull_requests.yml b/.github/workflows/close_pull_requests.yml deleted file mode 100644 index 2060eba..0000000 --- a/.github/workflows/close_pull_requests.yml +++ /dev/null @@ -1,54 +0,0 @@ -#/ -# @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. -#/ - -# Workflow name: -name: close_pull_requests - -# Workflow triggers: -on: - pull_request_target: - types: [opened] - -# Workflow jobs: -jobs: - - # Define job to close all pull requests: - run: - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - - # Close pull request - - name: 'Close pull request' - # Pin action to full length commit SHA corresponding to v3.1.2 - uses: superbrothers/close-pull-request@9c18513d320d7b2c7185fb93396d0c664d5d8448 - with: - comment: | - Thank you for submitting a pull request. :raised_hands: - - We greatly appreciate your willingness to submit a contribution. However, we are not accepting pull requests against this repository, as all development happens on the [main project repository](https://github.com/stdlib-js/stdlib). - - We kindly request that you submit this pull request against the [respective directory](https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/filter) of the main repository where we’ll review and provide feedback. If this is your first stdlib contribution, be sure to read the [contributing guide](https://github.com/stdlib-js/stdlib/blob/develop/CONTRIBUTING.md) which provides guidelines and instructions for submitting contributions. - - Thank you again, and we look forward to receiving your contribution! :smiley: - - Best, - The stdlib team \ No newline at end of file diff --git a/.github/workflows/examples.yml b/.github/workflows/examples.yml deleted file mode 100644 index c92f5c4..0000000 --- a/.github/workflows/examples.yml +++ /dev/null @@ -1,64 +0,0 @@ -#/ -# @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. -#/ - -# Workflow name: -name: examples - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to run the package examples... - examples: - - # Define display name: - name: 'Run examples' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - - # Checkout repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA corresponding to v3.8.1 - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Run examples: - - name: 'Run examples' - run: | - npm run examples diff --git a/.github/workflows/npm_downloads.yml b/.github/workflows/npm_downloads.yml deleted file mode 100644 index 476e0df..0000000 --- a/.github/workflows/npm_downloads.yml +++ /dev/null @@ -1,112 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2022 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. -#/ - -# Workflow name: -name: npm_downloads - -# Workflow triggers: -on: - # Run this workflow weekly: - schedule: - # cron: ' ' - - cron: '48 12 * * 3' - - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job for retrieving npm download counts... - npm_downloads: - - # Define display name: - name: 'Retrieve npm download counts' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - timeout-minutes: 10 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA corresponding to v3.8.1 - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d - with: - node-version: 20 - timeout-minutes: 5 - - # Resolve package name: - - name: 'Resolve package name' - id: package_name - run: | - name=`node -e 'console.log(require("./package.json").name)' | tr -d '\n'` - echo "package_name=$name" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Fetch download data: - - name: 'Fetch data' - id: download_data - run: | - url="https://api.npmjs.org/downloads/range/$(date --date='1 year ago' '+%Y-%m-%d'):$(date '+%Y-%m-%d')/${{ steps.package_name.outputs.package_name }}" - echo "$url" - data=$(curl "$url") - mkdir ./tmp - echo "$data" > ./tmp/npm_downloads.json - echo "data=$data" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Print summary of download data: - - name: 'Print summary' - run: | - echo "| Date | Downloads |" >> $GITHUB_STEP_SUMMARY - echo "|------|------------|" >> $GITHUB_STEP_SUMMARY - cat ./tmp/npm_downloads.json | jq -r ".downloads | .[-14:] | to_entries | map(\"| \(.value.day) | \(.value.downloads) |\") |.[]" >> $GITHUB_STEP_SUMMARY - - # Upload the download data: - - name: 'Upload data' - # Pin action to full length commit SHA corresponding to v3.1.3 - uses: actions/upload-artifact@a8a3f3ad30e3422c9c7b888a15615d19a852ae32 - with: - # Define a name for the uploaded artifact (ensuring a unique name for each job): - name: npm_downloads - - # Specify the path to the file to upload: - path: ./tmp/npm_downloads.json - - # Specify the number of days to retain the artifact (default is 90 days): - retention-days: 90 - timeout-minutes: 10 - if: success() - - # Send data to events server: - - name: 'Post data' - # Pin action to full length commit SHA - uses: distributhor/workflow-webhook@48a40b380ce4593b6a6676528cd005986ae56629 # v3.0.3 - env: - webhook_url: ${{ secrets.STDLIB_NPM_DOWNLOADS_URL }} - webhook_secret: ${{ secrets.STDLIB_WEBHOOK_SECRET }} - data: '{ "downloads": ${{ steps.download_data.outputs.data }} }' - timeout-minutes: 5 - if: success() diff --git a/.github/workflows/productionize.yml b/.github/workflows/productionize.yml deleted file mode 100644 index e1e3539..0000000 --- a/.github/workflows/productionize.yml +++ /dev/null @@ -1,797 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2022 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. -#/ - -# Workflow name: -name: productionize - -# Workflow triggers: -on: - # Run workflow when a new commit is pushed to the main branch: - push: - branches: - - main - - # Allow the workflow to be manually run: - workflow_dispatch: - inputs: - require-passing-tests: - description: 'Require passing tests for creating bundles' - type: boolean - default: true - - # Run workflow upon completion of `publish` workflow run: - workflow_run: - workflows: ["publish"] - types: [completed] - - -# Concurrency group to prevent multiple concurrent executions: -concurrency: - group: productionize - cancel-in-progress: true - -# Workflow jobs: -jobs: - - # Define a job to create a production build... - productionize: - - # Define display name: - name: 'Productionize' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Define the sequence of job steps... - steps: - # Checkout main branch of repository: - - name: 'Checkout main branch' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - with: - ref: main - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA corresponding to v3.8.1 - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d - with: - node-version: 20 - timeout-minutes: 5 - - # Create production branch: - - name: 'Create production branch' - run: | - git checkout -b production - - # Transform error messages: - - name: 'Transform error messages' - id: transform-error-messages - uses: stdlib-js/transform-errors-action@main - - # 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: | - PKG_VERSION=$(npm view @stdlib/error-tools-fmtprodmsg version) - if grep -q '"@stdlib/string-format"' package.json; then - sed -i "s/\"@stdlib\/string-format\": \"^.*\"/\"@stdlib\/error-tools-fmtprodmsg\": \"^$PKG_VERSION\"/g" package.json - else - node -e "var pkg = require( './package.json' ); pkg.dependencies[ '@stdlib/error-tools-fmtprodmsg' ] = '^$PKG_VERSION'; require( 'fs' ).writeFileSync( 'package.json', JSON.stringify( pkg, null, 2 ) );" - fi - - # Configure git: - - name: 'Configure git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Transform error messages" - - # Push changes: - - name: 'Push changes' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" production --force - - # Define a job for running tests of the productionized code... - test: - - # Define a display name: - name: 'Run Tests' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Indicate that this job depends on the prior job finishing: - needs: productionize - - # Run this job regardless of the outcome of the prior job: - if: always() - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout repository' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - with: - # Use the `production` branch: - ref: production - - # Install Node.js: - - name: 'Install Node.js' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA corresponding to v3.8.1 - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Build native add-on if present: - - name: 'Build native add-on (if present)' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - run: | - if [ -f "binding.gyp" ]; then - npm install node-gyp --no-save && ./node_modules/.bin/node-gyp rebuild - fi - - # Run tests: - - name: 'Run tests' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: tests - run: | - npm test || npm test || npm test - - # Define job to create a bundle for use in Deno... - deno: - - # Define display name: - name: 'Create Deno bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Configure git: - - name: 'Configure git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `deno` branch exists: - - name: 'Check if remote `deno` branch exists' - id: deno-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin deno - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `deno` exists, delete everything in branch and merge `production` into it - - name: 'If `deno` exists, delete everything in branch and merge `production` into it' - if: steps.deno-branch-exists.outputs.remote-exists - run: | - git checkout -b deno origin/deno - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `deno` does not exist, create `deno` branch: - - name: 'If `deno` does not exist, create `deno` branch' - if: ${{ steps.deno-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b deno - - # Copy files to deno directory: - - name: 'Copy files to deno directory' - run: | - mkdir -p deno - cp README.md LICENSE CONTRIBUTORS NOTICE ./deno - - # Copy TypeScript definitions to deno directory: - if [ -d index.d.ts ]; then - cp index.d.ts ./deno/index.d.ts - fi - if [ -e ./docs/types/index.d.ts ]; then - cp ./docs/types/index.d.ts ./deno/mod.d.ts - fi - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA corresponding to v3.8.1 - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: Install production and development dependencies - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Bundle package for use in Deno: - - name: 'Bundle package for Deno' - id: deno-bundle - uses: stdlib-js/bundle-action@main - with: - target: 'deno' - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - # Replace links to other packages with links to the deno branch: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/deno/"; - - # Replace reference to `@stdlib/types` with CDN link: - find ./deno -type f -name '*.ts' -print0 | xargs -0 sed -Ei "s/\/\/\/ /\/\/\/ /g" - - # Change wording of project description to avoid reference to JavaScript and Node.js: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "s/a standard library for JavaScript and Node.js, /a standard library /g" - - # Rewrite all `require()`s to use jsDelivr links: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/require\( '@stdlib\// { - s/(var|let|const)\s+([a-z0-9_]+)\s+=\s*require\( '([^']+)' \);/import \2 from \'\3\';/i - s/@stdlib/https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js/ - s/';/@deno\/mod.js';/ - }" - - # Rewrite first `import` to show importing of named exports if available: - exports=$(cat lib/index.js | \ - grep -E 'setReadOnly\(.*,.*,.*\)' | \ - sed -E 's/setReadOnly\((.*),(.*),(.*)\);/\2/' | \ - sed -E "s/'//g" | \ - sort) - if [ -n "$exports" ]; then - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\nimport\s+([a-zA-Z0-9_]+)\s+from\s*'([^']+)';\n\`\`\`/\`\`\`javascript\nimport \1 from '\2';\n\`\`\`\n\nYou can also import the following named exports from the package:\n\n\`\`\`javascript\nimport { $(echo $exports | sed -E 's/ /, /g') } from '\2';\n\`\`\`/" - fi - - # Remove `installation`, `cli`, and `c` sections: - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Create package.json file for deno branch: - jq --indent 2 '{"name": .name, "version": .version, "description": .description, "license": .license, "type": "module", "main": "./mod.js", "homepage": .homepage, "repository": .repository, "bugs": .bugs, "keywords": .keywords, "funding": .funding}' package.json > ./deno/package.json - - # Delete everything in current directory aside from deno folder: - - name: 'Delete everything in current directory aside from deno folder' - run: | - find . -type 'f' | grep -v -e "deno" -e ".git/" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e "deno" -e ".git" | xargs -r rm -rf - - # Move deno directory to root: - - name: 'Move deno directory to root' - run: | - mv ./deno/* . - rmdir ./deno - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Auto-generated commit" - - # Push changes to `deno` branch: - - name: 'Push changes to `deno` branch' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" deno - - # Send status to Slack channel if job fails: - - name: 'Send status to Slack channel in case of failure' - # Pin action to full length commit SHA corresponding to v2.0.0 - uses: act10ns/slack@ed1309ab9862e57e9e583e51c7889486b9a00b0f - with: - status: ${{ job.status }} - steps: ${{ toJson(steps) }} - channel: '#npm-ci' - if: failure() - - # Define job to create a UMD bundle... - umd: - - # Define display name: - name: 'Create UMD bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Configure git: - - name: 'Configure git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `umd` branch exists: - - name: 'Check if remote `umd` branch exists' - id: umd-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin umd - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `umd` exists, delete everything in branch and merge `production` into it - - name: 'If `umd` exists, delete everything in branch and merge `production` into it' - if: steps.umd-branch-exists.outputs.remote-exists - run: | - git checkout -b umd origin/umd - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `umd` does not exist, create `umd` branch: - - name: 'If `umd` does not exist, create `umd` branch' - if: ${{ steps.umd-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b umd - - # Copy files to umd directory: - - name: 'Copy files to umd directory' - run: | - mkdir -p umd - cp README.md LICENSE CONTRIBUTORS NOTICE ./umd - - # Install Node.js - - name: 'Install Node.js' - # Pin action to full length commit SHA corresponding to v3.8.1 - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Extract alias: - - name: 'Extract alias' - id: extract-alias - run: | - alias=$(grep -E 'require\(' README.md | head -n 1 | sed -E 's/^var ([a-zA-Z0-9_]+) = .+/\1/') - echo "alias=${alias}" >> $GITHUB_OUTPUT - - # Create Universal Module Definition (UMD) Node.js bundle: - - name: 'Create Universal Module Definition (UMD) Node.js bundle' - id: umd-bundle-node - uses: stdlib-js/bundle-action@main - with: - target: 'umd-node' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Create Universal Module Definition (UMD) browser bundle: - - name: 'Create Universal Module Definition (UMD) browser bundle' - id: umd-bundle-browser - uses: stdlib-js/bundle-action@main - with: - target: 'umd-browser' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - - # Replace links to other packages with links to the umd branch: - find ./umd -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/umd/"; - - # Remove `installation`, `cli`, and `c` sections: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Rewrite first `require()` to show consumption of the UMD bundle in Observable and via a `script` tag: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\n(var|let|const)\s+([a-zA-Z0-9_]+)\s+=\s*require\( '\@stdlib\/([^']+)' \);\n\`\`\`/To use in Observable,\n\n\`\`\`javascript\n\2 = require\( 'https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js\/\3\@umd\/browser.js' \)\n\`\`\`\n\nTo vendor stdlib functionality and avoid installing dependency trees for Node.js, you can use the UMD server build:\n\n\`\`\`javascript\nvar \2 = require\( 'path\/to\/vendor\/umd\/\3\/index.js' \)\n\`\`\`\n\nTo include the bundle in a webpage,\n\n\`\`\`html\n + + ```
@@ -187,7 +180,7 @@ var out = filter( x, naryFunction( isPositiveInteger, 1 ) ); ## 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. +This package is part of [stdlib][stdlib], a standard library 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]. diff --git a/SECURITY.md b/SECURITY.md deleted file mode 100644 index 9702d4c..0000000 --- a/SECURITY.md +++ /dev/null @@ -1,5 +0,0 @@ -# Security - -> Policy for reporting security vulnerabilities. - -See the security policy [in the main project repository](https://github.com/stdlib-js/stdlib/security). diff --git a/benchmark/benchmark.length.js b/benchmark/benchmark.length.js deleted file mode 100644 index bc79e33..0000000 --- a/benchmark/benchmark.length.js +++ /dev/null @@ -1,97 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 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 bench = require( '@stdlib/bench-harness' ); -var pow = require( '@stdlib/math-base-special-pow' ); -var isArray = require( '@stdlib/assert-is-array' ); -var isNonNegativeInteger = require( '@stdlib/assert-is-nonnegative-integer' ).isPrimitive; -var zeroTo = require( '@stdlib/array-base-zero-to' ); -var pkg = require( './../package.json' ).name; -var filter = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveInteger} len - array length -* @returns {Function} benchmark function -*/ -function createBenchmark( len ) { - var x = zeroTo( len ); - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var out; - var i; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - out = filter( x, isNonNegativeInteger ); - if ( typeof out !== 'object' ) { - b.fail( 'should return an array' ); - } - } - b.toc(); - if ( !isArray( out ) ) { - b.fail( 'should return an array' ); - } - b.pass( 'benchmark finished' ); - b.end(); - } -} - - -// MAIN // - -/** -* Main execution sequence. -* -* @private -*/ -function main() { - var len; - var min; - var max; - var f; - var i; - - min = 1; // 10^min - max = 6; // 10^max - - for ( i = min; i <= max; i++ ) { - len = pow( 10, i ); - - f = createBenchmark( len ); - bench( pkg+':dtype=generic,len='+len, f ); - } -} - -main(); diff --git a/branches.md b/branches.md deleted file mode 100644 index 70b81e2..0000000 --- a/branches.md +++ /dev/null @@ -1,53 +0,0 @@ - - -# Branches - -This repository has the following branches: - -- **main**: default branch generated from the [stdlib project][stdlib-url], where all development takes place. -- **production**: [production build][production-url] of the package (e.g., reformatted error messages to reduce bundle sizes and thus the number of bytes transmitted over a network). -- **esm**: [ES Module][esm-url] branch for use via a `script` tag without the need for installation and bundlers. -- **deno**: [Deno][deno-url] branch for use in Deno. -- **umd**: [UMD][umd-url] branch for use in Observable, or in dual browser/Node.js environments. - -The following diagram illustrates the relationships among the above branches: - -```mermaid -graph TD; -A[stdlib]-->|generate standalone package|B; -B[main] -->|productionize| C[production]; -C -->|bundle| D[esm]; -C -->|bundle| E[deno]; -C -->|bundle| F[umd]; - -%% click A href "https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/filter" -%% click B href "https://github.com/stdlib-js/array-base-filter/tree/main" -%% click C href "https://github.com/stdlib-js/array-base-filter/tree/production" -%% click D href "https://github.com/stdlib-js/array-base-filter/tree/esm" -%% click E href "https://github.com/stdlib-js/array-base-filter/tree/deno" -%% click F href "https://github.com/stdlib-js/array-base-filter/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/filter -[production-url]: https://github.com/stdlib-js/array-base-filter/tree/production -[deno-url]: https://github.com/stdlib-js/array-base-filter/tree/deno -[umd-url]: https://github.com/stdlib-js/array-base-filter/tree/umd -[esm-url]: https://github.com/stdlib-js/array-base-filter/tree/esm \ No newline at end of file diff --git a/dist/index.d.ts b/dist/index.d.ts deleted file mode 100644 index aafb9cb..0000000 --- a/dist/index.d.ts +++ /dev/null @@ -1,3 +0,0 @@ -/// -import filter from '../docs/types/index'; -export = filter; \ No newline at end of file diff --git a/dist/index.js b/dist/index.js deleted file mode 100644 index 5c2f789..0000000 --- a/dist/index.js +++ /dev/null @@ -1,5 +0,0 @@ -"use strict";var s=function(r,t){return function(){return t||r((t={exports:{}}).exports,t),t.exports}};var f=s(function(y,c){ -var v=require('@stdlib/array-base-arraylike2object/dist');function l(r,t){return typeof r[t]=="function"}function h(r,t,n){var e,o,a;for(e=[],a=0;a 0;\n* }\n*\n* var x = [ 1, -2, -3, 4 ];\n*\n* var out = internal( x, isPositive );\n* // returns [ 1, 4 ]\n*/\nfunction internal( x, predicate, thisArg ) {\n\tvar out;\n\tvar v;\n\tvar i;\n\n\tout = [];\n\tfor ( i = 0; i < x.length; i++ ) {\n\t\tv = x[ i ];\n\t\tif ( predicate.call( thisArg, v, i, x ) ) {\n\t\t\tout.push( v );\n\t\t}\n\t}\n\treturn out;\n}\n\n/**\n* Returns a shallow copy of an array containing only those elements which pass a test implemented by a predicate function.\n*\n* @private\n* @param {Object} x - input array object\n* @param {Function} predicate - test function\n* @param {*} thisArg - execution context\n* @returns {Array} output array\n*\n* @example\n* var toAccessorArray = require( '@stdlib/array-base-to-accessor-array' );\n* var arraylike2object = require( '@stdlib/array-base-arraylike2object' );\n*\n* function isPositive( v ) {\n* return v > 0;\n* }\n*\n* var x = arraylike2object( toAccessorArray( [ 1, -2, -3, 4 ] ) );\n*\n* var out = accessors( x, isPositive );\n* // returns [ 1, 4 ]\n*/\nfunction accessors( x, predicate, thisArg ) {\n\tvar data;\n\tvar get;\n\tvar out;\n\tvar v;\n\tvar i;\n\n\tdata = x.data;\n\tget = x.accessors[ 0 ];\n\n\tout = [];\n\tfor ( i = 0; i < data.length; i++ ) {\n\t\tv = get( data, i );\n\t\tif ( predicate.call( thisArg, v, i, data ) ) {\n\t\t\tout.push( v );\n\t\t}\n\t}\n\treturn out;\n}\n\n\n// MAIN //\n\n/**\n* Returns a shallow copy of an array containing only those elements which pass a test implemented by a predicate function.\n*\n* @param {Collection} x - input array\n* @param {Function} predicate - test function\n* @param {*} [thisArg] - execution context\n* @returns {Collection} output array\n*\n* @example\n* function isPositive( v ) {\n* return v > 0;\n* }\n*\n* var x = [ 1, -2, -3, 4 ];\n*\n* var out = filter( x, isPositive );\n* // returns [ 1, 4 ]\n*/\nfunction filter( x, predicate, thisArg ) {\n\tvar obj;\n\tif ( hasMethod( x, 'filter' ) ) {\n\t\treturn x.filter( predicate, thisArg );\n\t}\n\tobj = arraylike2object( x );\n\tif ( obj.accessorProtocol ) {\n\t\treturn accessors( obj, predicate, thisArg );\n\t}\n\treturn internal( x, predicate, thisArg );\n}\n\n\n// EXPORTS //\n\nmodule.exports = filter;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2024 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* Return a shallow copy of an array containing only those elements which pass a test implemented by a predicate function.\n*\n* @module @stdlib/array-base-filter\n*\n* @example\n* var filter = require( '@stdlib/array-base-filter' );\n*\n* function isPositive( v ) {\n* return v > 0;\n* }\n*\n* var x = [ 1, -2, -3, 4 ];\n*\n* var out = filter( x, isPositive );\n* // returns [ 1, 4 ]\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,EAAmB,QAAS,qCAAsC,EAqBtE,SAASC,EAAWC,EAAKC,EAAS,CACjC,OAAS,OAAOD,EAAKC,CAAO,GAAM,UACnC,CAqBA,SAASC,EAAUC,EAAGC,EAAWC,EAAU,CAC1C,IAAIC,EACAC,EACAC,EAGJ,IADAF,EAAM,CAAC,EACDE,EAAI,EAAGA,EAAIL,EAAE,OAAQK,IAC1BD,EAAIJ,EAAGK,CAAE,EACJJ,EAAU,KAAMC,EAASE,EAAGC,EAAGL,CAAE,GACrCG,EAAI,KAAMC,CAAE,EAGd,OAAOD,CACR,CAwBA,SAASG,EAAWN,EAAGC,EAAWC,EAAU,CAC3C,IAAIK,EACAC,EACAL,EACAC,EACAC,EAMJ,IAJAE,EAAOP,EAAE,KACTQ,EAAMR,EAAE,UAAW,CAAE,EAErBG,EAAM,CAAC,EACDE,EAAI,EAAGA,EAAIE,EAAK,OAAQF,IAC7BD,EAAII,EAAKD,EAAMF,CAAE,EACZJ,EAAU,KAAMC,EAASE,EAAGC,EAAGE,CAAK,GACxCJ,EAAI,KAAMC,CAAE,EAGd,OAAOD,CACR,CAuBA,SAASM,EAAQT,EAAGC,EAAWC,EAAU,CACxC,IAAIL,EACJ,OAAKD,EAAWI,EAAG,QAAS,EACpBA,EAAE,OAAQC,EAAWC,CAAQ,GAErCL,EAAMF,EAAkBK,CAAE,EACrBH,EAAI,iBACDS,EAAWT,EAAKI,EAAWC,CAAQ,EAEpCH,EAAUC,EAAGC,EAAWC,CAAQ,EACxC,CAKAR,EAAO,QAAUe,ICvHjB,IAAIC,EAAO,IAKX,OAAO,QAAUA", - "names": ["require_main", "__commonJSMin", "exports", "module", "arraylike2object", "hasMethod", "obj", "method", "internal", "x", "predicate", "thisArg", "out", "v", "i", "accessors", "data", "get", "filter", "main"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index bb2b17a..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,46 +0,0 @@ - -{{alias}}( x, predicate[, thisArg] ) - Returns a shallow copy of an array containing only those elements which pass - a test implemented by a predicate function. - - The predicate function is provided three arguments: - - - value: current array element. - - index: current array element index. - - arr: the input array. - - If provided an array-like object having a `filter` method , the function - defers execution to that method and assumes that the method has the - following signature: - - x.filter( predicate, thisArg ) - - If provided an array-like object without a `filter` method, the function - performs a linear scan and always returns a generic array. - - Parameters - ---------- - x: Array|TypedArray|Object - Input array. - - predicate: Function - Predicate function. - - thisArg: any (optional) - Execution context. - - Returns - ------- - out: Array|TypedArray|Object - Output array. - - Examples - -------- - > function f( v ) { return ( v > 0 ); }; - > var x = [ 1, -2, -3, 4 ]; - > var out = {{alias}}( x, f ) - [ 1, 4 ] - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index db0c38d..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,101 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2024 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. -*/ - -import toAccessorArray = require( '@stdlib/array-base-to-accessor-array' ); -import filter = require( './index' ); - -/** -* Tests whether a value is positive. -* -* @param value - input value -* @returns boolean indicating whether an element is positive -*/ -function isPositive( value: number ): boolean { - return ( value > 0 ); -} - - -// TESTS // - -// The function returns a collection... -{ - filter( [ 1, 2, 3 ], isPositive ); // $ExpectType number[] - filter( new Float64Array( [ 1, 2, 3 ] ), isPositive ); // $ExpectType Float64Array - filter( new Float32Array( [ 1, 2, 3 ] ), isPositive ); // $ExpectType Float32Array - filter( new Int32Array( [ 1, 2, 3 ] ), isPositive ); // $ExpectType Int32Array - filter( new Int16Array( [ 1, 2, 3 ] ), isPositive ); // $ExpectType Int16Array - filter( new Int8Array( [ 1, 2, 3 ] ), isPositive ); // $ExpectType Int8Array - filter( new Uint32Array( [ 1, 2, 3 ] ), isPositive ); // $ExpectType Uint32Array - filter( new Uint16Array( [ 1, 2, 3 ] ), isPositive ); // $ExpectType Uint16Array - filter( new Uint8Array( [ 1, 2, 3 ] ), isPositive ); // $ExpectType Uint8Array - filter( new Uint8ClampedArray( [ 1, 2, 3 ] ), isPositive ); // $ExpectType Uint8ClampedArray - filter( toAccessorArray( [ 1, 2, 3 ] ), isPositive ); // $ExpectType number[] - - filter( [ 1, 2, 3 ], isPositive, {} ); // $ExpectType number[] - filter( new Float64Array( [ 1, 2, 3 ] ), isPositive, {} ); // $ExpectType Float64Array - filter( new Float32Array( [ 1, 2, 3 ] ), isPositive, {} ); // $ExpectType Float32Array - filter( new Int32Array( [ 1, 2, 3 ] ), isPositive, {} ); // $ExpectType Int32Array - filter( new Int16Array( [ 1, 2, 3 ] ), isPositive, {} ); // $ExpectType Int16Array - filter( new Int8Array( [ 1, 2, 3 ] ), isPositive, {} ); // $ExpectType Int8Array - filter( new Uint32Array( [ 1, 2, 3 ] ), isPositive, {} ); // $ExpectType Uint32Array - filter( new Uint16Array( [ 1, 2, 3 ] ), isPositive, {} ); // $ExpectType Uint16Array - filter( new Uint8Array( [ 1, 2, 3 ] ), isPositive, {} ); // $ExpectType Uint8Array - filter( new Uint8ClampedArray( [ 1, 2, 3 ] ), isPositive, {} ); // $ExpectType Uint8ClampedArray - filter( toAccessorArray( [ 1, 2, 3 ] ), isPositive, {} ); // $ExpectType number[] -} - -// The compiler throws an error if the function is provided a first argument which is not a collection... -{ - filter( 2, isPositive ); // $ExpectError - filter( false, isPositive ); // $ExpectError - filter( true, isPositive ); // $ExpectError - filter( {}, isPositive ); // $ExpectError - - filter( 2, isPositive, {} ); // $ExpectError - filter( false, isPositive, {} ); // $ExpectError - filter( true, isPositive, {} ); // $ExpectError - filter( {}, isPositive, {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided a second argument which is not a function... -{ - filter( [ 1, 2, 3 ], 'abc' ); // $ExpectError - filter( [ 1, 2, 3 ], 2 ); // $ExpectError - filter( [ 1, 2, 3 ], false ); // $ExpectError - filter( [ 1, 2, 3 ], true ); // $ExpectError - filter( [ 1, 2, 3 ], null ); // $ExpectError - filter( [ 1, 2, 3 ], void 0 ); // $ExpectError - filter( [ 1, 2, 3 ], {} ); // $ExpectError - filter( [ 1, 2, 3 ], [] ); // $ExpectError - - filter( [ 1, 2, 3 ], 'abc', {} ); // $ExpectError - filter( [ 1, 2, 3 ], 2, {} ); // $ExpectError - filter( [ 1, 2, 3 ], false, {} ); // $ExpectError - filter( [ 1, 2, 3 ], true, {} ); // $ExpectError - filter( [ 1, 2, 3 ], null, {} ); // $ExpectError - filter( [ 1, 2, 3 ], void 0, {} ); // $ExpectError - filter( [ 1, 2, 3 ], {}, {} ); // $ExpectError - filter( [ 1, 2, 3 ], [], {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided an unsupported number of arguments... -{ - filter(); // $ExpectError - filter( [ 1, 2, 3 ] ); // $ExpectError - filter( [ 1, 2, 3 ], isPositive, {}, 3 ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index cdfb9a7..0000000 --- a/examples/index.js +++ /dev/null @@ -1,35 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 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'; - -var discreteUniform = require( '@stdlib/random-array-discrete-uniform' ); -var isPositiveInteger = require( '@stdlib/assert-is-positive-integer' ).isPrimitive; -var naryFunction = require( '@stdlib/utils-nary-function' ); -var filter = require( './../lib' ); - -var x = discreteUniform( 10, -5, 5, { - 'dtype': 'int32' -}); -// returns - -var out = filter( x, naryFunction( isPositiveInteger, 1 ) ); -// returns - -console.log( x ); -console.log( out ); diff --git a/docs/types/index.d.ts b/index.d.ts similarity index 99% rename from docs/types/index.d.ts rename to index.d.ts index 0f92cfd..1fa8dc7 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 4.1 -/// +/// import { Collection, AccessorArrayLike, Complex128Array, Complex64Array } from '@stdlib/types/array'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..48ac85d --- /dev/null +++ b/index.mjs @@ -0,0 +1,4 @@ +// Copyright (c) 2024 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 +/// +import r from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-arraylike2object@v0.1.0-esm/index.mjs";function t(t,e,n){var o;return function(r,t){return"function"==typeof r[t]}(t,"filter")?t.filter(e,n):(o=r(t)).accessorProtocol?function(r,t,e){var n,o,a,s,c;for(n=r.data,o=r.accessors[0],a=[],c=0;c 0;\n* }\n*\n* var x = [ 1, -2, -3, 4 ];\n*\n* var out = internal( x, isPositive );\n* // returns [ 1, 4 ]\n*/\nfunction internal( x, predicate, thisArg ) {\n\tvar out;\n\tvar v;\n\tvar i;\n\n\tout = [];\n\tfor ( i = 0; i < x.length; i++ ) {\n\t\tv = x[ i ];\n\t\tif ( predicate.call( thisArg, v, i, x ) ) {\n\t\t\tout.push( v );\n\t\t}\n\t}\n\treturn out;\n}\n\n/**\n* Returns a shallow copy of an array containing only those elements which pass a test implemented by a predicate function.\n*\n* @private\n* @param {Object} x - input array object\n* @param {Function} predicate - test function\n* @param {*} thisArg - execution context\n* @returns {Array} output array\n*\n* @example\n* import toAccessorArray from '@stdlib/array-base-to-accessor-array';\n* import arraylike2object from '@stdlib/array-base-arraylike2object';\n*\n* function isPositive( v ) {\n* return v > 0;\n* }\n*\n* var x = arraylike2object( toAccessorArray( [ 1, -2, -3, 4 ] ) );\n*\n* var out = accessors( x, isPositive );\n* // returns [ 1, 4 ]\n*/\nfunction accessors( x, predicate, thisArg ) {\n\tvar data;\n\tvar get;\n\tvar out;\n\tvar v;\n\tvar i;\n\n\tdata = x.data;\n\tget = x.accessors[ 0 ];\n\n\tout = [];\n\tfor ( i = 0; i < data.length; i++ ) {\n\t\tv = get( data, i );\n\t\tif ( predicate.call( thisArg, v, i, data ) ) {\n\t\t\tout.push( v );\n\t\t}\n\t}\n\treturn out;\n}\n\n\n// MAIN //\n\n/**\n* Returns a shallow copy of an array containing only those elements which pass a test implemented by a predicate function.\n*\n* @param {Collection} x - input array\n* @param {Function} predicate - test function\n* @param {*} [thisArg] - execution context\n* @returns {Collection} output array\n*\n* @example\n* function isPositive( v ) {\n* return v > 0;\n* }\n*\n* var x = [ 1, -2, -3, 4 ];\n*\n* var out = filter( x, isPositive );\n* // returns [ 1, 4 ]\n*/\nfunction filter( x, predicate, thisArg ) {\n\tvar obj;\n\tif ( hasMethod( x, 'filter' ) ) {\n\t\treturn x.filter( predicate, thisArg );\n\t}\n\tobj = arraylike2object( x );\n\tif ( obj.accessorProtocol ) {\n\t\treturn accessors( obj, predicate, thisArg );\n\t}\n\treturn internal( x, predicate, thisArg );\n}\n\n\n// EXPORTS //\n\nexport default filter;\n"],"names":["filter","x","predicate","thisArg","obj","method","hasMethod","arraylike2object","accessorProtocol","data","get","out","v","i","accessors","length","call","push","internal"],"mappings":";;sGAgJA,SAASA,EAAQC,EAAGC,EAAWC,GAC9B,IAAIC,EACJ,OAvGD,SAAoBA,EAAKC,GACxB,MAAkC,mBAAlBD,EAAKC,EACtB,CAqGMC,CAAWL,EAAG,UACXA,EAAED,OAAQE,EAAWC,IAE7BC,EAAMG,EAAkBN,IACfO,iBA/CV,SAAoBP,EAAGC,EAAWC,GACjC,IAAIM,EACAC,EACAC,EACAC,EACAC,EAMJ,IAJAJ,EAAOR,EAAEQ,KACTC,EAAMT,EAAEa,UAAW,GAEnBH,EAAM,GACAE,EAAI,EAAGA,EAAIJ,EAAKM,OAAQF,IAC7BD,EAAIF,EAAKD,EAAMI,GACVX,EAAUc,KAAMb,EAASS,EAAGC,EAAGJ,IACnCE,EAAIM,KAAML,GAGZ,OAAOD,CACR,CA8BSG,CAAWV,EAAKF,EAAWC,GArFpC,SAAmBF,EAAGC,EAAWC,GAChC,IAAIQ,EACAC,EACAC,EAGJ,IADAF,EAAM,GACAE,EAAI,EAAGA,EAAIZ,EAAEc,OAAQF,IAC1BD,EAAIX,EAAGY,GACFX,EAAUc,KAAMb,EAASS,EAAGC,EAAGZ,IACnCU,EAAIM,KAAML,GAGZ,OAAOD,CACR,CA0EQO,CAAUjB,EAAGC,EAAWC,EAChC"} \ No newline at end of file diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index 56236cd..0000000 --- a/lib/index.js +++ /dev/null @@ -1,46 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 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'; - -/** -* Return a shallow copy of an array containing only those elements which pass a test implemented by a predicate function. -* -* @module @stdlib/array-base-filter -* -* @example -* var filter = require( '@stdlib/array-base-filter' ); -* -* function isPositive( v ) { -* return v > 0; -* } -* -* var x = [ 1, -2, -3, 4 ]; -* -* var out = filter( x, isPositive ); -* // returns [ 1, 4 ] -*/ - -// MODULES // - -var main = require( './main.js' ); - - -// EXPORTS // - -module.exports = main; diff --git a/lib/main.js b/lib/main.js deleted file mode 100644 index 9b0c3db..0000000 --- a/lib/main.js +++ /dev/null @@ -1,160 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 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 arraylike2object = require( '@stdlib/array-base-arraylike2object' ); - - -// FUNCTIONS // - -/** -* Tests whether an object has a specified method. -* -* @private -* @param {Object} obj - input object -* @param {string} method - method name -* @returns {boolean} boolean indicating whether an object has a specified method -* -* @example -* var bool = hasMethod( [], 'filter' ); -* // returns true -* -* @example -* var bool = hasMethod( [], 'beep' ); -* // returns false -*/ -function hasMethod( obj, method ) { - return ( typeof obj[ method ] === 'function' ); -} - -/** -* Returns a shallow copy of an array containing only those elements which pass a test implemented by a predicate function. -* -* @private -* @param {Collection} x - input array -* @param {Function} predicate - test function -* @param {*} thisArg - execution context -* @returns {Array} output array -* -* @example -* function isPositive( v ) { -* return v > 0; -* } -* -* var x = [ 1, -2, -3, 4 ]; -* -* var out = internal( x, isPositive ); -* // returns [ 1, 4 ] -*/ -function internal( x, predicate, thisArg ) { - var out; - var v; - var i; - - out = []; - for ( i = 0; i < x.length; i++ ) { - v = x[ i ]; - if ( predicate.call( thisArg, v, i, x ) ) { - out.push( v ); - } - } - return out; -} - -/** -* Returns a shallow copy of an array containing only those elements which pass a test implemented by a predicate function. -* -* @private -* @param {Object} x - input array object -* @param {Function} predicate - test function -* @param {*} thisArg - execution context -* @returns {Array} output array -* -* @example -* var toAccessorArray = require( '@stdlib/array-base-to-accessor-array' ); -* var arraylike2object = require( '@stdlib/array-base-arraylike2object' ); -* -* function isPositive( v ) { -* return v > 0; -* } -* -* var x = arraylike2object( toAccessorArray( [ 1, -2, -3, 4 ] ) ); -* -* var out = accessors( x, isPositive ); -* // returns [ 1, 4 ] -*/ -function accessors( x, predicate, thisArg ) { - var data; - var get; - var out; - var v; - var i; - - data = x.data; - get = x.accessors[ 0 ]; - - out = []; - for ( i = 0; i < data.length; i++ ) { - v = get( data, i ); - if ( predicate.call( thisArg, v, i, data ) ) { - out.push( v ); - } - } - return out; -} - - -// MAIN // - -/** -* Returns a shallow copy of an array containing only those elements which pass a test implemented by a predicate function. -* -* @param {Collection} x - input array -* @param {Function} predicate - test function -* @param {*} [thisArg] - execution context -* @returns {Collection} output array -* -* @example -* function isPositive( v ) { -* return v > 0; -* } -* -* var x = [ 1, -2, -3, 4 ]; -* -* var out = filter( x, isPositive ); -* // returns [ 1, 4 ] -*/ -function filter( x, predicate, thisArg ) { - var obj; - if ( hasMethod( x, 'filter' ) ) { - return x.filter( predicate, thisArg ); - } - obj = arraylike2object( x ); - if ( obj.accessorProtocol ) { - return accessors( obj, predicate, thisArg ); - } - return internal( x, predicate, thisArg ); -} - - -// EXPORTS // - -module.exports = filter; diff --git a/package.json b/package.json index 40b4c23..4130a43 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.0.0", "description": "Return a shallow copy of an array containing only those elements which pass a test implemented by a predicate function.", "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", - "directories": { - "benchmark": "./benchmark", - "doc": "./docs", - "example": "./examples", - "lib": "./lib", - "test": "./test" - }, - "types": "./docs/types", - "scripts": { - "test": "make test", - "test-cov": "make test-cov", - "examples": "make examples", - "benchmark": "make benchmark" - }, + "type": "module", + "main": "./index.mjs", "homepage": "https://stdlib.io", "repository": { "type": "git", @@ -36,42 +13,6 @@ "bugs": { "url": "https://github.com/stdlib-js/stdlib/issues" }, - "dependencies": { - "@stdlib/array-base-arraylike2object": "^0.1.0", - "@stdlib/types": "^0.2.0", - "@stdlib/error-tools-fmtprodmsg": "^0.1.1" - }, - "devDependencies": { - "@stdlib/array-base-accessor": "^0.1.0", - "@stdlib/array-base-zero-to": "^0.1.0", - "@stdlib/array-float64": "^0.1.1", - "@stdlib/assert-instance-of": "^0.1.1", - "@stdlib/assert-is-array": "^0.1.1", - "@stdlib/assert-is-nonnegative-integer": "^0.1.0", - "@stdlib/assert-is-positive-integer": "^0.1.0", - "@stdlib/math-base-special-pow": "^0.1.0", - "@stdlib/random-array-discrete-uniform": "^0.1.0", - "@stdlib/utils-nary-function": "^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", - "@stdlib/bench-harness": "^0.1.2" - }, - "engines": { - "node": ">=0.10.0", - "npm": ">2.7.0" - }, - "os": [ - "aix", - "darwin", - "freebsd", - "linux", - "macos", - "openbsd", - "sunos", - "win32", - "windows" - ], "keywords": [ "stdlib", "stdtypes", @@ -91,4 +32,4 @@ "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} \ No newline at end of file +} diff --git a/stats.html b/stats.html new file mode 100644 index 0000000..5910c97 --- /dev/null +++ b/stats.html @@ -0,0 +1,6177 @@ + + + + + + + + Rollup Visualizer + + + +
+ + + + + diff --git a/test/dist/test.js b/test/dist/test.js deleted file mode 100644 index a8a9c60..0000000 --- a/test/dist/test.js +++ /dev/null @@ -1,33 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 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 tape = require( 'tape' ); -var main = require( './../../dist' ); - - -// TESTS // - -tape( 'main export is defined', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( main !== void 0, true, 'main export is defined' ); - t.end(); -}); diff --git a/test/test.js b/test/test.js deleted file mode 100644 index d4e7373..0000000 --- a/test/test.js +++ /dev/null @@ -1,251 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 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 tape = require( 'tape' ); -var AccessorArray = require( '@stdlib/array-base-accessor' ); -var Float64Array = require( '@stdlib/array-float64' ); -var instanceOf = require( '@stdlib/assert-instance-of' ); -var filter = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Tests whether a value is positive. -* -* @private -* @param {number} value - input value -* @returns {boolean} boolean indicating if a value is positive -*/ -function isPositive( value ) { - return ( value > 0 ); -} - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof filter, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'if provided an empty collection, the function returns an empty collection (generic)', function test( t ) { - var expected; - var actual; - var arr; - - arr = []; - expected = []; - actual = filter( arr, foo ); - - t.strictEqual( instanceOf( actual, Array ), true, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - t.end(); - - function foo() { - t.fail( 'should not be invoked' ); - } -}); - -tape( 'if provided an empty collection, the function returns an empty collection (typed array)', function test( t ) { - var expected; - var actual; - var arr; - - arr = new Float64Array( [] ); - expected = new Float64Array( [] ); - actual = filter( arr, foo ); - - t.strictEqual( instanceOf( actual, Float64Array ), true, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - t.end(); - - function foo() { - t.fail( 'should not be invoked' ); - } -}); - -tape( 'if provided an empty collection, the function returns an empty collection (accessor)', function test( t ) { - var expected; - var actual; - var arr; - - arr = new AccessorArray( [] ); - expected = []; - actual = filter( arr, foo ); - - t.strictEqual( instanceOf( actual, Array ), true, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - t.end(); - - function foo() { - t.fail( 'should not be invoked' ); - } -}); - -tape( 'the function filters a provided collection (generic)', function test( t ) { - var expected; - var actual; - var arr; - - arr = [ 1, -2, 3 ]; - expected = [ 1, 3 ]; - actual = filter( arr, isPositive ); - - t.strictEqual( instanceOf( actual, Array ), true, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - t.end(); -}); - -tape( 'the function filters a provided collection (typed array)', function test( t ) { - var expected; - var actual; - var arr; - - arr = new Float64Array( [ -1.0, 2.0, 3.0 ] ); - expected = new Float64Array( [ 2.0, 3.0 ] ); - actual = filter( arr, isPositive ); - - t.strictEqual( instanceOf( actual, Float64Array ), true, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - t.end(); -}); - -tape( 'the function filters a provided collection (accessor)', function test( t ) { - var expected; - var actual; - var arr; - - arr = new AccessorArray( [ 1, -2, -3 ] ); - expected = [ 1 ]; - actual = filter( arr, isPositive ); - - t.strictEqual( instanceOf( actual, Array ), true, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - t.end(); -}); - -tape( 'the function filters a provided collection (array-like object)', function test( t ) { - var expected; - var actual; - var arr; - - arr = { - 'length': 3, - '0': -1, - '1': -2, - '2': 3 - }; - expected = [ 3 ]; - actual = filter( arr, isPositive ); - - t.strictEqual( instanceOf( actual, Array ), true, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - t.end(); -}); - -tape( 'the function an empty collection if all elements fail a test (generic)', function test( t ) { - var expected; - var actual; - var arr; - - arr = [ -1, -2, -3 ]; - expected = []; - actual = filter( arr, isPositive ); - - t.strictEqual( instanceOf( actual, Array ), true, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - t.end(); -}); - -tape( 'the function an empty collection if all elements fail a test (typed array)', function test( t ) { - var expected; - var actual; - var arr; - - arr = new Float64Array( [ -1.0, -2.0, -3.0 ] ); - expected = new Float64Array( [] ); - actual = filter( arr, isPositive ); - - t.strictEqual( instanceOf( actual, Float64Array ), true, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - t.end(); -}); - -tape( 'the function an empty collection if all elements fail a test (accessor)', function test( t ) { - var expected; - var actual; - var arr; - - arr = new AccessorArray( [ -1, -2, -3 ] ); - expected = []; - actual = filter( arr, isPositive ); - - t.strictEqual( instanceOf( actual, Array ), true, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - t.end(); -}); - -tape( 'the function an empty collection if all elements fail a test (array-like object)', function test( t ) { - var expected; - var actual; - var arr; - - arr = { - 'length': 3, - '0': -1, - '1': -2, - '2': -3 - }; - expected = []; - actual = filter( arr, isPositive ); - - t.strictEqual( instanceOf( actual, Array ), true, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - t.end(); -}); - -tape( 'the function supports providing an execution context', function test( t ) { - var expected; - var actual; - var ctx; - var arr; - - ctx = { - 'count': 0 - }; - arr = [ 1, 2, 3 ]; - expected = [ 1, 2, 3 ]; - actual = filter( arr, predicate, ctx ); - - t.strictEqual( instanceOf( actual, Array ), true, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - t.strictEqual( ctx.count, arr.length, 'returns expected value' ); - - t.end(); - - function predicate( value ) { - this.count += 1; // eslint-disable-line no-invalid-this - return ( value > 0 ); - } -}); From 53329d778e338cd8bb1f9696bad243c69064c400 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Thu, 25 Jan 2024 13:42:11 +0000 Subject: [PATCH 03/40] Transform error messages --- package.json | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/package.json b/package.json index 441b764..717a554 100644 --- a/package.json +++ b/package.json @@ -38,7 +38,8 @@ }, "dependencies": { "@stdlib/array-base-arraylike2object": "^0.1.0", - "@stdlib/types": "^0.2.0" + "@stdlib/types": "^0.2.0", + "@stdlib/error-tools-fmtprodmsg": "^0.1.1" }, "devDependencies": { "@stdlib/array-base-accessor": "^0.1.0", @@ -90,4 +91,4 @@ "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} +} \ No newline at end of file From d1b07574973dd362642af3ed49df32241a2533b2 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Thu, 25 Jan 2024 13:42:38 +0000 Subject: [PATCH 04/40] Remove files --- index.d.ts | 343 --- index.mjs | 4 - index.mjs.map | 1 - stats.html | 6177 ------------------------------------------------- 4 files changed, 6525 deletions(-) delete mode 100644 index.d.ts delete mode 100644 index.mjs delete mode 100644 index.mjs.map delete mode 100644 stats.html diff --git a/index.d.ts b/index.d.ts deleted file mode 100644 index 1fa8dc7..0000000 --- a/index.d.ts +++ /dev/null @@ -1,343 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2024 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 - -/// - -import { Collection, AccessorArrayLike, Complex128Array, Complex64Array } from '@stdlib/types/array'; - -/** -* Returns a boolean indicating whether an element passes a test. -* -* @returns boolean indicating whether an element passes a test -*/ -type Nullary = ( this: U ) => boolean; - -/** -* Returns a boolean indicating whether an element passes a test. -* -* @param value - current array element -* @returns boolean indicating whether an element passes a test -*/ -type Unary = ( this: U, value: T ) => boolean; - -/** -* Returns a boolean indicating whether an element passes a test. -* -* @param value - current array element -* @param index - current array element index -* @returns boolean indicating whether an element passes a test -*/ -type Binary = ( this: U, value: T, index: number ) => boolean; - -/** -* Returns a boolean indicating whether an element passes a test. -* -* @param value - current array element -* @param index - current array element index -* @param arr - input array -* @returns boolean indicating whether an element passes a test -*/ -type Ternary = ( this: U, value: T, index: number, arr: V ) => boolean; - -/** -* Returns a boolean indicating whether an element passes a test. -* -* @param value - current array element -* @param index - current array element index -* @param arr - input array -* @returns boolean indicating whether an element passes a test -*/ -type Predicate = Nullary | Unary | Binary | Ternary; - -/** -* Returns a shallow copy of an array containing only those elements which pass a test implemented by a predicate function. -* -* @param x - input array -* @param predicate - predicate function -* @param thisArg - predicate function execution context -* @returns output array -* -* @example -* var isPositiveNumber = require( '@stdlib/assert-is-positive-number' ).isPrimitive; -* var Float64Array = require( '@stdlib/array-float64' ); -* -* var x = new Float64Array( [ 1.0, -2.0, -3.0, 4.0 ] ); -* -* var out = filter( x, isPositiveNumber ); -* // returns [ 1.0, 4.0 ] -*/ -declare function filter( x: Float64Array, predicate: Predicate, thisArg?: ThisParameterType> ): Float64Array; - -/** -* Returns a shallow copy of an array containing only those elements which pass a test implemented by a predicate function. -* -* @param x - input array -* @param predicate - predicate function -* @param thisArg - predicate function execution context -* @returns output array -* -* @example -* var isPositiveNumber = require( '@stdlib/assert-is-positive-number' ).isPrimitive; -* var Float32Array = require( '@stdlib/array-float32' ); -* -* var x = new Float32Array( [ 1.0, -2.0, -3.0, 4.0 ] ); -* -* var out = filter( x, isPositiveNumber ); -* // returns [ 1.0, 4.0 ] -*/ -declare function filter( x: Float32Array, predicate: Predicate, thisArg?: ThisParameterType> ): Float32Array; - -/** -* Returns a shallow copy of an array containing only those elements which pass a test implemented by a predicate function. -* -* @param x - input array -* @param predicate - predicate function -* @param thisArg - predicate function execution context -* @returns output array -* -* @example -* var isPositiveNumber = require( '@stdlib/assert-is-positive-number' ).isPrimitive; -* var Int32Array = require( '@stdlib/array-int32' ); -* -* var x = new Int32Array( [ 1, -2, -3, 4 ] ); -* -* var out = filter( x, isPositiveNumber ); -* // returns [ 1, 4 ] -*/ -declare function filter( x: Int32Array, predicate: Predicate, thisArg?: ThisParameterType> ): Int32Array; - -/** -* Returns a shallow copy of an array containing only those elements which pass a test implemented by a predicate function. -* -* @param x - input array -* @param predicate - predicate function -* @param thisArg - predicate function execution context -* @returns output array -* -* @example -* var isPositiveNumber = require( '@stdlib/assert-is-positive-number' ).isPrimitive; -* var Int16Array = require( '@stdlib/array-int16' ); -* -* var x = new Int16Array( [ 1, -2, -3, 4 ] ); -* -* var out = filter( x, isPositiveNumber ); -* // returns [ 1, 4 ] -*/ -declare function filter( x: Int16Array, predicate: Predicate, thisArg?: ThisParameterType> ): Int16Array; - -/** -* Returns a shallow copy of an array containing only those elements which pass a test implemented by a predicate function. -* -* @param x - input array -* @param predicate - predicate function -* @param thisArg - predicate function execution context -* @returns output array -* -* @example -* var isPositiveNumber = require( '@stdlib/assert-is-positive-number' ).isPrimitive; -* var Int8Array = require( '@stdlib/array-int8' ); -* -* var x = new Int8Array( [ 1, -2, -3, 4 ] ); -* -* var out = filter( x, isPositiveNumber ); -* // returns [ 1, 4 ] -*/ -declare function filter( x: Int8Array, predicate: Predicate, thisArg?: ThisParameterType> ): Int8Array; - -/** -* Returns a shallow copy of an array containing only those elements which pass a test implemented by a predicate function. -* -* @param x - input array -* @param predicate - predicate function -* @param thisArg - predicate function execution context -* @returns output array -* -* @example -* var isPositiveNumber = require( '@stdlib/assert-is-positive-number' ).isPrimitive; -* var Uint32Array = require( '@stdlib/array-uint32' ); -* -* var x = new Uint32Array( [ 1, 2, 3, 4 ] ); -* -* var out = filter( x, isPositiveNumber ); -* // returns [ 1, 2, 3, 4 ] -*/ -declare function filter( x: Uint32Array, predicate: Predicate, thisArg?: ThisParameterType> ): Uint32Array; - -/** -* Returns a shallow copy of an array containing only those elements which pass a test implemented by a predicate function. -* -* @param x - input array -* @param predicate - predicate function -* @param thisArg - predicate function execution context -* @returns output array -* -* @example -* var isPositiveNumber = require( '@stdlib/assert-is-positive-number' ).isPrimitive; -* var Uint16Array = require( '@stdlib/array-uint16' ); -* -* var x = new Uint16Array( [ 1, 2, 3, 4 ] ); -* -* var out = filter( x, isPositiveNumber ); -* // returns [ 1, 2, 3, 4 ] -*/ -declare function filter( x: Uint16Array, predicate: Predicate, thisArg?: ThisParameterType> ): Uint16Array; - -/** -* Returns a shallow copy of an array containing only those elements which pass a test implemented by a predicate function. -* -* @param x - input array -* @param predicate - predicate function -* @param thisArg - predicate function execution context -* @returns output array -* -* @example -* var isPositiveNumber = require( '@stdlib/assert-is-positive-number' ).isPrimitive; -* var Uint8Array = require( '@stdlib/array-uint8' ); -* -* var x = new Uint8Array( [ 1, 2, 3, 4 ] ); -* -* var out = filter( x, isPositiveNumber ); -* // returns [ 1, 2, 3, 4 ] -*/ -declare function filter( x: Uint8Array, predicate: Predicate, thisArg?: ThisParameterType> ): Uint8Array; - -/** -* Returns a shallow copy of an array containing only those elements which pass a test implemented by a predicate function. -* -* @param x - input array -* @param predicate - predicate function -* @param thisArg - predicate function execution context -* @returns output array -* -* @example -* var isPositiveNumber = require( '@stdlib/assert-is-positive-number' ).isPrimitive; -* var Uint8ClampedArray = require( '@stdlib/array-uint8c' ); -* -* var x = new Uint8ClampedArray( [ 1, 2, 3, 4 ] ); -* -* var out = filter( x, isPositiveNumber ); -* // returns [ 1, 2, 3, 4 ] -*/ -declare function filter( x: Uint8ClampedArray, predicate: Predicate, thisArg?: ThisParameterType> ): Uint8ClampedArray; - -/** -* Returns a shallow copy of an array containing only those elements which pass a test implemented by a predicate function. -* -* @param x - input array -* @param predicate - predicate function -* @param thisArg - predicate function execution context -* @returns output array -* -* @example -* var isPositiveNumber = require( '@stdlib/assert-is-positive-number' ).isPrimitive; -* var real = require( '@stdlib/complex-real' ); -* var imag = require( '@stdlib/complex-imag' ); -* var Complex128Array = require( '@stdlib/array-complex128' ); -* -* function predicate( v ) { -* return ( isPositiveNumber( real( v ) ) && isPositiveNumber( imag( v ) ) ); -* } -* -* var x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0 ] ); -* -* var out = filter( x, predicate ); -* // returns -*/ -declare function filter( x: Complex128Array, predicate: Predicate, thisArg?: ThisParameterType> ): Complex128Array; - -/** -* Returns a shallow copy of an array containing only those elements which pass a test implemented by a predicate function. -* -* @param x - input array -* @param predicate - predicate function -* @param thisArg - predicate function execution context -* @returns output array -* -* @example -* var isPositiveNumber = require( '@stdlib/assert-is-positive-number' ).isPrimitive; -* var realf = require( '@stdlib/complex-realf' ); -* var imagf = require( '@stdlib/complex-imagf' ); -* var Complex64Array = require( '@stdlib/array-complex64' ); -* -* function predicate( v ) { -* return ( isPositiveNumber( realf( v ) ) && isPositiveNumber( imagf( v ) ) ); -* } -* -* var x = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); -* -* var out = filter( x, predicate ); -* // returns -*/ -declare function filter( x: Complex64Array, predicate: Predicate, thisArg?: ThisParameterType> ): Complex64Array; - -/** -* Returns a shallow copy of an array containing only those elements which pass a test implemented by a predicate function. -* -* @param x - input array -* @param predicate - predicate function -* @param thisArg - predicate function execution context -* @returns output array -* -* @example -* var x = [ 1, -2, -3, 4 ]; -* -* var out = filter( x, isPositiveNumber ); -* // returns [ 1, 4 ] -*/ -declare function filter( x: Array, predicate: Predicate>, thisArg?: ThisParameterType>> ): Array; - -/** -* Returns a shallow copy of an array containing only those elements which pass a test implemented by a predicate function. -* -* @param x - input array -* @param predicate - predicate function -* @param thisArg - predicate function execution context -* @returns output array -* -* @example -* var toAccessorArray = require( '@stdlib/array-base-to-accessor-array' ); -* -* var x = toAccessorArray( [ 1, -2, -3, 4 ] ); -* -* var out = filter( x, isPositiveNumber ); -* // returns [ 1, 4 ] -*/ -declare function filter( x: AccessorArrayLike, predicate: Predicate>, thisArg?: ThisParameterType>> ): Array; - -/** -* Returns a shallow copy of an array containing only those elements which pass a test implemented by a predicate function. -* -* @param x - input array -* @param predicate - predicate function -* @param thisArg - predicate function execution context -* @returns output array -* -* @example -* var x = [ 1, -2, -3, 4 ]; -* -* var out = filter( x, isPositiveNumber ); -* // returns [ 1, 4 ] -*/ -declare function filter( x: Collection, predicate: Predicate>, thisArg?: ThisParameterType>> ): Array; - - -// EXPORTS // - -export = filter; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index 48ac85d..0000000 --- a/index.mjs +++ /dev/null @@ -1,4 +0,0 @@ -// Copyright (c) 2024 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 -/// -import r from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-arraylike2object@v0.1.0-esm/index.mjs";function t(t,e,n){var o;return function(r,t){return"function"==typeof r[t]}(t,"filter")?t.filter(e,n):(o=r(t)).accessorProtocol?function(r,t,e){var n,o,a,s,c;for(n=r.data,o=r.accessors[0],a=[],c=0;c 0;\n* }\n*\n* var x = [ 1, -2, -3, 4 ];\n*\n* var out = internal( x, isPositive );\n* // returns [ 1, 4 ]\n*/\nfunction internal( x, predicate, thisArg ) {\n\tvar out;\n\tvar v;\n\tvar i;\n\n\tout = [];\n\tfor ( i = 0; i < x.length; i++ ) {\n\t\tv = x[ i ];\n\t\tif ( predicate.call( thisArg, v, i, x ) ) {\n\t\t\tout.push( v );\n\t\t}\n\t}\n\treturn out;\n}\n\n/**\n* Returns a shallow copy of an array containing only those elements which pass a test implemented by a predicate function.\n*\n* @private\n* @param {Object} x - input array object\n* @param {Function} predicate - test function\n* @param {*} thisArg - execution context\n* @returns {Array} output array\n*\n* @example\n* import toAccessorArray from '@stdlib/array-base-to-accessor-array';\n* import arraylike2object from '@stdlib/array-base-arraylike2object';\n*\n* function isPositive( v ) {\n* return v > 0;\n* }\n*\n* var x = arraylike2object( toAccessorArray( [ 1, -2, -3, 4 ] ) );\n*\n* var out = accessors( x, isPositive );\n* // returns [ 1, 4 ]\n*/\nfunction accessors( x, predicate, thisArg ) {\n\tvar data;\n\tvar get;\n\tvar out;\n\tvar v;\n\tvar i;\n\n\tdata = x.data;\n\tget = x.accessors[ 0 ];\n\n\tout = [];\n\tfor ( i = 0; i < data.length; i++ ) {\n\t\tv = get( data, i );\n\t\tif ( predicate.call( thisArg, v, i, data ) ) {\n\t\t\tout.push( v );\n\t\t}\n\t}\n\treturn out;\n}\n\n\n// MAIN //\n\n/**\n* Returns a shallow copy of an array containing only those elements which pass a test implemented by a predicate function.\n*\n* @param {Collection} x - input array\n* @param {Function} predicate - test function\n* @param {*} [thisArg] - execution context\n* @returns {Collection} output array\n*\n* @example\n* function isPositive( v ) {\n* return v > 0;\n* }\n*\n* var x = [ 1, -2, -3, 4 ];\n*\n* var out = filter( x, isPositive );\n* // returns [ 1, 4 ]\n*/\nfunction filter( x, predicate, thisArg ) {\n\tvar obj;\n\tif ( hasMethod( x, 'filter' ) ) {\n\t\treturn x.filter( predicate, thisArg );\n\t}\n\tobj = arraylike2object( x );\n\tif ( obj.accessorProtocol ) {\n\t\treturn accessors( obj, predicate, thisArg );\n\t}\n\treturn internal( x, predicate, thisArg );\n}\n\n\n// EXPORTS //\n\nexport default filter;\n"],"names":["filter","x","predicate","thisArg","obj","method","hasMethod","arraylike2object","accessorProtocol","data","get","out","v","i","accessors","length","call","push","internal"],"mappings":";;sGAgJA,SAASA,EAAQC,EAAGC,EAAWC,GAC9B,IAAIC,EACJ,OAvGD,SAAoBA,EAAKC,GACxB,MAAkC,mBAAlBD,EAAKC,EACtB,CAqGMC,CAAWL,EAAG,UACXA,EAAED,OAAQE,EAAWC,IAE7BC,EAAMG,EAAkBN,IACfO,iBA/CV,SAAoBP,EAAGC,EAAWC,GACjC,IAAIM,EACAC,EACAC,EACAC,EACAC,EAMJ,IAJAJ,EAAOR,EAAEQ,KACTC,EAAMT,EAAEa,UAAW,GAEnBH,EAAM,GACAE,EAAI,EAAGA,EAAIJ,EAAKM,OAAQF,IAC7BD,EAAIF,EAAKD,EAAMI,GACVX,EAAUc,KAAMb,EAASS,EAAGC,EAAGJ,IACnCE,EAAIM,KAAML,GAGZ,OAAOD,CACR,CA8BSG,CAAWV,EAAKF,EAAWC,GArFpC,SAAmBF,EAAGC,EAAWC,GAChC,IAAIQ,EACAC,EACAC,EAGJ,IADAF,EAAM,GACAE,EAAI,EAAGA,EAAIZ,EAAEc,OAAQF,IAC1BD,EAAIX,EAAGY,GACFX,EAAUc,KAAMb,EAASS,EAAGC,EAAGZ,IACnCU,EAAIM,KAAML,GAGZ,OAAOD,CACR,CA0EQO,CAAUjB,EAAGC,EAAWC,EAChC"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index 5910c97..0000000 --- a/stats.html +++ /dev/null @@ -1,6177 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From 29ecb6d95c8e1adc86d649bdbdba49ed3caf2447 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Thu, 25 Jan 2024 13:43:33 +0000 Subject: [PATCH 05/40] Auto-generated commit --- .editorconfig | 181 - .eslintrc.js | 1 - .gitattributes | 49 - .github/PULL_REQUEST_TEMPLATE.md | 7 - .github/workflows/benchmark.yml | 64 - .github/workflows/cancel.yml | 57 - .github/workflows/close_pull_requests.yml | 54 - .github/workflows/examples.yml | 64 - .github/workflows/npm_downloads.yml | 112 - .github/workflows/productionize.yml | 797 --- .github/workflows/publish.yml | 255 - .github/workflows/test.yml | 100 - .github/workflows/test_bundles.yml | 189 - .github/workflows/test_coverage.yml | 128 - .github/workflows/test_install.yml | 86 - .gitignore | 188 - .npmignore | 228 - .npmrc | 28 - CHANGELOG.md | 5 - CITATION.cff | 30 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 -- README.md | 41 +- SECURITY.md | 5 - benchmark/benchmark.length.js | 97 - branches.md | 56 - dist/index.d.ts | 3 - dist/index.js | 5 - dist/index.js.map | 7 - docs/repl.txt | 46 - docs/types/test.ts | 101 - examples/index.js | 35 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/index.js | 46 - lib/main.js | 160 - package.json | 65 +- stats.html | 6177 +++++++++++++++++++++ test/dist/test.js | 33 - test/test.js | 251 - 42 files changed, 6202 insertions(+), 4096 deletions(-) delete mode 100644 .editorconfig delete mode 100644 .eslintrc.js delete mode 100644 .gitattributes delete mode 100644 .github/PULL_REQUEST_TEMPLATE.md delete mode 100644 .github/workflows/benchmark.yml delete mode 100644 .github/workflows/cancel.yml delete mode 100644 .github/workflows/close_pull_requests.yml delete mode 100644 .github/workflows/examples.yml delete mode 100644 .github/workflows/npm_downloads.yml delete mode 100644 .github/workflows/productionize.yml delete mode 100644 .github/workflows/publish.yml delete mode 100644 .github/workflows/test.yml delete mode 100644 .github/workflows/test_bundles.yml delete mode 100644 .github/workflows/test_coverage.yml delete mode 100644 .github/workflows/test_install.yml delete mode 100644 .gitignore delete mode 100644 .npmignore delete mode 100644 .npmrc delete mode 100644 CHANGELOG.md delete mode 100644 CITATION.cff delete mode 100644 CODE_OF_CONDUCT.md delete mode 100644 CONTRIBUTING.md delete mode 100644 Makefile delete mode 100644 SECURITY.md delete mode 100644 benchmark/benchmark.length.js delete mode 100644 branches.md delete mode 100644 dist/index.d.ts delete mode 100644 dist/index.js delete mode 100644 dist/index.js.map delete mode 100644 docs/repl.txt delete mode 100644 docs/types/test.ts delete mode 100644 examples/index.js rename docs/types/index.d.ts => index.d.ts (99%) create mode 100644 index.mjs create mode 100644 index.mjs.map delete mode 100644 lib/index.js delete mode 100644 lib/main.js create mode 100644 stats.html delete mode 100644 test/dist/test.js delete mode 100644 test/test.js diff --git a/.editorconfig b/.editorconfig deleted file mode 100644 index 60d743f..0000000 --- a/.editorconfig +++ /dev/null @@ -1,181 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 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. -#/ - -# EditorConfig configuration file (see ). - -# Indicate that this file is a root-level configuration file: -root = true - -# Set properties for all files: -[*] -end_of_line = lf -charset = utf-8 -trim_trailing_whitespace = true -insert_final_newline = true - -# Set properties for JavaScript files: -[*.{js,js.txt}] -indent_style = tab - -# Set properties for JavaScript ES module files: -[*.{mjs,mjs.txt}] -indent_style = tab - -# Set properties for JavaScript CommonJS files: -[*.{cjs,cjs.txt}] -indent_style = tab - -# Set properties for JSON files: -[*.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `cli_opts.json` files: -[cli_opts.json] -indent_style = tab - -# Set properties for TypeScript files: -[*.ts] -indent_style = tab - -# Set properties for Python files: -[*.{py,py.txt}] -indent_style = space -indent_size = 4 - -# Set properties for Julia files: -[*.{jl,jl.txt}] -indent_style = tab - -# Set properties for R files: -[*.{R,R.txt}] -indent_style = tab - -# Set properties for C files: -[*.{c,c.txt}] -indent_style = tab - -# Set properties for C header files: -[*.{h,h.txt}] -indent_style = tab - -# Set properties for C++ files: -[*.{cpp,cpp.txt}] -indent_style = tab - -# Set properties for C++ header files: -[*.{hpp,hpp.txt}] -indent_style = tab - -# Set properties for Fortran files: -[*.{f,f.txt}] -indent_style = space -indent_size = 2 -insert_final_newline = false - -# Set properties for shell files: -[*.{sh,sh.txt}] -indent_style = tab - -# Set properties for AWK files: -[*.{awk,awk.txt}] -indent_style = tab - -# Set properties for HTML files: -[*.{html,html.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for XML files: -[*.{xml,xml.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for CSS files: -[*.{css,css.txt}] -indent_style = tab - -# Set properties for Makefiles: -[Makefile] -indent_style = tab - -[*.{mk,mk.txt}] -indent_style = tab - -# Set properties for Markdown files: -[*.{md,md.txt}] -indent_style = space -indent_size = 4 -trim_trailing_whitespace = false - -# Set properties for `usage.txt` files: -[usage.txt] -indent_style = space -indent_size = 2 - -# Set properties for `repl.txt` files: -[repl.txt] -indent_style = space -indent_size = 4 - -# Set properties for `package.json` files: -[package.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `datapackage.json` files: -[datapackage.json] -indent_style = space -indent_size = 2 - -# Set properties for `manifest.json` files: -[manifest.json] -indent_style = space -indent_size = 2 - -# Set properties for `tsconfig.json` files: -[tsconfig.json] -indent_style = space -indent_size = 2 - -# Set properties for LaTeX files: -[*.{tex,tex.txt}] -indent_style = tab - -# Set properties for LaTeX Bibliography files: -[*.{bib,bib.txt}] -indent_style = tab - -# Set properties for YAML files: -[*.{yml,yml.txt}] -indent_style = space -indent_size = 2 - -# Set properties for GYP files: -[binding.gyp] -indent_style = space -indent_size = 2 - -[*.gypi] -indent_style = space -indent_size = 2 - -# Set properties for citation files: -[*.{cff,cff.txt}] -indent_style = space -indent_size = 2 diff --git a/.eslintrc.js b/.eslintrc.js deleted file mode 100644 index 5f30286..0000000 --- a/.eslintrc.js +++ /dev/null @@ -1 +0,0 @@ -/* For the `eslint` rules of this project, consult the main repository at https://github.com/stdlib-js/stdlib */ diff --git a/.gitattributes b/.gitattributes deleted file mode 100644 index 10a16e6..0000000 --- a/.gitattributes +++ /dev/null @@ -1,49 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 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. -#/ - -# Configuration file which assigns attributes to pathnames. -# -# [1]: https://git-scm.com/docs/gitattributes - -# Automatically normalize the line endings of any committed text files: -* text=auto - -# Override line endings for certain files on checkout: -*.crlf.csv text eol=crlf - -# Denote that certain files are binary and should not be modified: -*.png binary -*.jpg binary -*.jpeg binary -*.gif binary -*.ico binary -*.gz binary -*.zip binary -*.7z binary -*.mp3 binary -*.mp4 binary -*.mov binary - -# Override what is considered "vendored" by GitHub's linguist: -/deps/** linguist-vendored=false -/lib/node_modules/** linguist-vendored=false linguist-generated=false -test/fixtures/** linguist-vendored=false -tools/** linguist-vendored=false - -# Override what is considered "documentation" by GitHub's linguist: -examples/** linguist-documentation=false diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index 6559bc7..0000000 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ /dev/null @@ -1,7 +0,0 @@ - - -We are excited about your pull request, but unfortunately we are not accepting pull requests against this repository, as all development happens on the [main project repository](https://github.com/stdlib-js/stdlib). We kindly request that you submit this pull request against the [respective directory](https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/filter) of the main repository where we’ll review and provide feedback. - -If this is your first stdlib contribution, be sure to read the [contributing guide](https://github.com/stdlib-js/stdlib/blob/develop/CONTRIBUTING.md) which provides guidelines and instructions for submitting contributions. You may also consult the [development guide](https://github.com/stdlib-js/stdlib/blob/develop/docs/development.md) for help on developing stdlib. - -We look forward to receiving your contribution! :smiley: \ No newline at end of file diff --git a/.github/workflows/benchmark.yml b/.github/workflows/benchmark.yml deleted file mode 100644 index 30656c4..0000000 --- a/.github/workflows/benchmark.yml +++ /dev/null @@ -1,64 +0,0 @@ -#/ -# @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. -#/ - -# Workflow name: -name: benchmark - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to run benchmarks: - benchmark: - - # Define a display name: - name: 'Run benchmarks' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA corresponding to v3.8.1 - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Run benchmarks: - - name: 'Run benchmarks' - run: | - npm run benchmark diff --git a/.github/workflows/cancel.yml b/.github/workflows/cancel.yml deleted file mode 100644 index 3acd3a9..0000000 --- a/.github/workflows/cancel.yml +++ /dev/null @@ -1,57 +0,0 @@ -#/ -# @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. -#/ - -# Workflow name: -name: cancel - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to cancel existing workflow runs: - cancel: - - # Define a display name: - name: 'Cancel workflow runs' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Time limit: - timeout-minutes: 3 - - # Define the sequence of job steps... - steps: - - # Cancel existing workflow runs: - - name: 'Cancel existing workflow runs' - # Pin action to full length commit SHA corresponding to v0.11.0 - uses: styfle/cancel-workflow-action@b173b6ec0100793626c2d9e6b90435061f4fc3e5 - with: - workflow_id: >- - benchmark.yml, - examples.yml, - test.yml, - test_coverage.yml, - test_install.yml, - publish.yml - access_token: ${{ github.token }} diff --git a/.github/workflows/close_pull_requests.yml b/.github/workflows/close_pull_requests.yml deleted file mode 100644 index 2060eba..0000000 --- a/.github/workflows/close_pull_requests.yml +++ /dev/null @@ -1,54 +0,0 @@ -#/ -# @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. -#/ - -# Workflow name: -name: close_pull_requests - -# Workflow triggers: -on: - pull_request_target: - types: [opened] - -# Workflow jobs: -jobs: - - # Define job to close all pull requests: - run: - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - - # Close pull request - - name: 'Close pull request' - # Pin action to full length commit SHA corresponding to v3.1.2 - uses: superbrothers/close-pull-request@9c18513d320d7b2c7185fb93396d0c664d5d8448 - with: - comment: | - Thank you for submitting a pull request. :raised_hands: - - We greatly appreciate your willingness to submit a contribution. However, we are not accepting pull requests against this repository, as all development happens on the [main project repository](https://github.com/stdlib-js/stdlib). - - We kindly request that you submit this pull request against the [respective directory](https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/filter) of the main repository where we’ll review and provide feedback. If this is your first stdlib contribution, be sure to read the [contributing guide](https://github.com/stdlib-js/stdlib/blob/develop/CONTRIBUTING.md) which provides guidelines and instructions for submitting contributions. - - Thank you again, and we look forward to receiving your contribution! :smiley: - - Best, - The stdlib team \ No newline at end of file diff --git a/.github/workflows/examples.yml b/.github/workflows/examples.yml deleted file mode 100644 index c92f5c4..0000000 --- a/.github/workflows/examples.yml +++ /dev/null @@ -1,64 +0,0 @@ -#/ -# @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. -#/ - -# Workflow name: -name: examples - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to run the package examples... - examples: - - # Define display name: - name: 'Run examples' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - - # Checkout repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA corresponding to v3.8.1 - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Run examples: - - name: 'Run examples' - run: | - npm run examples diff --git a/.github/workflows/npm_downloads.yml b/.github/workflows/npm_downloads.yml deleted file mode 100644 index 476e0df..0000000 --- a/.github/workflows/npm_downloads.yml +++ /dev/null @@ -1,112 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2022 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. -#/ - -# Workflow name: -name: npm_downloads - -# Workflow triggers: -on: - # Run this workflow weekly: - schedule: - # cron: ' ' - - cron: '48 12 * * 3' - - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job for retrieving npm download counts... - npm_downloads: - - # Define display name: - name: 'Retrieve npm download counts' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - timeout-minutes: 10 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA corresponding to v3.8.1 - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d - with: - node-version: 20 - timeout-minutes: 5 - - # Resolve package name: - - name: 'Resolve package name' - id: package_name - run: | - name=`node -e 'console.log(require("./package.json").name)' | tr -d '\n'` - echo "package_name=$name" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Fetch download data: - - name: 'Fetch data' - id: download_data - run: | - url="https://api.npmjs.org/downloads/range/$(date --date='1 year ago' '+%Y-%m-%d'):$(date '+%Y-%m-%d')/${{ steps.package_name.outputs.package_name }}" - echo "$url" - data=$(curl "$url") - mkdir ./tmp - echo "$data" > ./tmp/npm_downloads.json - echo "data=$data" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Print summary of download data: - - name: 'Print summary' - run: | - echo "| Date | Downloads |" >> $GITHUB_STEP_SUMMARY - echo "|------|------------|" >> $GITHUB_STEP_SUMMARY - cat ./tmp/npm_downloads.json | jq -r ".downloads | .[-14:] | to_entries | map(\"| \(.value.day) | \(.value.downloads) |\") |.[]" >> $GITHUB_STEP_SUMMARY - - # Upload the download data: - - name: 'Upload data' - # Pin action to full length commit SHA corresponding to v3.1.3 - uses: actions/upload-artifact@a8a3f3ad30e3422c9c7b888a15615d19a852ae32 - with: - # Define a name for the uploaded artifact (ensuring a unique name for each job): - name: npm_downloads - - # Specify the path to the file to upload: - path: ./tmp/npm_downloads.json - - # Specify the number of days to retain the artifact (default is 90 days): - retention-days: 90 - timeout-minutes: 10 - if: success() - - # Send data to events server: - - name: 'Post data' - # Pin action to full length commit SHA - uses: distributhor/workflow-webhook@48a40b380ce4593b6a6676528cd005986ae56629 # v3.0.3 - env: - webhook_url: ${{ secrets.STDLIB_NPM_DOWNLOADS_URL }} - webhook_secret: ${{ secrets.STDLIB_WEBHOOK_SECRET }} - data: '{ "downloads": ${{ steps.download_data.outputs.data }} }' - timeout-minutes: 5 - if: success() diff --git a/.github/workflows/productionize.yml b/.github/workflows/productionize.yml deleted file mode 100644 index e1e3539..0000000 --- a/.github/workflows/productionize.yml +++ /dev/null @@ -1,797 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2022 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. -#/ - -# Workflow name: -name: productionize - -# Workflow triggers: -on: - # Run workflow when a new commit is pushed to the main branch: - push: - branches: - - main - - # Allow the workflow to be manually run: - workflow_dispatch: - inputs: - require-passing-tests: - description: 'Require passing tests for creating bundles' - type: boolean - default: true - - # Run workflow upon completion of `publish` workflow run: - workflow_run: - workflows: ["publish"] - types: [completed] - - -# Concurrency group to prevent multiple concurrent executions: -concurrency: - group: productionize - cancel-in-progress: true - -# Workflow jobs: -jobs: - - # Define a job to create a production build... - productionize: - - # Define display name: - name: 'Productionize' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Define the sequence of job steps... - steps: - # Checkout main branch of repository: - - name: 'Checkout main branch' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - with: - ref: main - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA corresponding to v3.8.1 - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d - with: - node-version: 20 - timeout-minutes: 5 - - # Create production branch: - - name: 'Create production branch' - run: | - git checkout -b production - - # Transform error messages: - - name: 'Transform error messages' - id: transform-error-messages - uses: stdlib-js/transform-errors-action@main - - # 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: | - PKG_VERSION=$(npm view @stdlib/error-tools-fmtprodmsg version) - if grep -q '"@stdlib/string-format"' package.json; then - sed -i "s/\"@stdlib\/string-format\": \"^.*\"/\"@stdlib\/error-tools-fmtprodmsg\": \"^$PKG_VERSION\"/g" package.json - else - node -e "var pkg = require( './package.json' ); pkg.dependencies[ '@stdlib/error-tools-fmtprodmsg' ] = '^$PKG_VERSION'; require( 'fs' ).writeFileSync( 'package.json', JSON.stringify( pkg, null, 2 ) );" - fi - - # Configure git: - - name: 'Configure git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Transform error messages" - - # Push changes: - - name: 'Push changes' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" production --force - - # Define a job for running tests of the productionized code... - test: - - # Define a display name: - name: 'Run Tests' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Indicate that this job depends on the prior job finishing: - needs: productionize - - # Run this job regardless of the outcome of the prior job: - if: always() - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout repository' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - with: - # Use the `production` branch: - ref: production - - # Install Node.js: - - name: 'Install Node.js' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA corresponding to v3.8.1 - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Build native add-on if present: - - name: 'Build native add-on (if present)' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - run: | - if [ -f "binding.gyp" ]; then - npm install node-gyp --no-save && ./node_modules/.bin/node-gyp rebuild - fi - - # Run tests: - - name: 'Run tests' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: tests - run: | - npm test || npm test || npm test - - # Define job to create a bundle for use in Deno... - deno: - - # Define display name: - name: 'Create Deno bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Configure git: - - name: 'Configure git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `deno` branch exists: - - name: 'Check if remote `deno` branch exists' - id: deno-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin deno - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `deno` exists, delete everything in branch and merge `production` into it - - name: 'If `deno` exists, delete everything in branch and merge `production` into it' - if: steps.deno-branch-exists.outputs.remote-exists - run: | - git checkout -b deno origin/deno - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `deno` does not exist, create `deno` branch: - - name: 'If `deno` does not exist, create `deno` branch' - if: ${{ steps.deno-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b deno - - # Copy files to deno directory: - - name: 'Copy files to deno directory' - run: | - mkdir -p deno - cp README.md LICENSE CONTRIBUTORS NOTICE ./deno - - # Copy TypeScript definitions to deno directory: - if [ -d index.d.ts ]; then - cp index.d.ts ./deno/index.d.ts - fi - if [ -e ./docs/types/index.d.ts ]; then - cp ./docs/types/index.d.ts ./deno/mod.d.ts - fi - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA corresponding to v3.8.1 - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: Install production and development dependencies - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Bundle package for use in Deno: - - name: 'Bundle package for Deno' - id: deno-bundle - uses: stdlib-js/bundle-action@main - with: - target: 'deno' - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - # Replace links to other packages with links to the deno branch: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/deno/"; - - # Replace reference to `@stdlib/types` with CDN link: - find ./deno -type f -name '*.ts' -print0 | xargs -0 sed -Ei "s/\/\/\/ /\/\/\/ /g" - - # Change wording of project description to avoid reference to JavaScript and Node.js: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "s/a standard library for JavaScript and Node.js, /a standard library /g" - - # Rewrite all `require()`s to use jsDelivr links: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/require\( '@stdlib\// { - s/(var|let|const)\s+([a-z0-9_]+)\s+=\s*require\( '([^']+)' \);/import \2 from \'\3\';/i - s/@stdlib/https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js/ - s/';/@deno\/mod.js';/ - }" - - # Rewrite first `import` to show importing of named exports if available: - exports=$(cat lib/index.js | \ - grep -E 'setReadOnly\(.*,.*,.*\)' | \ - sed -E 's/setReadOnly\((.*),(.*),(.*)\);/\2/' | \ - sed -E "s/'//g" | \ - sort) - if [ -n "$exports" ]; then - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\nimport\s+([a-zA-Z0-9_]+)\s+from\s*'([^']+)';\n\`\`\`/\`\`\`javascript\nimport \1 from '\2';\n\`\`\`\n\nYou can also import the following named exports from the package:\n\n\`\`\`javascript\nimport { $(echo $exports | sed -E 's/ /, /g') } from '\2';\n\`\`\`/" - fi - - # Remove `installation`, `cli`, and `c` sections: - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Create package.json file for deno branch: - jq --indent 2 '{"name": .name, "version": .version, "description": .description, "license": .license, "type": "module", "main": "./mod.js", "homepage": .homepage, "repository": .repository, "bugs": .bugs, "keywords": .keywords, "funding": .funding}' package.json > ./deno/package.json - - # Delete everything in current directory aside from deno folder: - - name: 'Delete everything in current directory aside from deno folder' - run: | - find . -type 'f' | grep -v -e "deno" -e ".git/" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e "deno" -e ".git" | xargs -r rm -rf - - # Move deno directory to root: - - name: 'Move deno directory to root' - run: | - mv ./deno/* . - rmdir ./deno - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Auto-generated commit" - - # Push changes to `deno` branch: - - name: 'Push changes to `deno` branch' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" deno - - # Send status to Slack channel if job fails: - - name: 'Send status to Slack channel in case of failure' - # Pin action to full length commit SHA corresponding to v2.0.0 - uses: act10ns/slack@ed1309ab9862e57e9e583e51c7889486b9a00b0f - with: - status: ${{ job.status }} - steps: ${{ toJson(steps) }} - channel: '#npm-ci' - if: failure() - - # Define job to create a UMD bundle... - umd: - - # Define display name: - name: 'Create UMD bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Configure git: - - name: 'Configure git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `umd` branch exists: - - name: 'Check if remote `umd` branch exists' - id: umd-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin umd - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `umd` exists, delete everything in branch and merge `production` into it - - name: 'If `umd` exists, delete everything in branch and merge `production` into it' - if: steps.umd-branch-exists.outputs.remote-exists - run: | - git checkout -b umd origin/umd - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `umd` does not exist, create `umd` branch: - - name: 'If `umd` does not exist, create `umd` branch' - if: ${{ steps.umd-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b umd - - # Copy files to umd directory: - - name: 'Copy files to umd directory' - run: | - mkdir -p umd - cp README.md LICENSE CONTRIBUTORS NOTICE ./umd - - # Install Node.js - - name: 'Install Node.js' - # Pin action to full length commit SHA corresponding to v3.8.1 - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Extract alias: - - name: 'Extract alias' - id: extract-alias - run: | - alias=$(grep -E 'require\(' README.md | head -n 1 | sed -E 's/^var ([a-zA-Z0-9_]+) = .+/\1/') - echo "alias=${alias}" >> $GITHUB_OUTPUT - - # Create Universal Module Definition (UMD) Node.js bundle: - - name: 'Create Universal Module Definition (UMD) Node.js bundle' - id: umd-bundle-node - uses: stdlib-js/bundle-action@main - with: - target: 'umd-node' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Create Universal Module Definition (UMD) browser bundle: - - name: 'Create Universal Module Definition (UMD) browser bundle' - id: umd-bundle-browser - uses: stdlib-js/bundle-action@main - with: - target: 'umd-browser' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - - # Replace links to other packages with links to the umd branch: - find ./umd -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/umd/"; - - # Remove `installation`, `cli`, and `c` sections: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Rewrite first `require()` to show consumption of the UMD bundle in Observable and via a `script` tag: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\n(var|let|const)\s+([a-zA-Z0-9_]+)\s+=\s*require\( '\@stdlib\/([^']+)' \);\n\`\`\`/To use in Observable,\n\n\`\`\`javascript\n\2 = require\( 'https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js\/\3\@umd\/browser.js' \)\n\`\`\`\n\nTo vendor stdlib functionality and avoid installing dependency trees for Node.js, you can use the UMD server build:\n\n\`\`\`javascript\nvar \2 = require\( 'path\/to\/vendor\/umd\/\3\/index.js' \)\n\`\`\`\n\nTo include the bundle in a webpage,\n\n\`\`\`html\n + + ```
@@ -189,7 +180,7 @@ var out = filter( x, naryFunction( isPositiveInteger, 1 ) ); ## 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. +This package is part of [stdlib][stdlib], a standard library 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]. diff --git a/SECURITY.md b/SECURITY.md deleted file mode 100644 index 9702d4c..0000000 --- a/SECURITY.md +++ /dev/null @@ -1,5 +0,0 @@ -# Security - -> Policy for reporting security vulnerabilities. - -See the security policy [in the main project repository](https://github.com/stdlib-js/stdlib/security). diff --git a/benchmark/benchmark.length.js b/benchmark/benchmark.length.js deleted file mode 100644 index bc79e33..0000000 --- a/benchmark/benchmark.length.js +++ /dev/null @@ -1,97 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 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 bench = require( '@stdlib/bench-harness' ); -var pow = require( '@stdlib/math-base-special-pow' ); -var isArray = require( '@stdlib/assert-is-array' ); -var isNonNegativeInteger = require( '@stdlib/assert-is-nonnegative-integer' ).isPrimitive; -var zeroTo = require( '@stdlib/array-base-zero-to' ); -var pkg = require( './../package.json' ).name; -var filter = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveInteger} len - array length -* @returns {Function} benchmark function -*/ -function createBenchmark( len ) { - var x = zeroTo( len ); - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var out; - var i; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - out = filter( x, isNonNegativeInteger ); - if ( typeof out !== 'object' ) { - b.fail( 'should return an array' ); - } - } - b.toc(); - if ( !isArray( out ) ) { - b.fail( 'should return an array' ); - } - b.pass( 'benchmark finished' ); - b.end(); - } -} - - -// MAIN // - -/** -* Main execution sequence. -* -* @private -*/ -function main() { - var len; - var min; - var max; - var f; - var i; - - min = 1; // 10^min - max = 6; // 10^max - - for ( i = min; i <= max; i++ ) { - len = pow( 10, i ); - - f = createBenchmark( len ); - bench( pkg+':dtype=generic,len='+len, f ); - } -} - -main(); diff --git a/branches.md b/branches.md deleted file mode 100644 index 9858901..0000000 --- a/branches.md +++ /dev/null @@ -1,56 +0,0 @@ - - -# Branches - -This repository has the following branches: - -- **main**: default branch generated from the [stdlib project][stdlib-url], where all development takes place. -- **production**: [production build][production-url] of the package (e.g., reformatted error messages to reduce bundle sizes and thus the number of bytes transmitted over a network). -- **esm**: [ES Module][esm-url] branch for use via a `script` tag without the need for installation and bundlers (see [README][esm-readme]). -- **deno**: [Deno][deno-url] branch for use in Deno (see [README][deno-readme]). -- **umd**: [UMD][umd-url] branch for use in Observable, or in dual browser/Node.js environments (see [README][umd-readme]). - -The following diagram illustrates the relationships among the above branches: - -```mermaid -graph TD; -A[stdlib]-->|generate standalone package|B; -B[main] -->|productionize| C[production]; -C -->|bundle| D[esm]; -C -->|bundle| E[deno]; -C -->|bundle| F[umd]; - -%% click A href "https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/filter" -%% click B href "https://github.com/stdlib-js/array-base-filter/tree/main" -%% click C href "https://github.com/stdlib-js/array-base-filter/tree/production" -%% click D href "https://github.com/stdlib-js/array-base-filter/tree/esm" -%% click E href "https://github.com/stdlib-js/array-base-filter/tree/deno" -%% click F href "https://github.com/stdlib-js/array-base-filter/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/filter -[production-url]: https://github.com/stdlib-js/array-base-filter/tree/production -[deno-url]: https://github.com/stdlib-js/array-base-filter/tree/deno -[deno-readme]: https://github.com/stdlib-js/array-base-filter/blob/deno/README.md -[umd-url]: https://github.com/stdlib-js/array-base-filter/tree/umd -[umd-readme]: https://github.com/stdlib-js/array-base-filter/blob/umd/README.md -[esm-url]: https://github.com/stdlib-js/array-base-filter/tree/esm -[esm-readme]: https://github.com/stdlib-js/array-base-filter/blob/esm/README.md \ No newline at end of file diff --git a/dist/index.d.ts b/dist/index.d.ts deleted file mode 100644 index aafb9cb..0000000 --- a/dist/index.d.ts +++ /dev/null @@ -1,3 +0,0 @@ -/// -import filter from '../docs/types/index'; -export = filter; \ No newline at end of file diff --git a/dist/index.js b/dist/index.js deleted file mode 100644 index 5c2f789..0000000 --- a/dist/index.js +++ /dev/null @@ -1,5 +0,0 @@ -"use strict";var s=function(r,t){return function(){return t||r((t={exports:{}}).exports,t),t.exports}};var f=s(function(y,c){ -var v=require('@stdlib/array-base-arraylike2object/dist');function l(r,t){return typeof r[t]=="function"}function h(r,t,n){var e,o,a;for(e=[],a=0;a 0;\n* }\n*\n* var x = [ 1, -2, -3, 4 ];\n*\n* var out = internal( x, isPositive );\n* // returns [ 1, 4 ]\n*/\nfunction internal( x, predicate, thisArg ) {\n\tvar out;\n\tvar v;\n\tvar i;\n\n\tout = [];\n\tfor ( i = 0; i < x.length; i++ ) {\n\t\tv = x[ i ];\n\t\tif ( predicate.call( thisArg, v, i, x ) ) {\n\t\t\tout.push( v );\n\t\t}\n\t}\n\treturn out;\n}\n\n/**\n* Returns a shallow copy of an array containing only those elements which pass a test implemented by a predicate function.\n*\n* @private\n* @param {Object} x - input array object\n* @param {Function} predicate - test function\n* @param {*} thisArg - execution context\n* @returns {Array} output array\n*\n* @example\n* var toAccessorArray = require( '@stdlib/array-base-to-accessor-array' );\n* var arraylike2object = require( '@stdlib/array-base-arraylike2object' );\n*\n* function isPositive( v ) {\n* return v > 0;\n* }\n*\n* var x = arraylike2object( toAccessorArray( [ 1, -2, -3, 4 ] ) );\n*\n* var out = accessors( x, isPositive );\n* // returns [ 1, 4 ]\n*/\nfunction accessors( x, predicate, thisArg ) {\n\tvar data;\n\tvar get;\n\tvar out;\n\tvar v;\n\tvar i;\n\n\tdata = x.data;\n\tget = x.accessors[ 0 ];\n\n\tout = [];\n\tfor ( i = 0; i < data.length; i++ ) {\n\t\tv = get( data, i );\n\t\tif ( predicate.call( thisArg, v, i, data ) ) {\n\t\t\tout.push( v );\n\t\t}\n\t}\n\treturn out;\n}\n\n\n// MAIN //\n\n/**\n* Returns a shallow copy of an array containing only those elements which pass a test implemented by a predicate function.\n*\n* @param {Collection} x - input array\n* @param {Function} predicate - test function\n* @param {*} [thisArg] - execution context\n* @returns {Collection} output array\n*\n* @example\n* function isPositive( v ) {\n* return v > 0;\n* }\n*\n* var x = [ 1, -2, -3, 4 ];\n*\n* var out = filter( x, isPositive );\n* // returns [ 1, 4 ]\n*/\nfunction filter( x, predicate, thisArg ) {\n\tvar obj;\n\tif ( hasMethod( x, 'filter' ) ) {\n\t\treturn x.filter( predicate, thisArg );\n\t}\n\tobj = arraylike2object( x );\n\tif ( obj.accessorProtocol ) {\n\t\treturn accessors( obj, predicate, thisArg );\n\t}\n\treturn internal( x, predicate, thisArg );\n}\n\n\n// EXPORTS //\n\nmodule.exports = filter;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2024 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* Return a shallow copy of an array containing only those elements which pass a test implemented by a predicate function.\n*\n* @module @stdlib/array-base-filter\n*\n* @example\n* var filter = require( '@stdlib/array-base-filter' );\n*\n* function isPositive( v ) {\n* return v > 0;\n* }\n*\n* var x = [ 1, -2, -3, 4 ];\n*\n* var out = filter( x, isPositive );\n* // returns [ 1, 4 ]\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,EAAmB,QAAS,qCAAsC,EAqBtE,SAASC,EAAWC,EAAKC,EAAS,CACjC,OAAS,OAAOD,EAAKC,CAAO,GAAM,UACnC,CAqBA,SAASC,EAAUC,EAAGC,EAAWC,EAAU,CAC1C,IAAIC,EACAC,EACAC,EAGJ,IADAF,EAAM,CAAC,EACDE,EAAI,EAAGA,EAAIL,EAAE,OAAQK,IAC1BD,EAAIJ,EAAGK,CAAE,EACJJ,EAAU,KAAMC,EAASE,EAAGC,EAAGL,CAAE,GACrCG,EAAI,KAAMC,CAAE,EAGd,OAAOD,CACR,CAwBA,SAASG,EAAWN,EAAGC,EAAWC,EAAU,CAC3C,IAAIK,EACAC,EACAL,EACAC,EACAC,EAMJ,IAJAE,EAAOP,EAAE,KACTQ,EAAMR,EAAE,UAAW,CAAE,EAErBG,EAAM,CAAC,EACDE,EAAI,EAAGA,EAAIE,EAAK,OAAQF,IAC7BD,EAAII,EAAKD,EAAMF,CAAE,EACZJ,EAAU,KAAMC,EAASE,EAAGC,EAAGE,CAAK,GACxCJ,EAAI,KAAMC,CAAE,EAGd,OAAOD,CACR,CAuBA,SAASM,EAAQT,EAAGC,EAAWC,EAAU,CACxC,IAAIL,EACJ,OAAKD,EAAWI,EAAG,QAAS,EACpBA,EAAE,OAAQC,EAAWC,CAAQ,GAErCL,EAAMF,EAAkBK,CAAE,EACrBH,EAAI,iBACDS,EAAWT,EAAKI,EAAWC,CAAQ,EAEpCH,EAAUC,EAAGC,EAAWC,CAAQ,EACxC,CAKAR,EAAO,QAAUe,ICvHjB,IAAIC,EAAO,IAKX,OAAO,QAAUA", - "names": ["require_main", "__commonJSMin", "exports", "module", "arraylike2object", "hasMethod", "obj", "method", "internal", "x", "predicate", "thisArg", "out", "v", "i", "accessors", "data", "get", "filter", "main"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index bb2b17a..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,46 +0,0 @@ - -{{alias}}( x, predicate[, thisArg] ) - Returns a shallow copy of an array containing only those elements which pass - a test implemented by a predicate function. - - The predicate function is provided three arguments: - - - value: current array element. - - index: current array element index. - - arr: the input array. - - If provided an array-like object having a `filter` method , the function - defers execution to that method and assumes that the method has the - following signature: - - x.filter( predicate, thisArg ) - - If provided an array-like object without a `filter` method, the function - performs a linear scan and always returns a generic array. - - Parameters - ---------- - x: Array|TypedArray|Object - Input array. - - predicate: Function - Predicate function. - - thisArg: any (optional) - Execution context. - - Returns - ------- - out: Array|TypedArray|Object - Output array. - - Examples - -------- - > function f( v ) { return ( v > 0 ); }; - > var x = [ 1, -2, -3, 4 ]; - > var out = {{alias}}( x, f ) - [ 1, 4 ] - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index db0c38d..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,101 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2024 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. -*/ - -import toAccessorArray = require( '@stdlib/array-base-to-accessor-array' ); -import filter = require( './index' ); - -/** -* Tests whether a value is positive. -* -* @param value - input value -* @returns boolean indicating whether an element is positive -*/ -function isPositive( value: number ): boolean { - return ( value > 0 ); -} - - -// TESTS // - -// The function returns a collection... -{ - filter( [ 1, 2, 3 ], isPositive ); // $ExpectType number[] - filter( new Float64Array( [ 1, 2, 3 ] ), isPositive ); // $ExpectType Float64Array - filter( new Float32Array( [ 1, 2, 3 ] ), isPositive ); // $ExpectType Float32Array - filter( new Int32Array( [ 1, 2, 3 ] ), isPositive ); // $ExpectType Int32Array - filter( new Int16Array( [ 1, 2, 3 ] ), isPositive ); // $ExpectType Int16Array - filter( new Int8Array( [ 1, 2, 3 ] ), isPositive ); // $ExpectType Int8Array - filter( new Uint32Array( [ 1, 2, 3 ] ), isPositive ); // $ExpectType Uint32Array - filter( new Uint16Array( [ 1, 2, 3 ] ), isPositive ); // $ExpectType Uint16Array - filter( new Uint8Array( [ 1, 2, 3 ] ), isPositive ); // $ExpectType Uint8Array - filter( new Uint8ClampedArray( [ 1, 2, 3 ] ), isPositive ); // $ExpectType Uint8ClampedArray - filter( toAccessorArray( [ 1, 2, 3 ] ), isPositive ); // $ExpectType number[] - - filter( [ 1, 2, 3 ], isPositive, {} ); // $ExpectType number[] - filter( new Float64Array( [ 1, 2, 3 ] ), isPositive, {} ); // $ExpectType Float64Array - filter( new Float32Array( [ 1, 2, 3 ] ), isPositive, {} ); // $ExpectType Float32Array - filter( new Int32Array( [ 1, 2, 3 ] ), isPositive, {} ); // $ExpectType Int32Array - filter( new Int16Array( [ 1, 2, 3 ] ), isPositive, {} ); // $ExpectType Int16Array - filter( new Int8Array( [ 1, 2, 3 ] ), isPositive, {} ); // $ExpectType Int8Array - filter( new Uint32Array( [ 1, 2, 3 ] ), isPositive, {} ); // $ExpectType Uint32Array - filter( new Uint16Array( [ 1, 2, 3 ] ), isPositive, {} ); // $ExpectType Uint16Array - filter( new Uint8Array( [ 1, 2, 3 ] ), isPositive, {} ); // $ExpectType Uint8Array - filter( new Uint8ClampedArray( [ 1, 2, 3 ] ), isPositive, {} ); // $ExpectType Uint8ClampedArray - filter( toAccessorArray( [ 1, 2, 3 ] ), isPositive, {} ); // $ExpectType number[] -} - -// The compiler throws an error if the function is provided a first argument which is not a collection... -{ - filter( 2, isPositive ); // $ExpectError - filter( false, isPositive ); // $ExpectError - filter( true, isPositive ); // $ExpectError - filter( {}, isPositive ); // $ExpectError - - filter( 2, isPositive, {} ); // $ExpectError - filter( false, isPositive, {} ); // $ExpectError - filter( true, isPositive, {} ); // $ExpectError - filter( {}, isPositive, {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided a second argument which is not a function... -{ - filter( [ 1, 2, 3 ], 'abc' ); // $ExpectError - filter( [ 1, 2, 3 ], 2 ); // $ExpectError - filter( [ 1, 2, 3 ], false ); // $ExpectError - filter( [ 1, 2, 3 ], true ); // $ExpectError - filter( [ 1, 2, 3 ], null ); // $ExpectError - filter( [ 1, 2, 3 ], void 0 ); // $ExpectError - filter( [ 1, 2, 3 ], {} ); // $ExpectError - filter( [ 1, 2, 3 ], [] ); // $ExpectError - - filter( [ 1, 2, 3 ], 'abc', {} ); // $ExpectError - filter( [ 1, 2, 3 ], 2, {} ); // $ExpectError - filter( [ 1, 2, 3 ], false, {} ); // $ExpectError - filter( [ 1, 2, 3 ], true, {} ); // $ExpectError - filter( [ 1, 2, 3 ], null, {} ); // $ExpectError - filter( [ 1, 2, 3 ], void 0, {} ); // $ExpectError - filter( [ 1, 2, 3 ], {}, {} ); // $ExpectError - filter( [ 1, 2, 3 ], [], {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided an unsupported number of arguments... -{ - filter(); // $ExpectError - filter( [ 1, 2, 3 ] ); // $ExpectError - filter( [ 1, 2, 3 ], isPositive, {}, 3 ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index cdfb9a7..0000000 --- a/examples/index.js +++ /dev/null @@ -1,35 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 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'; - -var discreteUniform = require( '@stdlib/random-array-discrete-uniform' ); -var isPositiveInteger = require( '@stdlib/assert-is-positive-integer' ).isPrimitive; -var naryFunction = require( '@stdlib/utils-nary-function' ); -var filter = require( './../lib' ); - -var x = discreteUniform( 10, -5, 5, { - 'dtype': 'int32' -}); -// returns - -var out = filter( x, naryFunction( isPositiveInteger, 1 ) ); -// returns - -console.log( x ); -console.log( out ); diff --git a/docs/types/index.d.ts b/index.d.ts similarity index 99% rename from docs/types/index.d.ts rename to index.d.ts index 0f92cfd..1fa8dc7 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 4.1 -/// +/// import { Collection, AccessorArrayLike, Complex128Array, Complex64Array } from '@stdlib/types/array'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..48ac85d --- /dev/null +++ b/index.mjs @@ -0,0 +1,4 @@ +// Copyright (c) 2024 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 +/// +import r from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-arraylike2object@v0.1.0-esm/index.mjs";function t(t,e,n){var o;return function(r,t){return"function"==typeof r[t]}(t,"filter")?t.filter(e,n):(o=r(t)).accessorProtocol?function(r,t,e){var n,o,a,s,c;for(n=r.data,o=r.accessors[0],a=[],c=0;c 0;\n* }\n*\n* var x = [ 1, -2, -3, 4 ];\n*\n* var out = internal( x, isPositive );\n* // returns [ 1, 4 ]\n*/\nfunction internal( x, predicate, thisArg ) {\n\tvar out;\n\tvar v;\n\tvar i;\n\n\tout = [];\n\tfor ( i = 0; i < x.length; i++ ) {\n\t\tv = x[ i ];\n\t\tif ( predicate.call( thisArg, v, i, x ) ) {\n\t\t\tout.push( v );\n\t\t}\n\t}\n\treturn out;\n}\n\n/**\n* Returns a shallow copy of an array containing only those elements which pass a test implemented by a predicate function.\n*\n* @private\n* @param {Object} x - input array object\n* @param {Function} predicate - test function\n* @param {*} thisArg - execution context\n* @returns {Array} output array\n*\n* @example\n* import toAccessorArray from '@stdlib/array-base-to-accessor-array';\n* import arraylike2object from '@stdlib/array-base-arraylike2object';\n*\n* function isPositive( v ) {\n* return v > 0;\n* }\n*\n* var x = arraylike2object( toAccessorArray( [ 1, -2, -3, 4 ] ) );\n*\n* var out = accessors( x, isPositive );\n* // returns [ 1, 4 ]\n*/\nfunction accessors( x, predicate, thisArg ) {\n\tvar data;\n\tvar get;\n\tvar out;\n\tvar v;\n\tvar i;\n\n\tdata = x.data;\n\tget = x.accessors[ 0 ];\n\n\tout = [];\n\tfor ( i = 0; i < data.length; i++ ) {\n\t\tv = get( data, i );\n\t\tif ( predicate.call( thisArg, v, i, data ) ) {\n\t\t\tout.push( v );\n\t\t}\n\t}\n\treturn out;\n}\n\n\n// MAIN //\n\n/**\n* Returns a shallow copy of an array containing only those elements which pass a test implemented by a predicate function.\n*\n* @param {Collection} x - input array\n* @param {Function} predicate - test function\n* @param {*} [thisArg] - execution context\n* @returns {Collection} output array\n*\n* @example\n* function isPositive( v ) {\n* return v > 0;\n* }\n*\n* var x = [ 1, -2, -3, 4 ];\n*\n* var out = filter( x, isPositive );\n* // returns [ 1, 4 ]\n*/\nfunction filter( x, predicate, thisArg ) {\n\tvar obj;\n\tif ( hasMethod( x, 'filter' ) ) {\n\t\treturn x.filter( predicate, thisArg );\n\t}\n\tobj = arraylike2object( x );\n\tif ( obj.accessorProtocol ) {\n\t\treturn accessors( obj, predicate, thisArg );\n\t}\n\treturn internal( x, predicate, thisArg );\n}\n\n\n// EXPORTS //\n\nexport default filter;\n"],"names":["filter","x","predicate","thisArg","obj","method","hasMethod","arraylike2object","accessorProtocol","data","get","out","v","i","accessors","length","call","push","internal"],"mappings":";;sGAgJA,SAASA,EAAQC,EAAGC,EAAWC,GAC9B,IAAIC,EACJ,OAvGD,SAAoBA,EAAKC,GACxB,MAAkC,mBAAlBD,EAAKC,EACtB,CAqGMC,CAAWL,EAAG,UACXA,EAAED,OAAQE,EAAWC,IAE7BC,EAAMG,EAAkBN,IACfO,iBA/CV,SAAoBP,EAAGC,EAAWC,GACjC,IAAIM,EACAC,EACAC,EACAC,EACAC,EAMJ,IAJAJ,EAAOR,EAAEQ,KACTC,EAAMT,EAAEa,UAAW,GAEnBH,EAAM,GACAE,EAAI,EAAGA,EAAIJ,EAAKM,OAAQF,IAC7BD,EAAIF,EAAKD,EAAMI,GACVX,EAAUc,KAAMb,EAASS,EAAGC,EAAGJ,IACnCE,EAAIM,KAAML,GAGZ,OAAOD,CACR,CA8BSG,CAAWV,EAAKF,EAAWC,GArFpC,SAAmBF,EAAGC,EAAWC,GAChC,IAAIQ,EACAC,EACAC,EAGJ,IADAF,EAAM,GACAE,EAAI,EAAGA,EAAIZ,EAAEc,OAAQF,IAC1BD,EAAIX,EAAGY,GACFX,EAAUc,KAAMb,EAASS,EAAGC,EAAGZ,IACnCU,EAAIM,KAAML,GAGZ,OAAOD,CACR,CA0EQO,CAAUjB,EAAGC,EAAWC,EAChC"} \ No newline at end of file diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index 56236cd..0000000 --- a/lib/index.js +++ /dev/null @@ -1,46 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 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'; - -/** -* Return a shallow copy of an array containing only those elements which pass a test implemented by a predicate function. -* -* @module @stdlib/array-base-filter -* -* @example -* var filter = require( '@stdlib/array-base-filter' ); -* -* function isPositive( v ) { -* return v > 0; -* } -* -* var x = [ 1, -2, -3, 4 ]; -* -* var out = filter( x, isPositive ); -* // returns [ 1, 4 ] -*/ - -// MODULES // - -var main = require( './main.js' ); - - -// EXPORTS // - -module.exports = main; diff --git a/lib/main.js b/lib/main.js deleted file mode 100644 index 9b0c3db..0000000 --- a/lib/main.js +++ /dev/null @@ -1,160 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 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 arraylike2object = require( '@stdlib/array-base-arraylike2object' ); - - -// FUNCTIONS // - -/** -* Tests whether an object has a specified method. -* -* @private -* @param {Object} obj - input object -* @param {string} method - method name -* @returns {boolean} boolean indicating whether an object has a specified method -* -* @example -* var bool = hasMethod( [], 'filter' ); -* // returns true -* -* @example -* var bool = hasMethod( [], 'beep' ); -* // returns false -*/ -function hasMethod( obj, method ) { - return ( typeof obj[ method ] === 'function' ); -} - -/** -* Returns a shallow copy of an array containing only those elements which pass a test implemented by a predicate function. -* -* @private -* @param {Collection} x - input array -* @param {Function} predicate - test function -* @param {*} thisArg - execution context -* @returns {Array} output array -* -* @example -* function isPositive( v ) { -* return v > 0; -* } -* -* var x = [ 1, -2, -3, 4 ]; -* -* var out = internal( x, isPositive ); -* // returns [ 1, 4 ] -*/ -function internal( x, predicate, thisArg ) { - var out; - var v; - var i; - - out = []; - for ( i = 0; i < x.length; i++ ) { - v = x[ i ]; - if ( predicate.call( thisArg, v, i, x ) ) { - out.push( v ); - } - } - return out; -} - -/** -* Returns a shallow copy of an array containing only those elements which pass a test implemented by a predicate function. -* -* @private -* @param {Object} x - input array object -* @param {Function} predicate - test function -* @param {*} thisArg - execution context -* @returns {Array} output array -* -* @example -* var toAccessorArray = require( '@stdlib/array-base-to-accessor-array' ); -* var arraylike2object = require( '@stdlib/array-base-arraylike2object' ); -* -* function isPositive( v ) { -* return v > 0; -* } -* -* var x = arraylike2object( toAccessorArray( [ 1, -2, -3, 4 ] ) ); -* -* var out = accessors( x, isPositive ); -* // returns [ 1, 4 ] -*/ -function accessors( x, predicate, thisArg ) { - var data; - var get; - var out; - var v; - var i; - - data = x.data; - get = x.accessors[ 0 ]; - - out = []; - for ( i = 0; i < data.length; i++ ) { - v = get( data, i ); - if ( predicate.call( thisArg, v, i, data ) ) { - out.push( v ); - } - } - return out; -} - - -// MAIN // - -/** -* Returns a shallow copy of an array containing only those elements which pass a test implemented by a predicate function. -* -* @param {Collection} x - input array -* @param {Function} predicate - test function -* @param {*} [thisArg] - execution context -* @returns {Collection} output array -* -* @example -* function isPositive( v ) { -* return v > 0; -* } -* -* var x = [ 1, -2, -3, 4 ]; -* -* var out = filter( x, isPositive ); -* // returns [ 1, 4 ] -*/ -function filter( x, predicate, thisArg ) { - var obj; - if ( hasMethod( x, 'filter' ) ) { - return x.filter( predicate, thisArg ); - } - obj = arraylike2object( x ); - if ( obj.accessorProtocol ) { - return accessors( obj, predicate, thisArg ); - } - return internal( x, predicate, thisArg ); -} - - -// EXPORTS // - -module.exports = filter; diff --git a/package.json b/package.json index 717a554..97f1135 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.1.0", "description": "Return a shallow copy of an array containing only those elements which pass a test implemented by a predicate function.", "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", - "directories": { - "benchmark": "./benchmark", - "doc": "./docs", - "example": "./examples", - "lib": "./lib", - "test": "./test" - }, - "types": "./docs/types", - "scripts": { - "test": "make test", - "test-cov": "make test-cov", - "examples": "make examples", - "benchmark": "make benchmark" - }, + "type": "module", + "main": "./index.mjs", "homepage": "https://stdlib.io", "repository": { "type": "git", @@ -36,42 +13,6 @@ "bugs": { "url": "https://github.com/stdlib-js/stdlib/issues" }, - "dependencies": { - "@stdlib/array-base-arraylike2object": "^0.1.0", - "@stdlib/types": "^0.2.0", - "@stdlib/error-tools-fmtprodmsg": "^0.1.1" - }, - "devDependencies": { - "@stdlib/array-base-accessor": "^0.1.0", - "@stdlib/array-base-zero-to": "^0.1.0", - "@stdlib/array-float64": "^0.1.1", - "@stdlib/assert-instance-of": "^0.1.1", - "@stdlib/assert-is-array": "^0.1.1", - "@stdlib/assert-is-nonnegative-integer": "^0.1.0", - "@stdlib/assert-is-positive-integer": "^0.1.0", - "@stdlib/math-base-special-pow": "^0.1.0", - "@stdlib/random-array-discrete-uniform": "^0.1.0", - "@stdlib/utils-nary-function": "^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", - "@stdlib/bench-harness": "^0.1.2" - }, - "engines": { - "node": ">=0.10.0", - "npm": ">2.7.0" - }, - "os": [ - "aix", - "darwin", - "freebsd", - "linux", - "macos", - "openbsd", - "sunos", - "win32", - "windows" - ], "keywords": [ "stdlib", "stdtypes", @@ -91,4 +32,4 @@ "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} \ No newline at end of file +} diff --git a/stats.html b/stats.html new file mode 100644 index 0000000..6c5fd06 --- /dev/null +++ b/stats.html @@ -0,0 +1,6177 @@ + + + + + + + + Rollup Visualizer + + + +
+ + + + + diff --git a/test/dist/test.js b/test/dist/test.js deleted file mode 100644 index a8a9c60..0000000 --- a/test/dist/test.js +++ /dev/null @@ -1,33 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 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 tape = require( 'tape' ); -var main = require( './../../dist' ); - - -// TESTS // - -tape( 'main export is defined', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( main !== void 0, true, 'main export is defined' ); - t.end(); -}); diff --git a/test/test.js b/test/test.js deleted file mode 100644 index d4e7373..0000000 --- a/test/test.js +++ /dev/null @@ -1,251 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 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 tape = require( 'tape' ); -var AccessorArray = require( '@stdlib/array-base-accessor' ); -var Float64Array = require( '@stdlib/array-float64' ); -var instanceOf = require( '@stdlib/assert-instance-of' ); -var filter = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Tests whether a value is positive. -* -* @private -* @param {number} value - input value -* @returns {boolean} boolean indicating if a value is positive -*/ -function isPositive( value ) { - return ( value > 0 ); -} - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof filter, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'if provided an empty collection, the function returns an empty collection (generic)', function test( t ) { - var expected; - var actual; - var arr; - - arr = []; - expected = []; - actual = filter( arr, foo ); - - t.strictEqual( instanceOf( actual, Array ), true, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - t.end(); - - function foo() { - t.fail( 'should not be invoked' ); - } -}); - -tape( 'if provided an empty collection, the function returns an empty collection (typed array)', function test( t ) { - var expected; - var actual; - var arr; - - arr = new Float64Array( [] ); - expected = new Float64Array( [] ); - actual = filter( arr, foo ); - - t.strictEqual( instanceOf( actual, Float64Array ), true, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - t.end(); - - function foo() { - t.fail( 'should not be invoked' ); - } -}); - -tape( 'if provided an empty collection, the function returns an empty collection (accessor)', function test( t ) { - var expected; - var actual; - var arr; - - arr = new AccessorArray( [] ); - expected = []; - actual = filter( arr, foo ); - - t.strictEqual( instanceOf( actual, Array ), true, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - t.end(); - - function foo() { - t.fail( 'should not be invoked' ); - } -}); - -tape( 'the function filters a provided collection (generic)', function test( t ) { - var expected; - var actual; - var arr; - - arr = [ 1, -2, 3 ]; - expected = [ 1, 3 ]; - actual = filter( arr, isPositive ); - - t.strictEqual( instanceOf( actual, Array ), true, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - t.end(); -}); - -tape( 'the function filters a provided collection (typed array)', function test( t ) { - var expected; - var actual; - var arr; - - arr = new Float64Array( [ -1.0, 2.0, 3.0 ] ); - expected = new Float64Array( [ 2.0, 3.0 ] ); - actual = filter( arr, isPositive ); - - t.strictEqual( instanceOf( actual, Float64Array ), true, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - t.end(); -}); - -tape( 'the function filters a provided collection (accessor)', function test( t ) { - var expected; - var actual; - var arr; - - arr = new AccessorArray( [ 1, -2, -3 ] ); - expected = [ 1 ]; - actual = filter( arr, isPositive ); - - t.strictEqual( instanceOf( actual, Array ), true, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - t.end(); -}); - -tape( 'the function filters a provided collection (array-like object)', function test( t ) { - var expected; - var actual; - var arr; - - arr = { - 'length': 3, - '0': -1, - '1': -2, - '2': 3 - }; - expected = [ 3 ]; - actual = filter( arr, isPositive ); - - t.strictEqual( instanceOf( actual, Array ), true, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - t.end(); -}); - -tape( 'the function an empty collection if all elements fail a test (generic)', function test( t ) { - var expected; - var actual; - var arr; - - arr = [ -1, -2, -3 ]; - expected = []; - actual = filter( arr, isPositive ); - - t.strictEqual( instanceOf( actual, Array ), true, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - t.end(); -}); - -tape( 'the function an empty collection if all elements fail a test (typed array)', function test( t ) { - var expected; - var actual; - var arr; - - arr = new Float64Array( [ -1.0, -2.0, -3.0 ] ); - expected = new Float64Array( [] ); - actual = filter( arr, isPositive ); - - t.strictEqual( instanceOf( actual, Float64Array ), true, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - t.end(); -}); - -tape( 'the function an empty collection if all elements fail a test (accessor)', function test( t ) { - var expected; - var actual; - var arr; - - arr = new AccessorArray( [ -1, -2, -3 ] ); - expected = []; - actual = filter( arr, isPositive ); - - t.strictEqual( instanceOf( actual, Array ), true, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - t.end(); -}); - -tape( 'the function an empty collection if all elements fail a test (array-like object)', function test( t ) { - var expected; - var actual; - var arr; - - arr = { - 'length': 3, - '0': -1, - '1': -2, - '2': -3 - }; - expected = []; - actual = filter( arr, isPositive ); - - t.strictEqual( instanceOf( actual, Array ), true, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - t.end(); -}); - -tape( 'the function supports providing an execution context', function test( t ) { - var expected; - var actual; - var ctx; - var arr; - - ctx = { - 'count': 0 - }; - arr = [ 1, 2, 3 ]; - expected = [ 1, 2, 3 ]; - actual = filter( arr, predicate, ctx ); - - t.strictEqual( instanceOf( actual, Array ), true, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - t.strictEqual( ctx.count, arr.length, 'returns expected value' ); - - t.end(); - - function predicate( value ) { - this.count += 1; // eslint-disable-line no-invalid-this - return ( value > 0 ); - } -}); From bd97f4c7c41f23063084004e14894a7a3e9c2f6c Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Thu, 25 Jan 2024 13:43:57 +0000 Subject: [PATCH 06/40] Update README.md for ESM bundle v0.1.0 --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 6deb31e..2436ed4 100644 --- a/README.md +++ b/README.md @@ -52,7 +52,7 @@ limitations under the License. ## Usage ```javascript -import filter from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-filter@esm/index.mjs'; +import filter from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-filter@v0.1.0-esm/index.mjs'; ``` #### filter( x, predicate\[, thisArg] ) @@ -136,7 +136,7 @@ var cnt = context.count; import discreteUniform from 'https://cdn.jsdelivr.net/gh/stdlib-js/random-array-discrete-uniform@esm/index.mjs'; var isPositiveInteger = require( 'https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-positive-integer' ).isPrimitive; import naryFunction from 'https://cdn.jsdelivr.net/gh/stdlib-js/utils-nary-function@esm/index.mjs'; -import filter from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-filter@esm/index.mjs'; +import filter from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-filter@v0.1.0-esm/index.mjs'; var x = discreteUniform( 10, -5, 5, { 'dtype': 'int32' From ad87b9b4d3313025b654f0309f8e85d63dbbb0c2 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Thu, 25 Jan 2024 13:43:58 +0000 Subject: [PATCH 07/40] Auto-generated commit --- README.md | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 2436ed4..30776c2 100644 --- a/README.md +++ b/README.md @@ -51,6 +51,11 @@ limitations under the License. ## Usage +```javascript +import filter from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-filter@esm/index.mjs'; +``` +The previous example will load the latest bundled code from the esm branch. Alternatively, you may load a specific version by loading the file from one of the [tagged bundles](https://github.com/stdlib-js/array-base-filter/tags). For example, + ```javascript import filter from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-filter@v0.1.0-esm/index.mjs'; ``` @@ -136,7 +141,7 @@ var cnt = context.count; import discreteUniform from 'https://cdn.jsdelivr.net/gh/stdlib-js/random-array-discrete-uniform@esm/index.mjs'; var isPositiveInteger = require( 'https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-positive-integer' ).isPrimitive; import naryFunction from 'https://cdn.jsdelivr.net/gh/stdlib-js/utils-nary-function@esm/index.mjs'; -import filter from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-filter@v0.1.0-esm/index.mjs'; +import filter from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-filter@esm/index.mjs'; var x = discreteUniform( 10, -5, 5, { 'dtype': 'int32' From f54baf3ac853aaed09a0fc9d202ed97dedaacbf3 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Thu, 15 Feb 2024 02:46:07 +0000 Subject: [PATCH 08/40] Transform error messages --- package.json | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/package.json b/package.json index b412dd7..a4b7761 100644 --- a/package.json +++ b/package.json @@ -38,7 +38,8 @@ }, "dependencies": { "@stdlib/array-base-arraylike2object": "^0.2.0", - "@stdlib/types": "^0.3.1" + "@stdlib/types": "^0.3.1", + "@stdlib/error-tools-fmtprodmsg": "^0.2.0" }, "devDependencies": { "@stdlib/array-base-accessor": "^0.1.0", @@ -90,4 +91,4 @@ "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} +} \ No newline at end of file From 2a57976f2b4462c476dc66ef6ba49a83c0ee28a0 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Thu, 15 Feb 2024 06:31:05 +0000 Subject: [PATCH 09/40] Remove files --- index.d.ts | 343 --- index.mjs | 4 - index.mjs.map | 1 - stats.html | 6177 ------------------------------------------------- 4 files changed, 6525 deletions(-) delete mode 100644 index.d.ts delete mode 100644 index.mjs delete mode 100644 index.mjs.map delete mode 100644 stats.html diff --git a/index.d.ts b/index.d.ts deleted file mode 100644 index 1fa8dc7..0000000 --- a/index.d.ts +++ /dev/null @@ -1,343 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2024 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 - -/// - -import { Collection, AccessorArrayLike, Complex128Array, Complex64Array } from '@stdlib/types/array'; - -/** -* Returns a boolean indicating whether an element passes a test. -* -* @returns boolean indicating whether an element passes a test -*/ -type Nullary = ( this: U ) => boolean; - -/** -* Returns a boolean indicating whether an element passes a test. -* -* @param value - current array element -* @returns boolean indicating whether an element passes a test -*/ -type Unary = ( this: U, value: T ) => boolean; - -/** -* Returns a boolean indicating whether an element passes a test. -* -* @param value - current array element -* @param index - current array element index -* @returns boolean indicating whether an element passes a test -*/ -type Binary = ( this: U, value: T, index: number ) => boolean; - -/** -* Returns a boolean indicating whether an element passes a test. -* -* @param value - current array element -* @param index - current array element index -* @param arr - input array -* @returns boolean indicating whether an element passes a test -*/ -type Ternary = ( this: U, value: T, index: number, arr: V ) => boolean; - -/** -* Returns a boolean indicating whether an element passes a test. -* -* @param value - current array element -* @param index - current array element index -* @param arr - input array -* @returns boolean indicating whether an element passes a test -*/ -type Predicate = Nullary | Unary | Binary | Ternary; - -/** -* Returns a shallow copy of an array containing only those elements which pass a test implemented by a predicate function. -* -* @param x - input array -* @param predicate - predicate function -* @param thisArg - predicate function execution context -* @returns output array -* -* @example -* var isPositiveNumber = require( '@stdlib/assert-is-positive-number' ).isPrimitive; -* var Float64Array = require( '@stdlib/array-float64' ); -* -* var x = new Float64Array( [ 1.0, -2.0, -3.0, 4.0 ] ); -* -* var out = filter( x, isPositiveNumber ); -* // returns [ 1.0, 4.0 ] -*/ -declare function filter( x: Float64Array, predicate: Predicate, thisArg?: ThisParameterType> ): Float64Array; - -/** -* Returns a shallow copy of an array containing only those elements which pass a test implemented by a predicate function. -* -* @param x - input array -* @param predicate - predicate function -* @param thisArg - predicate function execution context -* @returns output array -* -* @example -* var isPositiveNumber = require( '@stdlib/assert-is-positive-number' ).isPrimitive; -* var Float32Array = require( '@stdlib/array-float32' ); -* -* var x = new Float32Array( [ 1.0, -2.0, -3.0, 4.0 ] ); -* -* var out = filter( x, isPositiveNumber ); -* // returns [ 1.0, 4.0 ] -*/ -declare function filter( x: Float32Array, predicate: Predicate, thisArg?: ThisParameterType> ): Float32Array; - -/** -* Returns a shallow copy of an array containing only those elements which pass a test implemented by a predicate function. -* -* @param x - input array -* @param predicate - predicate function -* @param thisArg - predicate function execution context -* @returns output array -* -* @example -* var isPositiveNumber = require( '@stdlib/assert-is-positive-number' ).isPrimitive; -* var Int32Array = require( '@stdlib/array-int32' ); -* -* var x = new Int32Array( [ 1, -2, -3, 4 ] ); -* -* var out = filter( x, isPositiveNumber ); -* // returns [ 1, 4 ] -*/ -declare function filter( x: Int32Array, predicate: Predicate, thisArg?: ThisParameterType> ): Int32Array; - -/** -* Returns a shallow copy of an array containing only those elements which pass a test implemented by a predicate function. -* -* @param x - input array -* @param predicate - predicate function -* @param thisArg - predicate function execution context -* @returns output array -* -* @example -* var isPositiveNumber = require( '@stdlib/assert-is-positive-number' ).isPrimitive; -* var Int16Array = require( '@stdlib/array-int16' ); -* -* var x = new Int16Array( [ 1, -2, -3, 4 ] ); -* -* var out = filter( x, isPositiveNumber ); -* // returns [ 1, 4 ] -*/ -declare function filter( x: Int16Array, predicate: Predicate, thisArg?: ThisParameterType> ): Int16Array; - -/** -* Returns a shallow copy of an array containing only those elements which pass a test implemented by a predicate function. -* -* @param x - input array -* @param predicate - predicate function -* @param thisArg - predicate function execution context -* @returns output array -* -* @example -* var isPositiveNumber = require( '@stdlib/assert-is-positive-number' ).isPrimitive; -* var Int8Array = require( '@stdlib/array-int8' ); -* -* var x = new Int8Array( [ 1, -2, -3, 4 ] ); -* -* var out = filter( x, isPositiveNumber ); -* // returns [ 1, 4 ] -*/ -declare function filter( x: Int8Array, predicate: Predicate, thisArg?: ThisParameterType> ): Int8Array; - -/** -* Returns a shallow copy of an array containing only those elements which pass a test implemented by a predicate function. -* -* @param x - input array -* @param predicate - predicate function -* @param thisArg - predicate function execution context -* @returns output array -* -* @example -* var isPositiveNumber = require( '@stdlib/assert-is-positive-number' ).isPrimitive; -* var Uint32Array = require( '@stdlib/array-uint32' ); -* -* var x = new Uint32Array( [ 1, 2, 3, 4 ] ); -* -* var out = filter( x, isPositiveNumber ); -* // returns [ 1, 2, 3, 4 ] -*/ -declare function filter( x: Uint32Array, predicate: Predicate, thisArg?: ThisParameterType> ): Uint32Array; - -/** -* Returns a shallow copy of an array containing only those elements which pass a test implemented by a predicate function. -* -* @param x - input array -* @param predicate - predicate function -* @param thisArg - predicate function execution context -* @returns output array -* -* @example -* var isPositiveNumber = require( '@stdlib/assert-is-positive-number' ).isPrimitive; -* var Uint16Array = require( '@stdlib/array-uint16' ); -* -* var x = new Uint16Array( [ 1, 2, 3, 4 ] ); -* -* var out = filter( x, isPositiveNumber ); -* // returns [ 1, 2, 3, 4 ] -*/ -declare function filter( x: Uint16Array, predicate: Predicate, thisArg?: ThisParameterType> ): Uint16Array; - -/** -* Returns a shallow copy of an array containing only those elements which pass a test implemented by a predicate function. -* -* @param x - input array -* @param predicate - predicate function -* @param thisArg - predicate function execution context -* @returns output array -* -* @example -* var isPositiveNumber = require( '@stdlib/assert-is-positive-number' ).isPrimitive; -* var Uint8Array = require( '@stdlib/array-uint8' ); -* -* var x = new Uint8Array( [ 1, 2, 3, 4 ] ); -* -* var out = filter( x, isPositiveNumber ); -* // returns [ 1, 2, 3, 4 ] -*/ -declare function filter( x: Uint8Array, predicate: Predicate, thisArg?: ThisParameterType> ): Uint8Array; - -/** -* Returns a shallow copy of an array containing only those elements which pass a test implemented by a predicate function. -* -* @param x - input array -* @param predicate - predicate function -* @param thisArg - predicate function execution context -* @returns output array -* -* @example -* var isPositiveNumber = require( '@stdlib/assert-is-positive-number' ).isPrimitive; -* var Uint8ClampedArray = require( '@stdlib/array-uint8c' ); -* -* var x = new Uint8ClampedArray( [ 1, 2, 3, 4 ] ); -* -* var out = filter( x, isPositiveNumber ); -* // returns [ 1, 2, 3, 4 ] -*/ -declare function filter( x: Uint8ClampedArray, predicate: Predicate, thisArg?: ThisParameterType> ): Uint8ClampedArray; - -/** -* Returns a shallow copy of an array containing only those elements which pass a test implemented by a predicate function. -* -* @param x - input array -* @param predicate - predicate function -* @param thisArg - predicate function execution context -* @returns output array -* -* @example -* var isPositiveNumber = require( '@stdlib/assert-is-positive-number' ).isPrimitive; -* var real = require( '@stdlib/complex-real' ); -* var imag = require( '@stdlib/complex-imag' ); -* var Complex128Array = require( '@stdlib/array-complex128' ); -* -* function predicate( v ) { -* return ( isPositiveNumber( real( v ) ) && isPositiveNumber( imag( v ) ) ); -* } -* -* var x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0 ] ); -* -* var out = filter( x, predicate ); -* // returns -*/ -declare function filter( x: Complex128Array, predicate: Predicate, thisArg?: ThisParameterType> ): Complex128Array; - -/** -* Returns a shallow copy of an array containing only those elements which pass a test implemented by a predicate function. -* -* @param x - input array -* @param predicate - predicate function -* @param thisArg - predicate function execution context -* @returns output array -* -* @example -* var isPositiveNumber = require( '@stdlib/assert-is-positive-number' ).isPrimitive; -* var realf = require( '@stdlib/complex-realf' ); -* var imagf = require( '@stdlib/complex-imagf' ); -* var Complex64Array = require( '@stdlib/array-complex64' ); -* -* function predicate( v ) { -* return ( isPositiveNumber( realf( v ) ) && isPositiveNumber( imagf( v ) ) ); -* } -* -* var x = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); -* -* var out = filter( x, predicate ); -* // returns -*/ -declare function filter( x: Complex64Array, predicate: Predicate, thisArg?: ThisParameterType> ): Complex64Array; - -/** -* Returns a shallow copy of an array containing only those elements which pass a test implemented by a predicate function. -* -* @param x - input array -* @param predicate - predicate function -* @param thisArg - predicate function execution context -* @returns output array -* -* @example -* var x = [ 1, -2, -3, 4 ]; -* -* var out = filter( x, isPositiveNumber ); -* // returns [ 1, 4 ] -*/ -declare function filter( x: Array, predicate: Predicate>, thisArg?: ThisParameterType>> ): Array; - -/** -* Returns a shallow copy of an array containing only those elements which pass a test implemented by a predicate function. -* -* @param x - input array -* @param predicate - predicate function -* @param thisArg - predicate function execution context -* @returns output array -* -* @example -* var toAccessorArray = require( '@stdlib/array-base-to-accessor-array' ); -* -* var x = toAccessorArray( [ 1, -2, -3, 4 ] ); -* -* var out = filter( x, isPositiveNumber ); -* // returns [ 1, 4 ] -*/ -declare function filter( x: AccessorArrayLike, predicate: Predicate>, thisArg?: ThisParameterType>> ): Array; - -/** -* Returns a shallow copy of an array containing only those elements which pass a test implemented by a predicate function. -* -* @param x - input array -* @param predicate - predicate function -* @param thisArg - predicate function execution context -* @returns output array -* -* @example -* var x = [ 1, -2, -3, 4 ]; -* -* var out = filter( x, isPositiveNumber ); -* // returns [ 1, 4 ] -*/ -declare function filter( x: Collection, predicate: Predicate>, thisArg?: ThisParameterType>> ): Array; - - -// EXPORTS // - -export = filter; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index 48ac85d..0000000 --- a/index.mjs +++ /dev/null @@ -1,4 +0,0 @@ -// Copyright (c) 2024 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 -/// -import r from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-arraylike2object@v0.1.0-esm/index.mjs";function t(t,e,n){var o;return function(r,t){return"function"==typeof r[t]}(t,"filter")?t.filter(e,n):(o=r(t)).accessorProtocol?function(r,t,e){var n,o,a,s,c;for(n=r.data,o=r.accessors[0],a=[],c=0;c 0;\n* }\n*\n* var x = [ 1, -2, -3, 4 ];\n*\n* var out = internal( x, isPositive );\n* // returns [ 1, 4 ]\n*/\nfunction internal( x, predicate, thisArg ) {\n\tvar out;\n\tvar v;\n\tvar i;\n\n\tout = [];\n\tfor ( i = 0; i < x.length; i++ ) {\n\t\tv = x[ i ];\n\t\tif ( predicate.call( thisArg, v, i, x ) ) {\n\t\t\tout.push( v );\n\t\t}\n\t}\n\treturn out;\n}\n\n/**\n* Returns a shallow copy of an array containing only those elements which pass a test implemented by a predicate function.\n*\n* @private\n* @param {Object} x - input array object\n* @param {Function} predicate - test function\n* @param {*} thisArg - execution context\n* @returns {Array} output array\n*\n* @example\n* import toAccessorArray from '@stdlib/array-base-to-accessor-array';\n* import arraylike2object from '@stdlib/array-base-arraylike2object';\n*\n* function isPositive( v ) {\n* return v > 0;\n* }\n*\n* var x = arraylike2object( toAccessorArray( [ 1, -2, -3, 4 ] ) );\n*\n* var out = accessors( x, isPositive );\n* // returns [ 1, 4 ]\n*/\nfunction accessors( x, predicate, thisArg ) {\n\tvar data;\n\tvar get;\n\tvar out;\n\tvar v;\n\tvar i;\n\n\tdata = x.data;\n\tget = x.accessors[ 0 ];\n\n\tout = [];\n\tfor ( i = 0; i < data.length; i++ ) {\n\t\tv = get( data, i );\n\t\tif ( predicate.call( thisArg, v, i, data ) ) {\n\t\t\tout.push( v );\n\t\t}\n\t}\n\treturn out;\n}\n\n\n// MAIN //\n\n/**\n* Returns a shallow copy of an array containing only those elements which pass a test implemented by a predicate function.\n*\n* @param {Collection} x - input array\n* @param {Function} predicate - test function\n* @param {*} [thisArg] - execution context\n* @returns {Collection} output array\n*\n* @example\n* function isPositive( v ) {\n* return v > 0;\n* }\n*\n* var x = [ 1, -2, -3, 4 ];\n*\n* var out = filter( x, isPositive );\n* // returns [ 1, 4 ]\n*/\nfunction filter( x, predicate, thisArg ) {\n\tvar obj;\n\tif ( hasMethod( x, 'filter' ) ) {\n\t\treturn x.filter( predicate, thisArg );\n\t}\n\tobj = arraylike2object( x );\n\tif ( obj.accessorProtocol ) {\n\t\treturn accessors( obj, predicate, thisArg );\n\t}\n\treturn internal( x, predicate, thisArg );\n}\n\n\n// EXPORTS //\n\nexport default filter;\n"],"names":["filter","x","predicate","thisArg","obj","method","hasMethod","arraylike2object","accessorProtocol","data","get","out","v","i","accessors","length","call","push","internal"],"mappings":";;sGAgJA,SAASA,EAAQC,EAAGC,EAAWC,GAC9B,IAAIC,EACJ,OAvGD,SAAoBA,EAAKC,GACxB,MAAkC,mBAAlBD,EAAKC,EACtB,CAqGMC,CAAWL,EAAG,UACXA,EAAED,OAAQE,EAAWC,IAE7BC,EAAMG,EAAkBN,IACfO,iBA/CV,SAAoBP,EAAGC,EAAWC,GACjC,IAAIM,EACAC,EACAC,EACAC,EACAC,EAMJ,IAJAJ,EAAOR,EAAEQ,KACTC,EAAMT,EAAEa,UAAW,GAEnBH,EAAM,GACAE,EAAI,EAAGA,EAAIJ,EAAKM,OAAQF,IAC7BD,EAAIF,EAAKD,EAAMI,GACVX,EAAUc,KAAMb,EAASS,EAAGC,EAAGJ,IACnCE,EAAIM,KAAML,GAGZ,OAAOD,CACR,CA8BSG,CAAWV,EAAKF,EAAWC,GArFpC,SAAmBF,EAAGC,EAAWC,GAChC,IAAIQ,EACAC,EACAC,EAGJ,IADAF,EAAM,GACAE,EAAI,EAAGA,EAAIZ,EAAEc,OAAQF,IAC1BD,EAAIX,EAAGY,GACFX,EAAUc,KAAMb,EAASS,EAAGC,EAAGZ,IACnCU,EAAIM,KAAML,GAGZ,OAAOD,CACR,CA0EQO,CAAUjB,EAAGC,EAAWC,EAChC"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index 6c5fd06..0000000 --- a/stats.html +++ /dev/null @@ -1,6177 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From 42f486f3d7a1b8a2076410d999c59170fd21b9ac Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Thu, 15 Feb 2024 06:32:42 +0000 Subject: [PATCH 10/40] Auto-generated commit --- .editorconfig | 181 - .eslintrc.js | 1 - .gitattributes | 49 - .github/PULL_REQUEST_TEMPLATE.md | 7 - .github/workflows/benchmark.yml | 64 - .github/workflows/cancel.yml | 57 - .github/workflows/close_pull_requests.yml | 54 - .github/workflows/examples.yml | 64 - .github/workflows/npm_downloads.yml | 112 - .github/workflows/productionize.yml | 797 --- .github/workflows/publish.yml | 255 - .github/workflows/test.yml | 100 - .github/workflows/test_bundles.yml | 189 - .github/workflows/test_coverage.yml | 132 - .github/workflows/test_install.yml | 86 - .gitignore | 188 - .npmignore | 228 - .npmrc | 28 - CHANGELOG.md | 5 - CITATION.cff | 30 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 -- README.md | 41 +- SECURITY.md | 5 - benchmark/benchmark.length.js | 97 - branches.md | 56 - dist/index.d.ts | 3 - dist/index.js | 5 - dist/index.js.map | 7 - docs/repl.txt | 46 - docs/types/test.ts | 101 - examples/index.js | 35 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/index.js | 46 - lib/main.js | 160 - package.json | 65 +- stats.html | 6177 +++++++++++++++++++++ test/dist/test.js | 33 - test/test.js | 251 - 42 files changed, 6202 insertions(+), 4100 deletions(-) delete mode 100644 .editorconfig delete mode 100644 .eslintrc.js delete mode 100644 .gitattributes delete mode 100644 .github/PULL_REQUEST_TEMPLATE.md delete mode 100644 .github/workflows/benchmark.yml delete mode 100644 .github/workflows/cancel.yml delete mode 100644 .github/workflows/close_pull_requests.yml delete mode 100644 .github/workflows/examples.yml delete mode 100644 .github/workflows/npm_downloads.yml delete mode 100644 .github/workflows/productionize.yml delete mode 100644 .github/workflows/publish.yml delete mode 100644 .github/workflows/test.yml delete mode 100644 .github/workflows/test_bundles.yml delete mode 100644 .github/workflows/test_coverage.yml delete mode 100644 .github/workflows/test_install.yml delete mode 100644 .gitignore delete mode 100644 .npmignore delete mode 100644 .npmrc delete mode 100644 CHANGELOG.md delete mode 100644 CITATION.cff delete mode 100644 CODE_OF_CONDUCT.md delete mode 100644 CONTRIBUTING.md delete mode 100644 Makefile delete mode 100644 SECURITY.md delete mode 100644 benchmark/benchmark.length.js delete mode 100644 branches.md delete mode 100644 dist/index.d.ts delete mode 100644 dist/index.js delete mode 100644 dist/index.js.map delete mode 100644 docs/repl.txt delete mode 100644 docs/types/test.ts delete mode 100644 examples/index.js rename docs/types/index.d.ts => index.d.ts (99%) create mode 100644 index.mjs create mode 100644 index.mjs.map delete mode 100644 lib/index.js delete mode 100644 lib/main.js create mode 100644 stats.html delete mode 100644 test/dist/test.js delete mode 100644 test/test.js diff --git a/.editorconfig b/.editorconfig deleted file mode 100644 index 60d743f..0000000 --- a/.editorconfig +++ /dev/null @@ -1,181 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 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. -#/ - -# EditorConfig configuration file (see ). - -# Indicate that this file is a root-level configuration file: -root = true - -# Set properties for all files: -[*] -end_of_line = lf -charset = utf-8 -trim_trailing_whitespace = true -insert_final_newline = true - -# Set properties for JavaScript files: -[*.{js,js.txt}] -indent_style = tab - -# Set properties for JavaScript ES module files: -[*.{mjs,mjs.txt}] -indent_style = tab - -# Set properties for JavaScript CommonJS files: -[*.{cjs,cjs.txt}] -indent_style = tab - -# Set properties for JSON files: -[*.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `cli_opts.json` files: -[cli_opts.json] -indent_style = tab - -# Set properties for TypeScript files: -[*.ts] -indent_style = tab - -# Set properties for Python files: -[*.{py,py.txt}] -indent_style = space -indent_size = 4 - -# Set properties for Julia files: -[*.{jl,jl.txt}] -indent_style = tab - -# Set properties for R files: -[*.{R,R.txt}] -indent_style = tab - -# Set properties for C files: -[*.{c,c.txt}] -indent_style = tab - -# Set properties for C header files: -[*.{h,h.txt}] -indent_style = tab - -# Set properties for C++ files: -[*.{cpp,cpp.txt}] -indent_style = tab - -# Set properties for C++ header files: -[*.{hpp,hpp.txt}] -indent_style = tab - -# Set properties for Fortran files: -[*.{f,f.txt}] -indent_style = space -indent_size = 2 -insert_final_newline = false - -# Set properties for shell files: -[*.{sh,sh.txt}] -indent_style = tab - -# Set properties for AWK files: -[*.{awk,awk.txt}] -indent_style = tab - -# Set properties for HTML files: -[*.{html,html.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for XML files: -[*.{xml,xml.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for CSS files: -[*.{css,css.txt}] -indent_style = tab - -# Set properties for Makefiles: -[Makefile] -indent_style = tab - -[*.{mk,mk.txt}] -indent_style = tab - -# Set properties for Markdown files: -[*.{md,md.txt}] -indent_style = space -indent_size = 4 -trim_trailing_whitespace = false - -# Set properties for `usage.txt` files: -[usage.txt] -indent_style = space -indent_size = 2 - -# Set properties for `repl.txt` files: -[repl.txt] -indent_style = space -indent_size = 4 - -# Set properties for `package.json` files: -[package.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `datapackage.json` files: -[datapackage.json] -indent_style = space -indent_size = 2 - -# Set properties for `manifest.json` files: -[manifest.json] -indent_style = space -indent_size = 2 - -# Set properties for `tsconfig.json` files: -[tsconfig.json] -indent_style = space -indent_size = 2 - -# Set properties for LaTeX files: -[*.{tex,tex.txt}] -indent_style = tab - -# Set properties for LaTeX Bibliography files: -[*.{bib,bib.txt}] -indent_style = tab - -# Set properties for YAML files: -[*.{yml,yml.txt}] -indent_style = space -indent_size = 2 - -# Set properties for GYP files: -[binding.gyp] -indent_style = space -indent_size = 2 - -[*.gypi] -indent_style = space -indent_size = 2 - -# Set properties for citation files: -[*.{cff,cff.txt}] -indent_style = space -indent_size = 2 diff --git a/.eslintrc.js b/.eslintrc.js deleted file mode 100644 index 5f30286..0000000 --- a/.eslintrc.js +++ /dev/null @@ -1 +0,0 @@ -/* For the `eslint` rules of this project, consult the main repository at https://github.com/stdlib-js/stdlib */ diff --git a/.gitattributes b/.gitattributes deleted file mode 100644 index 10a16e6..0000000 --- a/.gitattributes +++ /dev/null @@ -1,49 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 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. -#/ - -# Configuration file which assigns attributes to pathnames. -# -# [1]: https://git-scm.com/docs/gitattributes - -# Automatically normalize the line endings of any committed text files: -* text=auto - -# Override line endings for certain files on checkout: -*.crlf.csv text eol=crlf - -# Denote that certain files are binary and should not be modified: -*.png binary -*.jpg binary -*.jpeg binary -*.gif binary -*.ico binary -*.gz binary -*.zip binary -*.7z binary -*.mp3 binary -*.mp4 binary -*.mov binary - -# Override what is considered "vendored" by GitHub's linguist: -/deps/** linguist-vendored=false -/lib/node_modules/** linguist-vendored=false linguist-generated=false -test/fixtures/** linguist-vendored=false -tools/** linguist-vendored=false - -# Override what is considered "documentation" by GitHub's linguist: -examples/** linguist-documentation=false diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index 6559bc7..0000000 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ /dev/null @@ -1,7 +0,0 @@ - - -We are excited about your pull request, but unfortunately we are not accepting pull requests against this repository, as all development happens on the [main project repository](https://github.com/stdlib-js/stdlib). We kindly request that you submit this pull request against the [respective directory](https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/filter) of the main repository where we’ll review and provide feedback. - -If this is your first stdlib contribution, be sure to read the [contributing guide](https://github.com/stdlib-js/stdlib/blob/develop/CONTRIBUTING.md) which provides guidelines and instructions for submitting contributions. You may also consult the [development guide](https://github.com/stdlib-js/stdlib/blob/develop/docs/development.md) for help on developing stdlib. - -We look forward to receiving your contribution! :smiley: \ No newline at end of file diff --git a/.github/workflows/benchmark.yml b/.github/workflows/benchmark.yml deleted file mode 100644 index e4f10fe..0000000 --- a/.github/workflows/benchmark.yml +++ /dev/null @@ -1,64 +0,0 @@ -#/ -# @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. -#/ - -# Workflow name: -name: benchmark - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to run benchmarks: - benchmark: - - # Define a display name: - name: 'Run benchmarks' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Run benchmarks: - - name: 'Run benchmarks' - run: | - npm run benchmark diff --git a/.github/workflows/cancel.yml b/.github/workflows/cancel.yml deleted file mode 100644 index b5291db..0000000 --- a/.github/workflows/cancel.yml +++ /dev/null @@ -1,57 +0,0 @@ -#/ -# @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. -#/ - -# Workflow name: -name: cancel - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to cancel existing workflow runs: - cancel: - - # Define a display name: - name: 'Cancel workflow runs' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Time limit: - timeout-minutes: 3 - - # Define the sequence of job steps... - steps: - - # Cancel existing workflow runs: - - name: 'Cancel existing workflow runs' - # Pin action to full length commit SHA - uses: styfle/cancel-workflow-action@85880fa0301c86cca9da44039ee3bb12d3bedbfa # v0.12.1 - with: - workflow_id: >- - benchmark.yml, - examples.yml, - test.yml, - test_coverage.yml, - test_install.yml, - publish.yml - access_token: ${{ github.token }} diff --git a/.github/workflows/close_pull_requests.yml b/.github/workflows/close_pull_requests.yml deleted file mode 100644 index 2060eba..0000000 --- a/.github/workflows/close_pull_requests.yml +++ /dev/null @@ -1,54 +0,0 @@ -#/ -# @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. -#/ - -# Workflow name: -name: close_pull_requests - -# Workflow triggers: -on: - pull_request_target: - types: [opened] - -# Workflow jobs: -jobs: - - # Define job to close all pull requests: - run: - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - - # Close pull request - - name: 'Close pull request' - # Pin action to full length commit SHA corresponding to v3.1.2 - uses: superbrothers/close-pull-request@9c18513d320d7b2c7185fb93396d0c664d5d8448 - with: - comment: | - Thank you for submitting a pull request. :raised_hands: - - We greatly appreciate your willingness to submit a contribution. However, we are not accepting pull requests against this repository, as all development happens on the [main project repository](https://github.com/stdlib-js/stdlib). - - We kindly request that you submit this pull request against the [respective directory](https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/filter) of the main repository where we’ll review and provide feedback. If this is your first stdlib contribution, be sure to read the [contributing guide](https://github.com/stdlib-js/stdlib/blob/develop/CONTRIBUTING.md) which provides guidelines and instructions for submitting contributions. - - Thank you again, and we look forward to receiving your contribution! :smiley: - - Best, - The stdlib team \ No newline at end of file diff --git a/.github/workflows/examples.yml b/.github/workflows/examples.yml deleted file mode 100644 index 2984901..0000000 --- a/.github/workflows/examples.yml +++ /dev/null @@ -1,64 +0,0 @@ -#/ -# @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. -#/ - -# Workflow name: -name: examples - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to run the package examples... - examples: - - # Define display name: - name: 'Run examples' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - - # Checkout repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Run examples: - - name: 'Run examples' - run: | - npm run examples diff --git a/.github/workflows/npm_downloads.yml b/.github/workflows/npm_downloads.yml deleted file mode 100644 index 6c9b827..0000000 --- a/.github/workflows/npm_downloads.yml +++ /dev/null @@ -1,112 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2022 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. -#/ - -# Workflow name: -name: npm_downloads - -# Workflow triggers: -on: - # Run this workflow weekly: - schedule: - # cron: ' ' - - cron: '48 12 * * 3' - - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job for retrieving npm download counts... - npm_downloads: - - # Define display name: - name: 'Retrieve npm download counts' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - timeout-minutes: 10 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Resolve package name: - - name: 'Resolve package name' - id: package_name - run: | - name=`node -e 'console.log(require("./package.json").name)' | tr -d '\n'` - echo "package_name=$name" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Fetch download data: - - name: 'Fetch data' - id: download_data - run: | - url="https://api.npmjs.org/downloads/range/$(date --date='1 year ago' '+%Y-%m-%d'):$(date '+%Y-%m-%d')/${{ steps.package_name.outputs.package_name }}" - echo "$url" - data=$(curl "$url") - mkdir ./tmp - echo "$data" > ./tmp/npm_downloads.json - echo "data=$data" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Print summary of download data: - - name: 'Print summary' - run: | - echo "| Date | Downloads |" >> $GITHUB_STEP_SUMMARY - echo "|------|------------|" >> $GITHUB_STEP_SUMMARY - cat ./tmp/npm_downloads.json | jq -r ".downloads | .[-14:] | to_entries | map(\"| \(.value.day) | \(.value.downloads) |\") |.[]" >> $GITHUB_STEP_SUMMARY - - # Upload the download data: - - name: 'Upload data' - # Pin action to full length commit SHA corresponding to v3.1.3 - uses: actions/upload-artifact@a8a3f3ad30e3422c9c7b888a15615d19a852ae32 - with: - # Define a name for the uploaded artifact (ensuring a unique name for each job): - name: npm_downloads - - # Specify the path to the file to upload: - path: ./tmp/npm_downloads.json - - # Specify the number of days to retain the artifact (default is 90 days): - retention-days: 90 - timeout-minutes: 10 - if: success() - - # Send data to events server: - - name: 'Post data' - # Pin action to full length commit SHA - uses: distributhor/workflow-webhook@48a40b380ce4593b6a6676528cd005986ae56629 # v3.0.3 - env: - webhook_url: ${{ secrets.STDLIB_NPM_DOWNLOADS_URL }} - webhook_secret: ${{ secrets.STDLIB_WEBHOOK_SECRET }} - data: '{ "downloads": ${{ steps.download_data.outputs.data }} }' - timeout-minutes: 5 - if: success() diff --git a/.github/workflows/productionize.yml b/.github/workflows/productionize.yml deleted file mode 100644 index 9106b5d..0000000 --- a/.github/workflows/productionize.yml +++ /dev/null @@ -1,797 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2022 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. -#/ - -# Workflow name: -name: productionize - -# Workflow triggers: -on: - # Run workflow when a new commit is pushed to the main branch: - push: - branches: - - main - - # Allow the workflow to be manually run: - workflow_dispatch: - inputs: - require-passing-tests: - description: 'Require passing tests for creating bundles' - type: boolean - default: true - - # Run workflow upon completion of `publish` workflow run: - workflow_run: - workflows: ["publish"] - types: [completed] - - -# Concurrency group to prevent multiple concurrent executions: -concurrency: - group: productionize - cancel-in-progress: true - -# Workflow jobs: -jobs: - - # Define a job to create a production build... - productionize: - - # Define display name: - name: 'Productionize' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Define the sequence of job steps... - steps: - # Checkout main branch of repository: - - name: 'Checkout main branch' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - with: - ref: main - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Create production branch: - - name: 'Create production branch' - run: | - git checkout -b production - - # Transform error messages: - - name: 'Transform error messages' - id: transform-error-messages - uses: stdlib-js/transform-errors-action@main - - # 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: | - PKG_VERSION=$(npm view @stdlib/error-tools-fmtprodmsg version) - if grep -q '"@stdlib/string-format"' package.json; then - sed -i "s/\"@stdlib\/string-format\": \"^.*\"/\"@stdlib\/error-tools-fmtprodmsg\": \"^$PKG_VERSION\"/g" package.json - else - node -e "var pkg = require( './package.json' ); pkg.dependencies[ '@stdlib/error-tools-fmtprodmsg' ] = '^$PKG_VERSION'; require( 'fs' ).writeFileSync( 'package.json', JSON.stringify( pkg, null, 2 ) );" - fi - - # Configure git: - - name: 'Configure git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Transform error messages" - - # Push changes: - - name: 'Push changes' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" production --force - - # Define a job for running tests of the productionized code... - test: - - # Define a display name: - name: 'Run Tests' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Indicate that this job depends on the prior job finishing: - needs: productionize - - # Run this job regardless of the outcome of the prior job: - if: always() - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout repository' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - with: - # Use the `production` branch: - ref: production - - # Install Node.js: - - name: 'Install Node.js' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Build native add-on if present: - - name: 'Build native add-on (if present)' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - run: | - if [ -f "binding.gyp" ]; then - npm install node-gyp --no-save && ./node_modules/.bin/node-gyp rebuild - fi - - # Run tests: - - name: 'Run tests' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: tests - run: | - npm test || npm test || npm test - - # Define job to create a bundle for use in Deno... - deno: - - # Define display name: - name: 'Create Deno bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Configure git: - - name: 'Configure git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `deno` branch exists: - - name: 'Check if remote `deno` branch exists' - id: deno-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin deno - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `deno` exists, delete everything in branch and merge `production` into it - - name: 'If `deno` exists, delete everything in branch and merge `production` into it' - if: steps.deno-branch-exists.outputs.remote-exists - run: | - git checkout -b deno origin/deno - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `deno` does not exist, create `deno` branch: - - name: 'If `deno` does not exist, create `deno` branch' - if: ${{ steps.deno-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b deno - - # Copy files to deno directory: - - name: 'Copy files to deno directory' - run: | - mkdir -p deno - cp README.md LICENSE CONTRIBUTORS NOTICE ./deno - - # Copy TypeScript definitions to deno directory: - if [ -d index.d.ts ]; then - cp index.d.ts ./deno/index.d.ts - fi - if [ -e ./docs/types/index.d.ts ]; then - cp ./docs/types/index.d.ts ./deno/mod.d.ts - fi - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: Install production and development dependencies - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Bundle package for use in Deno: - - name: 'Bundle package for Deno' - id: deno-bundle - uses: stdlib-js/bundle-action@main - with: - target: 'deno' - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - # Replace links to other packages with links to the deno branch: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/deno/"; - - # Replace reference to `@stdlib/types` with CDN link: - find ./deno -type f -name '*.ts' -print0 | xargs -0 -r sed -Ei "s/\/\/\/ /\/\/\/ /g" - - # Change wording of project description to avoid reference to JavaScript and Node.js: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "s/a standard library for JavaScript and Node.js, /a standard library /g" - - # Rewrite all `require()`s to use jsDelivr links: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/require\( '@stdlib\// { - s/(var|let|const)\s+([a-z0-9_]+)\s+=\s*require\( '([^']+)' \);/import \2 from \'\3\';/i - s/@stdlib/https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js/ - s/';/@deno\/mod.js';/ - }" - - # Rewrite first `import` to show importing of named exports if available: - exports=$(cat lib/index.js | \ - grep -E 'setReadOnly\(.*,.*,.*\)' | \ - sed -E 's/setReadOnly\((.*),(.*),(.*)\);/\2/' | \ - sed -E "s/'//g" | \ - sort) - if [ -n "$exports" ]; then - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\nimport\s+([a-zA-Z0-9_]+)\s+from\s*'([^']+)';\n\`\`\`/\`\`\`javascript\nimport \1 from '\2';\n\`\`\`\n\nYou can also import the following named exports from the package:\n\n\`\`\`javascript\nimport { $(echo $exports | sed -E 's/ /, /g') } from '\2';\n\`\`\`/" - fi - - # Remove `installation`, `cli`, and `c` sections: - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Create package.json file for deno branch: - jq --indent 2 '{"name": .name, "version": .version, "description": .description, "license": .license, "type": "module", "main": "./mod.js", "homepage": .homepage, "repository": .repository, "bugs": .bugs, "keywords": .keywords, "funding": .funding}' package.json > ./deno/package.json - - # Delete everything in current directory aside from deno folder: - - name: 'Delete everything in current directory aside from deno folder' - run: | - find . -type 'f' | grep -v -e "deno" -e ".git/" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e "deno" -e ".git" | xargs -r rm -rf - - # Move deno directory to root: - - name: 'Move deno directory to root' - run: | - mv ./deno/* . - rmdir ./deno - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Auto-generated commit" - - # Push changes to `deno` branch: - - name: 'Push changes to `deno` branch' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" deno - - # Send status to Slack channel if job fails: - - name: 'Send status to Slack channel in case of failure' - # Pin action to full length commit SHA corresponding to v2.0.0 - uses: act10ns/slack@ed1309ab9862e57e9e583e51c7889486b9a00b0f - with: - status: ${{ job.status }} - steps: ${{ toJson(steps) }} - channel: '#npm-ci' - if: failure() - - # Define job to create a UMD bundle... - umd: - - # Define display name: - name: 'Create UMD bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Configure git: - - name: 'Configure git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `umd` branch exists: - - name: 'Check if remote `umd` branch exists' - id: umd-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin umd - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `umd` exists, delete everything in branch and merge `production` into it - - name: 'If `umd` exists, delete everything in branch and merge `production` into it' - if: steps.umd-branch-exists.outputs.remote-exists - run: | - git checkout -b umd origin/umd - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `umd` does not exist, create `umd` branch: - - name: 'If `umd` does not exist, create `umd` branch' - if: ${{ steps.umd-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b umd - - # Copy files to umd directory: - - name: 'Copy files to umd directory' - run: | - mkdir -p umd - cp README.md LICENSE CONTRIBUTORS NOTICE ./umd - - # Install Node.js - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Extract alias: - - name: 'Extract alias' - id: extract-alias - run: | - alias=$(grep -E 'require\(' README.md | head -n 1 | sed -E 's/^var ([a-zA-Z0-9_]+) = .+/\1/') - echo "alias=${alias}" >> $GITHUB_OUTPUT - - # Create Universal Module Definition (UMD) Node.js bundle: - - name: 'Create Universal Module Definition (UMD) Node.js bundle' - id: umd-bundle-node - uses: stdlib-js/bundle-action@main - with: - target: 'umd-node' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Create Universal Module Definition (UMD) browser bundle: - - name: 'Create Universal Module Definition (UMD) browser bundle' - id: umd-bundle-browser - uses: stdlib-js/bundle-action@main - with: - target: 'umd-browser' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - - # Replace links to other packages with links to the umd branch: - find ./umd -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/umd/"; - - # Remove `installation`, `cli`, and `c` sections: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Rewrite first `require()` to show consumption of the UMD bundle in Observable and via a `script` tag: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\n(var|let|const)\s+([a-zA-Z0-9_]+)\s+=\s*require\( '\@stdlib\/([^']+)' \);\n\`\`\`/To use in Observable,\n\n\`\`\`javascript\n\2 = require\( 'https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js\/\3\@umd\/browser.js' \)\n\`\`\`\n\nTo vendor stdlib functionality and avoid installing dependency trees for Node.js, you can use the UMD server build:\n\n\`\`\`javascript\nvar \2 = require\( 'path\/to\/vendor\/umd\/\3\/index.js' \)\n\`\`\`\n\nTo include the bundle in a webpage,\n\n\`\`\`html\n + + ```
@@ -189,7 +180,7 @@ var out = filter( x, naryFunction( isPositiveInteger, 1 ) ); ## 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. +This package is part of [stdlib][stdlib], a standard library 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]. diff --git a/SECURITY.md b/SECURITY.md deleted file mode 100644 index 9702d4c..0000000 --- a/SECURITY.md +++ /dev/null @@ -1,5 +0,0 @@ -# Security - -> Policy for reporting security vulnerabilities. - -See the security policy [in the main project repository](https://github.com/stdlib-js/stdlib/security). diff --git a/benchmark/benchmark.length.js b/benchmark/benchmark.length.js deleted file mode 100644 index bc79e33..0000000 --- a/benchmark/benchmark.length.js +++ /dev/null @@ -1,97 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 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 bench = require( '@stdlib/bench-harness' ); -var pow = require( '@stdlib/math-base-special-pow' ); -var isArray = require( '@stdlib/assert-is-array' ); -var isNonNegativeInteger = require( '@stdlib/assert-is-nonnegative-integer' ).isPrimitive; -var zeroTo = require( '@stdlib/array-base-zero-to' ); -var pkg = require( './../package.json' ).name; -var filter = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveInteger} len - array length -* @returns {Function} benchmark function -*/ -function createBenchmark( len ) { - var x = zeroTo( len ); - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var out; - var i; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - out = filter( x, isNonNegativeInteger ); - if ( typeof out !== 'object' ) { - b.fail( 'should return an array' ); - } - } - b.toc(); - if ( !isArray( out ) ) { - b.fail( 'should return an array' ); - } - b.pass( 'benchmark finished' ); - b.end(); - } -} - - -// MAIN // - -/** -* Main execution sequence. -* -* @private -*/ -function main() { - var len; - var min; - var max; - var f; - var i; - - min = 1; // 10^min - max = 6; // 10^max - - for ( i = min; i <= max; i++ ) { - len = pow( 10, i ); - - f = createBenchmark( len ); - bench( pkg+':dtype=generic,len='+len, f ); - } -} - -main(); diff --git a/branches.md b/branches.md deleted file mode 100644 index 9858901..0000000 --- a/branches.md +++ /dev/null @@ -1,56 +0,0 @@ - - -# Branches - -This repository has the following branches: - -- **main**: default branch generated from the [stdlib project][stdlib-url], where all development takes place. -- **production**: [production build][production-url] of the package (e.g., reformatted error messages to reduce bundle sizes and thus the number of bytes transmitted over a network). -- **esm**: [ES Module][esm-url] branch for use via a `script` tag without the need for installation and bundlers (see [README][esm-readme]). -- **deno**: [Deno][deno-url] branch for use in Deno (see [README][deno-readme]). -- **umd**: [UMD][umd-url] branch for use in Observable, or in dual browser/Node.js environments (see [README][umd-readme]). - -The following diagram illustrates the relationships among the above branches: - -```mermaid -graph TD; -A[stdlib]-->|generate standalone package|B; -B[main] -->|productionize| C[production]; -C -->|bundle| D[esm]; -C -->|bundle| E[deno]; -C -->|bundle| F[umd]; - -%% click A href "https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/filter" -%% click B href "https://github.com/stdlib-js/array-base-filter/tree/main" -%% click C href "https://github.com/stdlib-js/array-base-filter/tree/production" -%% click D href "https://github.com/stdlib-js/array-base-filter/tree/esm" -%% click E href "https://github.com/stdlib-js/array-base-filter/tree/deno" -%% click F href "https://github.com/stdlib-js/array-base-filter/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/filter -[production-url]: https://github.com/stdlib-js/array-base-filter/tree/production -[deno-url]: https://github.com/stdlib-js/array-base-filter/tree/deno -[deno-readme]: https://github.com/stdlib-js/array-base-filter/blob/deno/README.md -[umd-url]: https://github.com/stdlib-js/array-base-filter/tree/umd -[umd-readme]: https://github.com/stdlib-js/array-base-filter/blob/umd/README.md -[esm-url]: https://github.com/stdlib-js/array-base-filter/tree/esm -[esm-readme]: https://github.com/stdlib-js/array-base-filter/blob/esm/README.md \ No newline at end of file diff --git a/dist/index.d.ts b/dist/index.d.ts deleted file mode 100644 index aafb9cb..0000000 --- a/dist/index.d.ts +++ /dev/null @@ -1,3 +0,0 @@ -/// -import filter from '../docs/types/index'; -export = filter; \ No newline at end of file diff --git a/dist/index.js b/dist/index.js deleted file mode 100644 index 5c2f789..0000000 --- a/dist/index.js +++ /dev/null @@ -1,5 +0,0 @@ -"use strict";var s=function(r,t){return function(){return t||r((t={exports:{}}).exports,t),t.exports}};var f=s(function(y,c){ -var v=require('@stdlib/array-base-arraylike2object/dist');function l(r,t){return typeof r[t]=="function"}function h(r,t,n){var e,o,a;for(e=[],a=0;a 0;\n* }\n*\n* var x = [ 1, -2, -3, 4 ];\n*\n* var out = internal( x, isPositive );\n* // returns [ 1, 4 ]\n*/\nfunction internal( x, predicate, thisArg ) {\n\tvar out;\n\tvar v;\n\tvar i;\n\n\tout = [];\n\tfor ( i = 0; i < x.length; i++ ) {\n\t\tv = x[ i ];\n\t\tif ( predicate.call( thisArg, v, i, x ) ) {\n\t\t\tout.push( v );\n\t\t}\n\t}\n\treturn out;\n}\n\n/**\n* Returns a shallow copy of an array containing only those elements which pass a test implemented by a predicate function.\n*\n* @private\n* @param {Object} x - input array object\n* @param {Function} predicate - test function\n* @param {*} thisArg - execution context\n* @returns {Array} output array\n*\n* @example\n* var toAccessorArray = require( '@stdlib/array-base-to-accessor-array' );\n* var arraylike2object = require( '@stdlib/array-base-arraylike2object' );\n*\n* function isPositive( v ) {\n* return v > 0;\n* }\n*\n* var x = arraylike2object( toAccessorArray( [ 1, -2, -3, 4 ] ) );\n*\n* var out = accessors( x, isPositive );\n* // returns [ 1, 4 ]\n*/\nfunction accessors( x, predicate, thisArg ) {\n\tvar data;\n\tvar get;\n\tvar out;\n\tvar v;\n\tvar i;\n\n\tdata = x.data;\n\tget = x.accessors[ 0 ];\n\n\tout = [];\n\tfor ( i = 0; i < data.length; i++ ) {\n\t\tv = get( data, i );\n\t\tif ( predicate.call( thisArg, v, i, data ) ) {\n\t\t\tout.push( v );\n\t\t}\n\t}\n\treturn out;\n}\n\n\n// MAIN //\n\n/**\n* Returns a shallow copy of an array containing only those elements which pass a test implemented by a predicate function.\n*\n* @param {Collection} x - input array\n* @param {Function} predicate - test function\n* @param {*} [thisArg] - execution context\n* @returns {Collection} output array\n*\n* @example\n* function isPositive( v ) {\n* return v > 0;\n* }\n*\n* var x = [ 1, -2, -3, 4 ];\n*\n* var out = filter( x, isPositive );\n* // returns [ 1, 4 ]\n*/\nfunction filter( x, predicate, thisArg ) {\n\tvar obj;\n\tif ( hasMethod( x, 'filter' ) ) {\n\t\treturn x.filter( predicate, thisArg );\n\t}\n\tobj = arraylike2object( x );\n\tif ( obj.accessorProtocol ) {\n\t\treturn accessors( obj, predicate, thisArg );\n\t}\n\treturn internal( x, predicate, thisArg );\n}\n\n\n// EXPORTS //\n\nmodule.exports = filter;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2024 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* Return a shallow copy of an array containing only those elements which pass a test implemented by a predicate function.\n*\n* @module @stdlib/array-base-filter\n*\n* @example\n* var filter = require( '@stdlib/array-base-filter' );\n*\n* function isPositive( v ) {\n* return v > 0;\n* }\n*\n* var x = [ 1, -2, -3, 4 ];\n*\n* var out = filter( x, isPositive );\n* // returns [ 1, 4 ]\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,EAAmB,QAAS,qCAAsC,EAqBtE,SAASC,EAAWC,EAAKC,EAAS,CACjC,OAAS,OAAOD,EAAKC,CAAO,GAAM,UACnC,CAqBA,SAASC,EAAUC,EAAGC,EAAWC,EAAU,CAC1C,IAAIC,EACAC,EACAC,EAGJ,IADAF,EAAM,CAAC,EACDE,EAAI,EAAGA,EAAIL,EAAE,OAAQK,IAC1BD,EAAIJ,EAAGK,CAAE,EACJJ,EAAU,KAAMC,EAASE,EAAGC,EAAGL,CAAE,GACrCG,EAAI,KAAMC,CAAE,EAGd,OAAOD,CACR,CAwBA,SAASG,EAAWN,EAAGC,EAAWC,EAAU,CAC3C,IAAIK,EACAC,EACAL,EACAC,EACAC,EAMJ,IAJAE,EAAOP,EAAE,KACTQ,EAAMR,EAAE,UAAW,CAAE,EAErBG,EAAM,CAAC,EACDE,EAAI,EAAGA,EAAIE,EAAK,OAAQF,IAC7BD,EAAII,EAAKD,EAAMF,CAAE,EACZJ,EAAU,KAAMC,EAASE,EAAGC,EAAGE,CAAK,GACxCJ,EAAI,KAAMC,CAAE,EAGd,OAAOD,CACR,CAuBA,SAASM,EAAQT,EAAGC,EAAWC,EAAU,CACxC,IAAIL,EACJ,OAAKD,EAAWI,EAAG,QAAS,EACpBA,EAAE,OAAQC,EAAWC,CAAQ,GAErCL,EAAMF,EAAkBK,CAAE,EACrBH,EAAI,iBACDS,EAAWT,EAAKI,EAAWC,CAAQ,EAEpCH,EAAUC,EAAGC,EAAWC,CAAQ,EACxC,CAKAR,EAAO,QAAUe,ICvHjB,IAAIC,EAAO,IAKX,OAAO,QAAUA", - "names": ["require_main", "__commonJSMin", "exports", "module", "arraylike2object", "hasMethod", "obj", "method", "internal", "x", "predicate", "thisArg", "out", "v", "i", "accessors", "data", "get", "filter", "main"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index bb2b17a..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,46 +0,0 @@ - -{{alias}}( x, predicate[, thisArg] ) - Returns a shallow copy of an array containing only those elements which pass - a test implemented by a predicate function. - - The predicate function is provided three arguments: - - - value: current array element. - - index: current array element index. - - arr: the input array. - - If provided an array-like object having a `filter` method , the function - defers execution to that method and assumes that the method has the - following signature: - - x.filter( predicate, thisArg ) - - If provided an array-like object without a `filter` method, the function - performs a linear scan and always returns a generic array. - - Parameters - ---------- - x: Array|TypedArray|Object - Input array. - - predicate: Function - Predicate function. - - thisArg: any (optional) - Execution context. - - Returns - ------- - out: Array|TypedArray|Object - Output array. - - Examples - -------- - > function f( v ) { return ( v > 0 ); }; - > var x = [ 1, -2, -3, 4 ]; - > var out = {{alias}}( x, f ) - [ 1, 4 ] - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index db0c38d..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,101 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2024 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. -*/ - -import toAccessorArray = require( '@stdlib/array-base-to-accessor-array' ); -import filter = require( './index' ); - -/** -* Tests whether a value is positive. -* -* @param value - input value -* @returns boolean indicating whether an element is positive -*/ -function isPositive( value: number ): boolean { - return ( value > 0 ); -} - - -// TESTS // - -// The function returns a collection... -{ - filter( [ 1, 2, 3 ], isPositive ); // $ExpectType number[] - filter( new Float64Array( [ 1, 2, 3 ] ), isPositive ); // $ExpectType Float64Array - filter( new Float32Array( [ 1, 2, 3 ] ), isPositive ); // $ExpectType Float32Array - filter( new Int32Array( [ 1, 2, 3 ] ), isPositive ); // $ExpectType Int32Array - filter( new Int16Array( [ 1, 2, 3 ] ), isPositive ); // $ExpectType Int16Array - filter( new Int8Array( [ 1, 2, 3 ] ), isPositive ); // $ExpectType Int8Array - filter( new Uint32Array( [ 1, 2, 3 ] ), isPositive ); // $ExpectType Uint32Array - filter( new Uint16Array( [ 1, 2, 3 ] ), isPositive ); // $ExpectType Uint16Array - filter( new Uint8Array( [ 1, 2, 3 ] ), isPositive ); // $ExpectType Uint8Array - filter( new Uint8ClampedArray( [ 1, 2, 3 ] ), isPositive ); // $ExpectType Uint8ClampedArray - filter( toAccessorArray( [ 1, 2, 3 ] ), isPositive ); // $ExpectType number[] - - filter( [ 1, 2, 3 ], isPositive, {} ); // $ExpectType number[] - filter( new Float64Array( [ 1, 2, 3 ] ), isPositive, {} ); // $ExpectType Float64Array - filter( new Float32Array( [ 1, 2, 3 ] ), isPositive, {} ); // $ExpectType Float32Array - filter( new Int32Array( [ 1, 2, 3 ] ), isPositive, {} ); // $ExpectType Int32Array - filter( new Int16Array( [ 1, 2, 3 ] ), isPositive, {} ); // $ExpectType Int16Array - filter( new Int8Array( [ 1, 2, 3 ] ), isPositive, {} ); // $ExpectType Int8Array - filter( new Uint32Array( [ 1, 2, 3 ] ), isPositive, {} ); // $ExpectType Uint32Array - filter( new Uint16Array( [ 1, 2, 3 ] ), isPositive, {} ); // $ExpectType Uint16Array - filter( new Uint8Array( [ 1, 2, 3 ] ), isPositive, {} ); // $ExpectType Uint8Array - filter( new Uint8ClampedArray( [ 1, 2, 3 ] ), isPositive, {} ); // $ExpectType Uint8ClampedArray - filter( toAccessorArray( [ 1, 2, 3 ] ), isPositive, {} ); // $ExpectType number[] -} - -// The compiler throws an error if the function is provided a first argument which is not a collection... -{ - filter( 2, isPositive ); // $ExpectError - filter( false, isPositive ); // $ExpectError - filter( true, isPositive ); // $ExpectError - filter( {}, isPositive ); // $ExpectError - - filter( 2, isPositive, {} ); // $ExpectError - filter( false, isPositive, {} ); // $ExpectError - filter( true, isPositive, {} ); // $ExpectError - filter( {}, isPositive, {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided a second argument which is not a function... -{ - filter( [ 1, 2, 3 ], 'abc' ); // $ExpectError - filter( [ 1, 2, 3 ], 2 ); // $ExpectError - filter( [ 1, 2, 3 ], false ); // $ExpectError - filter( [ 1, 2, 3 ], true ); // $ExpectError - filter( [ 1, 2, 3 ], null ); // $ExpectError - filter( [ 1, 2, 3 ], void 0 ); // $ExpectError - filter( [ 1, 2, 3 ], {} ); // $ExpectError - filter( [ 1, 2, 3 ], [] ); // $ExpectError - - filter( [ 1, 2, 3 ], 'abc', {} ); // $ExpectError - filter( [ 1, 2, 3 ], 2, {} ); // $ExpectError - filter( [ 1, 2, 3 ], false, {} ); // $ExpectError - filter( [ 1, 2, 3 ], true, {} ); // $ExpectError - filter( [ 1, 2, 3 ], null, {} ); // $ExpectError - filter( [ 1, 2, 3 ], void 0, {} ); // $ExpectError - filter( [ 1, 2, 3 ], {}, {} ); // $ExpectError - filter( [ 1, 2, 3 ], [], {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided an unsupported number of arguments... -{ - filter(); // $ExpectError - filter( [ 1, 2, 3 ] ); // $ExpectError - filter( [ 1, 2, 3 ], isPositive, {}, 3 ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index cdfb9a7..0000000 --- a/examples/index.js +++ /dev/null @@ -1,35 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 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'; - -var discreteUniform = require( '@stdlib/random-array-discrete-uniform' ); -var isPositiveInteger = require( '@stdlib/assert-is-positive-integer' ).isPrimitive; -var naryFunction = require( '@stdlib/utils-nary-function' ); -var filter = require( './../lib' ); - -var x = discreteUniform( 10, -5, 5, { - 'dtype': 'int32' -}); -// returns - -var out = filter( x, naryFunction( isPositiveInteger, 1 ) ); -// returns - -console.log( x ); -console.log( out ); diff --git a/docs/types/index.d.ts b/index.d.ts similarity index 99% rename from docs/types/index.d.ts rename to index.d.ts index 0f92cfd..1fa8dc7 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 4.1 -/// +/// import { Collection, AccessorArrayLike, Complex128Array, Complex64Array } from '@stdlib/types/array'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..48ac85d --- /dev/null +++ b/index.mjs @@ -0,0 +1,4 @@ +// Copyright (c) 2024 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 +/// +import r from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-arraylike2object@v0.1.0-esm/index.mjs";function t(t,e,n){var o;return function(r,t){return"function"==typeof r[t]}(t,"filter")?t.filter(e,n):(o=r(t)).accessorProtocol?function(r,t,e){var n,o,a,s,c;for(n=r.data,o=r.accessors[0],a=[],c=0;c 0;\n* }\n*\n* var x = [ 1, -2, -3, 4 ];\n*\n* var out = internal( x, isPositive );\n* // returns [ 1, 4 ]\n*/\nfunction internal( x, predicate, thisArg ) {\n\tvar out;\n\tvar v;\n\tvar i;\n\n\tout = [];\n\tfor ( i = 0; i < x.length; i++ ) {\n\t\tv = x[ i ];\n\t\tif ( predicate.call( thisArg, v, i, x ) ) {\n\t\t\tout.push( v );\n\t\t}\n\t}\n\treturn out;\n}\n\n/**\n* Returns a shallow copy of an array containing only those elements which pass a test implemented by a predicate function.\n*\n* @private\n* @param {Object} x - input array object\n* @param {Function} predicate - test function\n* @param {*} thisArg - execution context\n* @returns {Array} output array\n*\n* @example\n* import toAccessorArray from '@stdlib/array-base-to-accessor-array';\n* import arraylike2object from '@stdlib/array-base-arraylike2object';\n*\n* function isPositive( v ) {\n* return v > 0;\n* }\n*\n* var x = arraylike2object( toAccessorArray( [ 1, -2, -3, 4 ] ) );\n*\n* var out = accessors( x, isPositive );\n* // returns [ 1, 4 ]\n*/\nfunction accessors( x, predicate, thisArg ) {\n\tvar data;\n\tvar get;\n\tvar out;\n\tvar v;\n\tvar i;\n\n\tdata = x.data;\n\tget = x.accessors[ 0 ];\n\n\tout = [];\n\tfor ( i = 0; i < data.length; i++ ) {\n\t\tv = get( data, i );\n\t\tif ( predicate.call( thisArg, v, i, data ) ) {\n\t\t\tout.push( v );\n\t\t}\n\t}\n\treturn out;\n}\n\n\n// MAIN //\n\n/**\n* Returns a shallow copy of an array containing only those elements which pass a test implemented by a predicate function.\n*\n* @param {Collection} x - input array\n* @param {Function} predicate - test function\n* @param {*} [thisArg] - execution context\n* @returns {Collection} output array\n*\n* @example\n* function isPositive( v ) {\n* return v > 0;\n* }\n*\n* var x = [ 1, -2, -3, 4 ];\n*\n* var out = filter( x, isPositive );\n* // returns [ 1, 4 ]\n*/\nfunction filter( x, predicate, thisArg ) {\n\tvar obj;\n\tif ( hasMethod( x, 'filter' ) ) {\n\t\treturn x.filter( predicate, thisArg );\n\t}\n\tobj = arraylike2object( x );\n\tif ( obj.accessorProtocol ) {\n\t\treturn accessors( obj, predicate, thisArg );\n\t}\n\treturn internal( x, predicate, thisArg );\n}\n\n\n// EXPORTS //\n\nexport default filter;\n"],"names":["filter","x","predicate","thisArg","obj","method","hasMethod","arraylike2object","accessorProtocol","data","get","out","v","i","accessors","length","call","push","internal"],"mappings":";;sGAgJA,SAASA,EAAQC,EAAGC,EAAWC,GAC9B,IAAIC,EACJ,OAvGD,SAAoBA,EAAKC,GACxB,MAAkC,mBAAlBD,EAAKC,EACtB,CAqGMC,CAAWL,EAAG,UACXA,EAAED,OAAQE,EAAWC,IAE7BC,EAAMG,EAAkBN,IACfO,iBA/CV,SAAoBP,EAAGC,EAAWC,GACjC,IAAIM,EACAC,EACAC,EACAC,EACAC,EAMJ,IAJAJ,EAAOR,EAAEQ,KACTC,EAAMT,EAAEa,UAAW,GAEnBH,EAAM,GACAE,EAAI,EAAGA,EAAIJ,EAAKM,OAAQF,IAC7BD,EAAIF,EAAKD,EAAMI,GACVX,EAAUc,KAAMb,EAASS,EAAGC,EAAGJ,IACnCE,EAAIM,KAAML,GAGZ,OAAOD,CACR,CA8BSG,CAAWV,EAAKF,EAAWC,GArFpC,SAAmBF,EAAGC,EAAWC,GAChC,IAAIQ,EACAC,EACAC,EAGJ,IADAF,EAAM,GACAE,EAAI,EAAGA,EAAIZ,EAAEc,OAAQF,IAC1BD,EAAIX,EAAGY,GACFX,EAAUc,KAAMb,EAASS,EAAGC,EAAGZ,IACnCU,EAAIM,KAAML,GAGZ,OAAOD,CACR,CA0EQO,CAAUjB,EAAGC,EAAWC,EAChC"} \ No newline at end of file diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index 56236cd..0000000 --- a/lib/index.js +++ /dev/null @@ -1,46 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 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'; - -/** -* Return a shallow copy of an array containing only those elements which pass a test implemented by a predicate function. -* -* @module @stdlib/array-base-filter -* -* @example -* var filter = require( '@stdlib/array-base-filter' ); -* -* function isPositive( v ) { -* return v > 0; -* } -* -* var x = [ 1, -2, -3, 4 ]; -* -* var out = filter( x, isPositive ); -* // returns [ 1, 4 ] -*/ - -// MODULES // - -var main = require( './main.js' ); - - -// EXPORTS // - -module.exports = main; diff --git a/lib/main.js b/lib/main.js deleted file mode 100644 index 9b0c3db..0000000 --- a/lib/main.js +++ /dev/null @@ -1,160 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 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 arraylike2object = require( '@stdlib/array-base-arraylike2object' ); - - -// FUNCTIONS // - -/** -* Tests whether an object has a specified method. -* -* @private -* @param {Object} obj - input object -* @param {string} method - method name -* @returns {boolean} boolean indicating whether an object has a specified method -* -* @example -* var bool = hasMethod( [], 'filter' ); -* // returns true -* -* @example -* var bool = hasMethod( [], 'beep' ); -* // returns false -*/ -function hasMethod( obj, method ) { - return ( typeof obj[ method ] === 'function' ); -} - -/** -* Returns a shallow copy of an array containing only those elements which pass a test implemented by a predicate function. -* -* @private -* @param {Collection} x - input array -* @param {Function} predicate - test function -* @param {*} thisArg - execution context -* @returns {Array} output array -* -* @example -* function isPositive( v ) { -* return v > 0; -* } -* -* var x = [ 1, -2, -3, 4 ]; -* -* var out = internal( x, isPositive ); -* // returns [ 1, 4 ] -*/ -function internal( x, predicate, thisArg ) { - var out; - var v; - var i; - - out = []; - for ( i = 0; i < x.length; i++ ) { - v = x[ i ]; - if ( predicate.call( thisArg, v, i, x ) ) { - out.push( v ); - } - } - return out; -} - -/** -* Returns a shallow copy of an array containing only those elements which pass a test implemented by a predicate function. -* -* @private -* @param {Object} x - input array object -* @param {Function} predicate - test function -* @param {*} thisArg - execution context -* @returns {Array} output array -* -* @example -* var toAccessorArray = require( '@stdlib/array-base-to-accessor-array' ); -* var arraylike2object = require( '@stdlib/array-base-arraylike2object' ); -* -* function isPositive( v ) { -* return v > 0; -* } -* -* var x = arraylike2object( toAccessorArray( [ 1, -2, -3, 4 ] ) ); -* -* var out = accessors( x, isPositive ); -* // returns [ 1, 4 ] -*/ -function accessors( x, predicate, thisArg ) { - var data; - var get; - var out; - var v; - var i; - - data = x.data; - get = x.accessors[ 0 ]; - - out = []; - for ( i = 0; i < data.length; i++ ) { - v = get( data, i ); - if ( predicate.call( thisArg, v, i, data ) ) { - out.push( v ); - } - } - return out; -} - - -// MAIN // - -/** -* Returns a shallow copy of an array containing only those elements which pass a test implemented by a predicate function. -* -* @param {Collection} x - input array -* @param {Function} predicate - test function -* @param {*} [thisArg] - execution context -* @returns {Collection} output array -* -* @example -* function isPositive( v ) { -* return v > 0; -* } -* -* var x = [ 1, -2, -3, 4 ]; -* -* var out = filter( x, isPositive ); -* // returns [ 1, 4 ] -*/ -function filter( x, predicate, thisArg ) { - var obj; - if ( hasMethod( x, 'filter' ) ) { - return x.filter( predicate, thisArg ); - } - obj = arraylike2object( x ); - if ( obj.accessorProtocol ) { - return accessors( obj, predicate, thisArg ); - } - return internal( x, predicate, thisArg ); -} - - -// EXPORTS // - -module.exports = filter; diff --git a/package.json b/package.json index a4b7761..5faab2f 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.2.0", "description": "Return a shallow copy of an array containing only those elements which pass a test implemented by a predicate function.", "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", - "directories": { - "benchmark": "./benchmark", - "doc": "./docs", - "example": "./examples", - "lib": "./lib", - "test": "./test" - }, - "types": "./docs/types", - "scripts": { - "test": "make test", - "test-cov": "make test-cov", - "examples": "make examples", - "benchmark": "make benchmark" - }, + "type": "module", + "main": "./index.mjs", "homepage": "https://stdlib.io", "repository": { "type": "git", @@ -36,42 +13,6 @@ "bugs": { "url": "https://github.com/stdlib-js/stdlib/issues" }, - "dependencies": { - "@stdlib/array-base-arraylike2object": "^0.2.0", - "@stdlib/types": "^0.3.1", - "@stdlib/error-tools-fmtprodmsg": "^0.2.0" - }, - "devDependencies": { - "@stdlib/array-base-accessor": "^0.1.0", - "@stdlib/array-base-zero-to": "^0.1.0", - "@stdlib/array-float64": "^0.2.0", - "@stdlib/assert-instance-of": "^0.2.0", - "@stdlib/assert-is-array": "^0.2.0", - "@stdlib/assert-is-nonnegative-integer": "^0.2.0", - "@stdlib/assert-is-positive-integer": "^0.2.0", - "@stdlib/math-base-special-pow": "^0.2.0", - "@stdlib/random-array-discrete-uniform": "^0.1.0", - "@stdlib/utils-nary-function": "^0.2.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", - "@stdlib/bench-harness": "^0.2.0" - }, - "engines": { - "node": ">=0.10.0", - "npm": ">2.7.0" - }, - "os": [ - "aix", - "darwin", - "freebsd", - "linux", - "macos", - "openbsd", - "sunos", - "win32", - "windows" - ], "keywords": [ "stdlib", "stdtypes", @@ -91,4 +32,4 @@ "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} \ No newline at end of file +} diff --git a/stats.html b/stats.html new file mode 100644 index 0000000..e4c883f --- /dev/null +++ b/stats.html @@ -0,0 +1,6177 @@ + + + + + + + + Rollup Visualizer + + + +
+ + + + + diff --git a/test/dist/test.js b/test/dist/test.js deleted file mode 100644 index a8a9c60..0000000 --- a/test/dist/test.js +++ /dev/null @@ -1,33 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 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 tape = require( 'tape' ); -var main = require( './../../dist' ); - - -// TESTS // - -tape( 'main export is defined', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( main !== void 0, true, 'main export is defined' ); - t.end(); -}); diff --git a/test/test.js b/test/test.js deleted file mode 100644 index d4e7373..0000000 --- a/test/test.js +++ /dev/null @@ -1,251 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 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 tape = require( 'tape' ); -var AccessorArray = require( '@stdlib/array-base-accessor' ); -var Float64Array = require( '@stdlib/array-float64' ); -var instanceOf = require( '@stdlib/assert-instance-of' ); -var filter = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Tests whether a value is positive. -* -* @private -* @param {number} value - input value -* @returns {boolean} boolean indicating if a value is positive -*/ -function isPositive( value ) { - return ( value > 0 ); -} - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof filter, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'if provided an empty collection, the function returns an empty collection (generic)', function test( t ) { - var expected; - var actual; - var arr; - - arr = []; - expected = []; - actual = filter( arr, foo ); - - t.strictEqual( instanceOf( actual, Array ), true, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - t.end(); - - function foo() { - t.fail( 'should not be invoked' ); - } -}); - -tape( 'if provided an empty collection, the function returns an empty collection (typed array)', function test( t ) { - var expected; - var actual; - var arr; - - arr = new Float64Array( [] ); - expected = new Float64Array( [] ); - actual = filter( arr, foo ); - - t.strictEqual( instanceOf( actual, Float64Array ), true, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - t.end(); - - function foo() { - t.fail( 'should not be invoked' ); - } -}); - -tape( 'if provided an empty collection, the function returns an empty collection (accessor)', function test( t ) { - var expected; - var actual; - var arr; - - arr = new AccessorArray( [] ); - expected = []; - actual = filter( arr, foo ); - - t.strictEqual( instanceOf( actual, Array ), true, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - t.end(); - - function foo() { - t.fail( 'should not be invoked' ); - } -}); - -tape( 'the function filters a provided collection (generic)', function test( t ) { - var expected; - var actual; - var arr; - - arr = [ 1, -2, 3 ]; - expected = [ 1, 3 ]; - actual = filter( arr, isPositive ); - - t.strictEqual( instanceOf( actual, Array ), true, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - t.end(); -}); - -tape( 'the function filters a provided collection (typed array)', function test( t ) { - var expected; - var actual; - var arr; - - arr = new Float64Array( [ -1.0, 2.0, 3.0 ] ); - expected = new Float64Array( [ 2.0, 3.0 ] ); - actual = filter( arr, isPositive ); - - t.strictEqual( instanceOf( actual, Float64Array ), true, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - t.end(); -}); - -tape( 'the function filters a provided collection (accessor)', function test( t ) { - var expected; - var actual; - var arr; - - arr = new AccessorArray( [ 1, -2, -3 ] ); - expected = [ 1 ]; - actual = filter( arr, isPositive ); - - t.strictEqual( instanceOf( actual, Array ), true, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - t.end(); -}); - -tape( 'the function filters a provided collection (array-like object)', function test( t ) { - var expected; - var actual; - var arr; - - arr = { - 'length': 3, - '0': -1, - '1': -2, - '2': 3 - }; - expected = [ 3 ]; - actual = filter( arr, isPositive ); - - t.strictEqual( instanceOf( actual, Array ), true, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - t.end(); -}); - -tape( 'the function an empty collection if all elements fail a test (generic)', function test( t ) { - var expected; - var actual; - var arr; - - arr = [ -1, -2, -3 ]; - expected = []; - actual = filter( arr, isPositive ); - - t.strictEqual( instanceOf( actual, Array ), true, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - t.end(); -}); - -tape( 'the function an empty collection if all elements fail a test (typed array)', function test( t ) { - var expected; - var actual; - var arr; - - arr = new Float64Array( [ -1.0, -2.0, -3.0 ] ); - expected = new Float64Array( [] ); - actual = filter( arr, isPositive ); - - t.strictEqual( instanceOf( actual, Float64Array ), true, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - t.end(); -}); - -tape( 'the function an empty collection if all elements fail a test (accessor)', function test( t ) { - var expected; - var actual; - var arr; - - arr = new AccessorArray( [ -1, -2, -3 ] ); - expected = []; - actual = filter( arr, isPositive ); - - t.strictEqual( instanceOf( actual, Array ), true, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - t.end(); -}); - -tape( 'the function an empty collection if all elements fail a test (array-like object)', function test( t ) { - var expected; - var actual; - var arr; - - arr = { - 'length': 3, - '0': -1, - '1': -2, - '2': -3 - }; - expected = []; - actual = filter( arr, isPositive ); - - t.strictEqual( instanceOf( actual, Array ), true, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - t.end(); -}); - -tape( 'the function supports providing an execution context', function test( t ) { - var expected; - var actual; - var ctx; - var arr; - - ctx = { - 'count': 0 - }; - arr = [ 1, 2, 3 ]; - expected = [ 1, 2, 3 ]; - actual = filter( arr, predicate, ctx ); - - t.strictEqual( instanceOf( actual, Array ), true, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - t.strictEqual( ctx.count, arr.length, 'returns expected value' ); - - t.end(); - - function predicate( value ) { - this.count += 1; // eslint-disable-line no-invalid-this - return ( value > 0 ); - } -}); From 3f4544dc83f163ee7306256548110d7ca9647679 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Thu, 15 Feb 2024 06:53:24 +0000 Subject: [PATCH 11/40] Update README.md for ESM bundle v0.2.0 --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index ecccb89..dbe163b 100644 --- a/README.md +++ b/README.md @@ -52,7 +52,7 @@ limitations under the License. ## Usage ```javascript -import filter from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-filter@esm/index.mjs'; +import filter from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-filter@v0.2.0-esm/index.mjs'; ``` #### filter( x, predicate\[, thisArg] ) @@ -136,7 +136,7 @@ var cnt = context.count; import discreteUniform from 'https://cdn.jsdelivr.net/gh/stdlib-js/random-array-discrete-uniform@esm/index.mjs'; var isPositiveInteger = require( 'https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-positive-integer' ).isPrimitive; import naryFunction from 'https://cdn.jsdelivr.net/gh/stdlib-js/utils-nary-function@esm/index.mjs'; -import filter from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-filter@esm/index.mjs'; +import filter from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-filter@v0.2.0-esm/index.mjs'; var x = discreteUniform( 10, -5, 5, { 'dtype': 'int32' From 24843384381749d068e99e2077587fe32f76b81a Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Thu, 15 Feb 2024 06:53:24 +0000 Subject: [PATCH 12/40] Auto-generated commit --- README.md | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index dbe163b..8c7c424 100644 --- a/README.md +++ b/README.md @@ -51,6 +51,11 @@ limitations under the License. ## Usage +```javascript +import filter from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-filter@esm/index.mjs'; +``` +The previous example will load the latest bundled code from the esm branch. Alternatively, you may load a specific version by loading the file from one of the [tagged bundles](https://github.com/stdlib-js/array-base-filter/tags). For example, + ```javascript import filter from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-filter@v0.2.0-esm/index.mjs'; ``` @@ -136,7 +141,7 @@ var cnt = context.count; import discreteUniform from 'https://cdn.jsdelivr.net/gh/stdlib-js/random-array-discrete-uniform@esm/index.mjs'; var isPositiveInteger = require( 'https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-positive-integer' ).isPrimitive; import naryFunction from 'https://cdn.jsdelivr.net/gh/stdlib-js/utils-nary-function@esm/index.mjs'; -import filter from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-filter@v0.2.0-esm/index.mjs'; +import filter from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-filter@esm/index.mjs'; var x = discreteUniform( 10, -5, 5, { 'dtype': 'int32' From cc0202a74334dc2ed0b3b71bee99ad5c4746dbe0 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sun, 25 Feb 2024 21:00:31 +0000 Subject: [PATCH 13/40] Transform error messages --- package.json | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/package.json b/package.json index b79254f..8d5fd05 100644 --- a/package.json +++ b/package.json @@ -38,7 +38,8 @@ }, "dependencies": { "@stdlib/array-base-arraylike2object": "^0.2.1", - "@stdlib/types": "^0.3.2" + "@stdlib/types": "^0.3.2", + "@stdlib/error-tools-fmtprodmsg": "^0.2.1" }, "devDependencies": { "@stdlib/array-base-accessor": "^0.2.0", @@ -90,4 +91,4 @@ "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} +} \ No newline at end of file From 33dbb81bb70b9304ae27810a2e1967417b3cfff8 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sun, 25 Feb 2024 22:18:15 +0000 Subject: [PATCH 14/40] Remove files --- index.d.ts | 343 --- index.mjs | 4 - index.mjs.map | 1 - stats.html | 6177 ------------------------------------------------- 4 files changed, 6525 deletions(-) delete mode 100644 index.d.ts delete mode 100644 index.mjs delete mode 100644 index.mjs.map delete mode 100644 stats.html diff --git a/index.d.ts b/index.d.ts deleted file mode 100644 index 1fa8dc7..0000000 --- a/index.d.ts +++ /dev/null @@ -1,343 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2024 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 - -/// - -import { Collection, AccessorArrayLike, Complex128Array, Complex64Array } from '@stdlib/types/array'; - -/** -* Returns a boolean indicating whether an element passes a test. -* -* @returns boolean indicating whether an element passes a test -*/ -type Nullary = ( this: U ) => boolean; - -/** -* Returns a boolean indicating whether an element passes a test. -* -* @param value - current array element -* @returns boolean indicating whether an element passes a test -*/ -type Unary = ( this: U, value: T ) => boolean; - -/** -* Returns a boolean indicating whether an element passes a test. -* -* @param value - current array element -* @param index - current array element index -* @returns boolean indicating whether an element passes a test -*/ -type Binary = ( this: U, value: T, index: number ) => boolean; - -/** -* Returns a boolean indicating whether an element passes a test. -* -* @param value - current array element -* @param index - current array element index -* @param arr - input array -* @returns boolean indicating whether an element passes a test -*/ -type Ternary = ( this: U, value: T, index: number, arr: V ) => boolean; - -/** -* Returns a boolean indicating whether an element passes a test. -* -* @param value - current array element -* @param index - current array element index -* @param arr - input array -* @returns boolean indicating whether an element passes a test -*/ -type Predicate = Nullary | Unary | Binary | Ternary; - -/** -* Returns a shallow copy of an array containing only those elements which pass a test implemented by a predicate function. -* -* @param x - input array -* @param predicate - predicate function -* @param thisArg - predicate function execution context -* @returns output array -* -* @example -* var isPositiveNumber = require( '@stdlib/assert-is-positive-number' ).isPrimitive; -* var Float64Array = require( '@stdlib/array-float64' ); -* -* var x = new Float64Array( [ 1.0, -2.0, -3.0, 4.0 ] ); -* -* var out = filter( x, isPositiveNumber ); -* // returns [ 1.0, 4.0 ] -*/ -declare function filter( x: Float64Array, predicate: Predicate, thisArg?: ThisParameterType> ): Float64Array; - -/** -* Returns a shallow copy of an array containing only those elements which pass a test implemented by a predicate function. -* -* @param x - input array -* @param predicate - predicate function -* @param thisArg - predicate function execution context -* @returns output array -* -* @example -* var isPositiveNumber = require( '@stdlib/assert-is-positive-number' ).isPrimitive; -* var Float32Array = require( '@stdlib/array-float32' ); -* -* var x = new Float32Array( [ 1.0, -2.0, -3.0, 4.0 ] ); -* -* var out = filter( x, isPositiveNumber ); -* // returns [ 1.0, 4.0 ] -*/ -declare function filter( x: Float32Array, predicate: Predicate, thisArg?: ThisParameterType> ): Float32Array; - -/** -* Returns a shallow copy of an array containing only those elements which pass a test implemented by a predicate function. -* -* @param x - input array -* @param predicate - predicate function -* @param thisArg - predicate function execution context -* @returns output array -* -* @example -* var isPositiveNumber = require( '@stdlib/assert-is-positive-number' ).isPrimitive; -* var Int32Array = require( '@stdlib/array-int32' ); -* -* var x = new Int32Array( [ 1, -2, -3, 4 ] ); -* -* var out = filter( x, isPositiveNumber ); -* // returns [ 1, 4 ] -*/ -declare function filter( x: Int32Array, predicate: Predicate, thisArg?: ThisParameterType> ): Int32Array; - -/** -* Returns a shallow copy of an array containing only those elements which pass a test implemented by a predicate function. -* -* @param x - input array -* @param predicate - predicate function -* @param thisArg - predicate function execution context -* @returns output array -* -* @example -* var isPositiveNumber = require( '@stdlib/assert-is-positive-number' ).isPrimitive; -* var Int16Array = require( '@stdlib/array-int16' ); -* -* var x = new Int16Array( [ 1, -2, -3, 4 ] ); -* -* var out = filter( x, isPositiveNumber ); -* // returns [ 1, 4 ] -*/ -declare function filter( x: Int16Array, predicate: Predicate, thisArg?: ThisParameterType> ): Int16Array; - -/** -* Returns a shallow copy of an array containing only those elements which pass a test implemented by a predicate function. -* -* @param x - input array -* @param predicate - predicate function -* @param thisArg - predicate function execution context -* @returns output array -* -* @example -* var isPositiveNumber = require( '@stdlib/assert-is-positive-number' ).isPrimitive; -* var Int8Array = require( '@stdlib/array-int8' ); -* -* var x = new Int8Array( [ 1, -2, -3, 4 ] ); -* -* var out = filter( x, isPositiveNumber ); -* // returns [ 1, 4 ] -*/ -declare function filter( x: Int8Array, predicate: Predicate, thisArg?: ThisParameterType> ): Int8Array; - -/** -* Returns a shallow copy of an array containing only those elements which pass a test implemented by a predicate function. -* -* @param x - input array -* @param predicate - predicate function -* @param thisArg - predicate function execution context -* @returns output array -* -* @example -* var isPositiveNumber = require( '@stdlib/assert-is-positive-number' ).isPrimitive; -* var Uint32Array = require( '@stdlib/array-uint32' ); -* -* var x = new Uint32Array( [ 1, 2, 3, 4 ] ); -* -* var out = filter( x, isPositiveNumber ); -* // returns [ 1, 2, 3, 4 ] -*/ -declare function filter( x: Uint32Array, predicate: Predicate, thisArg?: ThisParameterType> ): Uint32Array; - -/** -* Returns a shallow copy of an array containing only those elements which pass a test implemented by a predicate function. -* -* @param x - input array -* @param predicate - predicate function -* @param thisArg - predicate function execution context -* @returns output array -* -* @example -* var isPositiveNumber = require( '@stdlib/assert-is-positive-number' ).isPrimitive; -* var Uint16Array = require( '@stdlib/array-uint16' ); -* -* var x = new Uint16Array( [ 1, 2, 3, 4 ] ); -* -* var out = filter( x, isPositiveNumber ); -* // returns [ 1, 2, 3, 4 ] -*/ -declare function filter( x: Uint16Array, predicate: Predicate, thisArg?: ThisParameterType> ): Uint16Array; - -/** -* Returns a shallow copy of an array containing only those elements which pass a test implemented by a predicate function. -* -* @param x - input array -* @param predicate - predicate function -* @param thisArg - predicate function execution context -* @returns output array -* -* @example -* var isPositiveNumber = require( '@stdlib/assert-is-positive-number' ).isPrimitive; -* var Uint8Array = require( '@stdlib/array-uint8' ); -* -* var x = new Uint8Array( [ 1, 2, 3, 4 ] ); -* -* var out = filter( x, isPositiveNumber ); -* // returns [ 1, 2, 3, 4 ] -*/ -declare function filter( x: Uint8Array, predicate: Predicate, thisArg?: ThisParameterType> ): Uint8Array; - -/** -* Returns a shallow copy of an array containing only those elements which pass a test implemented by a predicate function. -* -* @param x - input array -* @param predicate - predicate function -* @param thisArg - predicate function execution context -* @returns output array -* -* @example -* var isPositiveNumber = require( '@stdlib/assert-is-positive-number' ).isPrimitive; -* var Uint8ClampedArray = require( '@stdlib/array-uint8c' ); -* -* var x = new Uint8ClampedArray( [ 1, 2, 3, 4 ] ); -* -* var out = filter( x, isPositiveNumber ); -* // returns [ 1, 2, 3, 4 ] -*/ -declare function filter( x: Uint8ClampedArray, predicate: Predicate, thisArg?: ThisParameterType> ): Uint8ClampedArray; - -/** -* Returns a shallow copy of an array containing only those elements which pass a test implemented by a predicate function. -* -* @param x - input array -* @param predicate - predicate function -* @param thisArg - predicate function execution context -* @returns output array -* -* @example -* var isPositiveNumber = require( '@stdlib/assert-is-positive-number' ).isPrimitive; -* var real = require( '@stdlib/complex-real' ); -* var imag = require( '@stdlib/complex-imag' ); -* var Complex128Array = require( '@stdlib/array-complex128' ); -* -* function predicate( v ) { -* return ( isPositiveNumber( real( v ) ) && isPositiveNumber( imag( v ) ) ); -* } -* -* var x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0 ] ); -* -* var out = filter( x, predicate ); -* // returns -*/ -declare function filter( x: Complex128Array, predicate: Predicate, thisArg?: ThisParameterType> ): Complex128Array; - -/** -* Returns a shallow copy of an array containing only those elements which pass a test implemented by a predicate function. -* -* @param x - input array -* @param predicate - predicate function -* @param thisArg - predicate function execution context -* @returns output array -* -* @example -* var isPositiveNumber = require( '@stdlib/assert-is-positive-number' ).isPrimitive; -* var realf = require( '@stdlib/complex-realf' ); -* var imagf = require( '@stdlib/complex-imagf' ); -* var Complex64Array = require( '@stdlib/array-complex64' ); -* -* function predicate( v ) { -* return ( isPositiveNumber( realf( v ) ) && isPositiveNumber( imagf( v ) ) ); -* } -* -* var x = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); -* -* var out = filter( x, predicate ); -* // returns -*/ -declare function filter( x: Complex64Array, predicate: Predicate, thisArg?: ThisParameterType> ): Complex64Array; - -/** -* Returns a shallow copy of an array containing only those elements which pass a test implemented by a predicate function. -* -* @param x - input array -* @param predicate - predicate function -* @param thisArg - predicate function execution context -* @returns output array -* -* @example -* var x = [ 1, -2, -3, 4 ]; -* -* var out = filter( x, isPositiveNumber ); -* // returns [ 1, 4 ] -*/ -declare function filter( x: Array, predicate: Predicate>, thisArg?: ThisParameterType>> ): Array; - -/** -* Returns a shallow copy of an array containing only those elements which pass a test implemented by a predicate function. -* -* @param x - input array -* @param predicate - predicate function -* @param thisArg - predicate function execution context -* @returns output array -* -* @example -* var toAccessorArray = require( '@stdlib/array-base-to-accessor-array' ); -* -* var x = toAccessorArray( [ 1, -2, -3, 4 ] ); -* -* var out = filter( x, isPositiveNumber ); -* // returns [ 1, 4 ] -*/ -declare function filter( x: AccessorArrayLike, predicate: Predicate>, thisArg?: ThisParameterType>> ): Array; - -/** -* Returns a shallow copy of an array containing only those elements which pass a test implemented by a predicate function. -* -* @param x - input array -* @param predicate - predicate function -* @param thisArg - predicate function execution context -* @returns output array -* -* @example -* var x = [ 1, -2, -3, 4 ]; -* -* var out = filter( x, isPositiveNumber ); -* // returns [ 1, 4 ] -*/ -declare function filter( x: Collection, predicate: Predicate>, thisArg?: ThisParameterType>> ): Array; - - -// EXPORTS // - -export = filter; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index 48ac85d..0000000 --- a/index.mjs +++ /dev/null @@ -1,4 +0,0 @@ -// Copyright (c) 2024 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 -/// -import r from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-arraylike2object@v0.1.0-esm/index.mjs";function t(t,e,n){var o;return function(r,t){return"function"==typeof r[t]}(t,"filter")?t.filter(e,n):(o=r(t)).accessorProtocol?function(r,t,e){var n,o,a,s,c;for(n=r.data,o=r.accessors[0],a=[],c=0;c 0;\n* }\n*\n* var x = [ 1, -2, -3, 4 ];\n*\n* var out = internal( x, isPositive );\n* // returns [ 1, 4 ]\n*/\nfunction internal( x, predicate, thisArg ) {\n\tvar out;\n\tvar v;\n\tvar i;\n\n\tout = [];\n\tfor ( i = 0; i < x.length; i++ ) {\n\t\tv = x[ i ];\n\t\tif ( predicate.call( thisArg, v, i, x ) ) {\n\t\t\tout.push( v );\n\t\t}\n\t}\n\treturn out;\n}\n\n/**\n* Returns a shallow copy of an array containing only those elements which pass a test implemented by a predicate function.\n*\n* @private\n* @param {Object} x - input array object\n* @param {Function} predicate - test function\n* @param {*} thisArg - execution context\n* @returns {Array} output array\n*\n* @example\n* import toAccessorArray from '@stdlib/array-base-to-accessor-array';\n* import arraylike2object from '@stdlib/array-base-arraylike2object';\n*\n* function isPositive( v ) {\n* return v > 0;\n* }\n*\n* var x = arraylike2object( toAccessorArray( [ 1, -2, -3, 4 ] ) );\n*\n* var out = accessors( x, isPositive );\n* // returns [ 1, 4 ]\n*/\nfunction accessors( x, predicate, thisArg ) {\n\tvar data;\n\tvar get;\n\tvar out;\n\tvar v;\n\tvar i;\n\n\tdata = x.data;\n\tget = x.accessors[ 0 ];\n\n\tout = [];\n\tfor ( i = 0; i < data.length; i++ ) {\n\t\tv = get( data, i );\n\t\tif ( predicate.call( thisArg, v, i, data ) ) {\n\t\t\tout.push( v );\n\t\t}\n\t}\n\treturn out;\n}\n\n\n// MAIN //\n\n/**\n* Returns a shallow copy of an array containing only those elements which pass a test implemented by a predicate function.\n*\n* @param {Collection} x - input array\n* @param {Function} predicate - test function\n* @param {*} [thisArg] - execution context\n* @returns {Collection} output array\n*\n* @example\n* function isPositive( v ) {\n* return v > 0;\n* }\n*\n* var x = [ 1, -2, -3, 4 ];\n*\n* var out = filter( x, isPositive );\n* // returns [ 1, 4 ]\n*/\nfunction filter( x, predicate, thisArg ) {\n\tvar obj;\n\tif ( hasMethod( x, 'filter' ) ) {\n\t\treturn x.filter( predicate, thisArg );\n\t}\n\tobj = arraylike2object( x );\n\tif ( obj.accessorProtocol ) {\n\t\treturn accessors( obj, predicate, thisArg );\n\t}\n\treturn internal( x, predicate, thisArg );\n}\n\n\n// EXPORTS //\n\nexport default filter;\n"],"names":["filter","x","predicate","thisArg","obj","method","hasMethod","arraylike2object","accessorProtocol","data","get","out","v","i","accessors","length","call","push","internal"],"mappings":";;sGAgJA,SAASA,EAAQC,EAAGC,EAAWC,GAC9B,IAAIC,EACJ,OAvGD,SAAoBA,EAAKC,GACxB,MAAkC,mBAAlBD,EAAKC,EACtB,CAqGMC,CAAWL,EAAG,UACXA,EAAED,OAAQE,EAAWC,IAE7BC,EAAMG,EAAkBN,IACfO,iBA/CV,SAAoBP,EAAGC,EAAWC,GACjC,IAAIM,EACAC,EACAC,EACAC,EACAC,EAMJ,IAJAJ,EAAOR,EAAEQ,KACTC,EAAMT,EAAEa,UAAW,GAEnBH,EAAM,GACAE,EAAI,EAAGA,EAAIJ,EAAKM,OAAQF,IAC7BD,EAAIF,EAAKD,EAAMI,GACVX,EAAUc,KAAMb,EAASS,EAAGC,EAAGJ,IACnCE,EAAIM,KAAML,GAGZ,OAAOD,CACR,CA8BSG,CAAWV,EAAKF,EAAWC,GArFpC,SAAmBF,EAAGC,EAAWC,GAChC,IAAIQ,EACAC,EACAC,EAGJ,IADAF,EAAM,GACAE,EAAI,EAAGA,EAAIZ,EAAEc,OAAQF,IAC1BD,EAAIX,EAAGY,GACFX,EAAUc,KAAMb,EAASS,EAAGC,EAAGZ,IACnCU,EAAIM,KAAML,GAGZ,OAAOD,CACR,CA0EQO,CAAUjB,EAAGC,EAAWC,EAChC"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index e4c883f..0000000 --- a/stats.html +++ /dev/null @@ -1,6177 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From 7d1e840eff720bf38b0c5d0ef2c4c8365b773054 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sun, 25 Feb 2024 22:18:38 +0000 Subject: [PATCH 15/40] Auto-generated commit --- .editorconfig | 181 - .eslintrc.js | 1 - .gitattributes | 49 - .github/PULL_REQUEST_TEMPLATE.md | 7 - .github/workflows/benchmark.yml | 64 - .github/workflows/cancel.yml | 57 - .github/workflows/close_pull_requests.yml | 54 - .github/workflows/examples.yml | 64 - .github/workflows/npm_downloads.yml | 112 - .github/workflows/productionize.yml | 797 ---- .github/workflows/publish.yml | 249 -- .github/workflows/test.yml | 100 - .github/workflows/test_bundles.yml | 189 - .github/workflows/test_coverage.yml | 132 - .github/workflows/test_install.yml | 86 - .gitignore | 188 - .npmignore | 228 - .npmrc | 28 - CHANGELOG.md | 5 - CITATION.cff | 30 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 --- README.md | 41 +- SECURITY.md | 5 - benchmark/benchmark.length.js | 97 - branches.md | 56 - dist/index.d.ts | 3 - dist/index.js | 5 - dist/index.js.map | 7 - docs/repl.txt | 46 - docs/types/test.ts | 101 - examples/index.js | 35 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/index.js | 46 - lib/main.js | 160 - package.json | 65 +- stats.html | 4842 +++++++++++++++++++++ test/dist/test.js | 33 - test/test.js | 251 -- 42 files changed, 4867 insertions(+), 4094 deletions(-) delete mode 100644 .editorconfig delete mode 100644 .eslintrc.js delete mode 100644 .gitattributes delete mode 100644 .github/PULL_REQUEST_TEMPLATE.md delete mode 100644 .github/workflows/benchmark.yml delete mode 100644 .github/workflows/cancel.yml delete mode 100644 .github/workflows/close_pull_requests.yml delete mode 100644 .github/workflows/examples.yml delete mode 100644 .github/workflows/npm_downloads.yml delete mode 100644 .github/workflows/productionize.yml delete mode 100644 .github/workflows/publish.yml delete mode 100644 .github/workflows/test.yml delete mode 100644 .github/workflows/test_bundles.yml delete mode 100644 .github/workflows/test_coverage.yml delete mode 100644 .github/workflows/test_install.yml delete mode 100644 .gitignore delete mode 100644 .npmignore delete mode 100644 .npmrc delete mode 100644 CHANGELOG.md delete mode 100644 CITATION.cff delete mode 100644 CODE_OF_CONDUCT.md delete mode 100644 CONTRIBUTING.md delete mode 100644 Makefile delete mode 100644 SECURITY.md delete mode 100644 benchmark/benchmark.length.js delete mode 100644 branches.md delete mode 100644 dist/index.d.ts delete mode 100644 dist/index.js delete mode 100644 dist/index.js.map delete mode 100644 docs/repl.txt delete mode 100644 docs/types/test.ts delete mode 100644 examples/index.js rename docs/types/index.d.ts => index.d.ts (99%) create mode 100644 index.mjs create mode 100644 index.mjs.map delete mode 100644 lib/index.js delete mode 100644 lib/main.js create mode 100644 stats.html delete mode 100644 test/dist/test.js delete mode 100644 test/test.js diff --git a/.editorconfig b/.editorconfig deleted file mode 100644 index 60d743f..0000000 --- a/.editorconfig +++ /dev/null @@ -1,181 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 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. -#/ - -# EditorConfig configuration file (see ). - -# Indicate that this file is a root-level configuration file: -root = true - -# Set properties for all files: -[*] -end_of_line = lf -charset = utf-8 -trim_trailing_whitespace = true -insert_final_newline = true - -# Set properties for JavaScript files: -[*.{js,js.txt}] -indent_style = tab - -# Set properties for JavaScript ES module files: -[*.{mjs,mjs.txt}] -indent_style = tab - -# Set properties for JavaScript CommonJS files: -[*.{cjs,cjs.txt}] -indent_style = tab - -# Set properties for JSON files: -[*.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `cli_opts.json` files: -[cli_opts.json] -indent_style = tab - -# Set properties for TypeScript files: -[*.ts] -indent_style = tab - -# Set properties for Python files: -[*.{py,py.txt}] -indent_style = space -indent_size = 4 - -# Set properties for Julia files: -[*.{jl,jl.txt}] -indent_style = tab - -# Set properties for R files: -[*.{R,R.txt}] -indent_style = tab - -# Set properties for C files: -[*.{c,c.txt}] -indent_style = tab - -# Set properties for C header files: -[*.{h,h.txt}] -indent_style = tab - -# Set properties for C++ files: -[*.{cpp,cpp.txt}] -indent_style = tab - -# Set properties for C++ header files: -[*.{hpp,hpp.txt}] -indent_style = tab - -# Set properties for Fortran files: -[*.{f,f.txt}] -indent_style = space -indent_size = 2 -insert_final_newline = false - -# Set properties for shell files: -[*.{sh,sh.txt}] -indent_style = tab - -# Set properties for AWK files: -[*.{awk,awk.txt}] -indent_style = tab - -# Set properties for HTML files: -[*.{html,html.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for XML files: -[*.{xml,xml.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for CSS files: -[*.{css,css.txt}] -indent_style = tab - -# Set properties for Makefiles: -[Makefile] -indent_style = tab - -[*.{mk,mk.txt}] -indent_style = tab - -# Set properties for Markdown files: -[*.{md,md.txt}] -indent_style = space -indent_size = 4 -trim_trailing_whitespace = false - -# Set properties for `usage.txt` files: -[usage.txt] -indent_style = space -indent_size = 2 - -# Set properties for `repl.txt` files: -[repl.txt] -indent_style = space -indent_size = 4 - -# Set properties for `package.json` files: -[package.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `datapackage.json` files: -[datapackage.json] -indent_style = space -indent_size = 2 - -# Set properties for `manifest.json` files: -[manifest.json] -indent_style = space -indent_size = 2 - -# Set properties for `tsconfig.json` files: -[tsconfig.json] -indent_style = space -indent_size = 2 - -# Set properties for LaTeX files: -[*.{tex,tex.txt}] -indent_style = tab - -# Set properties for LaTeX Bibliography files: -[*.{bib,bib.txt}] -indent_style = tab - -# Set properties for YAML files: -[*.{yml,yml.txt}] -indent_style = space -indent_size = 2 - -# Set properties for GYP files: -[binding.gyp] -indent_style = space -indent_size = 2 - -[*.gypi] -indent_style = space -indent_size = 2 - -# Set properties for citation files: -[*.{cff,cff.txt}] -indent_style = space -indent_size = 2 diff --git a/.eslintrc.js b/.eslintrc.js deleted file mode 100644 index 5f30286..0000000 --- a/.eslintrc.js +++ /dev/null @@ -1 +0,0 @@ -/* For the `eslint` rules of this project, consult the main repository at https://github.com/stdlib-js/stdlib */ diff --git a/.gitattributes b/.gitattributes deleted file mode 100644 index 10a16e6..0000000 --- a/.gitattributes +++ /dev/null @@ -1,49 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 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. -#/ - -# Configuration file which assigns attributes to pathnames. -# -# [1]: https://git-scm.com/docs/gitattributes - -# Automatically normalize the line endings of any committed text files: -* text=auto - -# Override line endings for certain files on checkout: -*.crlf.csv text eol=crlf - -# Denote that certain files are binary and should not be modified: -*.png binary -*.jpg binary -*.jpeg binary -*.gif binary -*.ico binary -*.gz binary -*.zip binary -*.7z binary -*.mp3 binary -*.mp4 binary -*.mov binary - -# Override what is considered "vendored" by GitHub's linguist: -/deps/** linguist-vendored=false -/lib/node_modules/** linguist-vendored=false linguist-generated=false -test/fixtures/** linguist-vendored=false -tools/** linguist-vendored=false - -# Override what is considered "documentation" by GitHub's linguist: -examples/** linguist-documentation=false diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index 6559bc7..0000000 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ /dev/null @@ -1,7 +0,0 @@ - - -We are excited about your pull request, but unfortunately we are not accepting pull requests against this repository, as all development happens on the [main project repository](https://github.com/stdlib-js/stdlib). We kindly request that you submit this pull request against the [respective directory](https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/filter) of the main repository where we’ll review and provide feedback. - -If this is your first stdlib contribution, be sure to read the [contributing guide](https://github.com/stdlib-js/stdlib/blob/develop/CONTRIBUTING.md) which provides guidelines and instructions for submitting contributions. You may also consult the [development guide](https://github.com/stdlib-js/stdlib/blob/develop/docs/development.md) for help on developing stdlib. - -We look forward to receiving your contribution! :smiley: \ No newline at end of file diff --git a/.github/workflows/benchmark.yml b/.github/workflows/benchmark.yml deleted file mode 100644 index e4f10fe..0000000 --- a/.github/workflows/benchmark.yml +++ /dev/null @@ -1,64 +0,0 @@ -#/ -# @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. -#/ - -# Workflow name: -name: benchmark - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to run benchmarks: - benchmark: - - # Define a display name: - name: 'Run benchmarks' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Run benchmarks: - - name: 'Run benchmarks' - run: | - npm run benchmark diff --git a/.github/workflows/cancel.yml b/.github/workflows/cancel.yml deleted file mode 100644 index b5291db..0000000 --- a/.github/workflows/cancel.yml +++ /dev/null @@ -1,57 +0,0 @@ -#/ -# @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. -#/ - -# Workflow name: -name: cancel - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to cancel existing workflow runs: - cancel: - - # Define a display name: - name: 'Cancel workflow runs' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Time limit: - timeout-minutes: 3 - - # Define the sequence of job steps... - steps: - - # Cancel existing workflow runs: - - name: 'Cancel existing workflow runs' - # Pin action to full length commit SHA - uses: styfle/cancel-workflow-action@85880fa0301c86cca9da44039ee3bb12d3bedbfa # v0.12.1 - with: - workflow_id: >- - benchmark.yml, - examples.yml, - test.yml, - test_coverage.yml, - test_install.yml, - publish.yml - access_token: ${{ github.token }} diff --git a/.github/workflows/close_pull_requests.yml b/.github/workflows/close_pull_requests.yml deleted file mode 100644 index 2060eba..0000000 --- a/.github/workflows/close_pull_requests.yml +++ /dev/null @@ -1,54 +0,0 @@ -#/ -# @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. -#/ - -# Workflow name: -name: close_pull_requests - -# Workflow triggers: -on: - pull_request_target: - types: [opened] - -# Workflow jobs: -jobs: - - # Define job to close all pull requests: - run: - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - - # Close pull request - - name: 'Close pull request' - # Pin action to full length commit SHA corresponding to v3.1.2 - uses: superbrothers/close-pull-request@9c18513d320d7b2c7185fb93396d0c664d5d8448 - with: - comment: | - Thank you for submitting a pull request. :raised_hands: - - We greatly appreciate your willingness to submit a contribution. However, we are not accepting pull requests against this repository, as all development happens on the [main project repository](https://github.com/stdlib-js/stdlib). - - We kindly request that you submit this pull request against the [respective directory](https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/filter) of the main repository where we’ll review and provide feedback. If this is your first stdlib contribution, be sure to read the [contributing guide](https://github.com/stdlib-js/stdlib/blob/develop/CONTRIBUTING.md) which provides guidelines and instructions for submitting contributions. - - Thank you again, and we look forward to receiving your contribution! :smiley: - - Best, - The stdlib team \ No newline at end of file diff --git a/.github/workflows/examples.yml b/.github/workflows/examples.yml deleted file mode 100644 index 2984901..0000000 --- a/.github/workflows/examples.yml +++ /dev/null @@ -1,64 +0,0 @@ -#/ -# @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. -#/ - -# Workflow name: -name: examples - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to run the package examples... - examples: - - # Define display name: - name: 'Run examples' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - - # Checkout repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Run examples: - - name: 'Run examples' - run: | - npm run examples diff --git a/.github/workflows/npm_downloads.yml b/.github/workflows/npm_downloads.yml deleted file mode 100644 index c2326d6..0000000 --- a/.github/workflows/npm_downloads.yml +++ /dev/null @@ -1,112 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2022 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. -#/ - -# Workflow name: -name: npm_downloads - -# Workflow triggers: -on: - # Run this workflow weekly: - schedule: - # cron: ' ' - - cron: '48 12 * * 3' - - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job for retrieving npm download counts... - npm_downloads: - - # Define display name: - name: 'Retrieve npm download counts' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - timeout-minutes: 10 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Resolve package name: - - name: 'Resolve package name' - id: package_name - run: | - name=`node -e 'console.log(require("./package.json").name)' | tr -d '\n'` - echo "package_name=$name" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Fetch download data: - - name: 'Fetch data' - id: download_data - run: | - url="https://api.npmjs.org/downloads/range/$(date --date='1 year ago' '+%Y-%m-%d'):$(date '+%Y-%m-%d')/${{ steps.package_name.outputs.package_name }}" - echo "$url" - data=$(curl "$url") - mkdir ./tmp - echo "$data" > ./tmp/npm_downloads.json - echo "data=$data" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Print summary of download data: - - name: 'Print summary' - run: | - echo "| Date | Downloads |" >> $GITHUB_STEP_SUMMARY - echo "|------|------------|" >> $GITHUB_STEP_SUMMARY - cat ./tmp/npm_downloads.json | jq -r ".downloads | .[-14:] | to_entries | map(\"| \(.value.day) | \(.value.downloads) |\") |.[]" >> $GITHUB_STEP_SUMMARY - - # Upload the download data: - - name: 'Upload data' - # Pin action to full length commit SHA - uses: actions/upload-artifact@5d5d22a31266ced268874388b861e4b58bb5c2f3 # v4.3.1 - with: - # Define a name for the uploaded artifact (ensuring a unique name for each job): - name: npm_downloads - - # Specify the path to the file to upload: - path: ./tmp/npm_downloads.json - - # Specify the number of days to retain the artifact (default is 90 days): - retention-days: 90 - timeout-minutes: 10 - if: success() - - # Send data to events server: - - name: 'Post data' - # Pin action to full length commit SHA - uses: distributhor/workflow-webhook@48a40b380ce4593b6a6676528cd005986ae56629 # v3.0.3 - env: - webhook_url: ${{ secrets.STDLIB_NPM_DOWNLOADS_URL }} - webhook_secret: ${{ secrets.STDLIB_WEBHOOK_SECRET }} - data: '{ "downloads": ${{ steps.download_data.outputs.data }} }' - timeout-minutes: 5 - if: success() diff --git a/.github/workflows/productionize.yml b/.github/workflows/productionize.yml deleted file mode 100644 index 9106b5d..0000000 --- a/.github/workflows/productionize.yml +++ /dev/null @@ -1,797 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2022 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. -#/ - -# Workflow name: -name: productionize - -# Workflow triggers: -on: - # Run workflow when a new commit is pushed to the main branch: - push: - branches: - - main - - # Allow the workflow to be manually run: - workflow_dispatch: - inputs: - require-passing-tests: - description: 'Require passing tests for creating bundles' - type: boolean - default: true - - # Run workflow upon completion of `publish` workflow run: - workflow_run: - workflows: ["publish"] - types: [completed] - - -# Concurrency group to prevent multiple concurrent executions: -concurrency: - group: productionize - cancel-in-progress: true - -# Workflow jobs: -jobs: - - # Define a job to create a production build... - productionize: - - # Define display name: - name: 'Productionize' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Define the sequence of job steps... - steps: - # Checkout main branch of repository: - - name: 'Checkout main branch' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - with: - ref: main - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Create production branch: - - name: 'Create production branch' - run: | - git checkout -b production - - # Transform error messages: - - name: 'Transform error messages' - id: transform-error-messages - uses: stdlib-js/transform-errors-action@main - - # 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: | - PKG_VERSION=$(npm view @stdlib/error-tools-fmtprodmsg version) - if grep -q '"@stdlib/string-format"' package.json; then - sed -i "s/\"@stdlib\/string-format\": \"^.*\"/\"@stdlib\/error-tools-fmtprodmsg\": \"^$PKG_VERSION\"/g" package.json - else - node -e "var pkg = require( './package.json' ); pkg.dependencies[ '@stdlib/error-tools-fmtprodmsg' ] = '^$PKG_VERSION'; require( 'fs' ).writeFileSync( 'package.json', JSON.stringify( pkg, null, 2 ) );" - fi - - # Configure git: - - name: 'Configure git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Transform error messages" - - # Push changes: - - name: 'Push changes' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" production --force - - # Define a job for running tests of the productionized code... - test: - - # Define a display name: - name: 'Run Tests' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Indicate that this job depends on the prior job finishing: - needs: productionize - - # Run this job regardless of the outcome of the prior job: - if: always() - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout repository' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - with: - # Use the `production` branch: - ref: production - - # Install Node.js: - - name: 'Install Node.js' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Build native add-on if present: - - name: 'Build native add-on (if present)' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - run: | - if [ -f "binding.gyp" ]; then - npm install node-gyp --no-save && ./node_modules/.bin/node-gyp rebuild - fi - - # Run tests: - - name: 'Run tests' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: tests - run: | - npm test || npm test || npm test - - # Define job to create a bundle for use in Deno... - deno: - - # Define display name: - name: 'Create Deno bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Configure git: - - name: 'Configure git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `deno` branch exists: - - name: 'Check if remote `deno` branch exists' - id: deno-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin deno - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `deno` exists, delete everything in branch and merge `production` into it - - name: 'If `deno` exists, delete everything in branch and merge `production` into it' - if: steps.deno-branch-exists.outputs.remote-exists - run: | - git checkout -b deno origin/deno - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `deno` does not exist, create `deno` branch: - - name: 'If `deno` does not exist, create `deno` branch' - if: ${{ steps.deno-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b deno - - # Copy files to deno directory: - - name: 'Copy files to deno directory' - run: | - mkdir -p deno - cp README.md LICENSE CONTRIBUTORS NOTICE ./deno - - # Copy TypeScript definitions to deno directory: - if [ -d index.d.ts ]; then - cp index.d.ts ./deno/index.d.ts - fi - if [ -e ./docs/types/index.d.ts ]; then - cp ./docs/types/index.d.ts ./deno/mod.d.ts - fi - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: Install production and development dependencies - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Bundle package for use in Deno: - - name: 'Bundle package for Deno' - id: deno-bundle - uses: stdlib-js/bundle-action@main - with: - target: 'deno' - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - # Replace links to other packages with links to the deno branch: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/deno/"; - - # Replace reference to `@stdlib/types` with CDN link: - find ./deno -type f -name '*.ts' -print0 | xargs -0 -r sed -Ei "s/\/\/\/ /\/\/\/ /g" - - # Change wording of project description to avoid reference to JavaScript and Node.js: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "s/a standard library for JavaScript and Node.js, /a standard library /g" - - # Rewrite all `require()`s to use jsDelivr links: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/require\( '@stdlib\// { - s/(var|let|const)\s+([a-z0-9_]+)\s+=\s*require\( '([^']+)' \);/import \2 from \'\3\';/i - s/@stdlib/https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js/ - s/';/@deno\/mod.js';/ - }" - - # Rewrite first `import` to show importing of named exports if available: - exports=$(cat lib/index.js | \ - grep -E 'setReadOnly\(.*,.*,.*\)' | \ - sed -E 's/setReadOnly\((.*),(.*),(.*)\);/\2/' | \ - sed -E "s/'//g" | \ - sort) - if [ -n "$exports" ]; then - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\nimport\s+([a-zA-Z0-9_]+)\s+from\s*'([^']+)';\n\`\`\`/\`\`\`javascript\nimport \1 from '\2';\n\`\`\`\n\nYou can also import the following named exports from the package:\n\n\`\`\`javascript\nimport { $(echo $exports | sed -E 's/ /, /g') } from '\2';\n\`\`\`/" - fi - - # Remove `installation`, `cli`, and `c` sections: - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Create package.json file for deno branch: - jq --indent 2 '{"name": .name, "version": .version, "description": .description, "license": .license, "type": "module", "main": "./mod.js", "homepage": .homepage, "repository": .repository, "bugs": .bugs, "keywords": .keywords, "funding": .funding}' package.json > ./deno/package.json - - # Delete everything in current directory aside from deno folder: - - name: 'Delete everything in current directory aside from deno folder' - run: | - find . -type 'f' | grep -v -e "deno" -e ".git/" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e "deno" -e ".git" | xargs -r rm -rf - - # Move deno directory to root: - - name: 'Move deno directory to root' - run: | - mv ./deno/* . - rmdir ./deno - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Auto-generated commit" - - # Push changes to `deno` branch: - - name: 'Push changes to `deno` branch' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" deno - - # Send status to Slack channel if job fails: - - name: 'Send status to Slack channel in case of failure' - # Pin action to full length commit SHA corresponding to v2.0.0 - uses: act10ns/slack@ed1309ab9862e57e9e583e51c7889486b9a00b0f - with: - status: ${{ job.status }} - steps: ${{ toJson(steps) }} - channel: '#npm-ci' - if: failure() - - # Define job to create a UMD bundle... - umd: - - # Define display name: - name: 'Create UMD bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Configure git: - - name: 'Configure git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `umd` branch exists: - - name: 'Check if remote `umd` branch exists' - id: umd-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin umd - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `umd` exists, delete everything in branch and merge `production` into it - - name: 'If `umd` exists, delete everything in branch and merge `production` into it' - if: steps.umd-branch-exists.outputs.remote-exists - run: | - git checkout -b umd origin/umd - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `umd` does not exist, create `umd` branch: - - name: 'If `umd` does not exist, create `umd` branch' - if: ${{ steps.umd-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b umd - - # Copy files to umd directory: - - name: 'Copy files to umd directory' - run: | - mkdir -p umd - cp README.md LICENSE CONTRIBUTORS NOTICE ./umd - - # Install Node.js - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Extract alias: - - name: 'Extract alias' - id: extract-alias - run: | - alias=$(grep -E 'require\(' README.md | head -n 1 | sed -E 's/^var ([a-zA-Z0-9_]+) = .+/\1/') - echo "alias=${alias}" >> $GITHUB_OUTPUT - - # Create Universal Module Definition (UMD) Node.js bundle: - - name: 'Create Universal Module Definition (UMD) Node.js bundle' - id: umd-bundle-node - uses: stdlib-js/bundle-action@main - with: - target: 'umd-node' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Create Universal Module Definition (UMD) browser bundle: - - name: 'Create Universal Module Definition (UMD) browser bundle' - id: umd-bundle-browser - uses: stdlib-js/bundle-action@main - with: - target: 'umd-browser' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - - # Replace links to other packages with links to the umd branch: - find ./umd -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/umd/"; - - # Remove `installation`, `cli`, and `c` sections: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Rewrite first `require()` to show consumption of the UMD bundle in Observable and via a `script` tag: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\n(var|let|const)\s+([a-zA-Z0-9_]+)\s+=\s*require\( '\@stdlib\/([^']+)' \);\n\`\`\`/To use in Observable,\n\n\`\`\`javascript\n\2 = require\( 'https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js\/\3\@umd\/browser.js' \)\n\`\`\`\n\nTo vendor stdlib functionality and avoid installing dependency trees for Node.js, you can use the UMD server build:\n\n\`\`\`javascript\nvar \2 = require\( 'path\/to\/vendor\/umd\/\3\/index.js' \)\n\`\`\`\n\nTo include the bundle in a webpage,\n\n\`\`\`html\n + + ```
@@ -189,7 +180,7 @@ var out = filter( x, naryFunction( isPositiveInteger, 1 ) ); ## 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. +This package is part of [stdlib][stdlib], a standard library 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]. diff --git a/SECURITY.md b/SECURITY.md deleted file mode 100644 index 9702d4c..0000000 --- a/SECURITY.md +++ /dev/null @@ -1,5 +0,0 @@ -# Security - -> Policy for reporting security vulnerabilities. - -See the security policy [in the main project repository](https://github.com/stdlib-js/stdlib/security). diff --git a/benchmark/benchmark.length.js b/benchmark/benchmark.length.js deleted file mode 100644 index bc79e33..0000000 --- a/benchmark/benchmark.length.js +++ /dev/null @@ -1,97 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 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 bench = require( '@stdlib/bench-harness' ); -var pow = require( '@stdlib/math-base-special-pow' ); -var isArray = require( '@stdlib/assert-is-array' ); -var isNonNegativeInteger = require( '@stdlib/assert-is-nonnegative-integer' ).isPrimitive; -var zeroTo = require( '@stdlib/array-base-zero-to' ); -var pkg = require( './../package.json' ).name; -var filter = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveInteger} len - array length -* @returns {Function} benchmark function -*/ -function createBenchmark( len ) { - var x = zeroTo( len ); - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var out; - var i; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - out = filter( x, isNonNegativeInteger ); - if ( typeof out !== 'object' ) { - b.fail( 'should return an array' ); - } - } - b.toc(); - if ( !isArray( out ) ) { - b.fail( 'should return an array' ); - } - b.pass( 'benchmark finished' ); - b.end(); - } -} - - -// MAIN // - -/** -* Main execution sequence. -* -* @private -*/ -function main() { - var len; - var min; - var max; - var f; - var i; - - min = 1; // 10^min - max = 6; // 10^max - - for ( i = min; i <= max; i++ ) { - len = pow( 10, i ); - - f = createBenchmark( len ); - bench( pkg+':dtype=generic,len='+len, f ); - } -} - -main(); diff --git a/branches.md b/branches.md deleted file mode 100644 index 9858901..0000000 --- a/branches.md +++ /dev/null @@ -1,56 +0,0 @@ - - -# Branches - -This repository has the following branches: - -- **main**: default branch generated from the [stdlib project][stdlib-url], where all development takes place. -- **production**: [production build][production-url] of the package (e.g., reformatted error messages to reduce bundle sizes and thus the number of bytes transmitted over a network). -- **esm**: [ES Module][esm-url] branch for use via a `script` tag without the need for installation and bundlers (see [README][esm-readme]). -- **deno**: [Deno][deno-url] branch for use in Deno (see [README][deno-readme]). -- **umd**: [UMD][umd-url] branch for use in Observable, or in dual browser/Node.js environments (see [README][umd-readme]). - -The following diagram illustrates the relationships among the above branches: - -```mermaid -graph TD; -A[stdlib]-->|generate standalone package|B; -B[main] -->|productionize| C[production]; -C -->|bundle| D[esm]; -C -->|bundle| E[deno]; -C -->|bundle| F[umd]; - -%% click A href "https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/filter" -%% click B href "https://github.com/stdlib-js/array-base-filter/tree/main" -%% click C href "https://github.com/stdlib-js/array-base-filter/tree/production" -%% click D href "https://github.com/stdlib-js/array-base-filter/tree/esm" -%% click E href "https://github.com/stdlib-js/array-base-filter/tree/deno" -%% click F href "https://github.com/stdlib-js/array-base-filter/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/filter -[production-url]: https://github.com/stdlib-js/array-base-filter/tree/production -[deno-url]: https://github.com/stdlib-js/array-base-filter/tree/deno -[deno-readme]: https://github.com/stdlib-js/array-base-filter/blob/deno/README.md -[umd-url]: https://github.com/stdlib-js/array-base-filter/tree/umd -[umd-readme]: https://github.com/stdlib-js/array-base-filter/blob/umd/README.md -[esm-url]: https://github.com/stdlib-js/array-base-filter/tree/esm -[esm-readme]: https://github.com/stdlib-js/array-base-filter/blob/esm/README.md \ No newline at end of file diff --git a/dist/index.d.ts b/dist/index.d.ts deleted file mode 100644 index aafb9cb..0000000 --- a/dist/index.d.ts +++ /dev/null @@ -1,3 +0,0 @@ -/// -import filter from '../docs/types/index'; -export = filter; \ No newline at end of file diff --git a/dist/index.js b/dist/index.js deleted file mode 100644 index 5c2f789..0000000 --- a/dist/index.js +++ /dev/null @@ -1,5 +0,0 @@ -"use strict";var s=function(r,t){return function(){return t||r((t={exports:{}}).exports,t),t.exports}};var f=s(function(y,c){ -var v=require('@stdlib/array-base-arraylike2object/dist');function l(r,t){return typeof r[t]=="function"}function h(r,t,n){var e,o,a;for(e=[],a=0;a 0;\n* }\n*\n* var x = [ 1, -2, -3, 4 ];\n*\n* var out = internal( x, isPositive );\n* // returns [ 1, 4 ]\n*/\nfunction internal( x, predicate, thisArg ) {\n\tvar out;\n\tvar v;\n\tvar i;\n\n\tout = [];\n\tfor ( i = 0; i < x.length; i++ ) {\n\t\tv = x[ i ];\n\t\tif ( predicate.call( thisArg, v, i, x ) ) {\n\t\t\tout.push( v );\n\t\t}\n\t}\n\treturn out;\n}\n\n/**\n* Returns a shallow copy of an array containing only those elements which pass a test implemented by a predicate function.\n*\n* @private\n* @param {Object} x - input array object\n* @param {Function} predicate - test function\n* @param {*} thisArg - execution context\n* @returns {Array} output array\n*\n* @example\n* var toAccessorArray = require( '@stdlib/array-base-to-accessor-array' );\n* var arraylike2object = require( '@stdlib/array-base-arraylike2object' );\n*\n* function isPositive( v ) {\n* return v > 0;\n* }\n*\n* var x = arraylike2object( toAccessorArray( [ 1, -2, -3, 4 ] ) );\n*\n* var out = accessors( x, isPositive );\n* // returns [ 1, 4 ]\n*/\nfunction accessors( x, predicate, thisArg ) {\n\tvar data;\n\tvar get;\n\tvar out;\n\tvar v;\n\tvar i;\n\n\tdata = x.data;\n\tget = x.accessors[ 0 ];\n\n\tout = [];\n\tfor ( i = 0; i < data.length; i++ ) {\n\t\tv = get( data, i );\n\t\tif ( predicate.call( thisArg, v, i, data ) ) {\n\t\t\tout.push( v );\n\t\t}\n\t}\n\treturn out;\n}\n\n\n// MAIN //\n\n/**\n* Returns a shallow copy of an array containing only those elements which pass a test implemented by a predicate function.\n*\n* @param {Collection} x - input array\n* @param {Function} predicate - test function\n* @param {*} [thisArg] - execution context\n* @returns {Collection} output array\n*\n* @example\n* function isPositive( v ) {\n* return v > 0;\n* }\n*\n* var x = [ 1, -2, -3, 4 ];\n*\n* var out = filter( x, isPositive );\n* // returns [ 1, 4 ]\n*/\nfunction filter( x, predicate, thisArg ) {\n\tvar obj;\n\tif ( hasMethod( x, 'filter' ) ) {\n\t\treturn x.filter( predicate, thisArg );\n\t}\n\tobj = arraylike2object( x );\n\tif ( obj.accessorProtocol ) {\n\t\treturn accessors( obj, predicate, thisArg );\n\t}\n\treturn internal( x, predicate, thisArg );\n}\n\n\n// EXPORTS //\n\nmodule.exports = filter;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2024 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* Return a shallow copy of an array containing only those elements which pass a test implemented by a predicate function.\n*\n* @module @stdlib/array-base-filter\n*\n* @example\n* var filter = require( '@stdlib/array-base-filter' );\n*\n* function isPositive( v ) {\n* return v > 0;\n* }\n*\n* var x = [ 1, -2, -3, 4 ];\n*\n* var out = filter( x, isPositive );\n* // returns [ 1, 4 ]\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,EAAmB,QAAS,qCAAsC,EAqBtE,SAASC,EAAWC,EAAKC,EAAS,CACjC,OAAS,OAAOD,EAAKC,CAAO,GAAM,UACnC,CAqBA,SAASC,EAAUC,EAAGC,EAAWC,EAAU,CAC1C,IAAIC,EACAC,EACAC,EAGJ,IADAF,EAAM,CAAC,EACDE,EAAI,EAAGA,EAAIL,EAAE,OAAQK,IAC1BD,EAAIJ,EAAGK,CAAE,EACJJ,EAAU,KAAMC,EAASE,EAAGC,EAAGL,CAAE,GACrCG,EAAI,KAAMC,CAAE,EAGd,OAAOD,CACR,CAwBA,SAASG,EAAWN,EAAGC,EAAWC,EAAU,CAC3C,IAAIK,EACAC,EACAL,EACAC,EACAC,EAMJ,IAJAE,EAAOP,EAAE,KACTQ,EAAMR,EAAE,UAAW,CAAE,EAErBG,EAAM,CAAC,EACDE,EAAI,EAAGA,EAAIE,EAAK,OAAQF,IAC7BD,EAAII,EAAKD,EAAMF,CAAE,EACZJ,EAAU,KAAMC,EAASE,EAAGC,EAAGE,CAAK,GACxCJ,EAAI,KAAMC,CAAE,EAGd,OAAOD,CACR,CAuBA,SAASM,EAAQT,EAAGC,EAAWC,EAAU,CACxC,IAAIL,EACJ,OAAKD,EAAWI,EAAG,QAAS,EACpBA,EAAE,OAAQC,EAAWC,CAAQ,GAErCL,EAAMF,EAAkBK,CAAE,EACrBH,EAAI,iBACDS,EAAWT,EAAKI,EAAWC,CAAQ,EAEpCH,EAAUC,EAAGC,EAAWC,CAAQ,EACxC,CAKAR,EAAO,QAAUe,ICvHjB,IAAIC,EAAO,IAKX,OAAO,QAAUA", - "names": ["require_main", "__commonJSMin", "exports", "module", "arraylike2object", "hasMethod", "obj", "method", "internal", "x", "predicate", "thisArg", "out", "v", "i", "accessors", "data", "get", "filter", "main"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index bb2b17a..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,46 +0,0 @@ - -{{alias}}( x, predicate[, thisArg] ) - Returns a shallow copy of an array containing only those elements which pass - a test implemented by a predicate function. - - The predicate function is provided three arguments: - - - value: current array element. - - index: current array element index. - - arr: the input array. - - If provided an array-like object having a `filter` method , the function - defers execution to that method and assumes that the method has the - following signature: - - x.filter( predicate, thisArg ) - - If provided an array-like object without a `filter` method, the function - performs a linear scan and always returns a generic array. - - Parameters - ---------- - x: Array|TypedArray|Object - Input array. - - predicate: Function - Predicate function. - - thisArg: any (optional) - Execution context. - - Returns - ------- - out: Array|TypedArray|Object - Output array. - - Examples - -------- - > function f( v ) { return ( v > 0 ); }; - > var x = [ 1, -2, -3, 4 ]; - > var out = {{alias}}( x, f ) - [ 1, 4 ] - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index db0c38d..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,101 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2024 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. -*/ - -import toAccessorArray = require( '@stdlib/array-base-to-accessor-array' ); -import filter = require( './index' ); - -/** -* Tests whether a value is positive. -* -* @param value - input value -* @returns boolean indicating whether an element is positive -*/ -function isPositive( value: number ): boolean { - return ( value > 0 ); -} - - -// TESTS // - -// The function returns a collection... -{ - filter( [ 1, 2, 3 ], isPositive ); // $ExpectType number[] - filter( new Float64Array( [ 1, 2, 3 ] ), isPositive ); // $ExpectType Float64Array - filter( new Float32Array( [ 1, 2, 3 ] ), isPositive ); // $ExpectType Float32Array - filter( new Int32Array( [ 1, 2, 3 ] ), isPositive ); // $ExpectType Int32Array - filter( new Int16Array( [ 1, 2, 3 ] ), isPositive ); // $ExpectType Int16Array - filter( new Int8Array( [ 1, 2, 3 ] ), isPositive ); // $ExpectType Int8Array - filter( new Uint32Array( [ 1, 2, 3 ] ), isPositive ); // $ExpectType Uint32Array - filter( new Uint16Array( [ 1, 2, 3 ] ), isPositive ); // $ExpectType Uint16Array - filter( new Uint8Array( [ 1, 2, 3 ] ), isPositive ); // $ExpectType Uint8Array - filter( new Uint8ClampedArray( [ 1, 2, 3 ] ), isPositive ); // $ExpectType Uint8ClampedArray - filter( toAccessorArray( [ 1, 2, 3 ] ), isPositive ); // $ExpectType number[] - - filter( [ 1, 2, 3 ], isPositive, {} ); // $ExpectType number[] - filter( new Float64Array( [ 1, 2, 3 ] ), isPositive, {} ); // $ExpectType Float64Array - filter( new Float32Array( [ 1, 2, 3 ] ), isPositive, {} ); // $ExpectType Float32Array - filter( new Int32Array( [ 1, 2, 3 ] ), isPositive, {} ); // $ExpectType Int32Array - filter( new Int16Array( [ 1, 2, 3 ] ), isPositive, {} ); // $ExpectType Int16Array - filter( new Int8Array( [ 1, 2, 3 ] ), isPositive, {} ); // $ExpectType Int8Array - filter( new Uint32Array( [ 1, 2, 3 ] ), isPositive, {} ); // $ExpectType Uint32Array - filter( new Uint16Array( [ 1, 2, 3 ] ), isPositive, {} ); // $ExpectType Uint16Array - filter( new Uint8Array( [ 1, 2, 3 ] ), isPositive, {} ); // $ExpectType Uint8Array - filter( new Uint8ClampedArray( [ 1, 2, 3 ] ), isPositive, {} ); // $ExpectType Uint8ClampedArray - filter( toAccessorArray( [ 1, 2, 3 ] ), isPositive, {} ); // $ExpectType number[] -} - -// The compiler throws an error if the function is provided a first argument which is not a collection... -{ - filter( 2, isPositive ); // $ExpectError - filter( false, isPositive ); // $ExpectError - filter( true, isPositive ); // $ExpectError - filter( {}, isPositive ); // $ExpectError - - filter( 2, isPositive, {} ); // $ExpectError - filter( false, isPositive, {} ); // $ExpectError - filter( true, isPositive, {} ); // $ExpectError - filter( {}, isPositive, {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided a second argument which is not a function... -{ - filter( [ 1, 2, 3 ], 'abc' ); // $ExpectError - filter( [ 1, 2, 3 ], 2 ); // $ExpectError - filter( [ 1, 2, 3 ], false ); // $ExpectError - filter( [ 1, 2, 3 ], true ); // $ExpectError - filter( [ 1, 2, 3 ], null ); // $ExpectError - filter( [ 1, 2, 3 ], void 0 ); // $ExpectError - filter( [ 1, 2, 3 ], {} ); // $ExpectError - filter( [ 1, 2, 3 ], [] ); // $ExpectError - - filter( [ 1, 2, 3 ], 'abc', {} ); // $ExpectError - filter( [ 1, 2, 3 ], 2, {} ); // $ExpectError - filter( [ 1, 2, 3 ], false, {} ); // $ExpectError - filter( [ 1, 2, 3 ], true, {} ); // $ExpectError - filter( [ 1, 2, 3 ], null, {} ); // $ExpectError - filter( [ 1, 2, 3 ], void 0, {} ); // $ExpectError - filter( [ 1, 2, 3 ], {}, {} ); // $ExpectError - filter( [ 1, 2, 3 ], [], {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided an unsupported number of arguments... -{ - filter(); // $ExpectError - filter( [ 1, 2, 3 ] ); // $ExpectError - filter( [ 1, 2, 3 ], isPositive, {}, 3 ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index cdfb9a7..0000000 --- a/examples/index.js +++ /dev/null @@ -1,35 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 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'; - -var discreteUniform = require( '@stdlib/random-array-discrete-uniform' ); -var isPositiveInteger = require( '@stdlib/assert-is-positive-integer' ).isPrimitive; -var naryFunction = require( '@stdlib/utils-nary-function' ); -var filter = require( './../lib' ); - -var x = discreteUniform( 10, -5, 5, { - 'dtype': 'int32' -}); -// returns - -var out = filter( x, naryFunction( isPositiveInteger, 1 ) ); -// returns - -console.log( x ); -console.log( out ); diff --git a/docs/types/index.d.ts b/index.d.ts similarity index 99% rename from docs/types/index.d.ts rename to index.d.ts index 0f92cfd..1fa8dc7 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 4.1 -/// +/// import { Collection, AccessorArrayLike, Complex128Array, Complex64Array } from '@stdlib/types/array'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..a10870c --- /dev/null +++ b/index.mjs @@ -0,0 +1,4 @@ +// Copyright (c) 2024 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 +/// +import r from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-arraylike2object@v0.2.1-esm/index.mjs";function t(t,e,n){var o;return function(r,t){return"function"==typeof r[t]}(t,"filter")?t.filter(e,n):(o=r(t)).accessorProtocol?function(r,t,e){var n,o,a,s,c;for(n=r.data,o=r.accessors[0],a=[],c=0;c 0;\n* }\n*\n* var x = [ 1, -2, -3, 4 ];\n*\n* var out = internal( x, isPositive );\n* // returns [ 1, 4 ]\n*/\nfunction internal( x, predicate, thisArg ) {\n\tvar out;\n\tvar v;\n\tvar i;\n\n\tout = [];\n\tfor ( i = 0; i < x.length; i++ ) {\n\t\tv = x[ i ];\n\t\tif ( predicate.call( thisArg, v, i, x ) ) {\n\t\t\tout.push( v );\n\t\t}\n\t}\n\treturn out;\n}\n\n/**\n* Returns a shallow copy of an array containing only those elements which pass a test implemented by a predicate function.\n*\n* @private\n* @param {Object} x - input array object\n* @param {Function} predicate - test function\n* @param {*} thisArg - execution context\n* @returns {Array} output array\n*\n* @example\n* import toAccessorArray from '@stdlib/array-base-to-accessor-array';\n* import arraylike2object from '@stdlib/array-base-arraylike2object';\n*\n* function isPositive( v ) {\n* return v > 0;\n* }\n*\n* var x = arraylike2object( toAccessorArray( [ 1, -2, -3, 4 ] ) );\n*\n* var out = accessors( x, isPositive );\n* // returns [ 1, 4 ]\n*/\nfunction accessors( x, predicate, thisArg ) {\n\tvar data;\n\tvar get;\n\tvar out;\n\tvar v;\n\tvar i;\n\n\tdata = x.data;\n\tget = x.accessors[ 0 ];\n\n\tout = [];\n\tfor ( i = 0; i < data.length; i++ ) {\n\t\tv = get( data, i );\n\t\tif ( predicate.call( thisArg, v, i, data ) ) {\n\t\t\tout.push( v );\n\t\t}\n\t}\n\treturn out;\n}\n\n\n// MAIN //\n\n/**\n* Returns a shallow copy of an array containing only those elements which pass a test implemented by a predicate function.\n*\n* @param {Collection} x - input array\n* @param {Function} predicate - test function\n* @param {*} [thisArg] - execution context\n* @returns {Collection} output array\n*\n* @example\n* function isPositive( v ) {\n* return v > 0;\n* }\n*\n* var x = [ 1, -2, -3, 4 ];\n*\n* var out = filter( x, isPositive );\n* // returns [ 1, 4 ]\n*/\nfunction filter( x, predicate, thisArg ) {\n\tvar obj;\n\tif ( hasMethod( x, 'filter' ) ) {\n\t\treturn x.filter( predicate, thisArg );\n\t}\n\tobj = arraylike2object( x );\n\tif ( obj.accessorProtocol ) {\n\t\treturn accessors( obj, predicate, thisArg );\n\t}\n\treturn internal( x, predicate, thisArg );\n}\n\n\n// EXPORTS //\n\nexport default filter;\n"],"names":["filter","x","predicate","thisArg","obj","method","hasMethod","arraylike2object","accessorProtocol","data","get","out","v","i","accessors","length","call","push","internal"],"mappings":";;sGAgJA,SAASA,EAAQC,EAAGC,EAAWC,GAC9B,IAAIC,EACJ,OAvGD,SAAoBA,EAAKC,GACxB,MAAkC,mBAAlBD,EAAKC,EACtB,CAqGMC,CAAWL,EAAG,UACXA,EAAED,OAAQE,EAAWC,IAE7BC,EAAMG,EAAkBN,IACfO,iBA/CV,SAAoBP,EAAGC,EAAWC,GACjC,IAAIM,EACAC,EACAC,EACAC,EACAC,EAMJ,IAJAJ,EAAOR,EAAEQ,KACTC,EAAMT,EAAEa,UAAW,GAEnBH,EAAM,GACAE,EAAI,EAAGA,EAAIJ,EAAKM,OAAQF,IAC7BD,EAAIF,EAAKD,EAAMI,GACVX,EAAUc,KAAMb,EAASS,EAAGC,EAAGJ,IACnCE,EAAIM,KAAML,GAGZ,OAAOD,CACR,CA8BSG,CAAWV,EAAKF,EAAWC,GArFpC,SAAmBF,EAAGC,EAAWC,GAChC,IAAIQ,EACAC,EACAC,EAGJ,IADAF,EAAM,GACAE,EAAI,EAAGA,EAAIZ,EAAEc,OAAQF,IAC1BD,EAAIX,EAAGY,GACFX,EAAUc,KAAMb,EAASS,EAAGC,EAAGZ,IACnCU,EAAIM,KAAML,GAGZ,OAAOD,CACR,CA0EQO,CAAUjB,EAAGC,EAAWC,EAChC"} \ No newline at end of file diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index 56236cd..0000000 --- a/lib/index.js +++ /dev/null @@ -1,46 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 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'; - -/** -* Return a shallow copy of an array containing only those elements which pass a test implemented by a predicate function. -* -* @module @stdlib/array-base-filter -* -* @example -* var filter = require( '@stdlib/array-base-filter' ); -* -* function isPositive( v ) { -* return v > 0; -* } -* -* var x = [ 1, -2, -3, 4 ]; -* -* var out = filter( x, isPositive ); -* // returns [ 1, 4 ] -*/ - -// MODULES // - -var main = require( './main.js' ); - - -// EXPORTS // - -module.exports = main; diff --git a/lib/main.js b/lib/main.js deleted file mode 100644 index 9b0c3db..0000000 --- a/lib/main.js +++ /dev/null @@ -1,160 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 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 arraylike2object = require( '@stdlib/array-base-arraylike2object' ); - - -// FUNCTIONS // - -/** -* Tests whether an object has a specified method. -* -* @private -* @param {Object} obj - input object -* @param {string} method - method name -* @returns {boolean} boolean indicating whether an object has a specified method -* -* @example -* var bool = hasMethod( [], 'filter' ); -* // returns true -* -* @example -* var bool = hasMethod( [], 'beep' ); -* // returns false -*/ -function hasMethod( obj, method ) { - return ( typeof obj[ method ] === 'function' ); -} - -/** -* Returns a shallow copy of an array containing only those elements which pass a test implemented by a predicate function. -* -* @private -* @param {Collection} x - input array -* @param {Function} predicate - test function -* @param {*} thisArg - execution context -* @returns {Array} output array -* -* @example -* function isPositive( v ) { -* return v > 0; -* } -* -* var x = [ 1, -2, -3, 4 ]; -* -* var out = internal( x, isPositive ); -* // returns [ 1, 4 ] -*/ -function internal( x, predicate, thisArg ) { - var out; - var v; - var i; - - out = []; - for ( i = 0; i < x.length; i++ ) { - v = x[ i ]; - if ( predicate.call( thisArg, v, i, x ) ) { - out.push( v ); - } - } - return out; -} - -/** -* Returns a shallow copy of an array containing only those elements which pass a test implemented by a predicate function. -* -* @private -* @param {Object} x - input array object -* @param {Function} predicate - test function -* @param {*} thisArg - execution context -* @returns {Array} output array -* -* @example -* var toAccessorArray = require( '@stdlib/array-base-to-accessor-array' ); -* var arraylike2object = require( '@stdlib/array-base-arraylike2object' ); -* -* function isPositive( v ) { -* return v > 0; -* } -* -* var x = arraylike2object( toAccessorArray( [ 1, -2, -3, 4 ] ) ); -* -* var out = accessors( x, isPositive ); -* // returns [ 1, 4 ] -*/ -function accessors( x, predicate, thisArg ) { - var data; - var get; - var out; - var v; - var i; - - data = x.data; - get = x.accessors[ 0 ]; - - out = []; - for ( i = 0; i < data.length; i++ ) { - v = get( data, i ); - if ( predicate.call( thisArg, v, i, data ) ) { - out.push( v ); - } - } - return out; -} - - -// MAIN // - -/** -* Returns a shallow copy of an array containing only those elements which pass a test implemented by a predicate function. -* -* @param {Collection} x - input array -* @param {Function} predicate - test function -* @param {*} [thisArg] - execution context -* @returns {Collection} output array -* -* @example -* function isPositive( v ) { -* return v > 0; -* } -* -* var x = [ 1, -2, -3, 4 ]; -* -* var out = filter( x, isPositive ); -* // returns [ 1, 4 ] -*/ -function filter( x, predicate, thisArg ) { - var obj; - if ( hasMethod( x, 'filter' ) ) { - return x.filter( predicate, thisArg ); - } - obj = arraylike2object( x ); - if ( obj.accessorProtocol ) { - return accessors( obj, predicate, thisArg ); - } - return internal( x, predicate, thisArg ); -} - - -// EXPORTS // - -module.exports = filter; diff --git a/package.json b/package.json index 8d5fd05..222dce3 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.2.1", "description": "Return a shallow copy of an array containing only those elements which pass a test implemented by a predicate function.", "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", - "directories": { - "benchmark": "./benchmark", - "doc": "./docs", - "example": "./examples", - "lib": "./lib", - "test": "./test" - }, - "types": "./docs/types", - "scripts": { - "test": "make test", - "test-cov": "make test-cov", - "examples": "make examples", - "benchmark": "make benchmark" - }, + "type": "module", + "main": "./index.mjs", "homepage": "https://stdlib.io", "repository": { "type": "git", @@ -36,42 +13,6 @@ "bugs": { "url": "https://github.com/stdlib-js/stdlib/issues" }, - "dependencies": { - "@stdlib/array-base-arraylike2object": "^0.2.1", - "@stdlib/types": "^0.3.2", - "@stdlib/error-tools-fmtprodmsg": "^0.2.1" - }, - "devDependencies": { - "@stdlib/array-base-accessor": "^0.2.0", - "@stdlib/array-base-zero-to": "^0.2.0", - "@stdlib/array-float64": "^0.2.1", - "@stdlib/assert-instance-of": "^0.2.1", - "@stdlib/assert-is-array": "^0.2.1", - "@stdlib/assert-is-nonnegative-integer": "^0.2.1", - "@stdlib/assert-is-positive-integer": "^0.2.1", - "@stdlib/math-base-special-pow": "^0.2.1", - "@stdlib/random-array-discrete-uniform": "^0.2.0", - "@stdlib/utils-nary-function": "^0.2.1", - "tape": "git+https://github.com/kgryte/tape.git#fix/globby", - "istanbul": "^0.4.1", - "tap-min": "git+https://github.com/Planeshifter/tap-min.git", - "@stdlib/bench-harness": "^0.2.1" - }, - "engines": { - "node": ">=0.10.0", - "npm": ">2.7.0" - }, - "os": [ - "aix", - "darwin", - "freebsd", - "linux", - "macos", - "openbsd", - "sunos", - "win32", - "windows" - ], "keywords": [ "stdlib", "stdtypes", @@ -91,4 +32,4 @@ "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} \ No newline at end of file +} diff --git a/stats.html b/stats.html new file mode 100644 index 0000000..d4d08f0 --- /dev/null +++ b/stats.html @@ -0,0 +1,4842 @@ + + + + + + + + Rollup Visualizer + + + +
+ + + + + diff --git a/test/dist/test.js b/test/dist/test.js deleted file mode 100644 index a8a9c60..0000000 --- a/test/dist/test.js +++ /dev/null @@ -1,33 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 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 tape = require( 'tape' ); -var main = require( './../../dist' ); - - -// TESTS // - -tape( 'main export is defined', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( main !== void 0, true, 'main export is defined' ); - t.end(); -}); diff --git a/test/test.js b/test/test.js deleted file mode 100644 index d4e7373..0000000 --- a/test/test.js +++ /dev/null @@ -1,251 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 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 tape = require( 'tape' ); -var AccessorArray = require( '@stdlib/array-base-accessor' ); -var Float64Array = require( '@stdlib/array-float64' ); -var instanceOf = require( '@stdlib/assert-instance-of' ); -var filter = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Tests whether a value is positive. -* -* @private -* @param {number} value - input value -* @returns {boolean} boolean indicating if a value is positive -*/ -function isPositive( value ) { - return ( value > 0 ); -} - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof filter, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'if provided an empty collection, the function returns an empty collection (generic)', function test( t ) { - var expected; - var actual; - var arr; - - arr = []; - expected = []; - actual = filter( arr, foo ); - - t.strictEqual( instanceOf( actual, Array ), true, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - t.end(); - - function foo() { - t.fail( 'should not be invoked' ); - } -}); - -tape( 'if provided an empty collection, the function returns an empty collection (typed array)', function test( t ) { - var expected; - var actual; - var arr; - - arr = new Float64Array( [] ); - expected = new Float64Array( [] ); - actual = filter( arr, foo ); - - t.strictEqual( instanceOf( actual, Float64Array ), true, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - t.end(); - - function foo() { - t.fail( 'should not be invoked' ); - } -}); - -tape( 'if provided an empty collection, the function returns an empty collection (accessor)', function test( t ) { - var expected; - var actual; - var arr; - - arr = new AccessorArray( [] ); - expected = []; - actual = filter( arr, foo ); - - t.strictEqual( instanceOf( actual, Array ), true, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - t.end(); - - function foo() { - t.fail( 'should not be invoked' ); - } -}); - -tape( 'the function filters a provided collection (generic)', function test( t ) { - var expected; - var actual; - var arr; - - arr = [ 1, -2, 3 ]; - expected = [ 1, 3 ]; - actual = filter( arr, isPositive ); - - t.strictEqual( instanceOf( actual, Array ), true, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - t.end(); -}); - -tape( 'the function filters a provided collection (typed array)', function test( t ) { - var expected; - var actual; - var arr; - - arr = new Float64Array( [ -1.0, 2.0, 3.0 ] ); - expected = new Float64Array( [ 2.0, 3.0 ] ); - actual = filter( arr, isPositive ); - - t.strictEqual( instanceOf( actual, Float64Array ), true, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - t.end(); -}); - -tape( 'the function filters a provided collection (accessor)', function test( t ) { - var expected; - var actual; - var arr; - - arr = new AccessorArray( [ 1, -2, -3 ] ); - expected = [ 1 ]; - actual = filter( arr, isPositive ); - - t.strictEqual( instanceOf( actual, Array ), true, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - t.end(); -}); - -tape( 'the function filters a provided collection (array-like object)', function test( t ) { - var expected; - var actual; - var arr; - - arr = { - 'length': 3, - '0': -1, - '1': -2, - '2': 3 - }; - expected = [ 3 ]; - actual = filter( arr, isPositive ); - - t.strictEqual( instanceOf( actual, Array ), true, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - t.end(); -}); - -tape( 'the function an empty collection if all elements fail a test (generic)', function test( t ) { - var expected; - var actual; - var arr; - - arr = [ -1, -2, -3 ]; - expected = []; - actual = filter( arr, isPositive ); - - t.strictEqual( instanceOf( actual, Array ), true, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - t.end(); -}); - -tape( 'the function an empty collection if all elements fail a test (typed array)', function test( t ) { - var expected; - var actual; - var arr; - - arr = new Float64Array( [ -1.0, -2.0, -3.0 ] ); - expected = new Float64Array( [] ); - actual = filter( arr, isPositive ); - - t.strictEqual( instanceOf( actual, Float64Array ), true, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - t.end(); -}); - -tape( 'the function an empty collection if all elements fail a test (accessor)', function test( t ) { - var expected; - var actual; - var arr; - - arr = new AccessorArray( [ -1, -2, -3 ] ); - expected = []; - actual = filter( arr, isPositive ); - - t.strictEqual( instanceOf( actual, Array ), true, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - t.end(); -}); - -tape( 'the function an empty collection if all elements fail a test (array-like object)', function test( t ) { - var expected; - var actual; - var arr; - - arr = { - 'length': 3, - '0': -1, - '1': -2, - '2': -3 - }; - expected = []; - actual = filter( arr, isPositive ); - - t.strictEqual( instanceOf( actual, Array ), true, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - t.end(); -}); - -tape( 'the function supports providing an execution context', function test( t ) { - var expected; - var actual; - var ctx; - var arr; - - ctx = { - 'count': 0 - }; - arr = [ 1, 2, 3 ]; - expected = [ 1, 2, 3 ]; - actual = filter( arr, predicate, ctx ); - - t.strictEqual( instanceOf( actual, Array ), true, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - t.strictEqual( ctx.count, arr.length, 'returns expected value' ); - - t.end(); - - function predicate( value ) { - this.count += 1; // eslint-disable-line no-invalid-this - return ( value > 0 ); - } -}); From b7ff8c71c1f7267f4a7f8c398db5b587ee4cf4ba Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sun, 25 Feb 2024 22:33:45 +0000 Subject: [PATCH 16/40] Update README.md for ESM bundle v0.2.1 --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 82c2c1a..ae5b2cf 100644 --- a/README.md +++ b/README.md @@ -52,7 +52,7 @@ limitations under the License. ## Usage ```javascript -import filter from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-filter@esm/index.mjs'; +import filter from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-filter@v0.2.1-esm/index.mjs'; ``` #### filter( x, predicate\[, thisArg] ) @@ -136,7 +136,7 @@ var cnt = context.count; import discreteUniform from 'https://cdn.jsdelivr.net/gh/stdlib-js/random-array-discrete-uniform@esm/index.mjs'; var isPositiveInteger = require( 'https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-positive-integer' ).isPrimitive; import naryFunction from 'https://cdn.jsdelivr.net/gh/stdlib-js/utils-nary-function@esm/index.mjs'; -import filter from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-filter@esm/index.mjs'; +import filter from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-filter@v0.2.1-esm/index.mjs'; var x = discreteUniform( 10, -5, 5, { 'dtype': 'int32' From 205ce9d32bcd3a9ed15d5d04d347ca8ffaf31086 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sun, 25 Feb 2024 22:33:46 +0000 Subject: [PATCH 17/40] Auto-generated commit --- README.md | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index ae5b2cf..d695e3f 100644 --- a/README.md +++ b/README.md @@ -51,6 +51,11 @@ limitations under the License. ## Usage +```javascript +import filter from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-filter@esm/index.mjs'; +``` +The previous example will load the latest bundled code from the esm branch. Alternatively, you may load a specific version by loading the file from one of the [tagged bundles](https://github.com/stdlib-js/array-base-filter/tags). For example, + ```javascript import filter from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-filter@v0.2.1-esm/index.mjs'; ``` @@ -136,7 +141,7 @@ var cnt = context.count; import discreteUniform from 'https://cdn.jsdelivr.net/gh/stdlib-js/random-array-discrete-uniform@esm/index.mjs'; var isPositiveInteger = require( 'https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-positive-integer' ).isPrimitive; import naryFunction from 'https://cdn.jsdelivr.net/gh/stdlib-js/utils-nary-function@esm/index.mjs'; -import filter from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-filter@v0.2.1-esm/index.mjs'; +import filter from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-filter@esm/index.mjs'; var x = discreteUniform( 10, -5, 5, { 'dtype': 'int32' From 72e9ca31125144a21bf9596b3fa36e4f9ecafeca Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 1 Apr 2024 08:34:15 +0000 Subject: [PATCH 18/40] Transform error messages --- package.json | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/package.json b/package.json index 355145c..d836e77 100644 --- a/package.json +++ b/package.json @@ -38,7 +38,8 @@ }, "dependencies": { "@stdlib/array-base-arraylike2object": "^0.2.1", - "@stdlib/types": "^0.3.2" + "@stdlib/types": "^0.3.2", + "@stdlib/error-tools-fmtprodmsg": "^0.2.1" }, "devDependencies": { "@stdlib/array-base-accessor": "^0.2.1", @@ -90,4 +91,4 @@ "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} +} \ No newline at end of file From 5667bf3cd146180a6dd43fb6d38a45b3e8b9da5b Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 1 Apr 2024 14:11:05 +0000 Subject: [PATCH 19/40] Remove files --- index.d.ts | 343 ---- index.mjs | 4 - index.mjs.map | 1 - stats.html | 4842 ------------------------------------------------- 4 files changed, 5190 deletions(-) delete mode 100644 index.d.ts delete mode 100644 index.mjs delete mode 100644 index.mjs.map delete mode 100644 stats.html diff --git a/index.d.ts b/index.d.ts deleted file mode 100644 index 1fa8dc7..0000000 --- a/index.d.ts +++ /dev/null @@ -1,343 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2024 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 - -/// - -import { Collection, AccessorArrayLike, Complex128Array, Complex64Array } from '@stdlib/types/array'; - -/** -* Returns a boolean indicating whether an element passes a test. -* -* @returns boolean indicating whether an element passes a test -*/ -type Nullary = ( this: U ) => boolean; - -/** -* Returns a boolean indicating whether an element passes a test. -* -* @param value - current array element -* @returns boolean indicating whether an element passes a test -*/ -type Unary = ( this: U, value: T ) => boolean; - -/** -* Returns a boolean indicating whether an element passes a test. -* -* @param value - current array element -* @param index - current array element index -* @returns boolean indicating whether an element passes a test -*/ -type Binary = ( this: U, value: T, index: number ) => boolean; - -/** -* Returns a boolean indicating whether an element passes a test. -* -* @param value - current array element -* @param index - current array element index -* @param arr - input array -* @returns boolean indicating whether an element passes a test -*/ -type Ternary = ( this: U, value: T, index: number, arr: V ) => boolean; - -/** -* Returns a boolean indicating whether an element passes a test. -* -* @param value - current array element -* @param index - current array element index -* @param arr - input array -* @returns boolean indicating whether an element passes a test -*/ -type Predicate = Nullary | Unary | Binary | Ternary; - -/** -* Returns a shallow copy of an array containing only those elements which pass a test implemented by a predicate function. -* -* @param x - input array -* @param predicate - predicate function -* @param thisArg - predicate function execution context -* @returns output array -* -* @example -* var isPositiveNumber = require( '@stdlib/assert-is-positive-number' ).isPrimitive; -* var Float64Array = require( '@stdlib/array-float64' ); -* -* var x = new Float64Array( [ 1.0, -2.0, -3.0, 4.0 ] ); -* -* var out = filter( x, isPositiveNumber ); -* // returns [ 1.0, 4.0 ] -*/ -declare function filter( x: Float64Array, predicate: Predicate, thisArg?: ThisParameterType> ): Float64Array; - -/** -* Returns a shallow copy of an array containing only those elements which pass a test implemented by a predicate function. -* -* @param x - input array -* @param predicate - predicate function -* @param thisArg - predicate function execution context -* @returns output array -* -* @example -* var isPositiveNumber = require( '@stdlib/assert-is-positive-number' ).isPrimitive; -* var Float32Array = require( '@stdlib/array-float32' ); -* -* var x = new Float32Array( [ 1.0, -2.0, -3.0, 4.0 ] ); -* -* var out = filter( x, isPositiveNumber ); -* // returns [ 1.0, 4.0 ] -*/ -declare function filter( x: Float32Array, predicate: Predicate, thisArg?: ThisParameterType> ): Float32Array; - -/** -* Returns a shallow copy of an array containing only those elements which pass a test implemented by a predicate function. -* -* @param x - input array -* @param predicate - predicate function -* @param thisArg - predicate function execution context -* @returns output array -* -* @example -* var isPositiveNumber = require( '@stdlib/assert-is-positive-number' ).isPrimitive; -* var Int32Array = require( '@stdlib/array-int32' ); -* -* var x = new Int32Array( [ 1, -2, -3, 4 ] ); -* -* var out = filter( x, isPositiveNumber ); -* // returns [ 1, 4 ] -*/ -declare function filter( x: Int32Array, predicate: Predicate, thisArg?: ThisParameterType> ): Int32Array; - -/** -* Returns a shallow copy of an array containing only those elements which pass a test implemented by a predicate function. -* -* @param x - input array -* @param predicate - predicate function -* @param thisArg - predicate function execution context -* @returns output array -* -* @example -* var isPositiveNumber = require( '@stdlib/assert-is-positive-number' ).isPrimitive; -* var Int16Array = require( '@stdlib/array-int16' ); -* -* var x = new Int16Array( [ 1, -2, -3, 4 ] ); -* -* var out = filter( x, isPositiveNumber ); -* // returns [ 1, 4 ] -*/ -declare function filter( x: Int16Array, predicate: Predicate, thisArg?: ThisParameterType> ): Int16Array; - -/** -* Returns a shallow copy of an array containing only those elements which pass a test implemented by a predicate function. -* -* @param x - input array -* @param predicate - predicate function -* @param thisArg - predicate function execution context -* @returns output array -* -* @example -* var isPositiveNumber = require( '@stdlib/assert-is-positive-number' ).isPrimitive; -* var Int8Array = require( '@stdlib/array-int8' ); -* -* var x = new Int8Array( [ 1, -2, -3, 4 ] ); -* -* var out = filter( x, isPositiveNumber ); -* // returns [ 1, 4 ] -*/ -declare function filter( x: Int8Array, predicate: Predicate, thisArg?: ThisParameterType> ): Int8Array; - -/** -* Returns a shallow copy of an array containing only those elements which pass a test implemented by a predicate function. -* -* @param x - input array -* @param predicate - predicate function -* @param thisArg - predicate function execution context -* @returns output array -* -* @example -* var isPositiveNumber = require( '@stdlib/assert-is-positive-number' ).isPrimitive; -* var Uint32Array = require( '@stdlib/array-uint32' ); -* -* var x = new Uint32Array( [ 1, 2, 3, 4 ] ); -* -* var out = filter( x, isPositiveNumber ); -* // returns [ 1, 2, 3, 4 ] -*/ -declare function filter( x: Uint32Array, predicate: Predicate, thisArg?: ThisParameterType> ): Uint32Array; - -/** -* Returns a shallow copy of an array containing only those elements which pass a test implemented by a predicate function. -* -* @param x - input array -* @param predicate - predicate function -* @param thisArg - predicate function execution context -* @returns output array -* -* @example -* var isPositiveNumber = require( '@stdlib/assert-is-positive-number' ).isPrimitive; -* var Uint16Array = require( '@stdlib/array-uint16' ); -* -* var x = new Uint16Array( [ 1, 2, 3, 4 ] ); -* -* var out = filter( x, isPositiveNumber ); -* // returns [ 1, 2, 3, 4 ] -*/ -declare function filter( x: Uint16Array, predicate: Predicate, thisArg?: ThisParameterType> ): Uint16Array; - -/** -* Returns a shallow copy of an array containing only those elements which pass a test implemented by a predicate function. -* -* @param x - input array -* @param predicate - predicate function -* @param thisArg - predicate function execution context -* @returns output array -* -* @example -* var isPositiveNumber = require( '@stdlib/assert-is-positive-number' ).isPrimitive; -* var Uint8Array = require( '@stdlib/array-uint8' ); -* -* var x = new Uint8Array( [ 1, 2, 3, 4 ] ); -* -* var out = filter( x, isPositiveNumber ); -* // returns [ 1, 2, 3, 4 ] -*/ -declare function filter( x: Uint8Array, predicate: Predicate, thisArg?: ThisParameterType> ): Uint8Array; - -/** -* Returns a shallow copy of an array containing only those elements which pass a test implemented by a predicate function. -* -* @param x - input array -* @param predicate - predicate function -* @param thisArg - predicate function execution context -* @returns output array -* -* @example -* var isPositiveNumber = require( '@stdlib/assert-is-positive-number' ).isPrimitive; -* var Uint8ClampedArray = require( '@stdlib/array-uint8c' ); -* -* var x = new Uint8ClampedArray( [ 1, 2, 3, 4 ] ); -* -* var out = filter( x, isPositiveNumber ); -* // returns [ 1, 2, 3, 4 ] -*/ -declare function filter( x: Uint8ClampedArray, predicate: Predicate, thisArg?: ThisParameterType> ): Uint8ClampedArray; - -/** -* Returns a shallow copy of an array containing only those elements which pass a test implemented by a predicate function. -* -* @param x - input array -* @param predicate - predicate function -* @param thisArg - predicate function execution context -* @returns output array -* -* @example -* var isPositiveNumber = require( '@stdlib/assert-is-positive-number' ).isPrimitive; -* var real = require( '@stdlib/complex-real' ); -* var imag = require( '@stdlib/complex-imag' ); -* var Complex128Array = require( '@stdlib/array-complex128' ); -* -* function predicate( v ) { -* return ( isPositiveNumber( real( v ) ) && isPositiveNumber( imag( v ) ) ); -* } -* -* var x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0 ] ); -* -* var out = filter( x, predicate ); -* // returns -*/ -declare function filter( x: Complex128Array, predicate: Predicate, thisArg?: ThisParameterType> ): Complex128Array; - -/** -* Returns a shallow copy of an array containing only those elements which pass a test implemented by a predicate function. -* -* @param x - input array -* @param predicate - predicate function -* @param thisArg - predicate function execution context -* @returns output array -* -* @example -* var isPositiveNumber = require( '@stdlib/assert-is-positive-number' ).isPrimitive; -* var realf = require( '@stdlib/complex-realf' ); -* var imagf = require( '@stdlib/complex-imagf' ); -* var Complex64Array = require( '@stdlib/array-complex64' ); -* -* function predicate( v ) { -* return ( isPositiveNumber( realf( v ) ) && isPositiveNumber( imagf( v ) ) ); -* } -* -* var x = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); -* -* var out = filter( x, predicate ); -* // returns -*/ -declare function filter( x: Complex64Array, predicate: Predicate, thisArg?: ThisParameterType> ): Complex64Array; - -/** -* Returns a shallow copy of an array containing only those elements which pass a test implemented by a predicate function. -* -* @param x - input array -* @param predicate - predicate function -* @param thisArg - predicate function execution context -* @returns output array -* -* @example -* var x = [ 1, -2, -3, 4 ]; -* -* var out = filter( x, isPositiveNumber ); -* // returns [ 1, 4 ] -*/ -declare function filter( x: Array, predicate: Predicate>, thisArg?: ThisParameterType>> ): Array; - -/** -* Returns a shallow copy of an array containing only those elements which pass a test implemented by a predicate function. -* -* @param x - input array -* @param predicate - predicate function -* @param thisArg - predicate function execution context -* @returns output array -* -* @example -* var toAccessorArray = require( '@stdlib/array-base-to-accessor-array' ); -* -* var x = toAccessorArray( [ 1, -2, -3, 4 ] ); -* -* var out = filter( x, isPositiveNumber ); -* // returns [ 1, 4 ] -*/ -declare function filter( x: AccessorArrayLike, predicate: Predicate>, thisArg?: ThisParameterType>> ): Array; - -/** -* Returns a shallow copy of an array containing only those elements which pass a test implemented by a predicate function. -* -* @param x - input array -* @param predicate - predicate function -* @param thisArg - predicate function execution context -* @returns output array -* -* @example -* var x = [ 1, -2, -3, 4 ]; -* -* var out = filter( x, isPositiveNumber ); -* // returns [ 1, 4 ] -*/ -declare function filter( x: Collection, predicate: Predicate>, thisArg?: ThisParameterType>> ): Array; - - -// EXPORTS // - -export = filter; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index a10870c..0000000 --- a/index.mjs +++ /dev/null @@ -1,4 +0,0 @@ -// Copyright (c) 2024 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 -/// -import r from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-arraylike2object@v0.2.1-esm/index.mjs";function t(t,e,n){var o;return function(r,t){return"function"==typeof r[t]}(t,"filter")?t.filter(e,n):(o=r(t)).accessorProtocol?function(r,t,e){var n,o,a,s,c;for(n=r.data,o=r.accessors[0],a=[],c=0;c 0;\n* }\n*\n* var x = [ 1, -2, -3, 4 ];\n*\n* var out = internal( x, isPositive );\n* // returns [ 1, 4 ]\n*/\nfunction internal( x, predicate, thisArg ) {\n\tvar out;\n\tvar v;\n\tvar i;\n\n\tout = [];\n\tfor ( i = 0; i < x.length; i++ ) {\n\t\tv = x[ i ];\n\t\tif ( predicate.call( thisArg, v, i, x ) ) {\n\t\t\tout.push( v );\n\t\t}\n\t}\n\treturn out;\n}\n\n/**\n* Returns a shallow copy of an array containing only those elements which pass a test implemented by a predicate function.\n*\n* @private\n* @param {Object} x - input array object\n* @param {Function} predicate - test function\n* @param {*} thisArg - execution context\n* @returns {Array} output array\n*\n* @example\n* import toAccessorArray from '@stdlib/array-base-to-accessor-array';\n* import arraylike2object from '@stdlib/array-base-arraylike2object';\n*\n* function isPositive( v ) {\n* return v > 0;\n* }\n*\n* var x = arraylike2object( toAccessorArray( [ 1, -2, -3, 4 ] ) );\n*\n* var out = accessors( x, isPositive );\n* // returns [ 1, 4 ]\n*/\nfunction accessors( x, predicate, thisArg ) {\n\tvar data;\n\tvar get;\n\tvar out;\n\tvar v;\n\tvar i;\n\n\tdata = x.data;\n\tget = x.accessors[ 0 ];\n\n\tout = [];\n\tfor ( i = 0; i < data.length; i++ ) {\n\t\tv = get( data, i );\n\t\tif ( predicate.call( thisArg, v, i, data ) ) {\n\t\t\tout.push( v );\n\t\t}\n\t}\n\treturn out;\n}\n\n\n// MAIN //\n\n/**\n* Returns a shallow copy of an array containing only those elements which pass a test implemented by a predicate function.\n*\n* @param {Collection} x - input array\n* @param {Function} predicate - test function\n* @param {*} [thisArg] - execution context\n* @returns {Collection} output array\n*\n* @example\n* function isPositive( v ) {\n* return v > 0;\n* }\n*\n* var x = [ 1, -2, -3, 4 ];\n*\n* var out = filter( x, isPositive );\n* // returns [ 1, 4 ]\n*/\nfunction filter( x, predicate, thisArg ) {\n\tvar obj;\n\tif ( hasMethod( x, 'filter' ) ) {\n\t\treturn x.filter( predicate, thisArg );\n\t}\n\tobj = arraylike2object( x );\n\tif ( obj.accessorProtocol ) {\n\t\treturn accessors( obj, predicate, thisArg );\n\t}\n\treturn internal( x, predicate, thisArg );\n}\n\n\n// EXPORTS //\n\nexport default filter;\n"],"names":["filter","x","predicate","thisArg","obj","method","hasMethod","arraylike2object","accessorProtocol","data","get","out","v","i","accessors","length","call","push","internal"],"mappings":";;sGAgJA,SAASA,EAAQC,EAAGC,EAAWC,GAC9B,IAAIC,EACJ,OAvGD,SAAoBA,EAAKC,GACxB,MAAkC,mBAAlBD,EAAKC,EACtB,CAqGMC,CAAWL,EAAG,UACXA,EAAED,OAAQE,EAAWC,IAE7BC,EAAMG,EAAkBN,IACfO,iBA/CV,SAAoBP,EAAGC,EAAWC,GACjC,IAAIM,EACAC,EACAC,EACAC,EACAC,EAMJ,IAJAJ,EAAOR,EAAEQ,KACTC,EAAMT,EAAEa,UAAW,GAEnBH,EAAM,GACAE,EAAI,EAAGA,EAAIJ,EAAKM,OAAQF,IAC7BD,EAAIF,EAAKD,EAAMI,GACVX,EAAUc,KAAMb,EAASS,EAAGC,EAAGJ,IACnCE,EAAIM,KAAML,GAGZ,OAAOD,CACR,CA8BSG,CAAWV,EAAKF,EAAWC,GArFpC,SAAmBF,EAAGC,EAAWC,GAChC,IAAIQ,EACAC,EACAC,EAGJ,IADAF,EAAM,GACAE,EAAI,EAAGA,EAAIZ,EAAEc,OAAQF,IAC1BD,EAAIX,EAAGY,GACFX,EAAUc,KAAMb,EAASS,EAAGC,EAAGZ,IACnCU,EAAIM,KAAML,GAGZ,OAAOD,CACR,CA0EQO,CAAUjB,EAAGC,EAAWC,EAChC"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index d4d08f0..0000000 --- a/stats.html +++ /dev/null @@ -1,4842 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From 297e685a370984844a6b500c9035096e9de5a35a Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 1 Apr 2024 14:11:17 +0000 Subject: [PATCH 20/40] Auto-generated commit --- .editorconfig | 181 - .eslintrc.js | 1 - .gitattributes | 49 - .github/.keepalive | 1 - .github/PULL_REQUEST_TEMPLATE.md | 7 - .github/workflows/benchmark.yml | 64 - .github/workflows/cancel.yml | 57 - .github/workflows/close_pull_requests.yml | 54 - .github/workflows/examples.yml | 64 - .github/workflows/npm_downloads.yml | 112 - .github/workflows/productionize.yml | 797 ---- .github/workflows/publish.yml | 249 -- .github/workflows/test.yml | 100 - .github/workflows/test_bundles.yml | 189 - .github/workflows/test_coverage.yml | 132 - .github/workflows/test_install.yml | 86 - .gitignore | 188 - .npmignore | 229 - .npmrc | 31 - CHANGELOG.md | 5 - CITATION.cff | 30 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 --- README.md | 41 +- SECURITY.md | 5 - benchmark/benchmark.length.js | 97 - branches.md | 56 - dist/index.d.ts | 3 - dist/index.js | 5 - dist/index.js.map | 7 - docs/repl.txt | 46 - docs/types/test.ts | 101 - examples/index.js | 35 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/index.js | 46 - lib/main.js | 160 - package.json | 65 +- stats.html | 4842 +++++++++++++++++++++ test/dist/test.js | 33 - test/test.js | 251 -- 43 files changed, 4867 insertions(+), 4099 deletions(-) delete mode 100644 .editorconfig delete mode 100644 .eslintrc.js delete mode 100644 .gitattributes delete mode 100644 .github/.keepalive delete mode 100644 .github/PULL_REQUEST_TEMPLATE.md delete mode 100644 .github/workflows/benchmark.yml delete mode 100644 .github/workflows/cancel.yml delete mode 100644 .github/workflows/close_pull_requests.yml delete mode 100644 .github/workflows/examples.yml delete mode 100644 .github/workflows/npm_downloads.yml delete mode 100644 .github/workflows/productionize.yml delete mode 100644 .github/workflows/publish.yml delete mode 100644 .github/workflows/test.yml delete mode 100644 .github/workflows/test_bundles.yml delete mode 100644 .github/workflows/test_coverage.yml delete mode 100644 .github/workflows/test_install.yml delete mode 100644 .gitignore delete mode 100644 .npmignore delete mode 100644 .npmrc delete mode 100644 CHANGELOG.md delete mode 100644 CITATION.cff delete mode 100644 CODE_OF_CONDUCT.md delete mode 100644 CONTRIBUTING.md delete mode 100644 Makefile delete mode 100644 SECURITY.md delete mode 100644 benchmark/benchmark.length.js delete mode 100644 branches.md delete mode 100644 dist/index.d.ts delete mode 100644 dist/index.js delete mode 100644 dist/index.js.map delete mode 100644 docs/repl.txt delete mode 100644 docs/types/test.ts delete mode 100644 examples/index.js rename docs/types/index.d.ts => index.d.ts (99%) create mode 100644 index.mjs create mode 100644 index.mjs.map delete mode 100644 lib/index.js delete mode 100644 lib/main.js create mode 100644 stats.html delete mode 100644 test/dist/test.js delete mode 100644 test/test.js diff --git a/.editorconfig b/.editorconfig deleted file mode 100644 index 60d743f..0000000 --- a/.editorconfig +++ /dev/null @@ -1,181 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 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. -#/ - -# EditorConfig configuration file (see ). - -# Indicate that this file is a root-level configuration file: -root = true - -# Set properties for all files: -[*] -end_of_line = lf -charset = utf-8 -trim_trailing_whitespace = true -insert_final_newline = true - -# Set properties for JavaScript files: -[*.{js,js.txt}] -indent_style = tab - -# Set properties for JavaScript ES module files: -[*.{mjs,mjs.txt}] -indent_style = tab - -# Set properties for JavaScript CommonJS files: -[*.{cjs,cjs.txt}] -indent_style = tab - -# Set properties for JSON files: -[*.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `cli_opts.json` files: -[cli_opts.json] -indent_style = tab - -# Set properties for TypeScript files: -[*.ts] -indent_style = tab - -# Set properties for Python files: -[*.{py,py.txt}] -indent_style = space -indent_size = 4 - -# Set properties for Julia files: -[*.{jl,jl.txt}] -indent_style = tab - -# Set properties for R files: -[*.{R,R.txt}] -indent_style = tab - -# Set properties for C files: -[*.{c,c.txt}] -indent_style = tab - -# Set properties for C header files: -[*.{h,h.txt}] -indent_style = tab - -# Set properties for C++ files: -[*.{cpp,cpp.txt}] -indent_style = tab - -# Set properties for C++ header files: -[*.{hpp,hpp.txt}] -indent_style = tab - -# Set properties for Fortran files: -[*.{f,f.txt}] -indent_style = space -indent_size = 2 -insert_final_newline = false - -# Set properties for shell files: -[*.{sh,sh.txt}] -indent_style = tab - -# Set properties for AWK files: -[*.{awk,awk.txt}] -indent_style = tab - -# Set properties for HTML files: -[*.{html,html.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for XML files: -[*.{xml,xml.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for CSS files: -[*.{css,css.txt}] -indent_style = tab - -# Set properties for Makefiles: -[Makefile] -indent_style = tab - -[*.{mk,mk.txt}] -indent_style = tab - -# Set properties for Markdown files: -[*.{md,md.txt}] -indent_style = space -indent_size = 4 -trim_trailing_whitespace = false - -# Set properties for `usage.txt` files: -[usage.txt] -indent_style = space -indent_size = 2 - -# Set properties for `repl.txt` files: -[repl.txt] -indent_style = space -indent_size = 4 - -# Set properties for `package.json` files: -[package.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `datapackage.json` files: -[datapackage.json] -indent_style = space -indent_size = 2 - -# Set properties for `manifest.json` files: -[manifest.json] -indent_style = space -indent_size = 2 - -# Set properties for `tsconfig.json` files: -[tsconfig.json] -indent_style = space -indent_size = 2 - -# Set properties for LaTeX files: -[*.{tex,tex.txt}] -indent_style = tab - -# Set properties for LaTeX Bibliography files: -[*.{bib,bib.txt}] -indent_style = tab - -# Set properties for YAML files: -[*.{yml,yml.txt}] -indent_style = space -indent_size = 2 - -# Set properties for GYP files: -[binding.gyp] -indent_style = space -indent_size = 2 - -[*.gypi] -indent_style = space -indent_size = 2 - -# Set properties for citation files: -[*.{cff,cff.txt}] -indent_style = space -indent_size = 2 diff --git a/.eslintrc.js b/.eslintrc.js deleted file mode 100644 index 5f30286..0000000 --- a/.eslintrc.js +++ /dev/null @@ -1 +0,0 @@ -/* For the `eslint` rules of this project, consult the main repository at https://github.com/stdlib-js/stdlib */ diff --git a/.gitattributes b/.gitattributes deleted file mode 100644 index 10a16e6..0000000 --- a/.gitattributes +++ /dev/null @@ -1,49 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 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. -#/ - -# Configuration file which assigns attributes to pathnames. -# -# [1]: https://git-scm.com/docs/gitattributes - -# Automatically normalize the line endings of any committed text files: -* text=auto - -# Override line endings for certain files on checkout: -*.crlf.csv text eol=crlf - -# Denote that certain files are binary and should not be modified: -*.png binary -*.jpg binary -*.jpeg binary -*.gif binary -*.ico binary -*.gz binary -*.zip binary -*.7z binary -*.mp3 binary -*.mp4 binary -*.mov binary - -# Override what is considered "vendored" by GitHub's linguist: -/deps/** linguist-vendored=false -/lib/node_modules/** linguist-vendored=false linguist-generated=false -test/fixtures/** linguist-vendored=false -tools/** linguist-vendored=false - -# Override what is considered "documentation" by GitHub's linguist: -examples/** linguist-documentation=false diff --git a/.github/.keepalive b/.github/.keepalive deleted file mode 100644 index 0f38374..0000000 --- a/.github/.keepalive +++ /dev/null @@ -1 +0,0 @@ -2024-04-01T05:54:37.368Z diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index 6559bc7..0000000 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ /dev/null @@ -1,7 +0,0 @@ - - -We are excited about your pull request, but unfortunately we are not accepting pull requests against this repository, as all development happens on the [main project repository](https://github.com/stdlib-js/stdlib). We kindly request that you submit this pull request against the [respective directory](https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/filter) of the main repository where we’ll review and provide feedback. - -If this is your first stdlib contribution, be sure to read the [contributing guide](https://github.com/stdlib-js/stdlib/blob/develop/CONTRIBUTING.md) which provides guidelines and instructions for submitting contributions. You may also consult the [development guide](https://github.com/stdlib-js/stdlib/blob/develop/docs/development.md) for help on developing stdlib. - -We look forward to receiving your contribution! :smiley: \ No newline at end of file diff --git a/.github/workflows/benchmark.yml b/.github/workflows/benchmark.yml deleted file mode 100644 index e4f10fe..0000000 --- a/.github/workflows/benchmark.yml +++ /dev/null @@ -1,64 +0,0 @@ -#/ -# @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. -#/ - -# Workflow name: -name: benchmark - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to run benchmarks: - benchmark: - - # Define a display name: - name: 'Run benchmarks' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Run benchmarks: - - name: 'Run benchmarks' - run: | - npm run benchmark diff --git a/.github/workflows/cancel.yml b/.github/workflows/cancel.yml deleted file mode 100644 index b5291db..0000000 --- a/.github/workflows/cancel.yml +++ /dev/null @@ -1,57 +0,0 @@ -#/ -# @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. -#/ - -# Workflow name: -name: cancel - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to cancel existing workflow runs: - cancel: - - # Define a display name: - name: 'Cancel workflow runs' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Time limit: - timeout-minutes: 3 - - # Define the sequence of job steps... - steps: - - # Cancel existing workflow runs: - - name: 'Cancel existing workflow runs' - # Pin action to full length commit SHA - uses: styfle/cancel-workflow-action@85880fa0301c86cca9da44039ee3bb12d3bedbfa # v0.12.1 - with: - workflow_id: >- - benchmark.yml, - examples.yml, - test.yml, - test_coverage.yml, - test_install.yml, - publish.yml - access_token: ${{ github.token }} diff --git a/.github/workflows/close_pull_requests.yml b/.github/workflows/close_pull_requests.yml deleted file mode 100644 index 2060eba..0000000 --- a/.github/workflows/close_pull_requests.yml +++ /dev/null @@ -1,54 +0,0 @@ -#/ -# @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. -#/ - -# Workflow name: -name: close_pull_requests - -# Workflow triggers: -on: - pull_request_target: - types: [opened] - -# Workflow jobs: -jobs: - - # Define job to close all pull requests: - run: - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - - # Close pull request - - name: 'Close pull request' - # Pin action to full length commit SHA corresponding to v3.1.2 - uses: superbrothers/close-pull-request@9c18513d320d7b2c7185fb93396d0c664d5d8448 - with: - comment: | - Thank you for submitting a pull request. :raised_hands: - - We greatly appreciate your willingness to submit a contribution. However, we are not accepting pull requests against this repository, as all development happens on the [main project repository](https://github.com/stdlib-js/stdlib). - - We kindly request that you submit this pull request against the [respective directory](https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/filter) of the main repository where we’ll review and provide feedback. If this is your first stdlib contribution, be sure to read the [contributing guide](https://github.com/stdlib-js/stdlib/blob/develop/CONTRIBUTING.md) which provides guidelines and instructions for submitting contributions. - - Thank you again, and we look forward to receiving your contribution! :smiley: - - Best, - The stdlib team \ No newline at end of file diff --git a/.github/workflows/examples.yml b/.github/workflows/examples.yml deleted file mode 100644 index 2984901..0000000 --- a/.github/workflows/examples.yml +++ /dev/null @@ -1,64 +0,0 @@ -#/ -# @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. -#/ - -# Workflow name: -name: examples - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to run the package examples... - examples: - - # Define display name: - name: 'Run examples' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - - # Checkout repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Run examples: - - name: 'Run examples' - run: | - npm run examples diff --git a/.github/workflows/npm_downloads.yml b/.github/workflows/npm_downloads.yml deleted file mode 100644 index c2326d6..0000000 --- a/.github/workflows/npm_downloads.yml +++ /dev/null @@ -1,112 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2022 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. -#/ - -# Workflow name: -name: npm_downloads - -# Workflow triggers: -on: - # Run this workflow weekly: - schedule: - # cron: ' ' - - cron: '48 12 * * 3' - - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job for retrieving npm download counts... - npm_downloads: - - # Define display name: - name: 'Retrieve npm download counts' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - timeout-minutes: 10 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Resolve package name: - - name: 'Resolve package name' - id: package_name - run: | - name=`node -e 'console.log(require("./package.json").name)' | tr -d '\n'` - echo "package_name=$name" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Fetch download data: - - name: 'Fetch data' - id: download_data - run: | - url="https://api.npmjs.org/downloads/range/$(date --date='1 year ago' '+%Y-%m-%d'):$(date '+%Y-%m-%d')/${{ steps.package_name.outputs.package_name }}" - echo "$url" - data=$(curl "$url") - mkdir ./tmp - echo "$data" > ./tmp/npm_downloads.json - echo "data=$data" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Print summary of download data: - - name: 'Print summary' - run: | - echo "| Date | Downloads |" >> $GITHUB_STEP_SUMMARY - echo "|------|------------|" >> $GITHUB_STEP_SUMMARY - cat ./tmp/npm_downloads.json | jq -r ".downloads | .[-14:] | to_entries | map(\"| \(.value.day) | \(.value.downloads) |\") |.[]" >> $GITHUB_STEP_SUMMARY - - # Upload the download data: - - name: 'Upload data' - # Pin action to full length commit SHA - uses: actions/upload-artifact@5d5d22a31266ced268874388b861e4b58bb5c2f3 # v4.3.1 - with: - # Define a name for the uploaded artifact (ensuring a unique name for each job): - name: npm_downloads - - # Specify the path to the file to upload: - path: ./tmp/npm_downloads.json - - # Specify the number of days to retain the artifact (default is 90 days): - retention-days: 90 - timeout-minutes: 10 - if: success() - - # Send data to events server: - - name: 'Post data' - # Pin action to full length commit SHA - uses: distributhor/workflow-webhook@48a40b380ce4593b6a6676528cd005986ae56629 # v3.0.3 - env: - webhook_url: ${{ secrets.STDLIB_NPM_DOWNLOADS_URL }} - webhook_secret: ${{ secrets.STDLIB_WEBHOOK_SECRET }} - data: '{ "downloads": ${{ steps.download_data.outputs.data }} }' - timeout-minutes: 5 - if: success() diff --git a/.github/workflows/productionize.yml b/.github/workflows/productionize.yml deleted file mode 100644 index ec90164..0000000 --- a/.github/workflows/productionize.yml +++ /dev/null @@ -1,797 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2022 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. -#/ - -# Workflow name: -name: productionize - -# Workflow triggers: -on: - # Run workflow when a new commit is pushed to the main branch: - push: - branches: - - main - - # Allow the workflow to be manually run: - workflow_dispatch: - inputs: - require-passing-tests: - description: 'Require passing tests for creating bundles' - type: boolean - default: true - - # Run workflow upon completion of `publish` workflow run: - workflow_run: - workflows: ["publish"] - types: [completed] - - -# Concurrency group to prevent multiple concurrent executions: -concurrency: - group: productionize - cancel-in-progress: true - -# Workflow jobs: -jobs: - - # Define a job to create a production build... - productionize: - - # Define display name: - name: 'Productionize' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Define the sequence of job steps... - steps: - # Checkout main branch of repository: - - name: 'Checkout main branch' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - with: - ref: main - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Create production branch: - - name: 'Create production branch' - run: | - git checkout -b production - - # Transform error messages: - - name: 'Transform error messages' - id: transform-error-messages - uses: stdlib-js/transform-errors-action@main - - # 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: | - PKG_VERSION=$(npm view @stdlib/error-tools-fmtprodmsg version) - if grep -q '"@stdlib/string-format"' package.json; then - sed -i "s/\"@stdlib\/string-format\": \"^.*\"/\"@stdlib\/error-tools-fmtprodmsg\": \"^$PKG_VERSION\"/g" package.json - else - node -e "var pkg = require( './package.json' ); pkg.dependencies[ '@stdlib/error-tools-fmtprodmsg' ] = '^$PKG_VERSION'; require( 'fs' ).writeFileSync( 'package.json', JSON.stringify( pkg, null, 2 ) );" - fi - - # Configure git: - - name: 'Configure git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Transform error messages" - - # Push changes: - - name: 'Push changes' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" production --force - - # Define a job for running tests of the productionized code... - test: - - # Define a display name: - name: 'Run Tests' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Indicate that this job depends on the prior job finishing: - needs: productionize - - # Run this job regardless of the outcome of the prior job: - if: always() - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout repository' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - with: - # Use the `production` branch: - ref: production - - # Install Node.js: - - name: 'Install Node.js' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Build native add-on if present: - - name: 'Build native add-on (if present)' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - run: | - if [ -f "binding.gyp" ]; then - npm install node-gyp --no-save && ./node_modules/.bin/node-gyp rebuild - fi - - # Run tests: - - name: 'Run tests' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: tests - run: | - npm test || npm test || npm test - - # Define job to create a bundle for use in Deno... - deno: - - # Define display name: - name: 'Create Deno bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Configure git: - - name: 'Configure git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `deno` branch exists: - - name: 'Check if remote `deno` branch exists' - id: deno-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin deno - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `deno` exists, delete everything in branch and merge `production` into it - - name: 'If `deno` exists, delete everything in branch and merge `production` into it' - if: steps.deno-branch-exists.outputs.remote-exists - run: | - git checkout -b deno origin/deno - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `deno` does not exist, create `deno` branch: - - name: 'If `deno` does not exist, create `deno` branch' - if: ${{ steps.deno-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b deno - - # Copy files to deno directory: - - name: 'Copy files to deno directory' - run: | - mkdir -p deno - cp README.md LICENSE CONTRIBUTORS NOTICE ./deno - - # Copy TypeScript definitions to deno directory: - if [ -d index.d.ts ]; then - cp index.d.ts ./deno/index.d.ts - fi - if [ -e ./docs/types/index.d.ts ]; then - cp ./docs/types/index.d.ts ./deno/mod.d.ts - fi - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: Install production and development dependencies - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Bundle package for use in Deno: - - name: 'Bundle package for Deno' - id: deno-bundle - uses: stdlib-js/bundle-action@main - with: - target: 'deno' - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - # Replace links to other packages with links to the deno branch: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/deno/"; - - # Replace reference to `@stdlib/types` with CDN link: - find ./deno -type f -name '*.ts' -print0 | xargs -0 -r sed -Ei "s/\/\/\/ /\/\/\/ /g" - - # Change wording of project description to avoid reference to JavaScript and Node.js: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "s/a standard library for JavaScript and Node.js, /a standard library /g" - - # Rewrite all `require()`s to use jsDelivr links: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/require\( '@stdlib\// { - s/(var|let|const)\s+([a-z0-9_]+)\s+=\s*require\( '([^']+)' \);/import \2 from \'\3\';/i - s/@stdlib/https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js/ - s/';/@deno\/mod.js';/ - }" - - # Rewrite first `import` to show importing of named exports if available: - exports=$(cat lib/index.js | \ - grep -E 'setReadOnly\(.*,.*,.*\)' | \ - sed -E 's/setReadOnly\((.*),(.*),(.*)\);/\2/' | \ - sed -E "s/'//g" | \ - sort) - if [ -n "$exports" ]; then - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\nimport\s+([a-zA-Z0-9_]+)\s+from\s*'([^']+)';\n\`\`\`/\`\`\`javascript\nimport \1 from '\2';\n\`\`\`\n\nYou can also import the following named exports from the package:\n\n\`\`\`javascript\nimport { $(echo $exports | sed -E 's/ /, /g') } from '\2';\n\`\`\`/" - fi - - # Remove `installation`, `cli`, and `c` sections: - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Create package.json file for deno branch: - jq --indent 2 '{"name": .name, "version": .version, "description": .description, "license": .license, "type": "module", "main": "./mod.js", "homepage": .homepage, "repository": .repository, "bugs": .bugs, "keywords": .keywords, "funding": .funding}' package.json > ./deno/package.json - - # Delete everything in current directory aside from deno folder: - - name: 'Delete everything in current directory aside from deno folder' - run: | - find . -type 'f' | grep -v -e "deno" -e ".git/" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e "deno" -e ".git" | xargs -r rm -rf - - # Move deno directory to root: - - name: 'Move deno directory to root' - run: | - mv ./deno/* . - rmdir ./deno - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Auto-generated commit" - - # Push changes to `deno` branch: - - name: 'Push changes to `deno` branch' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" deno - - # Send status to Slack channel if job fails: - - name: 'Send status to Slack channel in case of failure' - # Pin action to full length commit SHA - uses: 8398a7/action-slack@28ba43ae48961b90635b50953d216767a6bea486 # v3.16.2 - with: - status: ${{ job.status }} - steps: ${{ toJson(steps) }} - channel: '#npm-ci' - if: failure() - - # Define job to create a UMD bundle... - umd: - - # Define display name: - name: 'Create UMD bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Configure git: - - name: 'Configure git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `umd` branch exists: - - name: 'Check if remote `umd` branch exists' - id: umd-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin umd - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `umd` exists, delete everything in branch and merge `production` into it - - name: 'If `umd` exists, delete everything in branch and merge `production` into it' - if: steps.umd-branch-exists.outputs.remote-exists - run: | - git checkout -b umd origin/umd - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `umd` does not exist, create `umd` branch: - - name: 'If `umd` does not exist, create `umd` branch' - if: ${{ steps.umd-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b umd - - # Copy files to umd directory: - - name: 'Copy files to umd directory' - run: | - mkdir -p umd - cp README.md LICENSE CONTRIBUTORS NOTICE ./umd - - # Install Node.js - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Extract alias: - - name: 'Extract alias' - id: extract-alias - run: | - alias=$(grep -E 'require\(' README.md | head -n 1 | sed -E 's/^var ([a-zA-Z0-9_]+) = .+/\1/') - echo "alias=${alias}" >> $GITHUB_OUTPUT - - # Create Universal Module Definition (UMD) Node.js bundle: - - name: 'Create Universal Module Definition (UMD) Node.js bundle' - id: umd-bundle-node - uses: stdlib-js/bundle-action@main - with: - target: 'umd-node' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Create Universal Module Definition (UMD) browser bundle: - - name: 'Create Universal Module Definition (UMD) browser bundle' - id: umd-bundle-browser - uses: stdlib-js/bundle-action@main - with: - target: 'umd-browser' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - - # Replace links to other packages with links to the umd branch: - find ./umd -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/umd/"; - - # Remove `installation`, `cli`, and `c` sections: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Rewrite first `require()` to show consumption of the UMD bundle in Observable and via a `script` tag: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\n(var|let|const)\s+([a-zA-Z0-9_]+)\s+=\s*require\( '\@stdlib\/([^']+)' \);\n\`\`\`/To use in Observable,\n\n\`\`\`javascript\n\2 = require\( 'https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js\/\3\@umd\/browser.js' \)\n\`\`\`\n\nTo vendor stdlib functionality and avoid installing dependency trees for Node.js, you can use the UMD server build:\n\n\`\`\`javascript\nvar \2 = require\( 'path\/to\/vendor\/umd\/\3\/index.js' \)\n\`\`\`\n\nTo include the bundle in a webpage,\n\n\`\`\`html\n + + ```
@@ -189,7 +180,7 @@ var out = filter( x, naryFunction( isPositiveInteger, 1 ) ); ## 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. +This package is part of [stdlib][stdlib], a standard library 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]. diff --git a/SECURITY.md b/SECURITY.md deleted file mode 100644 index 9702d4c..0000000 --- a/SECURITY.md +++ /dev/null @@ -1,5 +0,0 @@ -# Security - -> Policy for reporting security vulnerabilities. - -See the security policy [in the main project repository](https://github.com/stdlib-js/stdlib/security). diff --git a/benchmark/benchmark.length.js b/benchmark/benchmark.length.js deleted file mode 100644 index bc79e33..0000000 --- a/benchmark/benchmark.length.js +++ /dev/null @@ -1,97 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 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 bench = require( '@stdlib/bench-harness' ); -var pow = require( '@stdlib/math-base-special-pow' ); -var isArray = require( '@stdlib/assert-is-array' ); -var isNonNegativeInteger = require( '@stdlib/assert-is-nonnegative-integer' ).isPrimitive; -var zeroTo = require( '@stdlib/array-base-zero-to' ); -var pkg = require( './../package.json' ).name; -var filter = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveInteger} len - array length -* @returns {Function} benchmark function -*/ -function createBenchmark( len ) { - var x = zeroTo( len ); - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var out; - var i; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - out = filter( x, isNonNegativeInteger ); - if ( typeof out !== 'object' ) { - b.fail( 'should return an array' ); - } - } - b.toc(); - if ( !isArray( out ) ) { - b.fail( 'should return an array' ); - } - b.pass( 'benchmark finished' ); - b.end(); - } -} - - -// MAIN // - -/** -* Main execution sequence. -* -* @private -*/ -function main() { - var len; - var min; - var max; - var f; - var i; - - min = 1; // 10^min - max = 6; // 10^max - - for ( i = min; i <= max; i++ ) { - len = pow( 10, i ); - - f = createBenchmark( len ); - bench( pkg+':dtype=generic,len='+len, f ); - } -} - -main(); diff --git a/branches.md b/branches.md deleted file mode 100644 index 9858901..0000000 --- a/branches.md +++ /dev/null @@ -1,56 +0,0 @@ - - -# Branches - -This repository has the following branches: - -- **main**: default branch generated from the [stdlib project][stdlib-url], where all development takes place. -- **production**: [production build][production-url] of the package (e.g., reformatted error messages to reduce bundle sizes and thus the number of bytes transmitted over a network). -- **esm**: [ES Module][esm-url] branch for use via a `script` tag without the need for installation and bundlers (see [README][esm-readme]). -- **deno**: [Deno][deno-url] branch for use in Deno (see [README][deno-readme]). -- **umd**: [UMD][umd-url] branch for use in Observable, or in dual browser/Node.js environments (see [README][umd-readme]). - -The following diagram illustrates the relationships among the above branches: - -```mermaid -graph TD; -A[stdlib]-->|generate standalone package|B; -B[main] -->|productionize| C[production]; -C -->|bundle| D[esm]; -C -->|bundle| E[deno]; -C -->|bundle| F[umd]; - -%% click A href "https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/filter" -%% click B href "https://github.com/stdlib-js/array-base-filter/tree/main" -%% click C href "https://github.com/stdlib-js/array-base-filter/tree/production" -%% click D href "https://github.com/stdlib-js/array-base-filter/tree/esm" -%% click E href "https://github.com/stdlib-js/array-base-filter/tree/deno" -%% click F href "https://github.com/stdlib-js/array-base-filter/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/filter -[production-url]: https://github.com/stdlib-js/array-base-filter/tree/production -[deno-url]: https://github.com/stdlib-js/array-base-filter/tree/deno -[deno-readme]: https://github.com/stdlib-js/array-base-filter/blob/deno/README.md -[umd-url]: https://github.com/stdlib-js/array-base-filter/tree/umd -[umd-readme]: https://github.com/stdlib-js/array-base-filter/blob/umd/README.md -[esm-url]: https://github.com/stdlib-js/array-base-filter/tree/esm -[esm-readme]: https://github.com/stdlib-js/array-base-filter/blob/esm/README.md \ No newline at end of file diff --git a/dist/index.d.ts b/dist/index.d.ts deleted file mode 100644 index aafb9cb..0000000 --- a/dist/index.d.ts +++ /dev/null @@ -1,3 +0,0 @@ -/// -import filter from '../docs/types/index'; -export = filter; \ No newline at end of file diff --git a/dist/index.js b/dist/index.js deleted file mode 100644 index 5c2f789..0000000 --- a/dist/index.js +++ /dev/null @@ -1,5 +0,0 @@ -"use strict";var s=function(r,t){return function(){return t||r((t={exports:{}}).exports,t),t.exports}};var f=s(function(y,c){ -var v=require('@stdlib/array-base-arraylike2object/dist');function l(r,t){return typeof r[t]=="function"}function h(r,t,n){var e,o,a;for(e=[],a=0;a 0;\n* }\n*\n* var x = [ 1, -2, -3, 4 ];\n*\n* var out = internal( x, isPositive );\n* // returns [ 1, 4 ]\n*/\nfunction internal( x, predicate, thisArg ) {\n\tvar out;\n\tvar v;\n\tvar i;\n\n\tout = [];\n\tfor ( i = 0; i < x.length; i++ ) {\n\t\tv = x[ i ];\n\t\tif ( predicate.call( thisArg, v, i, x ) ) {\n\t\t\tout.push( v );\n\t\t}\n\t}\n\treturn out;\n}\n\n/**\n* Returns a shallow copy of an array containing only those elements which pass a test implemented by a predicate function.\n*\n* @private\n* @param {Object} x - input array object\n* @param {Function} predicate - test function\n* @param {*} thisArg - execution context\n* @returns {Array} output array\n*\n* @example\n* var toAccessorArray = require( '@stdlib/array-base-to-accessor-array' );\n* var arraylike2object = require( '@stdlib/array-base-arraylike2object' );\n*\n* function isPositive( v ) {\n* return v > 0;\n* }\n*\n* var x = arraylike2object( toAccessorArray( [ 1, -2, -3, 4 ] ) );\n*\n* var out = accessors( x, isPositive );\n* // returns [ 1, 4 ]\n*/\nfunction accessors( x, predicate, thisArg ) {\n\tvar data;\n\tvar get;\n\tvar out;\n\tvar v;\n\tvar i;\n\n\tdata = x.data;\n\tget = x.accessors[ 0 ];\n\n\tout = [];\n\tfor ( i = 0; i < data.length; i++ ) {\n\t\tv = get( data, i );\n\t\tif ( predicate.call( thisArg, v, i, data ) ) {\n\t\t\tout.push( v );\n\t\t}\n\t}\n\treturn out;\n}\n\n\n// MAIN //\n\n/**\n* Returns a shallow copy of an array containing only those elements which pass a test implemented by a predicate function.\n*\n* @param {Collection} x - input array\n* @param {Function} predicate - test function\n* @param {*} [thisArg] - execution context\n* @returns {Collection} output array\n*\n* @example\n* function isPositive( v ) {\n* return v > 0;\n* }\n*\n* var x = [ 1, -2, -3, 4 ];\n*\n* var out = filter( x, isPositive );\n* // returns [ 1, 4 ]\n*/\nfunction filter( x, predicate, thisArg ) {\n\tvar obj;\n\tif ( hasMethod( x, 'filter' ) ) {\n\t\treturn x.filter( predicate, thisArg );\n\t}\n\tobj = arraylike2object( x );\n\tif ( obj.accessorProtocol ) {\n\t\treturn accessors( obj, predicate, thisArg );\n\t}\n\treturn internal( x, predicate, thisArg );\n}\n\n\n// EXPORTS //\n\nmodule.exports = filter;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2024 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* Return a shallow copy of an array containing only those elements which pass a test implemented by a predicate function.\n*\n* @module @stdlib/array-base-filter\n*\n* @example\n* var filter = require( '@stdlib/array-base-filter' );\n*\n* function isPositive( v ) {\n* return v > 0;\n* }\n*\n* var x = [ 1, -2, -3, 4 ];\n*\n* var out = filter( x, isPositive );\n* // returns [ 1, 4 ]\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,EAAmB,QAAS,qCAAsC,EAqBtE,SAASC,EAAWC,EAAKC,EAAS,CACjC,OAAS,OAAOD,EAAKC,CAAO,GAAM,UACnC,CAqBA,SAASC,EAAUC,EAAGC,EAAWC,EAAU,CAC1C,IAAIC,EACAC,EACAC,EAGJ,IADAF,EAAM,CAAC,EACDE,EAAI,EAAGA,EAAIL,EAAE,OAAQK,IAC1BD,EAAIJ,EAAGK,CAAE,EACJJ,EAAU,KAAMC,EAASE,EAAGC,EAAGL,CAAE,GACrCG,EAAI,KAAMC,CAAE,EAGd,OAAOD,CACR,CAwBA,SAASG,EAAWN,EAAGC,EAAWC,EAAU,CAC3C,IAAIK,EACAC,EACAL,EACAC,EACAC,EAMJ,IAJAE,EAAOP,EAAE,KACTQ,EAAMR,EAAE,UAAW,CAAE,EAErBG,EAAM,CAAC,EACDE,EAAI,EAAGA,EAAIE,EAAK,OAAQF,IAC7BD,EAAII,EAAKD,EAAMF,CAAE,EACZJ,EAAU,KAAMC,EAASE,EAAGC,EAAGE,CAAK,GACxCJ,EAAI,KAAMC,CAAE,EAGd,OAAOD,CACR,CAuBA,SAASM,EAAQT,EAAGC,EAAWC,EAAU,CACxC,IAAIL,EACJ,OAAKD,EAAWI,EAAG,QAAS,EACpBA,EAAE,OAAQC,EAAWC,CAAQ,GAErCL,EAAMF,EAAkBK,CAAE,EACrBH,EAAI,iBACDS,EAAWT,EAAKI,EAAWC,CAAQ,EAEpCH,EAAUC,EAAGC,EAAWC,CAAQ,EACxC,CAKAR,EAAO,QAAUe,ICvHjB,IAAIC,EAAO,IAKX,OAAO,QAAUA", - "names": ["require_main", "__commonJSMin", "exports", "module", "arraylike2object", "hasMethod", "obj", "method", "internal", "x", "predicate", "thisArg", "out", "v", "i", "accessors", "data", "get", "filter", "main"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index bb2b17a..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,46 +0,0 @@ - -{{alias}}( x, predicate[, thisArg] ) - Returns a shallow copy of an array containing only those elements which pass - a test implemented by a predicate function. - - The predicate function is provided three arguments: - - - value: current array element. - - index: current array element index. - - arr: the input array. - - If provided an array-like object having a `filter` method , the function - defers execution to that method and assumes that the method has the - following signature: - - x.filter( predicate, thisArg ) - - If provided an array-like object without a `filter` method, the function - performs a linear scan and always returns a generic array. - - Parameters - ---------- - x: Array|TypedArray|Object - Input array. - - predicate: Function - Predicate function. - - thisArg: any (optional) - Execution context. - - Returns - ------- - out: Array|TypedArray|Object - Output array. - - Examples - -------- - > function f( v ) { return ( v > 0 ); }; - > var x = [ 1, -2, -3, 4 ]; - > var out = {{alias}}( x, f ) - [ 1, 4 ] - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index db0c38d..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,101 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2024 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. -*/ - -import toAccessorArray = require( '@stdlib/array-base-to-accessor-array' ); -import filter = require( './index' ); - -/** -* Tests whether a value is positive. -* -* @param value - input value -* @returns boolean indicating whether an element is positive -*/ -function isPositive( value: number ): boolean { - return ( value > 0 ); -} - - -// TESTS // - -// The function returns a collection... -{ - filter( [ 1, 2, 3 ], isPositive ); // $ExpectType number[] - filter( new Float64Array( [ 1, 2, 3 ] ), isPositive ); // $ExpectType Float64Array - filter( new Float32Array( [ 1, 2, 3 ] ), isPositive ); // $ExpectType Float32Array - filter( new Int32Array( [ 1, 2, 3 ] ), isPositive ); // $ExpectType Int32Array - filter( new Int16Array( [ 1, 2, 3 ] ), isPositive ); // $ExpectType Int16Array - filter( new Int8Array( [ 1, 2, 3 ] ), isPositive ); // $ExpectType Int8Array - filter( new Uint32Array( [ 1, 2, 3 ] ), isPositive ); // $ExpectType Uint32Array - filter( new Uint16Array( [ 1, 2, 3 ] ), isPositive ); // $ExpectType Uint16Array - filter( new Uint8Array( [ 1, 2, 3 ] ), isPositive ); // $ExpectType Uint8Array - filter( new Uint8ClampedArray( [ 1, 2, 3 ] ), isPositive ); // $ExpectType Uint8ClampedArray - filter( toAccessorArray( [ 1, 2, 3 ] ), isPositive ); // $ExpectType number[] - - filter( [ 1, 2, 3 ], isPositive, {} ); // $ExpectType number[] - filter( new Float64Array( [ 1, 2, 3 ] ), isPositive, {} ); // $ExpectType Float64Array - filter( new Float32Array( [ 1, 2, 3 ] ), isPositive, {} ); // $ExpectType Float32Array - filter( new Int32Array( [ 1, 2, 3 ] ), isPositive, {} ); // $ExpectType Int32Array - filter( new Int16Array( [ 1, 2, 3 ] ), isPositive, {} ); // $ExpectType Int16Array - filter( new Int8Array( [ 1, 2, 3 ] ), isPositive, {} ); // $ExpectType Int8Array - filter( new Uint32Array( [ 1, 2, 3 ] ), isPositive, {} ); // $ExpectType Uint32Array - filter( new Uint16Array( [ 1, 2, 3 ] ), isPositive, {} ); // $ExpectType Uint16Array - filter( new Uint8Array( [ 1, 2, 3 ] ), isPositive, {} ); // $ExpectType Uint8Array - filter( new Uint8ClampedArray( [ 1, 2, 3 ] ), isPositive, {} ); // $ExpectType Uint8ClampedArray - filter( toAccessorArray( [ 1, 2, 3 ] ), isPositive, {} ); // $ExpectType number[] -} - -// The compiler throws an error if the function is provided a first argument which is not a collection... -{ - filter( 2, isPositive ); // $ExpectError - filter( false, isPositive ); // $ExpectError - filter( true, isPositive ); // $ExpectError - filter( {}, isPositive ); // $ExpectError - - filter( 2, isPositive, {} ); // $ExpectError - filter( false, isPositive, {} ); // $ExpectError - filter( true, isPositive, {} ); // $ExpectError - filter( {}, isPositive, {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided a second argument which is not a function... -{ - filter( [ 1, 2, 3 ], 'abc' ); // $ExpectError - filter( [ 1, 2, 3 ], 2 ); // $ExpectError - filter( [ 1, 2, 3 ], false ); // $ExpectError - filter( [ 1, 2, 3 ], true ); // $ExpectError - filter( [ 1, 2, 3 ], null ); // $ExpectError - filter( [ 1, 2, 3 ], void 0 ); // $ExpectError - filter( [ 1, 2, 3 ], {} ); // $ExpectError - filter( [ 1, 2, 3 ], [] ); // $ExpectError - - filter( [ 1, 2, 3 ], 'abc', {} ); // $ExpectError - filter( [ 1, 2, 3 ], 2, {} ); // $ExpectError - filter( [ 1, 2, 3 ], false, {} ); // $ExpectError - filter( [ 1, 2, 3 ], true, {} ); // $ExpectError - filter( [ 1, 2, 3 ], null, {} ); // $ExpectError - filter( [ 1, 2, 3 ], void 0, {} ); // $ExpectError - filter( [ 1, 2, 3 ], {}, {} ); // $ExpectError - filter( [ 1, 2, 3 ], [], {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided an unsupported number of arguments... -{ - filter(); // $ExpectError - filter( [ 1, 2, 3 ] ); // $ExpectError - filter( [ 1, 2, 3 ], isPositive, {}, 3 ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index cdfb9a7..0000000 --- a/examples/index.js +++ /dev/null @@ -1,35 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 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'; - -var discreteUniform = require( '@stdlib/random-array-discrete-uniform' ); -var isPositiveInteger = require( '@stdlib/assert-is-positive-integer' ).isPrimitive; -var naryFunction = require( '@stdlib/utils-nary-function' ); -var filter = require( './../lib' ); - -var x = discreteUniform( 10, -5, 5, { - 'dtype': 'int32' -}); -// returns - -var out = filter( x, naryFunction( isPositiveInteger, 1 ) ); -// returns - -console.log( x ); -console.log( out ); diff --git a/docs/types/index.d.ts b/index.d.ts similarity index 99% rename from docs/types/index.d.ts rename to index.d.ts index 0f92cfd..1fa8dc7 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 4.1 -/// +/// import { Collection, AccessorArrayLike, Complex128Array, Complex64Array } from '@stdlib/types/array'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..a10870c --- /dev/null +++ b/index.mjs @@ -0,0 +1,4 @@ +// Copyright (c) 2024 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 +/// +import r from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-arraylike2object@v0.2.1-esm/index.mjs";function t(t,e,n){var o;return function(r,t){return"function"==typeof r[t]}(t,"filter")?t.filter(e,n):(o=r(t)).accessorProtocol?function(r,t,e){var n,o,a,s,c;for(n=r.data,o=r.accessors[0],a=[],c=0;c 0;\n* }\n*\n* var x = [ 1, -2, -3, 4 ];\n*\n* var out = internal( x, isPositive );\n* // returns [ 1, 4 ]\n*/\nfunction internal( x, predicate, thisArg ) {\n\tvar out;\n\tvar v;\n\tvar i;\n\n\tout = [];\n\tfor ( i = 0; i < x.length; i++ ) {\n\t\tv = x[ i ];\n\t\tif ( predicate.call( thisArg, v, i, x ) ) {\n\t\t\tout.push( v );\n\t\t}\n\t}\n\treturn out;\n}\n\n/**\n* Returns a shallow copy of an array containing only those elements which pass a test implemented by a predicate function.\n*\n* @private\n* @param {Object} x - input array object\n* @param {Function} predicate - test function\n* @param {*} thisArg - execution context\n* @returns {Array} output array\n*\n* @example\n* import toAccessorArray from '@stdlib/array-base-to-accessor-array';\n* import arraylike2object from '@stdlib/array-base-arraylike2object';\n*\n* function isPositive( v ) {\n* return v > 0;\n* }\n*\n* var x = arraylike2object( toAccessorArray( [ 1, -2, -3, 4 ] ) );\n*\n* var out = accessors( x, isPositive );\n* // returns [ 1, 4 ]\n*/\nfunction accessors( x, predicate, thisArg ) {\n\tvar data;\n\tvar get;\n\tvar out;\n\tvar v;\n\tvar i;\n\n\tdata = x.data;\n\tget = x.accessors[ 0 ];\n\n\tout = [];\n\tfor ( i = 0; i < data.length; i++ ) {\n\t\tv = get( data, i );\n\t\tif ( predicate.call( thisArg, v, i, data ) ) {\n\t\t\tout.push( v );\n\t\t}\n\t}\n\treturn out;\n}\n\n\n// MAIN //\n\n/**\n* Returns a shallow copy of an array containing only those elements which pass a test implemented by a predicate function.\n*\n* @param {Collection} x - input array\n* @param {Function} predicate - test function\n* @param {*} [thisArg] - execution context\n* @returns {Collection} output array\n*\n* @example\n* function isPositive( v ) {\n* return v > 0;\n* }\n*\n* var x = [ 1, -2, -3, 4 ];\n*\n* var out = filter( x, isPositive );\n* // returns [ 1, 4 ]\n*/\nfunction filter( x, predicate, thisArg ) {\n\tvar obj;\n\tif ( hasMethod( x, 'filter' ) ) {\n\t\treturn x.filter( predicate, thisArg );\n\t}\n\tobj = arraylike2object( x );\n\tif ( obj.accessorProtocol ) {\n\t\treturn accessors( obj, predicate, thisArg );\n\t}\n\treturn internal( x, predicate, thisArg );\n}\n\n\n// EXPORTS //\n\nexport default filter;\n"],"names":["filter","x","predicate","thisArg","obj","method","hasMethod","arraylike2object","accessorProtocol","data","get","out","v","i","accessors","length","call","push","internal"],"mappings":";;sGAgJA,SAASA,EAAQC,EAAGC,EAAWC,GAC9B,IAAIC,EACJ,OAvGD,SAAoBA,EAAKC,GACxB,MAAkC,mBAAlBD,EAAKC,EACtB,CAqGMC,CAAWL,EAAG,UACXA,EAAED,OAAQE,EAAWC,IAE7BC,EAAMG,EAAkBN,IACfO,iBA/CV,SAAoBP,EAAGC,EAAWC,GACjC,IAAIM,EACAC,EACAC,EACAC,EACAC,EAMJ,IAJAJ,EAAOR,EAAEQ,KACTC,EAAMT,EAAEa,UAAW,GAEnBH,EAAM,GACAE,EAAI,EAAGA,EAAIJ,EAAKM,OAAQF,IAC7BD,EAAIF,EAAKD,EAAMI,GACVX,EAAUc,KAAMb,EAASS,EAAGC,EAAGJ,IACnCE,EAAIM,KAAML,GAGZ,OAAOD,CACR,CA8BSG,CAAWV,EAAKF,EAAWC,GArFpC,SAAmBF,EAAGC,EAAWC,GAChC,IAAIQ,EACAC,EACAC,EAGJ,IADAF,EAAM,GACAE,EAAI,EAAGA,EAAIZ,EAAEc,OAAQF,IAC1BD,EAAIX,EAAGY,GACFX,EAAUc,KAAMb,EAASS,EAAGC,EAAGZ,IACnCU,EAAIM,KAAML,GAGZ,OAAOD,CACR,CA0EQO,CAAUjB,EAAGC,EAAWC,EAChC"} \ No newline at end of file diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index 56236cd..0000000 --- a/lib/index.js +++ /dev/null @@ -1,46 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 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'; - -/** -* Return a shallow copy of an array containing only those elements which pass a test implemented by a predicate function. -* -* @module @stdlib/array-base-filter -* -* @example -* var filter = require( '@stdlib/array-base-filter' ); -* -* function isPositive( v ) { -* return v > 0; -* } -* -* var x = [ 1, -2, -3, 4 ]; -* -* var out = filter( x, isPositive ); -* // returns [ 1, 4 ] -*/ - -// MODULES // - -var main = require( './main.js' ); - - -// EXPORTS // - -module.exports = main; diff --git a/lib/main.js b/lib/main.js deleted file mode 100644 index 9b0c3db..0000000 --- a/lib/main.js +++ /dev/null @@ -1,160 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 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 arraylike2object = require( '@stdlib/array-base-arraylike2object' ); - - -// FUNCTIONS // - -/** -* Tests whether an object has a specified method. -* -* @private -* @param {Object} obj - input object -* @param {string} method - method name -* @returns {boolean} boolean indicating whether an object has a specified method -* -* @example -* var bool = hasMethod( [], 'filter' ); -* // returns true -* -* @example -* var bool = hasMethod( [], 'beep' ); -* // returns false -*/ -function hasMethod( obj, method ) { - return ( typeof obj[ method ] === 'function' ); -} - -/** -* Returns a shallow copy of an array containing only those elements which pass a test implemented by a predicate function. -* -* @private -* @param {Collection} x - input array -* @param {Function} predicate - test function -* @param {*} thisArg - execution context -* @returns {Array} output array -* -* @example -* function isPositive( v ) { -* return v > 0; -* } -* -* var x = [ 1, -2, -3, 4 ]; -* -* var out = internal( x, isPositive ); -* // returns [ 1, 4 ] -*/ -function internal( x, predicate, thisArg ) { - var out; - var v; - var i; - - out = []; - for ( i = 0; i < x.length; i++ ) { - v = x[ i ]; - if ( predicate.call( thisArg, v, i, x ) ) { - out.push( v ); - } - } - return out; -} - -/** -* Returns a shallow copy of an array containing only those elements which pass a test implemented by a predicate function. -* -* @private -* @param {Object} x - input array object -* @param {Function} predicate - test function -* @param {*} thisArg - execution context -* @returns {Array} output array -* -* @example -* var toAccessorArray = require( '@stdlib/array-base-to-accessor-array' ); -* var arraylike2object = require( '@stdlib/array-base-arraylike2object' ); -* -* function isPositive( v ) { -* return v > 0; -* } -* -* var x = arraylike2object( toAccessorArray( [ 1, -2, -3, 4 ] ) ); -* -* var out = accessors( x, isPositive ); -* // returns [ 1, 4 ] -*/ -function accessors( x, predicate, thisArg ) { - var data; - var get; - var out; - var v; - var i; - - data = x.data; - get = x.accessors[ 0 ]; - - out = []; - for ( i = 0; i < data.length; i++ ) { - v = get( data, i ); - if ( predicate.call( thisArg, v, i, data ) ) { - out.push( v ); - } - } - return out; -} - - -// MAIN // - -/** -* Returns a shallow copy of an array containing only those elements which pass a test implemented by a predicate function. -* -* @param {Collection} x - input array -* @param {Function} predicate - test function -* @param {*} [thisArg] - execution context -* @returns {Collection} output array -* -* @example -* function isPositive( v ) { -* return v > 0; -* } -* -* var x = [ 1, -2, -3, 4 ]; -* -* var out = filter( x, isPositive ); -* // returns [ 1, 4 ] -*/ -function filter( x, predicate, thisArg ) { - var obj; - if ( hasMethod( x, 'filter' ) ) { - return x.filter( predicate, thisArg ); - } - obj = arraylike2object( x ); - if ( obj.accessorProtocol ) { - return accessors( obj, predicate, thisArg ); - } - return internal( x, predicate, thisArg ); -} - - -// EXPORTS // - -module.exports = filter; diff --git a/package.json b/package.json index d836e77..222dce3 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.2.1", "description": "Return a shallow copy of an array containing only those elements which pass a test implemented by a predicate function.", "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", - "directories": { - "benchmark": "./benchmark", - "doc": "./docs", - "example": "./examples", - "lib": "./lib", - "test": "./test" - }, - "types": "./docs/types", - "scripts": { - "test": "make test", - "test-cov": "make test-cov", - "examples": "make examples", - "benchmark": "make benchmark" - }, + "type": "module", + "main": "./index.mjs", "homepage": "https://stdlib.io", "repository": { "type": "git", @@ -36,42 +13,6 @@ "bugs": { "url": "https://github.com/stdlib-js/stdlib/issues" }, - "dependencies": { - "@stdlib/array-base-arraylike2object": "^0.2.1", - "@stdlib/types": "^0.3.2", - "@stdlib/error-tools-fmtprodmsg": "^0.2.1" - }, - "devDependencies": { - "@stdlib/array-base-accessor": "^0.2.1", - "@stdlib/array-base-zero-to": "^0.2.1", - "@stdlib/array-float64": "^0.2.1", - "@stdlib/assert-instance-of": "^0.2.1", - "@stdlib/assert-is-array": "^0.2.1", - "@stdlib/assert-is-nonnegative-integer": "^0.2.1", - "@stdlib/assert-is-positive-integer": "^0.2.1", - "@stdlib/math-base-special-pow": "^0.2.1", - "@stdlib/random-array-discrete-uniform": "^0.2.1", - "@stdlib/utils-nary-function": "^0.2.1", - "tape": "git+https://github.com/kgryte/tape.git#fix/globby", - "istanbul": "^0.4.1", - "tap-min": "git+https://github.com/Planeshifter/tap-min.git", - "@stdlib/bench-harness": "^0.2.1" - }, - "engines": { - "node": ">=0.10.0", - "npm": ">2.7.0" - }, - "os": [ - "aix", - "darwin", - "freebsd", - "linux", - "macos", - "openbsd", - "sunos", - "win32", - "windows" - ], "keywords": [ "stdlib", "stdtypes", @@ -91,4 +32,4 @@ "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} \ No newline at end of file +} diff --git a/stats.html b/stats.html new file mode 100644 index 0000000..d4d08f0 --- /dev/null +++ b/stats.html @@ -0,0 +1,4842 @@ + + + + + + + + Rollup Visualizer + + + +
+ + + + + diff --git a/test/dist/test.js b/test/dist/test.js deleted file mode 100644 index a8a9c60..0000000 --- a/test/dist/test.js +++ /dev/null @@ -1,33 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 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 tape = require( 'tape' ); -var main = require( './../../dist' ); - - -// TESTS // - -tape( 'main export is defined', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( main !== void 0, true, 'main export is defined' ); - t.end(); -}); diff --git a/test/test.js b/test/test.js deleted file mode 100644 index d4e7373..0000000 --- a/test/test.js +++ /dev/null @@ -1,251 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 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 tape = require( 'tape' ); -var AccessorArray = require( '@stdlib/array-base-accessor' ); -var Float64Array = require( '@stdlib/array-float64' ); -var instanceOf = require( '@stdlib/assert-instance-of' ); -var filter = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Tests whether a value is positive. -* -* @private -* @param {number} value - input value -* @returns {boolean} boolean indicating if a value is positive -*/ -function isPositive( value ) { - return ( value > 0 ); -} - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof filter, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'if provided an empty collection, the function returns an empty collection (generic)', function test( t ) { - var expected; - var actual; - var arr; - - arr = []; - expected = []; - actual = filter( arr, foo ); - - t.strictEqual( instanceOf( actual, Array ), true, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - t.end(); - - function foo() { - t.fail( 'should not be invoked' ); - } -}); - -tape( 'if provided an empty collection, the function returns an empty collection (typed array)', function test( t ) { - var expected; - var actual; - var arr; - - arr = new Float64Array( [] ); - expected = new Float64Array( [] ); - actual = filter( arr, foo ); - - t.strictEqual( instanceOf( actual, Float64Array ), true, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - t.end(); - - function foo() { - t.fail( 'should not be invoked' ); - } -}); - -tape( 'if provided an empty collection, the function returns an empty collection (accessor)', function test( t ) { - var expected; - var actual; - var arr; - - arr = new AccessorArray( [] ); - expected = []; - actual = filter( arr, foo ); - - t.strictEqual( instanceOf( actual, Array ), true, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - t.end(); - - function foo() { - t.fail( 'should not be invoked' ); - } -}); - -tape( 'the function filters a provided collection (generic)', function test( t ) { - var expected; - var actual; - var arr; - - arr = [ 1, -2, 3 ]; - expected = [ 1, 3 ]; - actual = filter( arr, isPositive ); - - t.strictEqual( instanceOf( actual, Array ), true, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - t.end(); -}); - -tape( 'the function filters a provided collection (typed array)', function test( t ) { - var expected; - var actual; - var arr; - - arr = new Float64Array( [ -1.0, 2.0, 3.0 ] ); - expected = new Float64Array( [ 2.0, 3.0 ] ); - actual = filter( arr, isPositive ); - - t.strictEqual( instanceOf( actual, Float64Array ), true, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - t.end(); -}); - -tape( 'the function filters a provided collection (accessor)', function test( t ) { - var expected; - var actual; - var arr; - - arr = new AccessorArray( [ 1, -2, -3 ] ); - expected = [ 1 ]; - actual = filter( arr, isPositive ); - - t.strictEqual( instanceOf( actual, Array ), true, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - t.end(); -}); - -tape( 'the function filters a provided collection (array-like object)', function test( t ) { - var expected; - var actual; - var arr; - - arr = { - 'length': 3, - '0': -1, - '1': -2, - '2': 3 - }; - expected = [ 3 ]; - actual = filter( arr, isPositive ); - - t.strictEqual( instanceOf( actual, Array ), true, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - t.end(); -}); - -tape( 'the function an empty collection if all elements fail a test (generic)', function test( t ) { - var expected; - var actual; - var arr; - - arr = [ -1, -2, -3 ]; - expected = []; - actual = filter( arr, isPositive ); - - t.strictEqual( instanceOf( actual, Array ), true, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - t.end(); -}); - -tape( 'the function an empty collection if all elements fail a test (typed array)', function test( t ) { - var expected; - var actual; - var arr; - - arr = new Float64Array( [ -1.0, -2.0, -3.0 ] ); - expected = new Float64Array( [] ); - actual = filter( arr, isPositive ); - - t.strictEqual( instanceOf( actual, Float64Array ), true, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - t.end(); -}); - -tape( 'the function an empty collection if all elements fail a test (accessor)', function test( t ) { - var expected; - var actual; - var arr; - - arr = new AccessorArray( [ -1, -2, -3 ] ); - expected = []; - actual = filter( arr, isPositive ); - - t.strictEqual( instanceOf( actual, Array ), true, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - t.end(); -}); - -tape( 'the function an empty collection if all elements fail a test (array-like object)', function test( t ) { - var expected; - var actual; - var arr; - - arr = { - 'length': 3, - '0': -1, - '1': -2, - '2': -3 - }; - expected = []; - actual = filter( arr, isPositive ); - - t.strictEqual( instanceOf( actual, Array ), true, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - t.end(); -}); - -tape( 'the function supports providing an execution context', function test( t ) { - var expected; - var actual; - var ctx; - var arr; - - ctx = { - 'count': 0 - }; - arr = [ 1, 2, 3 ]; - expected = [ 1, 2, 3 ]; - actual = filter( arr, predicate, ctx ); - - t.strictEqual( instanceOf( actual, Array ), true, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - t.strictEqual( ctx.count, arr.length, 'returns expected value' ); - - t.end(); - - function predicate( value ) { - this.count += 1; // eslint-disable-line no-invalid-this - return ( value > 0 ); - } -}); From 5832def598218a92ee8eae91b9504bd80ecf2e8b Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Fri, 12 Apr 2024 04:39:41 +0000 Subject: [PATCH 21/40] Transform error messages --- package.json | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/package.json b/package.json index 355145c..d836e77 100644 --- a/package.json +++ b/package.json @@ -38,7 +38,8 @@ }, "dependencies": { "@stdlib/array-base-arraylike2object": "^0.2.1", - "@stdlib/types": "^0.3.2" + "@stdlib/types": "^0.3.2", + "@stdlib/error-tools-fmtprodmsg": "^0.2.1" }, "devDependencies": { "@stdlib/array-base-accessor": "^0.2.1", @@ -90,4 +91,4 @@ "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} +} \ No newline at end of file From cb4a24b74d13530e82ca4d74c08d66aee0163ead Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Fri, 12 Apr 2024 10:24:45 +0000 Subject: [PATCH 22/40] Remove files --- index.d.ts | 343 ---- index.mjs | 4 - index.mjs.map | 1 - stats.html | 4842 ------------------------------------------------- 4 files changed, 5190 deletions(-) delete mode 100644 index.d.ts delete mode 100644 index.mjs delete mode 100644 index.mjs.map delete mode 100644 stats.html diff --git a/index.d.ts b/index.d.ts deleted file mode 100644 index 1fa8dc7..0000000 --- a/index.d.ts +++ /dev/null @@ -1,343 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2024 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 - -/// - -import { Collection, AccessorArrayLike, Complex128Array, Complex64Array } from '@stdlib/types/array'; - -/** -* Returns a boolean indicating whether an element passes a test. -* -* @returns boolean indicating whether an element passes a test -*/ -type Nullary = ( this: U ) => boolean; - -/** -* Returns a boolean indicating whether an element passes a test. -* -* @param value - current array element -* @returns boolean indicating whether an element passes a test -*/ -type Unary = ( this: U, value: T ) => boolean; - -/** -* Returns a boolean indicating whether an element passes a test. -* -* @param value - current array element -* @param index - current array element index -* @returns boolean indicating whether an element passes a test -*/ -type Binary = ( this: U, value: T, index: number ) => boolean; - -/** -* Returns a boolean indicating whether an element passes a test. -* -* @param value - current array element -* @param index - current array element index -* @param arr - input array -* @returns boolean indicating whether an element passes a test -*/ -type Ternary = ( this: U, value: T, index: number, arr: V ) => boolean; - -/** -* Returns a boolean indicating whether an element passes a test. -* -* @param value - current array element -* @param index - current array element index -* @param arr - input array -* @returns boolean indicating whether an element passes a test -*/ -type Predicate = Nullary | Unary | Binary | Ternary; - -/** -* Returns a shallow copy of an array containing only those elements which pass a test implemented by a predicate function. -* -* @param x - input array -* @param predicate - predicate function -* @param thisArg - predicate function execution context -* @returns output array -* -* @example -* var isPositiveNumber = require( '@stdlib/assert-is-positive-number' ).isPrimitive; -* var Float64Array = require( '@stdlib/array-float64' ); -* -* var x = new Float64Array( [ 1.0, -2.0, -3.0, 4.0 ] ); -* -* var out = filter( x, isPositiveNumber ); -* // returns [ 1.0, 4.0 ] -*/ -declare function filter( x: Float64Array, predicate: Predicate, thisArg?: ThisParameterType> ): Float64Array; - -/** -* Returns a shallow copy of an array containing only those elements which pass a test implemented by a predicate function. -* -* @param x - input array -* @param predicate - predicate function -* @param thisArg - predicate function execution context -* @returns output array -* -* @example -* var isPositiveNumber = require( '@stdlib/assert-is-positive-number' ).isPrimitive; -* var Float32Array = require( '@stdlib/array-float32' ); -* -* var x = new Float32Array( [ 1.0, -2.0, -3.0, 4.0 ] ); -* -* var out = filter( x, isPositiveNumber ); -* // returns [ 1.0, 4.0 ] -*/ -declare function filter( x: Float32Array, predicate: Predicate, thisArg?: ThisParameterType> ): Float32Array; - -/** -* Returns a shallow copy of an array containing only those elements which pass a test implemented by a predicate function. -* -* @param x - input array -* @param predicate - predicate function -* @param thisArg - predicate function execution context -* @returns output array -* -* @example -* var isPositiveNumber = require( '@stdlib/assert-is-positive-number' ).isPrimitive; -* var Int32Array = require( '@stdlib/array-int32' ); -* -* var x = new Int32Array( [ 1, -2, -3, 4 ] ); -* -* var out = filter( x, isPositiveNumber ); -* // returns [ 1, 4 ] -*/ -declare function filter( x: Int32Array, predicate: Predicate, thisArg?: ThisParameterType> ): Int32Array; - -/** -* Returns a shallow copy of an array containing only those elements which pass a test implemented by a predicate function. -* -* @param x - input array -* @param predicate - predicate function -* @param thisArg - predicate function execution context -* @returns output array -* -* @example -* var isPositiveNumber = require( '@stdlib/assert-is-positive-number' ).isPrimitive; -* var Int16Array = require( '@stdlib/array-int16' ); -* -* var x = new Int16Array( [ 1, -2, -3, 4 ] ); -* -* var out = filter( x, isPositiveNumber ); -* // returns [ 1, 4 ] -*/ -declare function filter( x: Int16Array, predicate: Predicate, thisArg?: ThisParameterType> ): Int16Array; - -/** -* Returns a shallow copy of an array containing only those elements which pass a test implemented by a predicate function. -* -* @param x - input array -* @param predicate - predicate function -* @param thisArg - predicate function execution context -* @returns output array -* -* @example -* var isPositiveNumber = require( '@stdlib/assert-is-positive-number' ).isPrimitive; -* var Int8Array = require( '@stdlib/array-int8' ); -* -* var x = new Int8Array( [ 1, -2, -3, 4 ] ); -* -* var out = filter( x, isPositiveNumber ); -* // returns [ 1, 4 ] -*/ -declare function filter( x: Int8Array, predicate: Predicate, thisArg?: ThisParameterType> ): Int8Array; - -/** -* Returns a shallow copy of an array containing only those elements which pass a test implemented by a predicate function. -* -* @param x - input array -* @param predicate - predicate function -* @param thisArg - predicate function execution context -* @returns output array -* -* @example -* var isPositiveNumber = require( '@stdlib/assert-is-positive-number' ).isPrimitive; -* var Uint32Array = require( '@stdlib/array-uint32' ); -* -* var x = new Uint32Array( [ 1, 2, 3, 4 ] ); -* -* var out = filter( x, isPositiveNumber ); -* // returns [ 1, 2, 3, 4 ] -*/ -declare function filter( x: Uint32Array, predicate: Predicate, thisArg?: ThisParameterType> ): Uint32Array; - -/** -* Returns a shallow copy of an array containing only those elements which pass a test implemented by a predicate function. -* -* @param x - input array -* @param predicate - predicate function -* @param thisArg - predicate function execution context -* @returns output array -* -* @example -* var isPositiveNumber = require( '@stdlib/assert-is-positive-number' ).isPrimitive; -* var Uint16Array = require( '@stdlib/array-uint16' ); -* -* var x = new Uint16Array( [ 1, 2, 3, 4 ] ); -* -* var out = filter( x, isPositiveNumber ); -* // returns [ 1, 2, 3, 4 ] -*/ -declare function filter( x: Uint16Array, predicate: Predicate, thisArg?: ThisParameterType> ): Uint16Array; - -/** -* Returns a shallow copy of an array containing only those elements which pass a test implemented by a predicate function. -* -* @param x - input array -* @param predicate - predicate function -* @param thisArg - predicate function execution context -* @returns output array -* -* @example -* var isPositiveNumber = require( '@stdlib/assert-is-positive-number' ).isPrimitive; -* var Uint8Array = require( '@stdlib/array-uint8' ); -* -* var x = new Uint8Array( [ 1, 2, 3, 4 ] ); -* -* var out = filter( x, isPositiveNumber ); -* // returns [ 1, 2, 3, 4 ] -*/ -declare function filter( x: Uint8Array, predicate: Predicate, thisArg?: ThisParameterType> ): Uint8Array; - -/** -* Returns a shallow copy of an array containing only those elements which pass a test implemented by a predicate function. -* -* @param x - input array -* @param predicate - predicate function -* @param thisArg - predicate function execution context -* @returns output array -* -* @example -* var isPositiveNumber = require( '@stdlib/assert-is-positive-number' ).isPrimitive; -* var Uint8ClampedArray = require( '@stdlib/array-uint8c' ); -* -* var x = new Uint8ClampedArray( [ 1, 2, 3, 4 ] ); -* -* var out = filter( x, isPositiveNumber ); -* // returns [ 1, 2, 3, 4 ] -*/ -declare function filter( x: Uint8ClampedArray, predicate: Predicate, thisArg?: ThisParameterType> ): Uint8ClampedArray; - -/** -* Returns a shallow copy of an array containing only those elements which pass a test implemented by a predicate function. -* -* @param x - input array -* @param predicate - predicate function -* @param thisArg - predicate function execution context -* @returns output array -* -* @example -* var isPositiveNumber = require( '@stdlib/assert-is-positive-number' ).isPrimitive; -* var real = require( '@stdlib/complex-real' ); -* var imag = require( '@stdlib/complex-imag' ); -* var Complex128Array = require( '@stdlib/array-complex128' ); -* -* function predicate( v ) { -* return ( isPositiveNumber( real( v ) ) && isPositiveNumber( imag( v ) ) ); -* } -* -* var x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0 ] ); -* -* var out = filter( x, predicate ); -* // returns -*/ -declare function filter( x: Complex128Array, predicate: Predicate, thisArg?: ThisParameterType> ): Complex128Array; - -/** -* Returns a shallow copy of an array containing only those elements which pass a test implemented by a predicate function. -* -* @param x - input array -* @param predicate - predicate function -* @param thisArg - predicate function execution context -* @returns output array -* -* @example -* var isPositiveNumber = require( '@stdlib/assert-is-positive-number' ).isPrimitive; -* var realf = require( '@stdlib/complex-realf' ); -* var imagf = require( '@stdlib/complex-imagf' ); -* var Complex64Array = require( '@stdlib/array-complex64' ); -* -* function predicate( v ) { -* return ( isPositiveNumber( realf( v ) ) && isPositiveNumber( imagf( v ) ) ); -* } -* -* var x = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); -* -* var out = filter( x, predicate ); -* // returns -*/ -declare function filter( x: Complex64Array, predicate: Predicate, thisArg?: ThisParameterType> ): Complex64Array; - -/** -* Returns a shallow copy of an array containing only those elements which pass a test implemented by a predicate function. -* -* @param x - input array -* @param predicate - predicate function -* @param thisArg - predicate function execution context -* @returns output array -* -* @example -* var x = [ 1, -2, -3, 4 ]; -* -* var out = filter( x, isPositiveNumber ); -* // returns [ 1, 4 ] -*/ -declare function filter( x: Array, predicate: Predicate>, thisArg?: ThisParameterType>> ): Array; - -/** -* Returns a shallow copy of an array containing only those elements which pass a test implemented by a predicate function. -* -* @param x - input array -* @param predicate - predicate function -* @param thisArg - predicate function execution context -* @returns output array -* -* @example -* var toAccessorArray = require( '@stdlib/array-base-to-accessor-array' ); -* -* var x = toAccessorArray( [ 1, -2, -3, 4 ] ); -* -* var out = filter( x, isPositiveNumber ); -* // returns [ 1, 4 ] -*/ -declare function filter( x: AccessorArrayLike, predicate: Predicate>, thisArg?: ThisParameterType>> ): Array; - -/** -* Returns a shallow copy of an array containing only those elements which pass a test implemented by a predicate function. -* -* @param x - input array -* @param predicate - predicate function -* @param thisArg - predicate function execution context -* @returns output array -* -* @example -* var x = [ 1, -2, -3, 4 ]; -* -* var out = filter( x, isPositiveNumber ); -* // returns [ 1, 4 ] -*/ -declare function filter( x: Collection, predicate: Predicate>, thisArg?: ThisParameterType>> ): Array; - - -// EXPORTS // - -export = filter; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index a10870c..0000000 --- a/index.mjs +++ /dev/null @@ -1,4 +0,0 @@ -// Copyright (c) 2024 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 -/// -import r from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-arraylike2object@v0.2.1-esm/index.mjs";function t(t,e,n){var o;return function(r,t){return"function"==typeof r[t]}(t,"filter")?t.filter(e,n):(o=r(t)).accessorProtocol?function(r,t,e){var n,o,a,s,c;for(n=r.data,o=r.accessors[0],a=[],c=0;c 0;\n* }\n*\n* var x = [ 1, -2, -3, 4 ];\n*\n* var out = internal( x, isPositive );\n* // returns [ 1, 4 ]\n*/\nfunction internal( x, predicate, thisArg ) {\n\tvar out;\n\tvar v;\n\tvar i;\n\n\tout = [];\n\tfor ( i = 0; i < x.length; i++ ) {\n\t\tv = x[ i ];\n\t\tif ( predicate.call( thisArg, v, i, x ) ) {\n\t\t\tout.push( v );\n\t\t}\n\t}\n\treturn out;\n}\n\n/**\n* Returns a shallow copy of an array containing only those elements which pass a test implemented by a predicate function.\n*\n* @private\n* @param {Object} x - input array object\n* @param {Function} predicate - test function\n* @param {*} thisArg - execution context\n* @returns {Array} output array\n*\n* @example\n* import toAccessorArray from '@stdlib/array-base-to-accessor-array';\n* import arraylike2object from '@stdlib/array-base-arraylike2object';\n*\n* function isPositive( v ) {\n* return v > 0;\n* }\n*\n* var x = arraylike2object( toAccessorArray( [ 1, -2, -3, 4 ] ) );\n*\n* var out = accessors( x, isPositive );\n* // returns [ 1, 4 ]\n*/\nfunction accessors( x, predicate, thisArg ) {\n\tvar data;\n\tvar get;\n\tvar out;\n\tvar v;\n\tvar i;\n\n\tdata = x.data;\n\tget = x.accessors[ 0 ];\n\n\tout = [];\n\tfor ( i = 0; i < data.length; i++ ) {\n\t\tv = get( data, i );\n\t\tif ( predicate.call( thisArg, v, i, data ) ) {\n\t\t\tout.push( v );\n\t\t}\n\t}\n\treturn out;\n}\n\n\n// MAIN //\n\n/**\n* Returns a shallow copy of an array containing only those elements which pass a test implemented by a predicate function.\n*\n* @param {Collection} x - input array\n* @param {Function} predicate - test function\n* @param {*} [thisArg] - execution context\n* @returns {Collection} output array\n*\n* @example\n* function isPositive( v ) {\n* return v > 0;\n* }\n*\n* var x = [ 1, -2, -3, 4 ];\n*\n* var out = filter( x, isPositive );\n* // returns [ 1, 4 ]\n*/\nfunction filter( x, predicate, thisArg ) {\n\tvar obj;\n\tif ( hasMethod( x, 'filter' ) ) {\n\t\treturn x.filter( predicate, thisArg );\n\t}\n\tobj = arraylike2object( x );\n\tif ( obj.accessorProtocol ) {\n\t\treturn accessors( obj, predicate, thisArg );\n\t}\n\treturn internal( x, predicate, thisArg );\n}\n\n\n// EXPORTS //\n\nexport default filter;\n"],"names":["filter","x","predicate","thisArg","obj","method","hasMethod","arraylike2object","accessorProtocol","data","get","out","v","i","accessors","length","call","push","internal"],"mappings":";;sGAgJA,SAASA,EAAQC,EAAGC,EAAWC,GAC9B,IAAIC,EACJ,OAvGD,SAAoBA,EAAKC,GACxB,MAAkC,mBAAlBD,EAAKC,EACtB,CAqGMC,CAAWL,EAAG,UACXA,EAAED,OAAQE,EAAWC,IAE7BC,EAAMG,EAAkBN,IACfO,iBA/CV,SAAoBP,EAAGC,EAAWC,GACjC,IAAIM,EACAC,EACAC,EACAC,EACAC,EAMJ,IAJAJ,EAAOR,EAAEQ,KACTC,EAAMT,EAAEa,UAAW,GAEnBH,EAAM,GACAE,EAAI,EAAGA,EAAIJ,EAAKM,OAAQF,IAC7BD,EAAIF,EAAKD,EAAMI,GACVX,EAAUc,KAAMb,EAASS,EAAGC,EAAGJ,IACnCE,EAAIM,KAAML,GAGZ,OAAOD,CACR,CA8BSG,CAAWV,EAAKF,EAAWC,GArFpC,SAAmBF,EAAGC,EAAWC,GAChC,IAAIQ,EACAC,EACAC,EAGJ,IADAF,EAAM,GACAE,EAAI,EAAGA,EAAIZ,EAAEc,OAAQF,IAC1BD,EAAIX,EAAGY,GACFX,EAAUc,KAAMb,EAASS,EAAGC,EAAGZ,IACnCU,EAAIM,KAAML,GAGZ,OAAOD,CACR,CA0EQO,CAAUjB,EAAGC,EAAWC,EAChC"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index d4d08f0..0000000 --- a/stats.html +++ /dev/null @@ -1,4842 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From dea0495a90e6e7348236bea0e37bdb37de4b0491 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Fri, 12 Apr 2024 10:25:01 +0000 Subject: [PATCH 23/40] Auto-generated commit --- .editorconfig | 181 - .eslintrc.js | 1 - .gitattributes | 49 - .github/PULL_REQUEST_TEMPLATE.md | 7 - .github/workflows/benchmark.yml | 64 - .github/workflows/cancel.yml | 57 - .github/workflows/close_pull_requests.yml | 54 - .github/workflows/examples.yml | 64 - .github/workflows/npm_downloads.yml | 112 - .github/workflows/productionize.yml | 797 ---- .github/workflows/publish.yml | 249 -- .github/workflows/test.yml | 100 - .github/workflows/test_bundles.yml | 189 - .github/workflows/test_coverage.yml | 134 - .github/workflows/test_install.yml | 86 - .gitignore | 188 - .npmignore | 229 - .npmrc | 31 - CHANGELOG.md | 5 - CITATION.cff | 30 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 --- README.md | 41 +- SECURITY.md | 5 - benchmark/benchmark.length.js | 97 - branches.md | 56 - dist/index.d.ts | 3 - dist/index.js | 5 - dist/index.js.map | 7 - docs/repl.txt | 46 - docs/types/test.ts | 101 - examples/index.js | 35 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/index.js | 46 - lib/main.js | 160 - package.json | 65 +- stats.html | 4842 +++++++++++++++++++++ test/dist/test.js | 33 - test/test.js | 251 -- 42 files changed, 4867 insertions(+), 4100 deletions(-) delete mode 100644 .editorconfig delete mode 100644 .eslintrc.js delete mode 100644 .gitattributes delete mode 100644 .github/PULL_REQUEST_TEMPLATE.md delete mode 100644 .github/workflows/benchmark.yml delete mode 100644 .github/workflows/cancel.yml delete mode 100644 .github/workflows/close_pull_requests.yml delete mode 100644 .github/workflows/examples.yml delete mode 100644 .github/workflows/npm_downloads.yml delete mode 100644 .github/workflows/productionize.yml delete mode 100644 .github/workflows/publish.yml delete mode 100644 .github/workflows/test.yml delete mode 100644 .github/workflows/test_bundles.yml delete mode 100644 .github/workflows/test_coverage.yml delete mode 100644 .github/workflows/test_install.yml delete mode 100644 .gitignore delete mode 100644 .npmignore delete mode 100644 .npmrc delete mode 100644 CHANGELOG.md delete mode 100644 CITATION.cff delete mode 100644 CODE_OF_CONDUCT.md delete mode 100644 CONTRIBUTING.md delete mode 100644 Makefile delete mode 100644 SECURITY.md delete mode 100644 benchmark/benchmark.length.js delete mode 100644 branches.md delete mode 100644 dist/index.d.ts delete mode 100644 dist/index.js delete mode 100644 dist/index.js.map delete mode 100644 docs/repl.txt delete mode 100644 docs/types/test.ts delete mode 100644 examples/index.js rename docs/types/index.d.ts => index.d.ts (99%) create mode 100644 index.mjs create mode 100644 index.mjs.map delete mode 100644 lib/index.js delete mode 100644 lib/main.js create mode 100644 stats.html delete mode 100644 test/dist/test.js delete mode 100644 test/test.js diff --git a/.editorconfig b/.editorconfig deleted file mode 100644 index 60d743f..0000000 --- a/.editorconfig +++ /dev/null @@ -1,181 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 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. -#/ - -# EditorConfig configuration file (see ). - -# Indicate that this file is a root-level configuration file: -root = true - -# Set properties for all files: -[*] -end_of_line = lf -charset = utf-8 -trim_trailing_whitespace = true -insert_final_newline = true - -# Set properties for JavaScript files: -[*.{js,js.txt}] -indent_style = tab - -# Set properties for JavaScript ES module files: -[*.{mjs,mjs.txt}] -indent_style = tab - -# Set properties for JavaScript CommonJS files: -[*.{cjs,cjs.txt}] -indent_style = tab - -# Set properties for JSON files: -[*.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `cli_opts.json` files: -[cli_opts.json] -indent_style = tab - -# Set properties for TypeScript files: -[*.ts] -indent_style = tab - -# Set properties for Python files: -[*.{py,py.txt}] -indent_style = space -indent_size = 4 - -# Set properties for Julia files: -[*.{jl,jl.txt}] -indent_style = tab - -# Set properties for R files: -[*.{R,R.txt}] -indent_style = tab - -# Set properties for C files: -[*.{c,c.txt}] -indent_style = tab - -# Set properties for C header files: -[*.{h,h.txt}] -indent_style = tab - -# Set properties for C++ files: -[*.{cpp,cpp.txt}] -indent_style = tab - -# Set properties for C++ header files: -[*.{hpp,hpp.txt}] -indent_style = tab - -# Set properties for Fortran files: -[*.{f,f.txt}] -indent_style = space -indent_size = 2 -insert_final_newline = false - -# Set properties for shell files: -[*.{sh,sh.txt}] -indent_style = tab - -# Set properties for AWK files: -[*.{awk,awk.txt}] -indent_style = tab - -# Set properties for HTML files: -[*.{html,html.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for XML files: -[*.{xml,xml.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for CSS files: -[*.{css,css.txt}] -indent_style = tab - -# Set properties for Makefiles: -[Makefile] -indent_style = tab - -[*.{mk,mk.txt}] -indent_style = tab - -# Set properties for Markdown files: -[*.{md,md.txt}] -indent_style = space -indent_size = 4 -trim_trailing_whitespace = false - -# Set properties for `usage.txt` files: -[usage.txt] -indent_style = space -indent_size = 2 - -# Set properties for `repl.txt` files: -[repl.txt] -indent_style = space -indent_size = 4 - -# Set properties for `package.json` files: -[package.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `datapackage.json` files: -[datapackage.json] -indent_style = space -indent_size = 2 - -# Set properties for `manifest.json` files: -[manifest.json] -indent_style = space -indent_size = 2 - -# Set properties for `tsconfig.json` files: -[tsconfig.json] -indent_style = space -indent_size = 2 - -# Set properties for LaTeX files: -[*.{tex,tex.txt}] -indent_style = tab - -# Set properties for LaTeX Bibliography files: -[*.{bib,bib.txt}] -indent_style = tab - -# Set properties for YAML files: -[*.{yml,yml.txt}] -indent_style = space -indent_size = 2 - -# Set properties for GYP files: -[binding.gyp] -indent_style = space -indent_size = 2 - -[*.gypi] -indent_style = space -indent_size = 2 - -# Set properties for citation files: -[*.{cff,cff.txt}] -indent_style = space -indent_size = 2 diff --git a/.eslintrc.js b/.eslintrc.js deleted file mode 100644 index 5f30286..0000000 --- a/.eslintrc.js +++ /dev/null @@ -1 +0,0 @@ -/* For the `eslint` rules of this project, consult the main repository at https://github.com/stdlib-js/stdlib */ diff --git a/.gitattributes b/.gitattributes deleted file mode 100644 index 10a16e6..0000000 --- a/.gitattributes +++ /dev/null @@ -1,49 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 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. -#/ - -# Configuration file which assigns attributes to pathnames. -# -# [1]: https://git-scm.com/docs/gitattributes - -# Automatically normalize the line endings of any committed text files: -* text=auto - -# Override line endings for certain files on checkout: -*.crlf.csv text eol=crlf - -# Denote that certain files are binary and should not be modified: -*.png binary -*.jpg binary -*.jpeg binary -*.gif binary -*.ico binary -*.gz binary -*.zip binary -*.7z binary -*.mp3 binary -*.mp4 binary -*.mov binary - -# Override what is considered "vendored" by GitHub's linguist: -/deps/** linguist-vendored=false -/lib/node_modules/** linguist-vendored=false linguist-generated=false -test/fixtures/** linguist-vendored=false -tools/** linguist-vendored=false - -# Override what is considered "documentation" by GitHub's linguist: -examples/** linguist-documentation=false diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index 6559bc7..0000000 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ /dev/null @@ -1,7 +0,0 @@ - - -We are excited about your pull request, but unfortunately we are not accepting pull requests against this repository, as all development happens on the [main project repository](https://github.com/stdlib-js/stdlib). We kindly request that you submit this pull request against the [respective directory](https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/filter) of the main repository where we’ll review and provide feedback. - -If this is your first stdlib contribution, be sure to read the [contributing guide](https://github.com/stdlib-js/stdlib/blob/develop/CONTRIBUTING.md) which provides guidelines and instructions for submitting contributions. You may also consult the [development guide](https://github.com/stdlib-js/stdlib/blob/develop/docs/development.md) for help on developing stdlib. - -We look forward to receiving your contribution! :smiley: \ No newline at end of file diff --git a/.github/workflows/benchmark.yml b/.github/workflows/benchmark.yml deleted file mode 100644 index e4f10fe..0000000 --- a/.github/workflows/benchmark.yml +++ /dev/null @@ -1,64 +0,0 @@ -#/ -# @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. -#/ - -# Workflow name: -name: benchmark - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to run benchmarks: - benchmark: - - # Define a display name: - name: 'Run benchmarks' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Run benchmarks: - - name: 'Run benchmarks' - run: | - npm run benchmark diff --git a/.github/workflows/cancel.yml b/.github/workflows/cancel.yml deleted file mode 100644 index b5291db..0000000 --- a/.github/workflows/cancel.yml +++ /dev/null @@ -1,57 +0,0 @@ -#/ -# @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. -#/ - -# Workflow name: -name: cancel - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to cancel existing workflow runs: - cancel: - - # Define a display name: - name: 'Cancel workflow runs' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Time limit: - timeout-minutes: 3 - - # Define the sequence of job steps... - steps: - - # Cancel existing workflow runs: - - name: 'Cancel existing workflow runs' - # Pin action to full length commit SHA - uses: styfle/cancel-workflow-action@85880fa0301c86cca9da44039ee3bb12d3bedbfa # v0.12.1 - with: - workflow_id: >- - benchmark.yml, - examples.yml, - test.yml, - test_coverage.yml, - test_install.yml, - publish.yml - access_token: ${{ github.token }} diff --git a/.github/workflows/close_pull_requests.yml b/.github/workflows/close_pull_requests.yml deleted file mode 100644 index 2060eba..0000000 --- a/.github/workflows/close_pull_requests.yml +++ /dev/null @@ -1,54 +0,0 @@ -#/ -# @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. -#/ - -# Workflow name: -name: close_pull_requests - -# Workflow triggers: -on: - pull_request_target: - types: [opened] - -# Workflow jobs: -jobs: - - # Define job to close all pull requests: - run: - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - - # Close pull request - - name: 'Close pull request' - # Pin action to full length commit SHA corresponding to v3.1.2 - uses: superbrothers/close-pull-request@9c18513d320d7b2c7185fb93396d0c664d5d8448 - with: - comment: | - Thank you for submitting a pull request. :raised_hands: - - We greatly appreciate your willingness to submit a contribution. However, we are not accepting pull requests against this repository, as all development happens on the [main project repository](https://github.com/stdlib-js/stdlib). - - We kindly request that you submit this pull request against the [respective directory](https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/filter) of the main repository where we’ll review and provide feedback. If this is your first stdlib contribution, be sure to read the [contributing guide](https://github.com/stdlib-js/stdlib/blob/develop/CONTRIBUTING.md) which provides guidelines and instructions for submitting contributions. - - Thank you again, and we look forward to receiving your contribution! :smiley: - - Best, - The stdlib team \ No newline at end of file diff --git a/.github/workflows/examples.yml b/.github/workflows/examples.yml deleted file mode 100644 index 2984901..0000000 --- a/.github/workflows/examples.yml +++ /dev/null @@ -1,64 +0,0 @@ -#/ -# @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. -#/ - -# Workflow name: -name: examples - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to run the package examples... - examples: - - # Define display name: - name: 'Run examples' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - - # Checkout repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Run examples: - - name: 'Run examples' - run: | - npm run examples diff --git a/.github/workflows/npm_downloads.yml b/.github/workflows/npm_downloads.yml deleted file mode 100644 index c2326d6..0000000 --- a/.github/workflows/npm_downloads.yml +++ /dev/null @@ -1,112 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2022 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. -#/ - -# Workflow name: -name: npm_downloads - -# Workflow triggers: -on: - # Run this workflow weekly: - schedule: - # cron: ' ' - - cron: '48 12 * * 3' - - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job for retrieving npm download counts... - npm_downloads: - - # Define display name: - name: 'Retrieve npm download counts' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - timeout-minutes: 10 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Resolve package name: - - name: 'Resolve package name' - id: package_name - run: | - name=`node -e 'console.log(require("./package.json").name)' | tr -d '\n'` - echo "package_name=$name" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Fetch download data: - - name: 'Fetch data' - id: download_data - run: | - url="https://api.npmjs.org/downloads/range/$(date --date='1 year ago' '+%Y-%m-%d'):$(date '+%Y-%m-%d')/${{ steps.package_name.outputs.package_name }}" - echo "$url" - data=$(curl "$url") - mkdir ./tmp - echo "$data" > ./tmp/npm_downloads.json - echo "data=$data" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Print summary of download data: - - name: 'Print summary' - run: | - echo "| Date | Downloads |" >> $GITHUB_STEP_SUMMARY - echo "|------|------------|" >> $GITHUB_STEP_SUMMARY - cat ./tmp/npm_downloads.json | jq -r ".downloads | .[-14:] | to_entries | map(\"| \(.value.day) | \(.value.downloads) |\") |.[]" >> $GITHUB_STEP_SUMMARY - - # Upload the download data: - - name: 'Upload data' - # Pin action to full length commit SHA - uses: actions/upload-artifact@5d5d22a31266ced268874388b861e4b58bb5c2f3 # v4.3.1 - with: - # Define a name for the uploaded artifact (ensuring a unique name for each job): - name: npm_downloads - - # Specify the path to the file to upload: - path: ./tmp/npm_downloads.json - - # Specify the number of days to retain the artifact (default is 90 days): - retention-days: 90 - timeout-minutes: 10 - if: success() - - # Send data to events server: - - name: 'Post data' - # Pin action to full length commit SHA - uses: distributhor/workflow-webhook@48a40b380ce4593b6a6676528cd005986ae56629 # v3.0.3 - env: - webhook_url: ${{ secrets.STDLIB_NPM_DOWNLOADS_URL }} - webhook_secret: ${{ secrets.STDLIB_WEBHOOK_SECRET }} - data: '{ "downloads": ${{ steps.download_data.outputs.data }} }' - timeout-minutes: 5 - if: success() diff --git a/.github/workflows/productionize.yml b/.github/workflows/productionize.yml deleted file mode 100644 index ec90164..0000000 --- a/.github/workflows/productionize.yml +++ /dev/null @@ -1,797 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2022 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. -#/ - -# Workflow name: -name: productionize - -# Workflow triggers: -on: - # Run workflow when a new commit is pushed to the main branch: - push: - branches: - - main - - # Allow the workflow to be manually run: - workflow_dispatch: - inputs: - require-passing-tests: - description: 'Require passing tests for creating bundles' - type: boolean - default: true - - # Run workflow upon completion of `publish` workflow run: - workflow_run: - workflows: ["publish"] - types: [completed] - - -# Concurrency group to prevent multiple concurrent executions: -concurrency: - group: productionize - cancel-in-progress: true - -# Workflow jobs: -jobs: - - # Define a job to create a production build... - productionize: - - # Define display name: - name: 'Productionize' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Define the sequence of job steps... - steps: - # Checkout main branch of repository: - - name: 'Checkout main branch' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - with: - ref: main - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Create production branch: - - name: 'Create production branch' - run: | - git checkout -b production - - # Transform error messages: - - name: 'Transform error messages' - id: transform-error-messages - uses: stdlib-js/transform-errors-action@main - - # 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: | - PKG_VERSION=$(npm view @stdlib/error-tools-fmtprodmsg version) - if grep -q '"@stdlib/string-format"' package.json; then - sed -i "s/\"@stdlib\/string-format\": \"^.*\"/\"@stdlib\/error-tools-fmtprodmsg\": \"^$PKG_VERSION\"/g" package.json - else - node -e "var pkg = require( './package.json' ); pkg.dependencies[ '@stdlib/error-tools-fmtprodmsg' ] = '^$PKG_VERSION'; require( 'fs' ).writeFileSync( 'package.json', JSON.stringify( pkg, null, 2 ) );" - fi - - # Configure git: - - name: 'Configure git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Transform error messages" - - # Push changes: - - name: 'Push changes' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" production --force - - # Define a job for running tests of the productionized code... - test: - - # Define a display name: - name: 'Run Tests' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Indicate that this job depends on the prior job finishing: - needs: productionize - - # Run this job regardless of the outcome of the prior job: - if: always() - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout repository' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - with: - # Use the `production` branch: - ref: production - - # Install Node.js: - - name: 'Install Node.js' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Build native add-on if present: - - name: 'Build native add-on (if present)' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - run: | - if [ -f "binding.gyp" ]; then - npm install node-gyp --no-save && ./node_modules/.bin/node-gyp rebuild - fi - - # Run tests: - - name: 'Run tests' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: tests - run: | - npm test || npm test || npm test - - # Define job to create a bundle for use in Deno... - deno: - - # Define display name: - name: 'Create Deno bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Configure git: - - name: 'Configure git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `deno` branch exists: - - name: 'Check if remote `deno` branch exists' - id: deno-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin deno - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `deno` exists, delete everything in branch and merge `production` into it - - name: 'If `deno` exists, delete everything in branch and merge `production` into it' - if: steps.deno-branch-exists.outputs.remote-exists - run: | - git checkout -b deno origin/deno - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `deno` does not exist, create `deno` branch: - - name: 'If `deno` does not exist, create `deno` branch' - if: ${{ steps.deno-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b deno - - # Copy files to deno directory: - - name: 'Copy files to deno directory' - run: | - mkdir -p deno - cp README.md LICENSE CONTRIBUTORS NOTICE ./deno - - # Copy TypeScript definitions to deno directory: - if [ -d index.d.ts ]; then - cp index.d.ts ./deno/index.d.ts - fi - if [ -e ./docs/types/index.d.ts ]; then - cp ./docs/types/index.d.ts ./deno/mod.d.ts - fi - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: Install production and development dependencies - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Bundle package for use in Deno: - - name: 'Bundle package for Deno' - id: deno-bundle - uses: stdlib-js/bundle-action@main - with: - target: 'deno' - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - # Replace links to other packages with links to the deno branch: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/deno/"; - - # Replace reference to `@stdlib/types` with CDN link: - find ./deno -type f -name '*.ts' -print0 | xargs -0 -r sed -Ei "s/\/\/\/ /\/\/\/ /g" - - # Change wording of project description to avoid reference to JavaScript and Node.js: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "s/a standard library for JavaScript and Node.js, /a standard library /g" - - # Rewrite all `require()`s to use jsDelivr links: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/require\( '@stdlib\// { - s/(var|let|const)\s+([a-z0-9_]+)\s+=\s*require\( '([^']+)' \);/import \2 from \'\3\';/i - s/@stdlib/https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js/ - s/';/@deno\/mod.js';/ - }" - - # Rewrite first `import` to show importing of named exports if available: - exports=$(cat lib/index.js | \ - grep -E 'setReadOnly\(.*,.*,.*\)' | \ - sed -E 's/setReadOnly\((.*),(.*),(.*)\);/\2/' | \ - sed -E "s/'//g" | \ - sort) - if [ -n "$exports" ]; then - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\nimport\s+([a-zA-Z0-9_]+)\s+from\s*'([^']+)';\n\`\`\`/\`\`\`javascript\nimport \1 from '\2';\n\`\`\`\n\nYou can also import the following named exports from the package:\n\n\`\`\`javascript\nimport { $(echo $exports | sed -E 's/ /, /g') } from '\2';\n\`\`\`/" - fi - - # Remove `installation`, `cli`, and `c` sections: - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Create package.json file for deno branch: - jq --indent 2 '{"name": .name, "version": .version, "description": .description, "license": .license, "type": "module", "main": "./mod.js", "homepage": .homepage, "repository": .repository, "bugs": .bugs, "keywords": .keywords, "funding": .funding}' package.json > ./deno/package.json - - # Delete everything in current directory aside from deno folder: - - name: 'Delete everything in current directory aside from deno folder' - run: | - find . -type 'f' | grep -v -e "deno" -e ".git/" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e "deno" -e ".git" | xargs -r rm -rf - - # Move deno directory to root: - - name: 'Move deno directory to root' - run: | - mv ./deno/* . - rmdir ./deno - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Auto-generated commit" - - # Push changes to `deno` branch: - - name: 'Push changes to `deno` branch' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" deno - - # Send status to Slack channel if job fails: - - name: 'Send status to Slack channel in case of failure' - # Pin action to full length commit SHA - uses: 8398a7/action-slack@28ba43ae48961b90635b50953d216767a6bea486 # v3.16.2 - with: - status: ${{ job.status }} - steps: ${{ toJson(steps) }} - channel: '#npm-ci' - if: failure() - - # Define job to create a UMD bundle... - umd: - - # Define display name: - name: 'Create UMD bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Configure git: - - name: 'Configure git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `umd` branch exists: - - name: 'Check if remote `umd` branch exists' - id: umd-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin umd - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `umd` exists, delete everything in branch and merge `production` into it - - name: 'If `umd` exists, delete everything in branch and merge `production` into it' - if: steps.umd-branch-exists.outputs.remote-exists - run: | - git checkout -b umd origin/umd - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `umd` does not exist, create `umd` branch: - - name: 'If `umd` does not exist, create `umd` branch' - if: ${{ steps.umd-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b umd - - # Copy files to umd directory: - - name: 'Copy files to umd directory' - run: | - mkdir -p umd - cp README.md LICENSE CONTRIBUTORS NOTICE ./umd - - # Install Node.js - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Extract alias: - - name: 'Extract alias' - id: extract-alias - run: | - alias=$(grep -E 'require\(' README.md | head -n 1 | sed -E 's/^var ([a-zA-Z0-9_]+) = .+/\1/') - echo "alias=${alias}" >> $GITHUB_OUTPUT - - # Create Universal Module Definition (UMD) Node.js bundle: - - name: 'Create Universal Module Definition (UMD) Node.js bundle' - id: umd-bundle-node - uses: stdlib-js/bundle-action@main - with: - target: 'umd-node' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Create Universal Module Definition (UMD) browser bundle: - - name: 'Create Universal Module Definition (UMD) browser bundle' - id: umd-bundle-browser - uses: stdlib-js/bundle-action@main - with: - target: 'umd-browser' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - - # Replace links to other packages with links to the umd branch: - find ./umd -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/umd/"; - - # Remove `installation`, `cli`, and `c` sections: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Rewrite first `require()` to show consumption of the UMD bundle in Observable and via a `script` tag: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\n(var|let|const)\s+([a-zA-Z0-9_]+)\s+=\s*require\( '\@stdlib\/([^']+)' \);\n\`\`\`/To use in Observable,\n\n\`\`\`javascript\n\2 = require\( 'https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js\/\3\@umd\/browser.js' \)\n\`\`\`\n\nTo vendor stdlib functionality and avoid installing dependency trees for Node.js, you can use the UMD server build:\n\n\`\`\`javascript\nvar \2 = require\( 'path\/to\/vendor\/umd\/\3\/index.js' \)\n\`\`\`\n\nTo include the bundle in a webpage,\n\n\`\`\`html\n + + ```
@@ -189,7 +180,7 @@ var out = filter( x, naryFunction( isPositiveInteger, 1 ) ); ## 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. +This package is part of [stdlib][stdlib], a standard library 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]. diff --git a/SECURITY.md b/SECURITY.md deleted file mode 100644 index 9702d4c..0000000 --- a/SECURITY.md +++ /dev/null @@ -1,5 +0,0 @@ -# Security - -> Policy for reporting security vulnerabilities. - -See the security policy [in the main project repository](https://github.com/stdlib-js/stdlib/security). diff --git a/benchmark/benchmark.length.js b/benchmark/benchmark.length.js deleted file mode 100644 index bc79e33..0000000 --- a/benchmark/benchmark.length.js +++ /dev/null @@ -1,97 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 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 bench = require( '@stdlib/bench-harness' ); -var pow = require( '@stdlib/math-base-special-pow' ); -var isArray = require( '@stdlib/assert-is-array' ); -var isNonNegativeInteger = require( '@stdlib/assert-is-nonnegative-integer' ).isPrimitive; -var zeroTo = require( '@stdlib/array-base-zero-to' ); -var pkg = require( './../package.json' ).name; -var filter = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveInteger} len - array length -* @returns {Function} benchmark function -*/ -function createBenchmark( len ) { - var x = zeroTo( len ); - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var out; - var i; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - out = filter( x, isNonNegativeInteger ); - if ( typeof out !== 'object' ) { - b.fail( 'should return an array' ); - } - } - b.toc(); - if ( !isArray( out ) ) { - b.fail( 'should return an array' ); - } - b.pass( 'benchmark finished' ); - b.end(); - } -} - - -// MAIN // - -/** -* Main execution sequence. -* -* @private -*/ -function main() { - var len; - var min; - var max; - var f; - var i; - - min = 1; // 10^min - max = 6; // 10^max - - for ( i = min; i <= max; i++ ) { - len = pow( 10, i ); - - f = createBenchmark( len ); - bench( pkg+':dtype=generic,len='+len, f ); - } -} - -main(); diff --git a/branches.md b/branches.md deleted file mode 100644 index 9858901..0000000 --- a/branches.md +++ /dev/null @@ -1,56 +0,0 @@ - - -# Branches - -This repository has the following branches: - -- **main**: default branch generated from the [stdlib project][stdlib-url], where all development takes place. -- **production**: [production build][production-url] of the package (e.g., reformatted error messages to reduce bundle sizes and thus the number of bytes transmitted over a network). -- **esm**: [ES Module][esm-url] branch for use via a `script` tag without the need for installation and bundlers (see [README][esm-readme]). -- **deno**: [Deno][deno-url] branch for use in Deno (see [README][deno-readme]). -- **umd**: [UMD][umd-url] branch for use in Observable, or in dual browser/Node.js environments (see [README][umd-readme]). - -The following diagram illustrates the relationships among the above branches: - -```mermaid -graph TD; -A[stdlib]-->|generate standalone package|B; -B[main] -->|productionize| C[production]; -C -->|bundle| D[esm]; -C -->|bundle| E[deno]; -C -->|bundle| F[umd]; - -%% click A href "https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/filter" -%% click B href "https://github.com/stdlib-js/array-base-filter/tree/main" -%% click C href "https://github.com/stdlib-js/array-base-filter/tree/production" -%% click D href "https://github.com/stdlib-js/array-base-filter/tree/esm" -%% click E href "https://github.com/stdlib-js/array-base-filter/tree/deno" -%% click F href "https://github.com/stdlib-js/array-base-filter/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/filter -[production-url]: https://github.com/stdlib-js/array-base-filter/tree/production -[deno-url]: https://github.com/stdlib-js/array-base-filter/tree/deno -[deno-readme]: https://github.com/stdlib-js/array-base-filter/blob/deno/README.md -[umd-url]: https://github.com/stdlib-js/array-base-filter/tree/umd -[umd-readme]: https://github.com/stdlib-js/array-base-filter/blob/umd/README.md -[esm-url]: https://github.com/stdlib-js/array-base-filter/tree/esm -[esm-readme]: https://github.com/stdlib-js/array-base-filter/blob/esm/README.md \ No newline at end of file diff --git a/dist/index.d.ts b/dist/index.d.ts deleted file mode 100644 index aafb9cb..0000000 --- a/dist/index.d.ts +++ /dev/null @@ -1,3 +0,0 @@ -/// -import filter from '../docs/types/index'; -export = filter; \ No newline at end of file diff --git a/dist/index.js b/dist/index.js deleted file mode 100644 index 5c2f789..0000000 --- a/dist/index.js +++ /dev/null @@ -1,5 +0,0 @@ -"use strict";var s=function(r,t){return function(){return t||r((t={exports:{}}).exports,t),t.exports}};var f=s(function(y,c){ -var v=require('@stdlib/array-base-arraylike2object/dist');function l(r,t){return typeof r[t]=="function"}function h(r,t,n){var e,o,a;for(e=[],a=0;a 0;\n* }\n*\n* var x = [ 1, -2, -3, 4 ];\n*\n* var out = internal( x, isPositive );\n* // returns [ 1, 4 ]\n*/\nfunction internal( x, predicate, thisArg ) {\n\tvar out;\n\tvar v;\n\tvar i;\n\n\tout = [];\n\tfor ( i = 0; i < x.length; i++ ) {\n\t\tv = x[ i ];\n\t\tif ( predicate.call( thisArg, v, i, x ) ) {\n\t\t\tout.push( v );\n\t\t}\n\t}\n\treturn out;\n}\n\n/**\n* Returns a shallow copy of an array containing only those elements which pass a test implemented by a predicate function.\n*\n* @private\n* @param {Object} x - input array object\n* @param {Function} predicate - test function\n* @param {*} thisArg - execution context\n* @returns {Array} output array\n*\n* @example\n* var toAccessorArray = require( '@stdlib/array-base-to-accessor-array' );\n* var arraylike2object = require( '@stdlib/array-base-arraylike2object' );\n*\n* function isPositive( v ) {\n* return v > 0;\n* }\n*\n* var x = arraylike2object( toAccessorArray( [ 1, -2, -3, 4 ] ) );\n*\n* var out = accessors( x, isPositive );\n* // returns [ 1, 4 ]\n*/\nfunction accessors( x, predicate, thisArg ) {\n\tvar data;\n\tvar get;\n\tvar out;\n\tvar v;\n\tvar i;\n\n\tdata = x.data;\n\tget = x.accessors[ 0 ];\n\n\tout = [];\n\tfor ( i = 0; i < data.length; i++ ) {\n\t\tv = get( data, i );\n\t\tif ( predicate.call( thisArg, v, i, data ) ) {\n\t\t\tout.push( v );\n\t\t}\n\t}\n\treturn out;\n}\n\n\n// MAIN //\n\n/**\n* Returns a shallow copy of an array containing only those elements which pass a test implemented by a predicate function.\n*\n* @param {Collection} x - input array\n* @param {Function} predicate - test function\n* @param {*} [thisArg] - execution context\n* @returns {Collection} output array\n*\n* @example\n* function isPositive( v ) {\n* return v > 0;\n* }\n*\n* var x = [ 1, -2, -3, 4 ];\n*\n* var out = filter( x, isPositive );\n* // returns [ 1, 4 ]\n*/\nfunction filter( x, predicate, thisArg ) {\n\tvar obj;\n\tif ( hasMethod( x, 'filter' ) ) {\n\t\treturn x.filter( predicate, thisArg );\n\t}\n\tobj = arraylike2object( x );\n\tif ( obj.accessorProtocol ) {\n\t\treturn accessors( obj, predicate, thisArg );\n\t}\n\treturn internal( x, predicate, thisArg );\n}\n\n\n// EXPORTS //\n\nmodule.exports = filter;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2024 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* Return a shallow copy of an array containing only those elements which pass a test implemented by a predicate function.\n*\n* @module @stdlib/array-base-filter\n*\n* @example\n* var filter = require( '@stdlib/array-base-filter' );\n*\n* function isPositive( v ) {\n* return v > 0;\n* }\n*\n* var x = [ 1, -2, -3, 4 ];\n*\n* var out = filter( x, isPositive );\n* // returns [ 1, 4 ]\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,EAAmB,QAAS,qCAAsC,EAqBtE,SAASC,EAAWC,EAAKC,EAAS,CACjC,OAAS,OAAOD,EAAKC,CAAO,GAAM,UACnC,CAqBA,SAASC,EAAUC,EAAGC,EAAWC,EAAU,CAC1C,IAAIC,EACAC,EACAC,EAGJ,IADAF,EAAM,CAAC,EACDE,EAAI,EAAGA,EAAIL,EAAE,OAAQK,IAC1BD,EAAIJ,EAAGK,CAAE,EACJJ,EAAU,KAAMC,EAASE,EAAGC,EAAGL,CAAE,GACrCG,EAAI,KAAMC,CAAE,EAGd,OAAOD,CACR,CAwBA,SAASG,EAAWN,EAAGC,EAAWC,EAAU,CAC3C,IAAIK,EACAC,EACAL,EACAC,EACAC,EAMJ,IAJAE,EAAOP,EAAE,KACTQ,EAAMR,EAAE,UAAW,CAAE,EAErBG,EAAM,CAAC,EACDE,EAAI,EAAGA,EAAIE,EAAK,OAAQF,IAC7BD,EAAII,EAAKD,EAAMF,CAAE,EACZJ,EAAU,KAAMC,EAASE,EAAGC,EAAGE,CAAK,GACxCJ,EAAI,KAAMC,CAAE,EAGd,OAAOD,CACR,CAuBA,SAASM,EAAQT,EAAGC,EAAWC,EAAU,CACxC,IAAIL,EACJ,OAAKD,EAAWI,EAAG,QAAS,EACpBA,EAAE,OAAQC,EAAWC,CAAQ,GAErCL,EAAMF,EAAkBK,CAAE,EACrBH,EAAI,iBACDS,EAAWT,EAAKI,EAAWC,CAAQ,EAEpCH,EAAUC,EAAGC,EAAWC,CAAQ,EACxC,CAKAR,EAAO,QAAUe,ICvHjB,IAAIC,EAAO,IAKX,OAAO,QAAUA", - "names": ["require_main", "__commonJSMin", "exports", "module", "arraylike2object", "hasMethod", "obj", "method", "internal", "x", "predicate", "thisArg", "out", "v", "i", "accessors", "data", "get", "filter", "main"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index bb2b17a..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,46 +0,0 @@ - -{{alias}}( x, predicate[, thisArg] ) - Returns a shallow copy of an array containing only those elements which pass - a test implemented by a predicate function. - - The predicate function is provided three arguments: - - - value: current array element. - - index: current array element index. - - arr: the input array. - - If provided an array-like object having a `filter` method , the function - defers execution to that method and assumes that the method has the - following signature: - - x.filter( predicate, thisArg ) - - If provided an array-like object without a `filter` method, the function - performs a linear scan and always returns a generic array. - - Parameters - ---------- - x: Array|TypedArray|Object - Input array. - - predicate: Function - Predicate function. - - thisArg: any (optional) - Execution context. - - Returns - ------- - out: Array|TypedArray|Object - Output array. - - Examples - -------- - > function f( v ) { return ( v > 0 ); }; - > var x = [ 1, -2, -3, 4 ]; - > var out = {{alias}}( x, f ) - [ 1, 4 ] - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index db0c38d..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,101 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2024 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. -*/ - -import toAccessorArray = require( '@stdlib/array-base-to-accessor-array' ); -import filter = require( './index' ); - -/** -* Tests whether a value is positive. -* -* @param value - input value -* @returns boolean indicating whether an element is positive -*/ -function isPositive( value: number ): boolean { - return ( value > 0 ); -} - - -// TESTS // - -// The function returns a collection... -{ - filter( [ 1, 2, 3 ], isPositive ); // $ExpectType number[] - filter( new Float64Array( [ 1, 2, 3 ] ), isPositive ); // $ExpectType Float64Array - filter( new Float32Array( [ 1, 2, 3 ] ), isPositive ); // $ExpectType Float32Array - filter( new Int32Array( [ 1, 2, 3 ] ), isPositive ); // $ExpectType Int32Array - filter( new Int16Array( [ 1, 2, 3 ] ), isPositive ); // $ExpectType Int16Array - filter( new Int8Array( [ 1, 2, 3 ] ), isPositive ); // $ExpectType Int8Array - filter( new Uint32Array( [ 1, 2, 3 ] ), isPositive ); // $ExpectType Uint32Array - filter( new Uint16Array( [ 1, 2, 3 ] ), isPositive ); // $ExpectType Uint16Array - filter( new Uint8Array( [ 1, 2, 3 ] ), isPositive ); // $ExpectType Uint8Array - filter( new Uint8ClampedArray( [ 1, 2, 3 ] ), isPositive ); // $ExpectType Uint8ClampedArray - filter( toAccessorArray( [ 1, 2, 3 ] ), isPositive ); // $ExpectType number[] - - filter( [ 1, 2, 3 ], isPositive, {} ); // $ExpectType number[] - filter( new Float64Array( [ 1, 2, 3 ] ), isPositive, {} ); // $ExpectType Float64Array - filter( new Float32Array( [ 1, 2, 3 ] ), isPositive, {} ); // $ExpectType Float32Array - filter( new Int32Array( [ 1, 2, 3 ] ), isPositive, {} ); // $ExpectType Int32Array - filter( new Int16Array( [ 1, 2, 3 ] ), isPositive, {} ); // $ExpectType Int16Array - filter( new Int8Array( [ 1, 2, 3 ] ), isPositive, {} ); // $ExpectType Int8Array - filter( new Uint32Array( [ 1, 2, 3 ] ), isPositive, {} ); // $ExpectType Uint32Array - filter( new Uint16Array( [ 1, 2, 3 ] ), isPositive, {} ); // $ExpectType Uint16Array - filter( new Uint8Array( [ 1, 2, 3 ] ), isPositive, {} ); // $ExpectType Uint8Array - filter( new Uint8ClampedArray( [ 1, 2, 3 ] ), isPositive, {} ); // $ExpectType Uint8ClampedArray - filter( toAccessorArray( [ 1, 2, 3 ] ), isPositive, {} ); // $ExpectType number[] -} - -// The compiler throws an error if the function is provided a first argument which is not a collection... -{ - filter( 2, isPositive ); // $ExpectError - filter( false, isPositive ); // $ExpectError - filter( true, isPositive ); // $ExpectError - filter( {}, isPositive ); // $ExpectError - - filter( 2, isPositive, {} ); // $ExpectError - filter( false, isPositive, {} ); // $ExpectError - filter( true, isPositive, {} ); // $ExpectError - filter( {}, isPositive, {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided a second argument which is not a function... -{ - filter( [ 1, 2, 3 ], 'abc' ); // $ExpectError - filter( [ 1, 2, 3 ], 2 ); // $ExpectError - filter( [ 1, 2, 3 ], false ); // $ExpectError - filter( [ 1, 2, 3 ], true ); // $ExpectError - filter( [ 1, 2, 3 ], null ); // $ExpectError - filter( [ 1, 2, 3 ], void 0 ); // $ExpectError - filter( [ 1, 2, 3 ], {} ); // $ExpectError - filter( [ 1, 2, 3 ], [] ); // $ExpectError - - filter( [ 1, 2, 3 ], 'abc', {} ); // $ExpectError - filter( [ 1, 2, 3 ], 2, {} ); // $ExpectError - filter( [ 1, 2, 3 ], false, {} ); // $ExpectError - filter( [ 1, 2, 3 ], true, {} ); // $ExpectError - filter( [ 1, 2, 3 ], null, {} ); // $ExpectError - filter( [ 1, 2, 3 ], void 0, {} ); // $ExpectError - filter( [ 1, 2, 3 ], {}, {} ); // $ExpectError - filter( [ 1, 2, 3 ], [], {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided an unsupported number of arguments... -{ - filter(); // $ExpectError - filter( [ 1, 2, 3 ] ); // $ExpectError - filter( [ 1, 2, 3 ], isPositive, {}, 3 ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index cdfb9a7..0000000 --- a/examples/index.js +++ /dev/null @@ -1,35 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 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'; - -var discreteUniform = require( '@stdlib/random-array-discrete-uniform' ); -var isPositiveInteger = require( '@stdlib/assert-is-positive-integer' ).isPrimitive; -var naryFunction = require( '@stdlib/utils-nary-function' ); -var filter = require( './../lib' ); - -var x = discreteUniform( 10, -5, 5, { - 'dtype': 'int32' -}); -// returns - -var out = filter( x, naryFunction( isPositiveInteger, 1 ) ); -// returns - -console.log( x ); -console.log( out ); diff --git a/docs/types/index.d.ts b/index.d.ts similarity index 99% rename from docs/types/index.d.ts rename to index.d.ts index 0f92cfd..1fa8dc7 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 4.1 -/// +/// import { Collection, AccessorArrayLike, Complex128Array, Complex64Array } from '@stdlib/types/array'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..a10870c --- /dev/null +++ b/index.mjs @@ -0,0 +1,4 @@ +// Copyright (c) 2024 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 +/// +import r from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-arraylike2object@v0.2.1-esm/index.mjs";function t(t,e,n){var o;return function(r,t){return"function"==typeof r[t]}(t,"filter")?t.filter(e,n):(o=r(t)).accessorProtocol?function(r,t,e){var n,o,a,s,c;for(n=r.data,o=r.accessors[0],a=[],c=0;c 0;\n* }\n*\n* var x = [ 1, -2, -3, 4 ];\n*\n* var out = internal( x, isPositive );\n* // returns [ 1, 4 ]\n*/\nfunction internal( x, predicate, thisArg ) {\n\tvar out;\n\tvar v;\n\tvar i;\n\n\tout = [];\n\tfor ( i = 0; i < x.length; i++ ) {\n\t\tv = x[ i ];\n\t\tif ( predicate.call( thisArg, v, i, x ) ) {\n\t\t\tout.push( v );\n\t\t}\n\t}\n\treturn out;\n}\n\n/**\n* Returns a shallow copy of an array containing only those elements which pass a test implemented by a predicate function.\n*\n* @private\n* @param {Object} x - input array object\n* @param {Function} predicate - test function\n* @param {*} thisArg - execution context\n* @returns {Array} output array\n*\n* @example\n* import toAccessorArray from '@stdlib/array-base-to-accessor-array';\n* import arraylike2object from '@stdlib/array-base-arraylike2object';\n*\n* function isPositive( v ) {\n* return v > 0;\n* }\n*\n* var x = arraylike2object( toAccessorArray( [ 1, -2, -3, 4 ] ) );\n*\n* var out = accessors( x, isPositive );\n* // returns [ 1, 4 ]\n*/\nfunction accessors( x, predicate, thisArg ) {\n\tvar data;\n\tvar get;\n\tvar out;\n\tvar v;\n\tvar i;\n\n\tdata = x.data;\n\tget = x.accessors[ 0 ];\n\n\tout = [];\n\tfor ( i = 0; i < data.length; i++ ) {\n\t\tv = get( data, i );\n\t\tif ( predicate.call( thisArg, v, i, data ) ) {\n\t\t\tout.push( v );\n\t\t}\n\t}\n\treturn out;\n}\n\n\n// MAIN //\n\n/**\n* Returns a shallow copy of an array containing only those elements which pass a test implemented by a predicate function.\n*\n* @param {Collection} x - input array\n* @param {Function} predicate - test function\n* @param {*} [thisArg] - execution context\n* @returns {Collection} output array\n*\n* @example\n* function isPositive( v ) {\n* return v > 0;\n* }\n*\n* var x = [ 1, -2, -3, 4 ];\n*\n* var out = filter( x, isPositive );\n* // returns [ 1, 4 ]\n*/\nfunction filter( x, predicate, thisArg ) {\n\tvar obj;\n\tif ( hasMethod( x, 'filter' ) ) {\n\t\treturn x.filter( predicate, thisArg );\n\t}\n\tobj = arraylike2object( x );\n\tif ( obj.accessorProtocol ) {\n\t\treturn accessors( obj, predicate, thisArg );\n\t}\n\treturn internal( x, predicate, thisArg );\n}\n\n\n// EXPORTS //\n\nexport default filter;\n"],"names":["filter","x","predicate","thisArg","obj","method","hasMethod","arraylike2object","accessorProtocol","data","get","out","v","i","accessors","length","call","push","internal"],"mappings":";;sGAgJA,SAASA,EAAQC,EAAGC,EAAWC,GAC9B,IAAIC,EACJ,OAvGD,SAAoBA,EAAKC,GACxB,MAAkC,mBAAlBD,EAAKC,EACtB,CAqGMC,CAAWL,EAAG,UACXA,EAAED,OAAQE,EAAWC,IAE7BC,EAAMG,EAAkBN,IACfO,iBA/CV,SAAoBP,EAAGC,EAAWC,GACjC,IAAIM,EACAC,EACAC,EACAC,EACAC,EAMJ,IAJAJ,EAAOR,EAAEQ,KACTC,EAAMT,EAAEa,UAAW,GAEnBH,EAAM,GACAE,EAAI,EAAGA,EAAIJ,EAAKM,OAAQF,IAC7BD,EAAIF,EAAKD,EAAMI,GACVX,EAAUc,KAAMb,EAASS,EAAGC,EAAGJ,IACnCE,EAAIM,KAAML,GAGZ,OAAOD,CACR,CA8BSG,CAAWV,EAAKF,EAAWC,GArFpC,SAAmBF,EAAGC,EAAWC,GAChC,IAAIQ,EACAC,EACAC,EAGJ,IADAF,EAAM,GACAE,EAAI,EAAGA,EAAIZ,EAAEc,OAAQF,IAC1BD,EAAIX,EAAGY,GACFX,EAAUc,KAAMb,EAASS,EAAGC,EAAGZ,IACnCU,EAAIM,KAAML,GAGZ,OAAOD,CACR,CA0EQO,CAAUjB,EAAGC,EAAWC,EAChC"} \ No newline at end of file diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index 56236cd..0000000 --- a/lib/index.js +++ /dev/null @@ -1,46 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 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'; - -/** -* Return a shallow copy of an array containing only those elements which pass a test implemented by a predicate function. -* -* @module @stdlib/array-base-filter -* -* @example -* var filter = require( '@stdlib/array-base-filter' ); -* -* function isPositive( v ) { -* return v > 0; -* } -* -* var x = [ 1, -2, -3, 4 ]; -* -* var out = filter( x, isPositive ); -* // returns [ 1, 4 ] -*/ - -// MODULES // - -var main = require( './main.js' ); - - -// EXPORTS // - -module.exports = main; diff --git a/lib/main.js b/lib/main.js deleted file mode 100644 index 9b0c3db..0000000 --- a/lib/main.js +++ /dev/null @@ -1,160 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 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 arraylike2object = require( '@stdlib/array-base-arraylike2object' ); - - -// FUNCTIONS // - -/** -* Tests whether an object has a specified method. -* -* @private -* @param {Object} obj - input object -* @param {string} method - method name -* @returns {boolean} boolean indicating whether an object has a specified method -* -* @example -* var bool = hasMethod( [], 'filter' ); -* // returns true -* -* @example -* var bool = hasMethod( [], 'beep' ); -* // returns false -*/ -function hasMethod( obj, method ) { - return ( typeof obj[ method ] === 'function' ); -} - -/** -* Returns a shallow copy of an array containing only those elements which pass a test implemented by a predicate function. -* -* @private -* @param {Collection} x - input array -* @param {Function} predicate - test function -* @param {*} thisArg - execution context -* @returns {Array} output array -* -* @example -* function isPositive( v ) { -* return v > 0; -* } -* -* var x = [ 1, -2, -3, 4 ]; -* -* var out = internal( x, isPositive ); -* // returns [ 1, 4 ] -*/ -function internal( x, predicate, thisArg ) { - var out; - var v; - var i; - - out = []; - for ( i = 0; i < x.length; i++ ) { - v = x[ i ]; - if ( predicate.call( thisArg, v, i, x ) ) { - out.push( v ); - } - } - return out; -} - -/** -* Returns a shallow copy of an array containing only those elements which pass a test implemented by a predicate function. -* -* @private -* @param {Object} x - input array object -* @param {Function} predicate - test function -* @param {*} thisArg - execution context -* @returns {Array} output array -* -* @example -* var toAccessorArray = require( '@stdlib/array-base-to-accessor-array' ); -* var arraylike2object = require( '@stdlib/array-base-arraylike2object' ); -* -* function isPositive( v ) { -* return v > 0; -* } -* -* var x = arraylike2object( toAccessorArray( [ 1, -2, -3, 4 ] ) ); -* -* var out = accessors( x, isPositive ); -* // returns [ 1, 4 ] -*/ -function accessors( x, predicate, thisArg ) { - var data; - var get; - var out; - var v; - var i; - - data = x.data; - get = x.accessors[ 0 ]; - - out = []; - for ( i = 0; i < data.length; i++ ) { - v = get( data, i ); - if ( predicate.call( thisArg, v, i, data ) ) { - out.push( v ); - } - } - return out; -} - - -// MAIN // - -/** -* Returns a shallow copy of an array containing only those elements which pass a test implemented by a predicate function. -* -* @param {Collection} x - input array -* @param {Function} predicate - test function -* @param {*} [thisArg] - execution context -* @returns {Collection} output array -* -* @example -* function isPositive( v ) { -* return v > 0; -* } -* -* var x = [ 1, -2, -3, 4 ]; -* -* var out = filter( x, isPositive ); -* // returns [ 1, 4 ] -*/ -function filter( x, predicate, thisArg ) { - var obj; - if ( hasMethod( x, 'filter' ) ) { - return x.filter( predicate, thisArg ); - } - obj = arraylike2object( x ); - if ( obj.accessorProtocol ) { - return accessors( obj, predicate, thisArg ); - } - return internal( x, predicate, thisArg ); -} - - -// EXPORTS // - -module.exports = filter; diff --git a/package.json b/package.json index d836e77..222dce3 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.2.1", "description": "Return a shallow copy of an array containing only those elements which pass a test implemented by a predicate function.", "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", - "directories": { - "benchmark": "./benchmark", - "doc": "./docs", - "example": "./examples", - "lib": "./lib", - "test": "./test" - }, - "types": "./docs/types", - "scripts": { - "test": "make test", - "test-cov": "make test-cov", - "examples": "make examples", - "benchmark": "make benchmark" - }, + "type": "module", + "main": "./index.mjs", "homepage": "https://stdlib.io", "repository": { "type": "git", @@ -36,42 +13,6 @@ "bugs": { "url": "https://github.com/stdlib-js/stdlib/issues" }, - "dependencies": { - "@stdlib/array-base-arraylike2object": "^0.2.1", - "@stdlib/types": "^0.3.2", - "@stdlib/error-tools-fmtprodmsg": "^0.2.1" - }, - "devDependencies": { - "@stdlib/array-base-accessor": "^0.2.1", - "@stdlib/array-base-zero-to": "^0.2.1", - "@stdlib/array-float64": "^0.2.1", - "@stdlib/assert-instance-of": "^0.2.1", - "@stdlib/assert-is-array": "^0.2.1", - "@stdlib/assert-is-nonnegative-integer": "^0.2.1", - "@stdlib/assert-is-positive-integer": "^0.2.1", - "@stdlib/math-base-special-pow": "^0.2.1", - "@stdlib/random-array-discrete-uniform": "^0.2.1", - "@stdlib/utils-nary-function": "^0.2.1", - "tape": "git+https://github.com/kgryte/tape.git#fix/globby", - "istanbul": "^0.4.1", - "tap-min": "git+https://github.com/Planeshifter/tap-min.git", - "@stdlib/bench-harness": "^0.2.1" - }, - "engines": { - "node": ">=0.10.0", - "npm": ">2.7.0" - }, - "os": [ - "aix", - "darwin", - "freebsd", - "linux", - "macos", - "openbsd", - "sunos", - "win32", - "windows" - ], "keywords": [ "stdlib", "stdtypes", @@ -91,4 +32,4 @@ "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} \ No newline at end of file +} diff --git a/stats.html b/stats.html new file mode 100644 index 0000000..d4d08f0 --- /dev/null +++ b/stats.html @@ -0,0 +1,4842 @@ + + + + + + + + Rollup Visualizer + + + +
+ + + + + diff --git a/test/dist/test.js b/test/dist/test.js deleted file mode 100644 index a8a9c60..0000000 --- a/test/dist/test.js +++ /dev/null @@ -1,33 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 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 tape = require( 'tape' ); -var main = require( './../../dist' ); - - -// TESTS // - -tape( 'main export is defined', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( main !== void 0, true, 'main export is defined' ); - t.end(); -}); diff --git a/test/test.js b/test/test.js deleted file mode 100644 index d4e7373..0000000 --- a/test/test.js +++ /dev/null @@ -1,251 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 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 tape = require( 'tape' ); -var AccessorArray = require( '@stdlib/array-base-accessor' ); -var Float64Array = require( '@stdlib/array-float64' ); -var instanceOf = require( '@stdlib/assert-instance-of' ); -var filter = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Tests whether a value is positive. -* -* @private -* @param {number} value - input value -* @returns {boolean} boolean indicating if a value is positive -*/ -function isPositive( value ) { - return ( value > 0 ); -} - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof filter, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'if provided an empty collection, the function returns an empty collection (generic)', function test( t ) { - var expected; - var actual; - var arr; - - arr = []; - expected = []; - actual = filter( arr, foo ); - - t.strictEqual( instanceOf( actual, Array ), true, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - t.end(); - - function foo() { - t.fail( 'should not be invoked' ); - } -}); - -tape( 'if provided an empty collection, the function returns an empty collection (typed array)', function test( t ) { - var expected; - var actual; - var arr; - - arr = new Float64Array( [] ); - expected = new Float64Array( [] ); - actual = filter( arr, foo ); - - t.strictEqual( instanceOf( actual, Float64Array ), true, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - t.end(); - - function foo() { - t.fail( 'should not be invoked' ); - } -}); - -tape( 'if provided an empty collection, the function returns an empty collection (accessor)', function test( t ) { - var expected; - var actual; - var arr; - - arr = new AccessorArray( [] ); - expected = []; - actual = filter( arr, foo ); - - t.strictEqual( instanceOf( actual, Array ), true, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - t.end(); - - function foo() { - t.fail( 'should not be invoked' ); - } -}); - -tape( 'the function filters a provided collection (generic)', function test( t ) { - var expected; - var actual; - var arr; - - arr = [ 1, -2, 3 ]; - expected = [ 1, 3 ]; - actual = filter( arr, isPositive ); - - t.strictEqual( instanceOf( actual, Array ), true, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - t.end(); -}); - -tape( 'the function filters a provided collection (typed array)', function test( t ) { - var expected; - var actual; - var arr; - - arr = new Float64Array( [ -1.0, 2.0, 3.0 ] ); - expected = new Float64Array( [ 2.0, 3.0 ] ); - actual = filter( arr, isPositive ); - - t.strictEqual( instanceOf( actual, Float64Array ), true, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - t.end(); -}); - -tape( 'the function filters a provided collection (accessor)', function test( t ) { - var expected; - var actual; - var arr; - - arr = new AccessorArray( [ 1, -2, -3 ] ); - expected = [ 1 ]; - actual = filter( arr, isPositive ); - - t.strictEqual( instanceOf( actual, Array ), true, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - t.end(); -}); - -tape( 'the function filters a provided collection (array-like object)', function test( t ) { - var expected; - var actual; - var arr; - - arr = { - 'length': 3, - '0': -1, - '1': -2, - '2': 3 - }; - expected = [ 3 ]; - actual = filter( arr, isPositive ); - - t.strictEqual( instanceOf( actual, Array ), true, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - t.end(); -}); - -tape( 'the function an empty collection if all elements fail a test (generic)', function test( t ) { - var expected; - var actual; - var arr; - - arr = [ -1, -2, -3 ]; - expected = []; - actual = filter( arr, isPositive ); - - t.strictEqual( instanceOf( actual, Array ), true, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - t.end(); -}); - -tape( 'the function an empty collection if all elements fail a test (typed array)', function test( t ) { - var expected; - var actual; - var arr; - - arr = new Float64Array( [ -1.0, -2.0, -3.0 ] ); - expected = new Float64Array( [] ); - actual = filter( arr, isPositive ); - - t.strictEqual( instanceOf( actual, Float64Array ), true, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - t.end(); -}); - -tape( 'the function an empty collection if all elements fail a test (accessor)', function test( t ) { - var expected; - var actual; - var arr; - - arr = new AccessorArray( [ -1, -2, -3 ] ); - expected = []; - actual = filter( arr, isPositive ); - - t.strictEqual( instanceOf( actual, Array ), true, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - t.end(); -}); - -tape( 'the function an empty collection if all elements fail a test (array-like object)', function test( t ) { - var expected; - var actual; - var arr; - - arr = { - 'length': 3, - '0': -1, - '1': -2, - '2': -3 - }; - expected = []; - actual = filter( arr, isPositive ); - - t.strictEqual( instanceOf( actual, Array ), true, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - t.end(); -}); - -tape( 'the function supports providing an execution context', function test( t ) { - var expected; - var actual; - var ctx; - var arr; - - ctx = { - 'count': 0 - }; - arr = [ 1, 2, 3 ]; - expected = [ 1, 2, 3 ]; - actual = filter( arr, predicate, ctx ); - - t.strictEqual( instanceOf( actual, Array ), true, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - t.strictEqual( ctx.count, arr.length, 'returns expected value' ); - - t.end(); - - function predicate( value ) { - this.count += 1; // eslint-disable-line no-invalid-this - return ( value > 0 ); - } -}); From b9f9cd0ed7ef5bf80d294cc4247c1886d6a29e32 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Wed, 17 Jul 2024 03:26:31 +0000 Subject: [PATCH 24/40] Transform error messages --- package.json | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/package.json b/package.json index 355145c..d836e77 100644 --- a/package.json +++ b/package.json @@ -38,7 +38,8 @@ }, "dependencies": { "@stdlib/array-base-arraylike2object": "^0.2.1", - "@stdlib/types": "^0.3.2" + "@stdlib/types": "^0.3.2", + "@stdlib/error-tools-fmtprodmsg": "^0.2.1" }, "devDependencies": { "@stdlib/array-base-accessor": "^0.2.1", @@ -90,4 +91,4 @@ "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} +} \ No newline at end of file From 82f48c7562d936bdb29ad309d367687ced10582c Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Wed, 17 Jul 2024 03:34:21 +0000 Subject: [PATCH 25/40] Remove files --- index.d.ts | 343 ---- index.mjs | 4 - index.mjs.map | 1 - stats.html | 4842 ------------------------------------------------- 4 files changed, 5190 deletions(-) delete mode 100644 index.d.ts delete mode 100644 index.mjs delete mode 100644 index.mjs.map delete mode 100644 stats.html diff --git a/index.d.ts b/index.d.ts deleted file mode 100644 index 1fa8dc7..0000000 --- a/index.d.ts +++ /dev/null @@ -1,343 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2024 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 - -/// - -import { Collection, AccessorArrayLike, Complex128Array, Complex64Array } from '@stdlib/types/array'; - -/** -* Returns a boolean indicating whether an element passes a test. -* -* @returns boolean indicating whether an element passes a test -*/ -type Nullary = ( this: U ) => boolean; - -/** -* Returns a boolean indicating whether an element passes a test. -* -* @param value - current array element -* @returns boolean indicating whether an element passes a test -*/ -type Unary = ( this: U, value: T ) => boolean; - -/** -* Returns a boolean indicating whether an element passes a test. -* -* @param value - current array element -* @param index - current array element index -* @returns boolean indicating whether an element passes a test -*/ -type Binary = ( this: U, value: T, index: number ) => boolean; - -/** -* Returns a boolean indicating whether an element passes a test. -* -* @param value - current array element -* @param index - current array element index -* @param arr - input array -* @returns boolean indicating whether an element passes a test -*/ -type Ternary = ( this: U, value: T, index: number, arr: V ) => boolean; - -/** -* Returns a boolean indicating whether an element passes a test. -* -* @param value - current array element -* @param index - current array element index -* @param arr - input array -* @returns boolean indicating whether an element passes a test -*/ -type Predicate = Nullary | Unary | Binary | Ternary; - -/** -* Returns a shallow copy of an array containing only those elements which pass a test implemented by a predicate function. -* -* @param x - input array -* @param predicate - predicate function -* @param thisArg - predicate function execution context -* @returns output array -* -* @example -* var isPositiveNumber = require( '@stdlib/assert-is-positive-number' ).isPrimitive; -* var Float64Array = require( '@stdlib/array-float64' ); -* -* var x = new Float64Array( [ 1.0, -2.0, -3.0, 4.0 ] ); -* -* var out = filter( x, isPositiveNumber ); -* // returns [ 1.0, 4.0 ] -*/ -declare function filter( x: Float64Array, predicate: Predicate, thisArg?: ThisParameterType> ): Float64Array; - -/** -* Returns a shallow copy of an array containing only those elements which pass a test implemented by a predicate function. -* -* @param x - input array -* @param predicate - predicate function -* @param thisArg - predicate function execution context -* @returns output array -* -* @example -* var isPositiveNumber = require( '@stdlib/assert-is-positive-number' ).isPrimitive; -* var Float32Array = require( '@stdlib/array-float32' ); -* -* var x = new Float32Array( [ 1.0, -2.0, -3.0, 4.0 ] ); -* -* var out = filter( x, isPositiveNumber ); -* // returns [ 1.0, 4.0 ] -*/ -declare function filter( x: Float32Array, predicate: Predicate, thisArg?: ThisParameterType> ): Float32Array; - -/** -* Returns a shallow copy of an array containing only those elements which pass a test implemented by a predicate function. -* -* @param x - input array -* @param predicate - predicate function -* @param thisArg - predicate function execution context -* @returns output array -* -* @example -* var isPositiveNumber = require( '@stdlib/assert-is-positive-number' ).isPrimitive; -* var Int32Array = require( '@stdlib/array-int32' ); -* -* var x = new Int32Array( [ 1, -2, -3, 4 ] ); -* -* var out = filter( x, isPositiveNumber ); -* // returns [ 1, 4 ] -*/ -declare function filter( x: Int32Array, predicate: Predicate, thisArg?: ThisParameterType> ): Int32Array; - -/** -* Returns a shallow copy of an array containing only those elements which pass a test implemented by a predicate function. -* -* @param x - input array -* @param predicate - predicate function -* @param thisArg - predicate function execution context -* @returns output array -* -* @example -* var isPositiveNumber = require( '@stdlib/assert-is-positive-number' ).isPrimitive; -* var Int16Array = require( '@stdlib/array-int16' ); -* -* var x = new Int16Array( [ 1, -2, -3, 4 ] ); -* -* var out = filter( x, isPositiveNumber ); -* // returns [ 1, 4 ] -*/ -declare function filter( x: Int16Array, predicate: Predicate, thisArg?: ThisParameterType> ): Int16Array; - -/** -* Returns a shallow copy of an array containing only those elements which pass a test implemented by a predicate function. -* -* @param x - input array -* @param predicate - predicate function -* @param thisArg - predicate function execution context -* @returns output array -* -* @example -* var isPositiveNumber = require( '@stdlib/assert-is-positive-number' ).isPrimitive; -* var Int8Array = require( '@stdlib/array-int8' ); -* -* var x = new Int8Array( [ 1, -2, -3, 4 ] ); -* -* var out = filter( x, isPositiveNumber ); -* // returns [ 1, 4 ] -*/ -declare function filter( x: Int8Array, predicate: Predicate, thisArg?: ThisParameterType> ): Int8Array; - -/** -* Returns a shallow copy of an array containing only those elements which pass a test implemented by a predicate function. -* -* @param x - input array -* @param predicate - predicate function -* @param thisArg - predicate function execution context -* @returns output array -* -* @example -* var isPositiveNumber = require( '@stdlib/assert-is-positive-number' ).isPrimitive; -* var Uint32Array = require( '@stdlib/array-uint32' ); -* -* var x = new Uint32Array( [ 1, 2, 3, 4 ] ); -* -* var out = filter( x, isPositiveNumber ); -* // returns [ 1, 2, 3, 4 ] -*/ -declare function filter( x: Uint32Array, predicate: Predicate, thisArg?: ThisParameterType> ): Uint32Array; - -/** -* Returns a shallow copy of an array containing only those elements which pass a test implemented by a predicate function. -* -* @param x - input array -* @param predicate - predicate function -* @param thisArg - predicate function execution context -* @returns output array -* -* @example -* var isPositiveNumber = require( '@stdlib/assert-is-positive-number' ).isPrimitive; -* var Uint16Array = require( '@stdlib/array-uint16' ); -* -* var x = new Uint16Array( [ 1, 2, 3, 4 ] ); -* -* var out = filter( x, isPositiveNumber ); -* // returns [ 1, 2, 3, 4 ] -*/ -declare function filter( x: Uint16Array, predicate: Predicate, thisArg?: ThisParameterType> ): Uint16Array; - -/** -* Returns a shallow copy of an array containing only those elements which pass a test implemented by a predicate function. -* -* @param x - input array -* @param predicate - predicate function -* @param thisArg - predicate function execution context -* @returns output array -* -* @example -* var isPositiveNumber = require( '@stdlib/assert-is-positive-number' ).isPrimitive; -* var Uint8Array = require( '@stdlib/array-uint8' ); -* -* var x = new Uint8Array( [ 1, 2, 3, 4 ] ); -* -* var out = filter( x, isPositiveNumber ); -* // returns [ 1, 2, 3, 4 ] -*/ -declare function filter( x: Uint8Array, predicate: Predicate, thisArg?: ThisParameterType> ): Uint8Array; - -/** -* Returns a shallow copy of an array containing only those elements which pass a test implemented by a predicate function. -* -* @param x - input array -* @param predicate - predicate function -* @param thisArg - predicate function execution context -* @returns output array -* -* @example -* var isPositiveNumber = require( '@stdlib/assert-is-positive-number' ).isPrimitive; -* var Uint8ClampedArray = require( '@stdlib/array-uint8c' ); -* -* var x = new Uint8ClampedArray( [ 1, 2, 3, 4 ] ); -* -* var out = filter( x, isPositiveNumber ); -* // returns [ 1, 2, 3, 4 ] -*/ -declare function filter( x: Uint8ClampedArray, predicate: Predicate, thisArg?: ThisParameterType> ): Uint8ClampedArray; - -/** -* Returns a shallow copy of an array containing only those elements which pass a test implemented by a predicate function. -* -* @param x - input array -* @param predicate - predicate function -* @param thisArg - predicate function execution context -* @returns output array -* -* @example -* var isPositiveNumber = require( '@stdlib/assert-is-positive-number' ).isPrimitive; -* var real = require( '@stdlib/complex-real' ); -* var imag = require( '@stdlib/complex-imag' ); -* var Complex128Array = require( '@stdlib/array-complex128' ); -* -* function predicate( v ) { -* return ( isPositiveNumber( real( v ) ) && isPositiveNumber( imag( v ) ) ); -* } -* -* var x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0 ] ); -* -* var out = filter( x, predicate ); -* // returns -*/ -declare function filter( x: Complex128Array, predicate: Predicate, thisArg?: ThisParameterType> ): Complex128Array; - -/** -* Returns a shallow copy of an array containing only those elements which pass a test implemented by a predicate function. -* -* @param x - input array -* @param predicate - predicate function -* @param thisArg - predicate function execution context -* @returns output array -* -* @example -* var isPositiveNumber = require( '@stdlib/assert-is-positive-number' ).isPrimitive; -* var realf = require( '@stdlib/complex-realf' ); -* var imagf = require( '@stdlib/complex-imagf' ); -* var Complex64Array = require( '@stdlib/array-complex64' ); -* -* function predicate( v ) { -* return ( isPositiveNumber( realf( v ) ) && isPositiveNumber( imagf( v ) ) ); -* } -* -* var x = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); -* -* var out = filter( x, predicate ); -* // returns -*/ -declare function filter( x: Complex64Array, predicate: Predicate, thisArg?: ThisParameterType> ): Complex64Array; - -/** -* Returns a shallow copy of an array containing only those elements which pass a test implemented by a predicate function. -* -* @param x - input array -* @param predicate - predicate function -* @param thisArg - predicate function execution context -* @returns output array -* -* @example -* var x = [ 1, -2, -3, 4 ]; -* -* var out = filter( x, isPositiveNumber ); -* // returns [ 1, 4 ] -*/ -declare function filter( x: Array, predicate: Predicate>, thisArg?: ThisParameterType>> ): Array; - -/** -* Returns a shallow copy of an array containing only those elements which pass a test implemented by a predicate function. -* -* @param x - input array -* @param predicate - predicate function -* @param thisArg - predicate function execution context -* @returns output array -* -* @example -* var toAccessorArray = require( '@stdlib/array-base-to-accessor-array' ); -* -* var x = toAccessorArray( [ 1, -2, -3, 4 ] ); -* -* var out = filter( x, isPositiveNumber ); -* // returns [ 1, 4 ] -*/ -declare function filter( x: AccessorArrayLike, predicate: Predicate>, thisArg?: ThisParameterType>> ): Array; - -/** -* Returns a shallow copy of an array containing only those elements which pass a test implemented by a predicate function. -* -* @param x - input array -* @param predicate - predicate function -* @param thisArg - predicate function execution context -* @returns output array -* -* @example -* var x = [ 1, -2, -3, 4 ]; -* -* var out = filter( x, isPositiveNumber ); -* // returns [ 1, 4 ] -*/ -declare function filter( x: Collection, predicate: Predicate>, thisArg?: ThisParameterType>> ): Array; - - -// EXPORTS // - -export = filter; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index a10870c..0000000 --- a/index.mjs +++ /dev/null @@ -1,4 +0,0 @@ -// Copyright (c) 2024 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 -/// -import r from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-arraylike2object@v0.2.1-esm/index.mjs";function t(t,e,n){var o;return function(r,t){return"function"==typeof r[t]}(t,"filter")?t.filter(e,n):(o=r(t)).accessorProtocol?function(r,t,e){var n,o,a,s,c;for(n=r.data,o=r.accessors[0],a=[],c=0;c 0;\n* }\n*\n* var x = [ 1, -2, -3, 4 ];\n*\n* var out = internal( x, isPositive );\n* // returns [ 1, 4 ]\n*/\nfunction internal( x, predicate, thisArg ) {\n\tvar out;\n\tvar v;\n\tvar i;\n\n\tout = [];\n\tfor ( i = 0; i < x.length; i++ ) {\n\t\tv = x[ i ];\n\t\tif ( predicate.call( thisArg, v, i, x ) ) {\n\t\t\tout.push( v );\n\t\t}\n\t}\n\treturn out;\n}\n\n/**\n* Returns a shallow copy of an array containing only those elements which pass a test implemented by a predicate function.\n*\n* @private\n* @param {Object} x - input array object\n* @param {Function} predicate - test function\n* @param {*} thisArg - execution context\n* @returns {Array} output array\n*\n* @example\n* import toAccessorArray from '@stdlib/array-base-to-accessor-array';\n* import arraylike2object from '@stdlib/array-base-arraylike2object';\n*\n* function isPositive( v ) {\n* return v > 0;\n* }\n*\n* var x = arraylike2object( toAccessorArray( [ 1, -2, -3, 4 ] ) );\n*\n* var out = accessors( x, isPositive );\n* // returns [ 1, 4 ]\n*/\nfunction accessors( x, predicate, thisArg ) {\n\tvar data;\n\tvar get;\n\tvar out;\n\tvar v;\n\tvar i;\n\n\tdata = x.data;\n\tget = x.accessors[ 0 ];\n\n\tout = [];\n\tfor ( i = 0; i < data.length; i++ ) {\n\t\tv = get( data, i );\n\t\tif ( predicate.call( thisArg, v, i, data ) ) {\n\t\t\tout.push( v );\n\t\t}\n\t}\n\treturn out;\n}\n\n\n// MAIN //\n\n/**\n* Returns a shallow copy of an array containing only those elements which pass a test implemented by a predicate function.\n*\n* @param {Collection} x - input array\n* @param {Function} predicate - test function\n* @param {*} [thisArg] - execution context\n* @returns {Collection} output array\n*\n* @example\n* function isPositive( v ) {\n* return v > 0;\n* }\n*\n* var x = [ 1, -2, -3, 4 ];\n*\n* var out = filter( x, isPositive );\n* // returns [ 1, 4 ]\n*/\nfunction filter( x, predicate, thisArg ) {\n\tvar obj;\n\tif ( hasMethod( x, 'filter' ) ) {\n\t\treturn x.filter( predicate, thisArg );\n\t}\n\tobj = arraylike2object( x );\n\tif ( obj.accessorProtocol ) {\n\t\treturn accessors( obj, predicate, thisArg );\n\t}\n\treturn internal( x, predicate, thisArg );\n}\n\n\n// EXPORTS //\n\nexport default filter;\n"],"names":["filter","x","predicate","thisArg","obj","method","hasMethod","arraylike2object","accessorProtocol","data","get","out","v","i","accessors","length","call","push","internal"],"mappings":";;sGAgJA,SAASA,EAAQC,EAAGC,EAAWC,GAC9B,IAAIC,EACJ,OAvGD,SAAoBA,EAAKC,GACxB,MAAkC,mBAAlBD,EAAKC,EACtB,CAqGMC,CAAWL,EAAG,UACXA,EAAED,OAAQE,EAAWC,IAE7BC,EAAMG,EAAkBN,IACfO,iBA/CV,SAAoBP,EAAGC,EAAWC,GACjC,IAAIM,EACAC,EACAC,EACAC,EACAC,EAMJ,IAJAJ,EAAOR,EAAEQ,KACTC,EAAMT,EAAEa,UAAW,GAEnBH,EAAM,GACAE,EAAI,EAAGA,EAAIJ,EAAKM,OAAQF,IAC7BD,EAAIF,EAAKD,EAAMI,GACVX,EAAUc,KAAMb,EAASS,EAAGC,EAAGJ,IACnCE,EAAIM,KAAML,GAGZ,OAAOD,CACR,CA8BSG,CAAWV,EAAKF,EAAWC,GArFpC,SAAmBF,EAAGC,EAAWC,GAChC,IAAIQ,EACAC,EACAC,EAGJ,IADAF,EAAM,GACAE,EAAI,EAAGA,EAAIZ,EAAEc,OAAQF,IAC1BD,EAAIX,EAAGY,GACFX,EAAUc,KAAMb,EAASS,EAAGC,EAAGZ,IACnCU,EAAIM,KAAML,GAGZ,OAAOD,CACR,CA0EQO,CAAUjB,EAAGC,EAAWC,EAChC"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index d4d08f0..0000000 --- a/stats.html +++ /dev/null @@ -1,4842 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From f73daebf4ca0a67cca1fb73c6fc4eba22dae594e Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Wed, 17 Jul 2024 03:34:36 +0000 Subject: [PATCH 26/40] Auto-generated commit --- .editorconfig | 181 - .eslintrc.js | 1 - .gitattributes | 66 - .github/PULL_REQUEST_TEMPLATE.md | 7 - .github/workflows/benchmark.yml | 64 - .github/workflows/cancel.yml | 57 - .github/workflows/close_pull_requests.yml | 54 - .github/workflows/examples.yml | 64 - .github/workflows/npm_downloads.yml | 112 - .github/workflows/productionize.yml | 794 ---- .github/workflows/publish.yml | 252 -- .github/workflows/test.yml | 99 - .github/workflows/test_bundles.yml | 186 - .github/workflows/test_coverage.yml | 133 - .github/workflows/test_install.yml | 85 - .gitignore | 188 - .npmignore | 229 - .npmrc | 31 - CHANGELOG.md | 84 - CITATION.cff | 30 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 --- README.md | 41 +- SECURITY.md | 5 - benchmark/benchmark.length.js | 97 - branches.md | 56 - dist/index.d.ts | 3 - dist/index.js | 5 - dist/index.js.map | 7 - docs/repl.txt | 46 - docs/types/test.ts | 101 - examples/index.js | 35 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/index.js | 46 - lib/main.js | 160 - package.json | 65 +- stats.html | 4842 +++++++++++++++++++++ test/dist/test.js | 33 - test/test.js | 251 -- 42 files changed, 4867 insertions(+), 4190 deletions(-) delete mode 100644 .editorconfig delete mode 100644 .eslintrc.js delete mode 100644 .gitattributes delete mode 100644 .github/PULL_REQUEST_TEMPLATE.md delete mode 100644 .github/workflows/benchmark.yml delete mode 100644 .github/workflows/cancel.yml delete mode 100644 .github/workflows/close_pull_requests.yml delete mode 100644 .github/workflows/examples.yml delete mode 100644 .github/workflows/npm_downloads.yml delete mode 100644 .github/workflows/productionize.yml delete mode 100644 .github/workflows/publish.yml delete mode 100644 .github/workflows/test.yml delete mode 100644 .github/workflows/test_bundles.yml delete mode 100644 .github/workflows/test_coverage.yml delete mode 100644 .github/workflows/test_install.yml delete mode 100644 .gitignore delete mode 100644 .npmignore delete mode 100644 .npmrc delete mode 100644 CHANGELOG.md delete mode 100644 CITATION.cff delete mode 100644 CODE_OF_CONDUCT.md delete mode 100644 CONTRIBUTING.md delete mode 100644 Makefile delete mode 100644 SECURITY.md delete mode 100644 benchmark/benchmark.length.js delete mode 100644 branches.md delete mode 100644 dist/index.d.ts delete mode 100644 dist/index.js delete mode 100644 dist/index.js.map delete mode 100644 docs/repl.txt delete mode 100644 docs/types/test.ts delete mode 100644 examples/index.js rename docs/types/index.d.ts => index.d.ts (99%) create mode 100644 index.mjs create mode 100644 index.mjs.map delete mode 100644 lib/index.js delete mode 100644 lib/main.js create mode 100644 stats.html delete mode 100644 test/dist/test.js delete mode 100644 test/test.js diff --git a/.editorconfig b/.editorconfig deleted file mode 100644 index 60d743f..0000000 --- a/.editorconfig +++ /dev/null @@ -1,181 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 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. -#/ - -# EditorConfig configuration file (see ). - -# Indicate that this file is a root-level configuration file: -root = true - -# Set properties for all files: -[*] -end_of_line = lf -charset = utf-8 -trim_trailing_whitespace = true -insert_final_newline = true - -# Set properties for JavaScript files: -[*.{js,js.txt}] -indent_style = tab - -# Set properties for JavaScript ES module files: -[*.{mjs,mjs.txt}] -indent_style = tab - -# Set properties for JavaScript CommonJS files: -[*.{cjs,cjs.txt}] -indent_style = tab - -# Set properties for JSON files: -[*.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `cli_opts.json` files: -[cli_opts.json] -indent_style = tab - -# Set properties for TypeScript files: -[*.ts] -indent_style = tab - -# Set properties for Python files: -[*.{py,py.txt}] -indent_style = space -indent_size = 4 - -# Set properties for Julia files: -[*.{jl,jl.txt}] -indent_style = tab - -# Set properties for R files: -[*.{R,R.txt}] -indent_style = tab - -# Set properties for C files: -[*.{c,c.txt}] -indent_style = tab - -# Set properties for C header files: -[*.{h,h.txt}] -indent_style = tab - -# Set properties for C++ files: -[*.{cpp,cpp.txt}] -indent_style = tab - -# Set properties for C++ header files: -[*.{hpp,hpp.txt}] -indent_style = tab - -# Set properties for Fortran files: -[*.{f,f.txt}] -indent_style = space -indent_size = 2 -insert_final_newline = false - -# Set properties for shell files: -[*.{sh,sh.txt}] -indent_style = tab - -# Set properties for AWK files: -[*.{awk,awk.txt}] -indent_style = tab - -# Set properties for HTML files: -[*.{html,html.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for XML files: -[*.{xml,xml.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for CSS files: -[*.{css,css.txt}] -indent_style = tab - -# Set properties for Makefiles: -[Makefile] -indent_style = tab - -[*.{mk,mk.txt}] -indent_style = tab - -# Set properties for Markdown files: -[*.{md,md.txt}] -indent_style = space -indent_size = 4 -trim_trailing_whitespace = false - -# Set properties for `usage.txt` files: -[usage.txt] -indent_style = space -indent_size = 2 - -# Set properties for `repl.txt` files: -[repl.txt] -indent_style = space -indent_size = 4 - -# Set properties for `package.json` files: -[package.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `datapackage.json` files: -[datapackage.json] -indent_style = space -indent_size = 2 - -# Set properties for `manifest.json` files: -[manifest.json] -indent_style = space -indent_size = 2 - -# Set properties for `tsconfig.json` files: -[tsconfig.json] -indent_style = space -indent_size = 2 - -# Set properties for LaTeX files: -[*.{tex,tex.txt}] -indent_style = tab - -# Set properties for LaTeX Bibliography files: -[*.{bib,bib.txt}] -indent_style = tab - -# Set properties for YAML files: -[*.{yml,yml.txt}] -indent_style = space -indent_size = 2 - -# Set properties for GYP files: -[binding.gyp] -indent_style = space -indent_size = 2 - -[*.gypi] -indent_style = space -indent_size = 2 - -# Set properties for citation files: -[*.{cff,cff.txt}] -indent_style = space -indent_size = 2 diff --git a/.eslintrc.js b/.eslintrc.js deleted file mode 100644 index 5f30286..0000000 --- a/.eslintrc.js +++ /dev/null @@ -1 +0,0 @@ -/* For the `eslint` rules of this project, consult the main repository at https://github.com/stdlib-js/stdlib */ diff --git a/.gitattributes b/.gitattributes deleted file mode 100644 index 1c88e69..0000000 --- a/.gitattributes +++ /dev/null @@ -1,66 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 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. -#/ - -# Configuration file which assigns attributes to pathnames. -# -# [1]: https://git-scm.com/docs/gitattributes - -# Automatically normalize the line endings of any committed text files: -* text=auto - -# Override line endings for certain files on checkout: -*.crlf.csv text eol=crlf - -# Denote that certain files are binary and should not be modified: -*.png binary -*.jpg binary -*.jpeg binary -*.gif binary -*.ico binary -*.gz binary -*.zip binary -*.7z binary -*.mp3 binary -*.mp4 binary -*.mov binary - -# Override what is considered "vendored" by GitHub's linguist: -/lib/node_modules/** -linguist-vendored -linguist-generated - -# Configure directories which should *not* be included in GitHub language statistics: -/deps/** linguist-vendored -/dist/** linguist-generated -/workshops/** linguist-vendored - -benchmark/** linguist-vendored -docs/* linguist-documentation -etc/** linguist-vendored -examples/** linguist-documentation -scripts/** linguist-vendored -test/** linguist-vendored -tools/** linguist-vendored - -# Configure files which should *not* be included in GitHub language statistics: -Makefile linguist-vendored -*.mk linguist-vendored -*.jl linguist-vendored -*.py linguist-vendored -*.R linguist-vendored - -# Configure files which should be included in GitHub language statistics: -docs/types/*.d.ts -linguist-documentation diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index 6559bc7..0000000 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ /dev/null @@ -1,7 +0,0 @@ - - -We are excited about your pull request, but unfortunately we are not accepting pull requests against this repository, as all development happens on the [main project repository](https://github.com/stdlib-js/stdlib). We kindly request that you submit this pull request against the [respective directory](https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/filter) of the main repository where we’ll review and provide feedback. - -If this is your first stdlib contribution, be sure to read the [contributing guide](https://github.com/stdlib-js/stdlib/blob/develop/CONTRIBUTING.md) which provides guidelines and instructions for submitting contributions. You may also consult the [development guide](https://github.com/stdlib-js/stdlib/blob/develop/docs/development.md) for help on developing stdlib. - -We look forward to receiving your contribution! :smiley: \ No newline at end of file diff --git a/.github/workflows/benchmark.yml b/.github/workflows/benchmark.yml deleted file mode 100644 index e4f10fe..0000000 --- a/.github/workflows/benchmark.yml +++ /dev/null @@ -1,64 +0,0 @@ -#/ -# @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. -#/ - -# Workflow name: -name: benchmark - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to run benchmarks: - benchmark: - - # Define a display name: - name: 'Run benchmarks' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Run benchmarks: - - name: 'Run benchmarks' - run: | - npm run benchmark diff --git a/.github/workflows/cancel.yml b/.github/workflows/cancel.yml deleted file mode 100644 index b5291db..0000000 --- a/.github/workflows/cancel.yml +++ /dev/null @@ -1,57 +0,0 @@ -#/ -# @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. -#/ - -# Workflow name: -name: cancel - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to cancel existing workflow runs: - cancel: - - # Define a display name: - name: 'Cancel workflow runs' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Time limit: - timeout-minutes: 3 - - # Define the sequence of job steps... - steps: - - # Cancel existing workflow runs: - - name: 'Cancel existing workflow runs' - # Pin action to full length commit SHA - uses: styfle/cancel-workflow-action@85880fa0301c86cca9da44039ee3bb12d3bedbfa # v0.12.1 - with: - workflow_id: >- - benchmark.yml, - examples.yml, - test.yml, - test_coverage.yml, - test_install.yml, - publish.yml - access_token: ${{ github.token }} diff --git a/.github/workflows/close_pull_requests.yml b/.github/workflows/close_pull_requests.yml deleted file mode 100644 index 2060eba..0000000 --- a/.github/workflows/close_pull_requests.yml +++ /dev/null @@ -1,54 +0,0 @@ -#/ -# @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. -#/ - -# Workflow name: -name: close_pull_requests - -# Workflow triggers: -on: - pull_request_target: - types: [opened] - -# Workflow jobs: -jobs: - - # Define job to close all pull requests: - run: - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - - # Close pull request - - name: 'Close pull request' - # Pin action to full length commit SHA corresponding to v3.1.2 - uses: superbrothers/close-pull-request@9c18513d320d7b2c7185fb93396d0c664d5d8448 - with: - comment: | - Thank you for submitting a pull request. :raised_hands: - - We greatly appreciate your willingness to submit a contribution. However, we are not accepting pull requests against this repository, as all development happens on the [main project repository](https://github.com/stdlib-js/stdlib). - - We kindly request that you submit this pull request against the [respective directory](https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/filter) of the main repository where we’ll review and provide feedback. If this is your first stdlib contribution, be sure to read the [contributing guide](https://github.com/stdlib-js/stdlib/blob/develop/CONTRIBUTING.md) which provides guidelines and instructions for submitting contributions. - - Thank you again, and we look forward to receiving your contribution! :smiley: - - Best, - The stdlib team \ No newline at end of file diff --git a/.github/workflows/examples.yml b/.github/workflows/examples.yml deleted file mode 100644 index 2984901..0000000 --- a/.github/workflows/examples.yml +++ /dev/null @@ -1,64 +0,0 @@ -#/ -# @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. -#/ - -# Workflow name: -name: examples - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to run the package examples... - examples: - - # Define display name: - name: 'Run examples' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - - # Checkout repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Run examples: - - name: 'Run examples' - run: | - npm run examples diff --git a/.github/workflows/npm_downloads.yml b/.github/workflows/npm_downloads.yml deleted file mode 100644 index c2326d6..0000000 --- a/.github/workflows/npm_downloads.yml +++ /dev/null @@ -1,112 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2022 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. -#/ - -# Workflow name: -name: npm_downloads - -# Workflow triggers: -on: - # Run this workflow weekly: - schedule: - # cron: ' ' - - cron: '48 12 * * 3' - - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job for retrieving npm download counts... - npm_downloads: - - # Define display name: - name: 'Retrieve npm download counts' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - timeout-minutes: 10 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Resolve package name: - - name: 'Resolve package name' - id: package_name - run: | - name=`node -e 'console.log(require("./package.json").name)' | tr -d '\n'` - echo "package_name=$name" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Fetch download data: - - name: 'Fetch data' - id: download_data - run: | - url="https://api.npmjs.org/downloads/range/$(date --date='1 year ago' '+%Y-%m-%d'):$(date '+%Y-%m-%d')/${{ steps.package_name.outputs.package_name }}" - echo "$url" - data=$(curl "$url") - mkdir ./tmp - echo "$data" > ./tmp/npm_downloads.json - echo "data=$data" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Print summary of download data: - - name: 'Print summary' - run: | - echo "| Date | Downloads |" >> $GITHUB_STEP_SUMMARY - echo "|------|------------|" >> $GITHUB_STEP_SUMMARY - cat ./tmp/npm_downloads.json | jq -r ".downloads | .[-14:] | to_entries | map(\"| \(.value.day) | \(.value.downloads) |\") |.[]" >> $GITHUB_STEP_SUMMARY - - # Upload the download data: - - name: 'Upload data' - # Pin action to full length commit SHA - uses: actions/upload-artifact@5d5d22a31266ced268874388b861e4b58bb5c2f3 # v4.3.1 - with: - # Define a name for the uploaded artifact (ensuring a unique name for each job): - name: npm_downloads - - # Specify the path to the file to upload: - path: ./tmp/npm_downloads.json - - # Specify the number of days to retain the artifact (default is 90 days): - retention-days: 90 - timeout-minutes: 10 - if: success() - - # Send data to events server: - - name: 'Post data' - # Pin action to full length commit SHA - uses: distributhor/workflow-webhook@48a40b380ce4593b6a6676528cd005986ae56629 # v3.0.3 - env: - webhook_url: ${{ secrets.STDLIB_NPM_DOWNLOADS_URL }} - webhook_secret: ${{ secrets.STDLIB_WEBHOOK_SECRET }} - data: '{ "downloads": ${{ steps.download_data.outputs.data }} }' - timeout-minutes: 5 - if: success() diff --git a/.github/workflows/productionize.yml b/.github/workflows/productionize.yml deleted file mode 100644 index f92a6c5..0000000 --- a/.github/workflows/productionize.yml +++ /dev/null @@ -1,794 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2022 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. -#/ - -# Workflow name: -name: productionize - -# Workflow triggers: -on: - # Run workflow when a new commit is pushed to the main branch: - push: - branches: - - main - - # Allow the workflow to be manually run: - workflow_dispatch: - inputs: - require-passing-tests: - description: 'Require passing tests for creating bundles' - type: boolean - default: true - - # Run workflow upon completion of `publish` workflow run: - workflow_run: - workflows: ["publish"] - types: [completed] - - -# Concurrency group to prevent multiple concurrent executions: -concurrency: - group: productionize - cancel-in-progress: true - -# Workflow jobs: -jobs: - - # Define a job to create a production build... - productionize: - - # Define display name: - name: 'Productionize' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Define the sequence of job steps... - steps: - # Checkout main branch of repository: - - name: 'Checkout main branch' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - with: - ref: main - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Create production branch: - - name: 'Create production branch' - run: | - git checkout -b production - - # Transform error messages: - - name: 'Transform error messages' - id: transform-error-messages - uses: stdlib-js/transform-errors-action@main - - # 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: | - PKG_VERSION=$(npm view @stdlib/error-tools-fmtprodmsg version) - if grep -q '"@stdlib/string-format"' package.json; then - sed -i "s/\"@stdlib\/string-format\": \"^.*\"/\"@stdlib\/error-tools-fmtprodmsg\": \"^$PKG_VERSION\"/g" package.json - else - node -e "var pkg = require( './package.json' ); pkg.dependencies[ '@stdlib/error-tools-fmtprodmsg' ] = '^$PKG_VERSION'; require( 'fs' ).writeFileSync( 'package.json', JSON.stringify( pkg, null, 2 ) );" - fi - - # Configure git: - - name: 'Configure git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Transform error messages" - - # Push changes: - - name: 'Push changes' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" production --force - - # Define a job for running tests of the productionized code... - test: - - # Define a display name: - name: 'Run Tests' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Indicate that this job depends on the prior job finishing: - needs: productionize - - # Run this job regardless of the outcome of the prior job: - if: always() - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout repository' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - with: - # Use the `production` branch: - ref: production - - # Install Node.js: - - name: 'Install Node.js' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Build native add-on if present: - - name: 'Build native add-on (if present)' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - run: | - if [ -f "binding.gyp" ]; then - npm install node-gyp --no-save && ./node_modules/.bin/node-gyp rebuild - fi - - # Run tests: - - name: 'Run tests' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: tests - run: | - npm test || npm test || npm test - - # Define job to create a bundle for use in Deno... - deno: - - # Define display name: - name: 'Create Deno bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Configure git: - - name: 'Configure git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `deno` branch exists: - - name: 'Check if remote `deno` branch exists' - id: deno-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin deno - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `deno` exists, delete everything in branch and merge `production` into it - - name: 'If `deno` exists, delete everything in branch and merge `production` into it' - if: steps.deno-branch-exists.outputs.remote-exists - run: | - git checkout -b deno origin/deno - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `deno` does not exist, create `deno` branch: - - name: 'If `deno` does not exist, create `deno` branch' - if: ${{ steps.deno-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b deno - - # Copy files to deno directory: - - name: 'Copy files to deno directory' - run: | - mkdir -p deno - cp README.md LICENSE CONTRIBUTORS NOTICE ./deno - - # Copy TypeScript definitions to deno directory: - if [ -d index.d.ts ]; then - cp index.d.ts ./deno/index.d.ts - fi - if [ -e ./docs/types/index.d.ts ]; then - cp ./docs/types/index.d.ts ./deno/mod.d.ts - fi - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: Install production and development dependencies - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Bundle package for use in Deno: - - name: 'Bundle package for Deno' - id: deno-bundle - uses: stdlib-js/bundle-action@main - with: - target: 'deno' - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - # Replace links to other packages with links to the deno branch: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/deno/"; - - # Replace reference to `@stdlib/types` with CDN link: - find ./deno -type f -name '*.ts' -print0 | xargs -0 -r sed -Ei "s/\/\/\/ /\/\/\/ /g" - - # Change wording of project description to avoid reference to JavaScript and Node.js: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "s/a standard library for JavaScript and Node.js, /a standard library /g" - - # Rewrite all `require()`s to use jsDelivr links: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/require\( '@stdlib\// { - s/(var|let|const)\s+([a-z0-9_]+)\s+=\s*require\( '([^']+)' \);/import \2 from \'\3\';/i - s/@stdlib/https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js/ - s/';/@deno\/mod.js';/ - }" - - # Rewrite first `import` to show importing of named exports if available: - exports=$(cat lib/index.js | \ - grep -E 'setReadOnly\(.*,.*,.*\)' | \ - sed -E 's/setReadOnly\((.*),(.*),(.*)\);/\2/' | \ - sed -E "s/'//g" | \ - sort) - if [ -n "$exports" ]; then - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\nimport\s+([a-zA-Z0-9_]+)\s+from\s*'([^']+)';\n\`\`\`/\`\`\`javascript\nimport \1 from '\2';\n\`\`\`\n\nYou can also import the following named exports from the package:\n\n\`\`\`javascript\nimport { $(echo $exports | sed -E 's/ /, /g') } from '\2';\n\`\`\`/" - fi - - # Remove `installation`, `cli`, and `c` sections: - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Create package.json file for deno branch: - jq --indent 2 '{"name": .name, "version": .version, "description": .description, "license": .license, "type": "module", "main": "./mod.js", "homepage": .homepage, "repository": .repository, "bugs": .bugs, "keywords": .keywords, "funding": .funding}' package.json > ./deno/package.json - - # Delete everything in current directory aside from deno folder: - - name: 'Delete everything in current directory aside from deno folder' - run: | - find . -type 'f' | grep -v -e "deno" -e ".git/" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e "deno" -e ".git" | xargs -r rm -rf - - # Move deno directory to root: - - name: 'Move deno directory to root' - run: | - mv ./deno/* . - rmdir ./deno - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Auto-generated commit" - - # Push changes to `deno` branch: - - name: 'Push changes to `deno` branch' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" deno - - # Send status to Slack channel if job fails: - - name: 'Send status to Slack channel in case of failure' - # Pin action to full length commit SHA - uses: 8398a7/action-slack@28ba43ae48961b90635b50953d216767a6bea486 # v3.16.2 - with: - status: ${{ job.status }} - channel: '#npm-ci' - if: failure() - - # Define job to create a UMD bundle... - umd: - - # Define display name: - name: 'Create UMD bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Configure git: - - name: 'Configure git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `umd` branch exists: - - name: 'Check if remote `umd` branch exists' - id: umd-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin umd - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `umd` exists, delete everything in branch and merge `production` into it - - name: 'If `umd` exists, delete everything in branch and merge `production` into it' - if: steps.umd-branch-exists.outputs.remote-exists - run: | - git checkout -b umd origin/umd - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `umd` does not exist, create `umd` branch: - - name: 'If `umd` does not exist, create `umd` branch' - if: ${{ steps.umd-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b umd - - # Copy files to umd directory: - - name: 'Copy files to umd directory' - run: | - mkdir -p umd - cp README.md LICENSE CONTRIBUTORS NOTICE ./umd - - # Install Node.js - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Extract alias: - - name: 'Extract alias' - id: extract-alias - run: | - alias=$(grep -E 'require\(' README.md | head -n 1 | sed -E 's/^var ([a-zA-Z0-9_]+) = .+/\1/') - echo "alias=${alias}" >> $GITHUB_OUTPUT - - # Create Universal Module Definition (UMD) Node.js bundle: - - name: 'Create Universal Module Definition (UMD) Node.js bundle' - id: umd-bundle-node - uses: stdlib-js/bundle-action@main - with: - target: 'umd-node' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Create Universal Module Definition (UMD) browser bundle: - - name: 'Create Universal Module Definition (UMD) browser bundle' - id: umd-bundle-browser - uses: stdlib-js/bundle-action@main - with: - target: 'umd-browser' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - - # Replace links to other packages with links to the umd branch: - find ./umd -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/umd/"; - - # Remove `installation`, `cli`, and `c` sections: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Rewrite first `require()` to show consumption of the UMD bundle in Observable and via a `script` tag: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\n(var|let|const)\s+([a-zA-Z0-9_]+)\s+=\s*require\( '\@stdlib\/([^']+)' \);\n\`\`\`/To use in Observable,\n\n\`\`\`javascript\n\2 = require\( 'https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js\/\3\@umd\/browser.js' \)\n\`\`\`\n\nTo vendor stdlib functionality and avoid installing dependency trees for Node.js, you can use the UMD server build:\n\n\`\`\`javascript\nvar \2 = require\( 'path\/to\/vendor\/umd\/\3\/index.js' \)\n\`\`\`\n\nTo include the bundle in a webpage,\n\n\`\`\`html\n + + ```
@@ -189,7 +180,7 @@ var out = filter( x, naryFunction( isPositiveInteger, 1 ) ); ## 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. +This package is part of [stdlib][stdlib], a standard library 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]. diff --git a/SECURITY.md b/SECURITY.md deleted file mode 100644 index 9702d4c..0000000 --- a/SECURITY.md +++ /dev/null @@ -1,5 +0,0 @@ -# Security - -> Policy for reporting security vulnerabilities. - -See the security policy [in the main project repository](https://github.com/stdlib-js/stdlib/security). diff --git a/benchmark/benchmark.length.js b/benchmark/benchmark.length.js deleted file mode 100644 index bc79e33..0000000 --- a/benchmark/benchmark.length.js +++ /dev/null @@ -1,97 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 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 bench = require( '@stdlib/bench-harness' ); -var pow = require( '@stdlib/math-base-special-pow' ); -var isArray = require( '@stdlib/assert-is-array' ); -var isNonNegativeInteger = require( '@stdlib/assert-is-nonnegative-integer' ).isPrimitive; -var zeroTo = require( '@stdlib/array-base-zero-to' ); -var pkg = require( './../package.json' ).name; -var filter = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveInteger} len - array length -* @returns {Function} benchmark function -*/ -function createBenchmark( len ) { - var x = zeroTo( len ); - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var out; - var i; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - out = filter( x, isNonNegativeInteger ); - if ( typeof out !== 'object' ) { - b.fail( 'should return an array' ); - } - } - b.toc(); - if ( !isArray( out ) ) { - b.fail( 'should return an array' ); - } - b.pass( 'benchmark finished' ); - b.end(); - } -} - - -// MAIN // - -/** -* Main execution sequence. -* -* @private -*/ -function main() { - var len; - var min; - var max; - var f; - var i; - - min = 1; // 10^min - max = 6; // 10^max - - for ( i = min; i <= max; i++ ) { - len = pow( 10, i ); - - f = createBenchmark( len ); - bench( pkg+':dtype=generic,len='+len, f ); - } -} - -main(); diff --git a/branches.md b/branches.md deleted file mode 100644 index 9858901..0000000 --- a/branches.md +++ /dev/null @@ -1,56 +0,0 @@ - - -# Branches - -This repository has the following branches: - -- **main**: default branch generated from the [stdlib project][stdlib-url], where all development takes place. -- **production**: [production build][production-url] of the package (e.g., reformatted error messages to reduce bundle sizes and thus the number of bytes transmitted over a network). -- **esm**: [ES Module][esm-url] branch for use via a `script` tag without the need for installation and bundlers (see [README][esm-readme]). -- **deno**: [Deno][deno-url] branch for use in Deno (see [README][deno-readme]). -- **umd**: [UMD][umd-url] branch for use in Observable, or in dual browser/Node.js environments (see [README][umd-readme]). - -The following diagram illustrates the relationships among the above branches: - -```mermaid -graph TD; -A[stdlib]-->|generate standalone package|B; -B[main] -->|productionize| C[production]; -C -->|bundle| D[esm]; -C -->|bundle| E[deno]; -C -->|bundle| F[umd]; - -%% click A href "https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/filter" -%% click B href "https://github.com/stdlib-js/array-base-filter/tree/main" -%% click C href "https://github.com/stdlib-js/array-base-filter/tree/production" -%% click D href "https://github.com/stdlib-js/array-base-filter/tree/esm" -%% click E href "https://github.com/stdlib-js/array-base-filter/tree/deno" -%% click F href "https://github.com/stdlib-js/array-base-filter/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/filter -[production-url]: https://github.com/stdlib-js/array-base-filter/tree/production -[deno-url]: https://github.com/stdlib-js/array-base-filter/tree/deno -[deno-readme]: https://github.com/stdlib-js/array-base-filter/blob/deno/README.md -[umd-url]: https://github.com/stdlib-js/array-base-filter/tree/umd -[umd-readme]: https://github.com/stdlib-js/array-base-filter/blob/umd/README.md -[esm-url]: https://github.com/stdlib-js/array-base-filter/tree/esm -[esm-readme]: https://github.com/stdlib-js/array-base-filter/blob/esm/README.md \ No newline at end of file diff --git a/dist/index.d.ts b/dist/index.d.ts deleted file mode 100644 index aafb9cb..0000000 --- a/dist/index.d.ts +++ /dev/null @@ -1,3 +0,0 @@ -/// -import filter from '../docs/types/index'; -export = filter; \ No newline at end of file diff --git a/dist/index.js b/dist/index.js deleted file mode 100644 index 5c2f789..0000000 --- a/dist/index.js +++ /dev/null @@ -1,5 +0,0 @@ -"use strict";var s=function(r,t){return function(){return t||r((t={exports:{}}).exports,t),t.exports}};var f=s(function(y,c){ -var v=require('@stdlib/array-base-arraylike2object/dist');function l(r,t){return typeof r[t]=="function"}function h(r,t,n){var e,o,a;for(e=[],a=0;a 0;\n* }\n*\n* var x = [ 1, -2, -3, 4 ];\n*\n* var out = internal( x, isPositive );\n* // returns [ 1, 4 ]\n*/\nfunction internal( x, predicate, thisArg ) {\n\tvar out;\n\tvar v;\n\tvar i;\n\n\tout = [];\n\tfor ( i = 0; i < x.length; i++ ) {\n\t\tv = x[ i ];\n\t\tif ( predicate.call( thisArg, v, i, x ) ) {\n\t\t\tout.push( v );\n\t\t}\n\t}\n\treturn out;\n}\n\n/**\n* Returns a shallow copy of an array containing only those elements which pass a test implemented by a predicate function.\n*\n* @private\n* @param {Object} x - input array object\n* @param {Function} predicate - test function\n* @param {*} thisArg - execution context\n* @returns {Array} output array\n*\n* @example\n* var toAccessorArray = require( '@stdlib/array-base-to-accessor-array' );\n* var arraylike2object = require( '@stdlib/array-base-arraylike2object' );\n*\n* function isPositive( v ) {\n* return v > 0;\n* }\n*\n* var x = arraylike2object( toAccessorArray( [ 1, -2, -3, 4 ] ) );\n*\n* var out = accessors( x, isPositive );\n* // returns [ 1, 4 ]\n*/\nfunction accessors( x, predicate, thisArg ) {\n\tvar data;\n\tvar get;\n\tvar out;\n\tvar v;\n\tvar i;\n\n\tdata = x.data;\n\tget = x.accessors[ 0 ];\n\n\tout = [];\n\tfor ( i = 0; i < data.length; i++ ) {\n\t\tv = get( data, i );\n\t\tif ( predicate.call( thisArg, v, i, data ) ) {\n\t\t\tout.push( v );\n\t\t}\n\t}\n\treturn out;\n}\n\n\n// MAIN //\n\n/**\n* Returns a shallow copy of an array containing only those elements which pass a test implemented by a predicate function.\n*\n* @param {Collection} x - input array\n* @param {Function} predicate - test function\n* @param {*} [thisArg] - execution context\n* @returns {Collection} output array\n*\n* @example\n* function isPositive( v ) {\n* return v > 0;\n* }\n*\n* var x = [ 1, -2, -3, 4 ];\n*\n* var out = filter( x, isPositive );\n* // returns [ 1, 4 ]\n*/\nfunction filter( x, predicate, thisArg ) {\n\tvar obj;\n\tif ( hasMethod( x, 'filter' ) ) {\n\t\treturn x.filter( predicate, thisArg );\n\t}\n\tobj = arraylike2object( x );\n\tif ( obj.accessorProtocol ) {\n\t\treturn accessors( obj, predicate, thisArg );\n\t}\n\treturn internal( x, predicate, thisArg );\n}\n\n\n// EXPORTS //\n\nmodule.exports = filter;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2024 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* Return a shallow copy of an array containing only those elements which pass a test implemented by a predicate function.\n*\n* @module @stdlib/array-base-filter\n*\n* @example\n* var filter = require( '@stdlib/array-base-filter' );\n*\n* function isPositive( v ) {\n* return v > 0;\n* }\n*\n* var x = [ 1, -2, -3, 4 ];\n*\n* var out = filter( x, isPositive );\n* // returns [ 1, 4 ]\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,EAAmB,QAAS,qCAAsC,EAqBtE,SAASC,EAAWC,EAAKC,EAAS,CACjC,OAAS,OAAOD,EAAKC,CAAO,GAAM,UACnC,CAqBA,SAASC,EAAUC,EAAGC,EAAWC,EAAU,CAC1C,IAAIC,EACAC,EACAC,EAGJ,IADAF,EAAM,CAAC,EACDE,EAAI,EAAGA,EAAIL,EAAE,OAAQK,IAC1BD,EAAIJ,EAAGK,CAAE,EACJJ,EAAU,KAAMC,EAASE,EAAGC,EAAGL,CAAE,GACrCG,EAAI,KAAMC,CAAE,EAGd,OAAOD,CACR,CAwBA,SAASG,EAAWN,EAAGC,EAAWC,EAAU,CAC3C,IAAIK,EACAC,EACAL,EACAC,EACAC,EAMJ,IAJAE,EAAOP,EAAE,KACTQ,EAAMR,EAAE,UAAW,CAAE,EAErBG,EAAM,CAAC,EACDE,EAAI,EAAGA,EAAIE,EAAK,OAAQF,IAC7BD,EAAII,EAAKD,EAAMF,CAAE,EACZJ,EAAU,KAAMC,EAASE,EAAGC,EAAGE,CAAK,GACxCJ,EAAI,KAAMC,CAAE,EAGd,OAAOD,CACR,CAuBA,SAASM,EAAQT,EAAGC,EAAWC,EAAU,CACxC,IAAIL,EACJ,OAAKD,EAAWI,EAAG,QAAS,EACpBA,EAAE,OAAQC,EAAWC,CAAQ,GAErCL,EAAMF,EAAkBK,CAAE,EACrBH,EAAI,iBACDS,EAAWT,EAAKI,EAAWC,CAAQ,EAEpCH,EAAUC,EAAGC,EAAWC,CAAQ,EACxC,CAKAR,EAAO,QAAUe,ICvHjB,IAAIC,EAAO,IAKX,OAAO,QAAUA", - "names": ["require_main", "__commonJSMin", "exports", "module", "arraylike2object", "hasMethod", "obj", "method", "internal", "x", "predicate", "thisArg", "out", "v", "i", "accessors", "data", "get", "filter", "main"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index bb2b17a..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,46 +0,0 @@ - -{{alias}}( x, predicate[, thisArg] ) - Returns a shallow copy of an array containing only those elements which pass - a test implemented by a predicate function. - - The predicate function is provided three arguments: - - - value: current array element. - - index: current array element index. - - arr: the input array. - - If provided an array-like object having a `filter` method , the function - defers execution to that method and assumes that the method has the - following signature: - - x.filter( predicate, thisArg ) - - If provided an array-like object without a `filter` method, the function - performs a linear scan and always returns a generic array. - - Parameters - ---------- - x: Array|TypedArray|Object - Input array. - - predicate: Function - Predicate function. - - thisArg: any (optional) - Execution context. - - Returns - ------- - out: Array|TypedArray|Object - Output array. - - Examples - -------- - > function f( v ) { return ( v > 0 ); }; - > var x = [ 1, -2, -3, 4 ]; - > var out = {{alias}}( x, f ) - [ 1, 4 ] - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index db0c38d..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,101 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2024 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. -*/ - -import toAccessorArray = require( '@stdlib/array-base-to-accessor-array' ); -import filter = require( './index' ); - -/** -* Tests whether a value is positive. -* -* @param value - input value -* @returns boolean indicating whether an element is positive -*/ -function isPositive( value: number ): boolean { - return ( value > 0 ); -} - - -// TESTS // - -// The function returns a collection... -{ - filter( [ 1, 2, 3 ], isPositive ); // $ExpectType number[] - filter( new Float64Array( [ 1, 2, 3 ] ), isPositive ); // $ExpectType Float64Array - filter( new Float32Array( [ 1, 2, 3 ] ), isPositive ); // $ExpectType Float32Array - filter( new Int32Array( [ 1, 2, 3 ] ), isPositive ); // $ExpectType Int32Array - filter( new Int16Array( [ 1, 2, 3 ] ), isPositive ); // $ExpectType Int16Array - filter( new Int8Array( [ 1, 2, 3 ] ), isPositive ); // $ExpectType Int8Array - filter( new Uint32Array( [ 1, 2, 3 ] ), isPositive ); // $ExpectType Uint32Array - filter( new Uint16Array( [ 1, 2, 3 ] ), isPositive ); // $ExpectType Uint16Array - filter( new Uint8Array( [ 1, 2, 3 ] ), isPositive ); // $ExpectType Uint8Array - filter( new Uint8ClampedArray( [ 1, 2, 3 ] ), isPositive ); // $ExpectType Uint8ClampedArray - filter( toAccessorArray( [ 1, 2, 3 ] ), isPositive ); // $ExpectType number[] - - filter( [ 1, 2, 3 ], isPositive, {} ); // $ExpectType number[] - filter( new Float64Array( [ 1, 2, 3 ] ), isPositive, {} ); // $ExpectType Float64Array - filter( new Float32Array( [ 1, 2, 3 ] ), isPositive, {} ); // $ExpectType Float32Array - filter( new Int32Array( [ 1, 2, 3 ] ), isPositive, {} ); // $ExpectType Int32Array - filter( new Int16Array( [ 1, 2, 3 ] ), isPositive, {} ); // $ExpectType Int16Array - filter( new Int8Array( [ 1, 2, 3 ] ), isPositive, {} ); // $ExpectType Int8Array - filter( new Uint32Array( [ 1, 2, 3 ] ), isPositive, {} ); // $ExpectType Uint32Array - filter( new Uint16Array( [ 1, 2, 3 ] ), isPositive, {} ); // $ExpectType Uint16Array - filter( new Uint8Array( [ 1, 2, 3 ] ), isPositive, {} ); // $ExpectType Uint8Array - filter( new Uint8ClampedArray( [ 1, 2, 3 ] ), isPositive, {} ); // $ExpectType Uint8ClampedArray - filter( toAccessorArray( [ 1, 2, 3 ] ), isPositive, {} ); // $ExpectType number[] -} - -// The compiler throws an error if the function is provided a first argument which is not a collection... -{ - filter( 2, isPositive ); // $ExpectError - filter( false, isPositive ); // $ExpectError - filter( true, isPositive ); // $ExpectError - filter( {}, isPositive ); // $ExpectError - - filter( 2, isPositive, {} ); // $ExpectError - filter( false, isPositive, {} ); // $ExpectError - filter( true, isPositive, {} ); // $ExpectError - filter( {}, isPositive, {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided a second argument which is not a function... -{ - filter( [ 1, 2, 3 ], 'abc' ); // $ExpectError - filter( [ 1, 2, 3 ], 2 ); // $ExpectError - filter( [ 1, 2, 3 ], false ); // $ExpectError - filter( [ 1, 2, 3 ], true ); // $ExpectError - filter( [ 1, 2, 3 ], null ); // $ExpectError - filter( [ 1, 2, 3 ], void 0 ); // $ExpectError - filter( [ 1, 2, 3 ], {} ); // $ExpectError - filter( [ 1, 2, 3 ], [] ); // $ExpectError - - filter( [ 1, 2, 3 ], 'abc', {} ); // $ExpectError - filter( [ 1, 2, 3 ], 2, {} ); // $ExpectError - filter( [ 1, 2, 3 ], false, {} ); // $ExpectError - filter( [ 1, 2, 3 ], true, {} ); // $ExpectError - filter( [ 1, 2, 3 ], null, {} ); // $ExpectError - filter( [ 1, 2, 3 ], void 0, {} ); // $ExpectError - filter( [ 1, 2, 3 ], {}, {} ); // $ExpectError - filter( [ 1, 2, 3 ], [], {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided an unsupported number of arguments... -{ - filter(); // $ExpectError - filter( [ 1, 2, 3 ] ); // $ExpectError - filter( [ 1, 2, 3 ], isPositive, {}, 3 ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index cdfb9a7..0000000 --- a/examples/index.js +++ /dev/null @@ -1,35 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 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'; - -var discreteUniform = require( '@stdlib/random-array-discrete-uniform' ); -var isPositiveInteger = require( '@stdlib/assert-is-positive-integer' ).isPrimitive; -var naryFunction = require( '@stdlib/utils-nary-function' ); -var filter = require( './../lib' ); - -var x = discreteUniform( 10, -5, 5, { - 'dtype': 'int32' -}); -// returns - -var out = filter( x, naryFunction( isPositiveInteger, 1 ) ); -// returns - -console.log( x ); -console.log( out ); diff --git a/docs/types/index.d.ts b/index.d.ts similarity index 99% rename from docs/types/index.d.ts rename to index.d.ts index 6387b45..66b6dff 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 4.1 -/// +/// import { Collection, AccessorArrayLike, Complex128Array, Complex64Array } from '@stdlib/types/array'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..a10870c --- /dev/null +++ b/index.mjs @@ -0,0 +1,4 @@ +// Copyright (c) 2024 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 +/// +import r from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-arraylike2object@v0.2.1-esm/index.mjs";function t(t,e,n){var o;return function(r,t){return"function"==typeof r[t]}(t,"filter")?t.filter(e,n):(o=r(t)).accessorProtocol?function(r,t,e){var n,o,a,s,c;for(n=r.data,o=r.accessors[0],a=[],c=0;c 0;\n* }\n*\n* var x = [ 1, -2, -3, 4 ];\n*\n* var out = internal( x, isPositive );\n* // returns [ 1, 4 ]\n*/\nfunction internal( x, predicate, thisArg ) {\n\tvar out;\n\tvar v;\n\tvar i;\n\n\tout = [];\n\tfor ( i = 0; i < x.length; i++ ) {\n\t\tv = x[ i ];\n\t\tif ( predicate.call( thisArg, v, i, x ) ) {\n\t\t\tout.push( v );\n\t\t}\n\t}\n\treturn out;\n}\n\n/**\n* Returns a shallow copy of an array containing only those elements which pass a test implemented by a predicate function.\n*\n* @private\n* @param {Object} x - input array object\n* @param {Function} predicate - test function\n* @param {*} thisArg - execution context\n* @returns {Array} output array\n*\n* @example\n* import toAccessorArray from '@stdlib/array-base-to-accessor-array';\n* import arraylike2object from '@stdlib/array-base-arraylike2object';\n*\n* function isPositive( v ) {\n* return v > 0;\n* }\n*\n* var x = arraylike2object( toAccessorArray( [ 1, -2, -3, 4 ] ) );\n*\n* var out = accessors( x, isPositive );\n* // returns [ 1, 4 ]\n*/\nfunction accessors( x, predicate, thisArg ) {\n\tvar data;\n\tvar get;\n\tvar out;\n\tvar v;\n\tvar i;\n\n\tdata = x.data;\n\tget = x.accessors[ 0 ];\n\n\tout = [];\n\tfor ( i = 0; i < data.length; i++ ) {\n\t\tv = get( data, i );\n\t\tif ( predicate.call( thisArg, v, i, data ) ) {\n\t\t\tout.push( v );\n\t\t}\n\t}\n\treturn out;\n}\n\n\n// MAIN //\n\n/**\n* Returns a shallow copy of an array containing only those elements which pass a test implemented by a predicate function.\n*\n* @param {Collection} x - input array\n* @param {Function} predicate - test function\n* @param {*} [thisArg] - execution context\n* @returns {Collection} output array\n*\n* @example\n* function isPositive( v ) {\n* return v > 0;\n* }\n*\n* var x = [ 1, -2, -3, 4 ];\n*\n* var out = filter( x, isPositive );\n* // returns [ 1, 4 ]\n*/\nfunction filter( x, predicate, thisArg ) {\n\tvar obj;\n\tif ( hasMethod( x, 'filter' ) ) {\n\t\treturn x.filter( predicate, thisArg );\n\t}\n\tobj = arraylike2object( x );\n\tif ( obj.accessorProtocol ) {\n\t\treturn accessors( obj, predicate, thisArg );\n\t}\n\treturn internal( x, predicate, thisArg );\n}\n\n\n// EXPORTS //\n\nexport default filter;\n"],"names":["filter","x","predicate","thisArg","obj","method","hasMethod","arraylike2object","accessorProtocol","data","get","out","v","i","accessors","length","call","push","internal"],"mappings":";;sGAgJA,SAASA,EAAQC,EAAGC,EAAWC,GAC9B,IAAIC,EACJ,OAvGD,SAAoBA,EAAKC,GACxB,MAAkC,mBAAlBD,EAAKC,EACtB,CAqGMC,CAAWL,EAAG,UACXA,EAAED,OAAQE,EAAWC,IAE7BC,EAAMG,EAAkBN,IACfO,iBA/CV,SAAoBP,EAAGC,EAAWC,GACjC,IAAIM,EACAC,EACAC,EACAC,EACAC,EAMJ,IAJAJ,EAAOR,EAAEQ,KACTC,EAAMT,EAAEa,UAAW,GAEnBH,EAAM,GACAE,EAAI,EAAGA,EAAIJ,EAAKM,OAAQF,IAC7BD,EAAIF,EAAKD,EAAMI,GACVX,EAAUc,KAAMb,EAASS,EAAGC,EAAGJ,IACnCE,EAAIM,KAAML,GAGZ,OAAOD,CACR,CA8BSG,CAAWV,EAAKF,EAAWC,GArFpC,SAAmBF,EAAGC,EAAWC,GAChC,IAAIQ,EACAC,EACAC,EAGJ,IADAF,EAAM,GACAE,EAAI,EAAGA,EAAIZ,EAAEc,OAAQF,IAC1BD,EAAIX,EAAGY,GACFX,EAAUc,KAAMb,EAASS,EAAGC,EAAGZ,IACnCU,EAAIM,KAAML,GAGZ,OAAOD,CACR,CA0EQO,CAAUjB,EAAGC,EAAWC,EAChC"} \ No newline at end of file diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index 56236cd..0000000 --- a/lib/index.js +++ /dev/null @@ -1,46 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 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'; - -/** -* Return a shallow copy of an array containing only those elements which pass a test implemented by a predicate function. -* -* @module @stdlib/array-base-filter -* -* @example -* var filter = require( '@stdlib/array-base-filter' ); -* -* function isPositive( v ) { -* return v > 0; -* } -* -* var x = [ 1, -2, -3, 4 ]; -* -* var out = filter( x, isPositive ); -* // returns [ 1, 4 ] -*/ - -// MODULES // - -var main = require( './main.js' ); - - -// EXPORTS // - -module.exports = main; diff --git a/lib/main.js b/lib/main.js deleted file mode 100644 index 9b0c3db..0000000 --- a/lib/main.js +++ /dev/null @@ -1,160 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 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 arraylike2object = require( '@stdlib/array-base-arraylike2object' ); - - -// FUNCTIONS // - -/** -* Tests whether an object has a specified method. -* -* @private -* @param {Object} obj - input object -* @param {string} method - method name -* @returns {boolean} boolean indicating whether an object has a specified method -* -* @example -* var bool = hasMethod( [], 'filter' ); -* // returns true -* -* @example -* var bool = hasMethod( [], 'beep' ); -* // returns false -*/ -function hasMethod( obj, method ) { - return ( typeof obj[ method ] === 'function' ); -} - -/** -* Returns a shallow copy of an array containing only those elements which pass a test implemented by a predicate function. -* -* @private -* @param {Collection} x - input array -* @param {Function} predicate - test function -* @param {*} thisArg - execution context -* @returns {Array} output array -* -* @example -* function isPositive( v ) { -* return v > 0; -* } -* -* var x = [ 1, -2, -3, 4 ]; -* -* var out = internal( x, isPositive ); -* // returns [ 1, 4 ] -*/ -function internal( x, predicate, thisArg ) { - var out; - var v; - var i; - - out = []; - for ( i = 0; i < x.length; i++ ) { - v = x[ i ]; - if ( predicate.call( thisArg, v, i, x ) ) { - out.push( v ); - } - } - return out; -} - -/** -* Returns a shallow copy of an array containing only those elements which pass a test implemented by a predicate function. -* -* @private -* @param {Object} x - input array object -* @param {Function} predicate - test function -* @param {*} thisArg - execution context -* @returns {Array} output array -* -* @example -* var toAccessorArray = require( '@stdlib/array-base-to-accessor-array' ); -* var arraylike2object = require( '@stdlib/array-base-arraylike2object' ); -* -* function isPositive( v ) { -* return v > 0; -* } -* -* var x = arraylike2object( toAccessorArray( [ 1, -2, -3, 4 ] ) ); -* -* var out = accessors( x, isPositive ); -* // returns [ 1, 4 ] -*/ -function accessors( x, predicate, thisArg ) { - var data; - var get; - var out; - var v; - var i; - - data = x.data; - get = x.accessors[ 0 ]; - - out = []; - for ( i = 0; i < data.length; i++ ) { - v = get( data, i ); - if ( predicate.call( thisArg, v, i, data ) ) { - out.push( v ); - } - } - return out; -} - - -// MAIN // - -/** -* Returns a shallow copy of an array containing only those elements which pass a test implemented by a predicate function. -* -* @param {Collection} x - input array -* @param {Function} predicate - test function -* @param {*} [thisArg] - execution context -* @returns {Collection} output array -* -* @example -* function isPositive( v ) { -* return v > 0; -* } -* -* var x = [ 1, -2, -3, 4 ]; -* -* var out = filter( x, isPositive ); -* // returns [ 1, 4 ] -*/ -function filter( x, predicate, thisArg ) { - var obj; - if ( hasMethod( x, 'filter' ) ) { - return x.filter( predicate, thisArg ); - } - obj = arraylike2object( x ); - if ( obj.accessorProtocol ) { - return accessors( obj, predicate, thisArg ); - } - return internal( x, predicate, thisArg ); -} - - -// EXPORTS // - -module.exports = filter; diff --git a/package.json b/package.json index d836e77..222dce3 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.2.1", "description": "Return a shallow copy of an array containing only those elements which pass a test implemented by a predicate function.", "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", - "directories": { - "benchmark": "./benchmark", - "doc": "./docs", - "example": "./examples", - "lib": "./lib", - "test": "./test" - }, - "types": "./docs/types", - "scripts": { - "test": "make test", - "test-cov": "make test-cov", - "examples": "make examples", - "benchmark": "make benchmark" - }, + "type": "module", + "main": "./index.mjs", "homepage": "https://stdlib.io", "repository": { "type": "git", @@ -36,42 +13,6 @@ "bugs": { "url": "https://github.com/stdlib-js/stdlib/issues" }, - "dependencies": { - "@stdlib/array-base-arraylike2object": "^0.2.1", - "@stdlib/types": "^0.3.2", - "@stdlib/error-tools-fmtprodmsg": "^0.2.1" - }, - "devDependencies": { - "@stdlib/array-base-accessor": "^0.2.1", - "@stdlib/array-base-zero-to": "^0.2.1", - "@stdlib/array-float64": "^0.2.1", - "@stdlib/assert-instance-of": "^0.2.1", - "@stdlib/assert-is-array": "^0.2.1", - "@stdlib/assert-is-nonnegative-integer": "^0.2.1", - "@stdlib/assert-is-positive-integer": "^0.2.1", - "@stdlib/math-base-special-pow": "^0.2.1", - "@stdlib/random-array-discrete-uniform": "^0.2.1", - "@stdlib/utils-nary-function": "^0.2.1", - "tape": "git+https://github.com/kgryte/tape.git#fix/globby", - "istanbul": "^0.4.1", - "tap-min": "git+https://github.com/Planeshifter/tap-min.git", - "@stdlib/bench-harness": "^0.2.1" - }, - "engines": { - "node": ">=0.10.0", - "npm": ">2.7.0" - }, - "os": [ - "aix", - "darwin", - "freebsd", - "linux", - "macos", - "openbsd", - "sunos", - "win32", - "windows" - ], "keywords": [ "stdlib", "stdtypes", @@ -91,4 +32,4 @@ "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} \ No newline at end of file +} diff --git a/stats.html b/stats.html new file mode 100644 index 0000000..d4d08f0 --- /dev/null +++ b/stats.html @@ -0,0 +1,4842 @@ + + + + + + + + Rollup Visualizer + + + +
+ + + + + diff --git a/test/dist/test.js b/test/dist/test.js deleted file mode 100644 index a8a9c60..0000000 --- a/test/dist/test.js +++ /dev/null @@ -1,33 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 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 tape = require( 'tape' ); -var main = require( './../../dist' ); - - -// TESTS // - -tape( 'main export is defined', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( main !== void 0, true, 'main export is defined' ); - t.end(); -}); diff --git a/test/test.js b/test/test.js deleted file mode 100644 index d4e7373..0000000 --- a/test/test.js +++ /dev/null @@ -1,251 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 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 tape = require( 'tape' ); -var AccessorArray = require( '@stdlib/array-base-accessor' ); -var Float64Array = require( '@stdlib/array-float64' ); -var instanceOf = require( '@stdlib/assert-instance-of' ); -var filter = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Tests whether a value is positive. -* -* @private -* @param {number} value - input value -* @returns {boolean} boolean indicating if a value is positive -*/ -function isPositive( value ) { - return ( value > 0 ); -} - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof filter, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'if provided an empty collection, the function returns an empty collection (generic)', function test( t ) { - var expected; - var actual; - var arr; - - arr = []; - expected = []; - actual = filter( arr, foo ); - - t.strictEqual( instanceOf( actual, Array ), true, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - t.end(); - - function foo() { - t.fail( 'should not be invoked' ); - } -}); - -tape( 'if provided an empty collection, the function returns an empty collection (typed array)', function test( t ) { - var expected; - var actual; - var arr; - - arr = new Float64Array( [] ); - expected = new Float64Array( [] ); - actual = filter( arr, foo ); - - t.strictEqual( instanceOf( actual, Float64Array ), true, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - t.end(); - - function foo() { - t.fail( 'should not be invoked' ); - } -}); - -tape( 'if provided an empty collection, the function returns an empty collection (accessor)', function test( t ) { - var expected; - var actual; - var arr; - - arr = new AccessorArray( [] ); - expected = []; - actual = filter( arr, foo ); - - t.strictEqual( instanceOf( actual, Array ), true, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - t.end(); - - function foo() { - t.fail( 'should not be invoked' ); - } -}); - -tape( 'the function filters a provided collection (generic)', function test( t ) { - var expected; - var actual; - var arr; - - arr = [ 1, -2, 3 ]; - expected = [ 1, 3 ]; - actual = filter( arr, isPositive ); - - t.strictEqual( instanceOf( actual, Array ), true, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - t.end(); -}); - -tape( 'the function filters a provided collection (typed array)', function test( t ) { - var expected; - var actual; - var arr; - - arr = new Float64Array( [ -1.0, 2.0, 3.0 ] ); - expected = new Float64Array( [ 2.0, 3.0 ] ); - actual = filter( arr, isPositive ); - - t.strictEqual( instanceOf( actual, Float64Array ), true, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - t.end(); -}); - -tape( 'the function filters a provided collection (accessor)', function test( t ) { - var expected; - var actual; - var arr; - - arr = new AccessorArray( [ 1, -2, -3 ] ); - expected = [ 1 ]; - actual = filter( arr, isPositive ); - - t.strictEqual( instanceOf( actual, Array ), true, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - t.end(); -}); - -tape( 'the function filters a provided collection (array-like object)', function test( t ) { - var expected; - var actual; - var arr; - - arr = { - 'length': 3, - '0': -1, - '1': -2, - '2': 3 - }; - expected = [ 3 ]; - actual = filter( arr, isPositive ); - - t.strictEqual( instanceOf( actual, Array ), true, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - t.end(); -}); - -tape( 'the function an empty collection if all elements fail a test (generic)', function test( t ) { - var expected; - var actual; - var arr; - - arr = [ -1, -2, -3 ]; - expected = []; - actual = filter( arr, isPositive ); - - t.strictEqual( instanceOf( actual, Array ), true, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - t.end(); -}); - -tape( 'the function an empty collection if all elements fail a test (typed array)', function test( t ) { - var expected; - var actual; - var arr; - - arr = new Float64Array( [ -1.0, -2.0, -3.0 ] ); - expected = new Float64Array( [] ); - actual = filter( arr, isPositive ); - - t.strictEqual( instanceOf( actual, Float64Array ), true, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - t.end(); -}); - -tape( 'the function an empty collection if all elements fail a test (accessor)', function test( t ) { - var expected; - var actual; - var arr; - - arr = new AccessorArray( [ -1, -2, -3 ] ); - expected = []; - actual = filter( arr, isPositive ); - - t.strictEqual( instanceOf( actual, Array ), true, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - t.end(); -}); - -tape( 'the function an empty collection if all elements fail a test (array-like object)', function test( t ) { - var expected; - var actual; - var arr; - - arr = { - 'length': 3, - '0': -1, - '1': -2, - '2': -3 - }; - expected = []; - actual = filter( arr, isPositive ); - - t.strictEqual( instanceOf( actual, Array ), true, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - t.end(); -}); - -tape( 'the function supports providing an execution context', function test( t ) { - var expected; - var actual; - var ctx; - var arr; - - ctx = { - 'count': 0 - }; - arr = [ 1, 2, 3 ]; - expected = [ 1, 2, 3 ]; - actual = filter( arr, predicate, ctx ); - - t.strictEqual( instanceOf( actual, Array ), true, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - t.strictEqual( ctx.count, arr.length, 'returns expected value' ); - - t.end(); - - function predicate( value ) { - this.count += 1; // eslint-disable-line no-invalid-this - return ( value > 0 ); - } -}); From b4f82016583872e33e7cca56440bac4b018306de Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Wed, 17 Jul 2024 10:16:53 +0000 Subject: [PATCH 27/40] Transform error messages --- package.json | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/package.json b/package.json index 355145c..d836e77 100644 --- a/package.json +++ b/package.json @@ -38,7 +38,8 @@ }, "dependencies": { "@stdlib/array-base-arraylike2object": "^0.2.1", - "@stdlib/types": "^0.3.2" + "@stdlib/types": "^0.3.2", + "@stdlib/error-tools-fmtprodmsg": "^0.2.1" }, "devDependencies": { "@stdlib/array-base-accessor": "^0.2.1", @@ -90,4 +91,4 @@ "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} +} \ No newline at end of file From 26717335fe499a5dbae022cf325b1b1f8cf7ae6b Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Wed, 17 Jul 2024 10:20:47 +0000 Subject: [PATCH 28/40] Remove files --- index.d.ts | 343 ---- index.mjs | 4 - index.mjs.map | 1 - stats.html | 4842 ------------------------------------------------- 4 files changed, 5190 deletions(-) delete mode 100644 index.d.ts delete mode 100644 index.mjs delete mode 100644 index.mjs.map delete mode 100644 stats.html diff --git a/index.d.ts b/index.d.ts deleted file mode 100644 index 66b6dff..0000000 --- a/index.d.ts +++ /dev/null @@ -1,343 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2024 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 - -/// - -import { Collection, AccessorArrayLike, Complex128Array, Complex64Array } from '@stdlib/types/array'; - -/** -* Returns a boolean indicating whether an element passes a test. -* -* @returns boolean indicating whether an element passes a test -*/ -type Nullary = ( this: U ) => boolean; - -/** -* Returns a boolean indicating whether an element passes a test. -* -* @param value - current array element -* @returns boolean indicating whether an element passes a test -*/ -type Unary = ( this: U, value: T ) => boolean; - -/** -* Returns a boolean indicating whether an element passes a test. -* -* @param value - current array element -* @param index - current array element index -* @returns boolean indicating whether an element passes a test -*/ -type Binary = ( this: U, value: T, index: number ) => boolean; - -/** -* Returns a boolean indicating whether an element passes a test. -* -* @param value - current array element -* @param index - current array element index -* @param arr - input array -* @returns boolean indicating whether an element passes a test -*/ -type Ternary = ( this: U, value: T, index: number, arr: V ) => boolean; - -/** -* Returns a boolean indicating whether an element passes a test. -* -* @param value - current array element -* @param index - current array element index -* @param arr - input array -* @returns boolean indicating whether an element passes a test -*/ -type Predicate = Nullary | Unary | Binary | Ternary; - -/** -* Returns a shallow copy of an array containing only those elements which pass a test implemented by a predicate function. -* -* @param x - input array -* @param predicate - predicate function -* @param thisArg - predicate function execution context -* @returns output array -* -* @example -* var isPositiveNumber = require( '@stdlib/assert-is-positive-number' ).isPrimitive; -* var Float64Array = require( '@stdlib/array-float64' ); -* -* var x = new Float64Array( [ 1.0, -2.0, -3.0, 4.0 ] ); -* -* var out = filter( x, isPositiveNumber ); -* // returns [ 1.0, 4.0 ] -*/ -declare function filter( x: Float64Array, predicate: Predicate, thisArg?: ThisParameterType> ): Float64Array; - -/** -* Returns a shallow copy of an array containing only those elements which pass a test implemented by a predicate function. -* -* @param x - input array -* @param predicate - predicate function -* @param thisArg - predicate function execution context -* @returns output array -* -* @example -* var isPositiveNumber = require( '@stdlib/assert-is-positive-number' ).isPrimitive; -* var Float32Array = require( '@stdlib/array-float32' ); -* -* var x = new Float32Array( [ 1.0, -2.0, -3.0, 4.0 ] ); -* -* var out = filter( x, isPositiveNumber ); -* // returns [ 1.0, 4.0 ] -*/ -declare function filter( x: Float32Array, predicate: Predicate, thisArg?: ThisParameterType> ): Float32Array; - -/** -* Returns a shallow copy of an array containing only those elements which pass a test implemented by a predicate function. -* -* @param x - input array -* @param predicate - predicate function -* @param thisArg - predicate function execution context -* @returns output array -* -* @example -* var isPositiveNumber = require( '@stdlib/assert-is-positive-number' ).isPrimitive; -* var Int32Array = require( '@stdlib/array-int32' ); -* -* var x = new Int32Array( [ 1, -2, -3, 4 ] ); -* -* var out = filter( x, isPositiveNumber ); -* // returns [ 1, 4 ] -*/ -declare function filter( x: Int32Array, predicate: Predicate, thisArg?: ThisParameterType> ): Int32Array; - -/** -* Returns a shallow copy of an array containing only those elements which pass a test implemented by a predicate function. -* -* @param x - input array -* @param predicate - predicate function -* @param thisArg - predicate function execution context -* @returns output array -* -* @example -* var isPositiveNumber = require( '@stdlib/assert-is-positive-number' ).isPrimitive; -* var Int16Array = require( '@stdlib/array-int16' ); -* -* var x = new Int16Array( [ 1, -2, -3, 4 ] ); -* -* var out = filter( x, isPositiveNumber ); -* // returns [ 1, 4 ] -*/ -declare function filter( x: Int16Array, predicate: Predicate, thisArg?: ThisParameterType> ): Int16Array; - -/** -* Returns a shallow copy of an array containing only those elements which pass a test implemented by a predicate function. -* -* @param x - input array -* @param predicate - predicate function -* @param thisArg - predicate function execution context -* @returns output array -* -* @example -* var isPositiveNumber = require( '@stdlib/assert-is-positive-number' ).isPrimitive; -* var Int8Array = require( '@stdlib/array-int8' ); -* -* var x = new Int8Array( [ 1, -2, -3, 4 ] ); -* -* var out = filter( x, isPositiveNumber ); -* // returns [ 1, 4 ] -*/ -declare function filter( x: Int8Array, predicate: Predicate, thisArg?: ThisParameterType> ): Int8Array; - -/** -* Returns a shallow copy of an array containing only those elements which pass a test implemented by a predicate function. -* -* @param x - input array -* @param predicate - predicate function -* @param thisArg - predicate function execution context -* @returns output array -* -* @example -* var isPositiveNumber = require( '@stdlib/assert-is-positive-number' ).isPrimitive; -* var Uint32Array = require( '@stdlib/array-uint32' ); -* -* var x = new Uint32Array( [ 1, 2, 3, 4 ] ); -* -* var out = filter( x, isPositiveNumber ); -* // returns [ 1, 2, 3, 4 ] -*/ -declare function filter( x: Uint32Array, predicate: Predicate, thisArg?: ThisParameterType> ): Uint32Array; - -/** -* Returns a shallow copy of an array containing only those elements which pass a test implemented by a predicate function. -* -* @param x - input array -* @param predicate - predicate function -* @param thisArg - predicate function execution context -* @returns output array -* -* @example -* var isPositiveNumber = require( '@stdlib/assert-is-positive-number' ).isPrimitive; -* var Uint16Array = require( '@stdlib/array-uint16' ); -* -* var x = new Uint16Array( [ 1, 2, 3, 4 ] ); -* -* var out = filter( x, isPositiveNumber ); -* // returns [ 1, 2, 3, 4 ] -*/ -declare function filter( x: Uint16Array, predicate: Predicate, thisArg?: ThisParameterType> ): Uint16Array; - -/** -* Returns a shallow copy of an array containing only those elements which pass a test implemented by a predicate function. -* -* @param x - input array -* @param predicate - predicate function -* @param thisArg - predicate function execution context -* @returns output array -* -* @example -* var isPositiveNumber = require( '@stdlib/assert-is-positive-number' ).isPrimitive; -* var Uint8Array = require( '@stdlib/array-uint8' ); -* -* var x = new Uint8Array( [ 1, 2, 3, 4 ] ); -* -* var out = filter( x, isPositiveNumber ); -* // returns [ 1, 2, 3, 4 ] -*/ -declare function filter( x: Uint8Array, predicate: Predicate, thisArg?: ThisParameterType> ): Uint8Array; - -/** -* Returns a shallow copy of an array containing only those elements which pass a test implemented by a predicate function. -* -* @param x - input array -* @param predicate - predicate function -* @param thisArg - predicate function execution context -* @returns output array -* -* @example -* var isPositiveNumber = require( '@stdlib/assert-is-positive-number' ).isPrimitive; -* var Uint8ClampedArray = require( '@stdlib/array-uint8c' ); -* -* var x = new Uint8ClampedArray( [ 1, 2, 3, 4 ] ); -* -* var out = filter( x, isPositiveNumber ); -* // returns [ 1, 2, 3, 4 ] -*/ -declare function filter( x: Uint8ClampedArray, predicate: Predicate, thisArg?: ThisParameterType> ): Uint8ClampedArray; - -/** -* Returns a shallow copy of an array containing only those elements which pass a test implemented by a predicate function. -* -* @param x - input array -* @param predicate - predicate function -* @param thisArg - predicate function execution context -* @returns output array -* -* @example -* var isPositiveNumber = require( '@stdlib/assert-is-positive-number' ).isPrimitive; -* var real = require( '@stdlib/complex-real' ); -* var imag = require( '@stdlib/complex-float64-imag' ); -* var Complex128Array = require( '@stdlib/array-complex128' ); -* -* function predicate( v ) { -* return ( isPositiveNumber( real( v ) ) && isPositiveNumber( imag( v ) ) ); -* } -* -* var x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0 ] ); -* -* var out = filter( x, predicate ); -* // returns -*/ -declare function filter( x: Complex128Array, predicate: Predicate, thisArg?: ThisParameterType> ): Complex128Array; - -/** -* Returns a shallow copy of an array containing only those elements which pass a test implemented by a predicate function. -* -* @param x - input array -* @param predicate - predicate function -* @param thisArg - predicate function execution context -* @returns output array -* -* @example -* var isPositiveNumber = require( '@stdlib/assert-is-positive-number' ).isPrimitive; -* var realf = require( '@stdlib/complex-float32-real' ); -* var imagf = require( '@stdlib/complex-float32-imag' ); -* var Complex64Array = require( '@stdlib/array-complex64' ); -* -* function predicate( v ) { -* return ( isPositiveNumber( realf( v ) ) && isPositiveNumber( imagf( v ) ) ); -* } -* -* var x = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); -* -* var out = filter( x, predicate ); -* // returns -*/ -declare function filter( x: Complex64Array, predicate: Predicate, thisArg?: ThisParameterType> ): Complex64Array; - -/** -* Returns a shallow copy of an array containing only those elements which pass a test implemented by a predicate function. -* -* @param x - input array -* @param predicate - predicate function -* @param thisArg - predicate function execution context -* @returns output array -* -* @example -* var x = [ 1, -2, -3, 4 ]; -* -* var out = filter( x, isPositiveNumber ); -* // returns [ 1, 4 ] -*/ -declare function filter( x: Array, predicate: Predicate>, thisArg?: ThisParameterType>> ): Array; - -/** -* Returns a shallow copy of an array containing only those elements which pass a test implemented by a predicate function. -* -* @param x - input array -* @param predicate - predicate function -* @param thisArg - predicate function execution context -* @returns output array -* -* @example -* var toAccessorArray = require( '@stdlib/array-base-to-accessor-array' ); -* -* var x = toAccessorArray( [ 1, -2, -3, 4 ] ); -* -* var out = filter( x, isPositiveNumber ); -* // returns [ 1, 4 ] -*/ -declare function filter( x: AccessorArrayLike, predicate: Predicate>, thisArg?: ThisParameterType>> ): Array; - -/** -* Returns a shallow copy of an array containing only those elements which pass a test implemented by a predicate function. -* -* @param x - input array -* @param predicate - predicate function -* @param thisArg - predicate function execution context -* @returns output array -* -* @example -* var x = [ 1, -2, -3, 4 ]; -* -* var out = filter( x, isPositiveNumber ); -* // returns [ 1, 4 ] -*/ -declare function filter( x: Collection, predicate: Predicate>, thisArg?: ThisParameterType>> ): Array; - - -// EXPORTS // - -export = filter; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index a10870c..0000000 --- a/index.mjs +++ /dev/null @@ -1,4 +0,0 @@ -// Copyright (c) 2024 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 -/// -import r from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-arraylike2object@v0.2.1-esm/index.mjs";function t(t,e,n){var o;return function(r,t){return"function"==typeof r[t]}(t,"filter")?t.filter(e,n):(o=r(t)).accessorProtocol?function(r,t,e){var n,o,a,s,c;for(n=r.data,o=r.accessors[0],a=[],c=0;c 0;\n* }\n*\n* var x = [ 1, -2, -3, 4 ];\n*\n* var out = internal( x, isPositive );\n* // returns [ 1, 4 ]\n*/\nfunction internal( x, predicate, thisArg ) {\n\tvar out;\n\tvar v;\n\tvar i;\n\n\tout = [];\n\tfor ( i = 0; i < x.length; i++ ) {\n\t\tv = x[ i ];\n\t\tif ( predicate.call( thisArg, v, i, x ) ) {\n\t\t\tout.push( v );\n\t\t}\n\t}\n\treturn out;\n}\n\n/**\n* Returns a shallow copy of an array containing only those elements which pass a test implemented by a predicate function.\n*\n* @private\n* @param {Object} x - input array object\n* @param {Function} predicate - test function\n* @param {*} thisArg - execution context\n* @returns {Array} output array\n*\n* @example\n* import toAccessorArray from '@stdlib/array-base-to-accessor-array';\n* import arraylike2object from '@stdlib/array-base-arraylike2object';\n*\n* function isPositive( v ) {\n* return v > 0;\n* }\n*\n* var x = arraylike2object( toAccessorArray( [ 1, -2, -3, 4 ] ) );\n*\n* var out = accessors( x, isPositive );\n* // returns [ 1, 4 ]\n*/\nfunction accessors( x, predicate, thisArg ) {\n\tvar data;\n\tvar get;\n\tvar out;\n\tvar v;\n\tvar i;\n\n\tdata = x.data;\n\tget = x.accessors[ 0 ];\n\n\tout = [];\n\tfor ( i = 0; i < data.length; i++ ) {\n\t\tv = get( data, i );\n\t\tif ( predicate.call( thisArg, v, i, data ) ) {\n\t\t\tout.push( v );\n\t\t}\n\t}\n\treturn out;\n}\n\n\n// MAIN //\n\n/**\n* Returns a shallow copy of an array containing only those elements which pass a test implemented by a predicate function.\n*\n* @param {Collection} x - input array\n* @param {Function} predicate - test function\n* @param {*} [thisArg] - execution context\n* @returns {Collection} output array\n*\n* @example\n* function isPositive( v ) {\n* return v > 0;\n* }\n*\n* var x = [ 1, -2, -3, 4 ];\n*\n* var out = filter( x, isPositive );\n* // returns [ 1, 4 ]\n*/\nfunction filter( x, predicate, thisArg ) {\n\tvar obj;\n\tif ( hasMethod( x, 'filter' ) ) {\n\t\treturn x.filter( predicate, thisArg );\n\t}\n\tobj = arraylike2object( x );\n\tif ( obj.accessorProtocol ) {\n\t\treturn accessors( obj, predicate, thisArg );\n\t}\n\treturn internal( x, predicate, thisArg );\n}\n\n\n// EXPORTS //\n\nexport default filter;\n"],"names":["filter","x","predicate","thisArg","obj","method","hasMethod","arraylike2object","accessorProtocol","data","get","out","v","i","accessors","length","call","push","internal"],"mappings":";;sGAgJA,SAASA,EAAQC,EAAGC,EAAWC,GAC9B,IAAIC,EACJ,OAvGD,SAAoBA,EAAKC,GACxB,MAAkC,mBAAlBD,EAAKC,EACtB,CAqGMC,CAAWL,EAAG,UACXA,EAAED,OAAQE,EAAWC,IAE7BC,EAAMG,EAAkBN,IACfO,iBA/CV,SAAoBP,EAAGC,EAAWC,GACjC,IAAIM,EACAC,EACAC,EACAC,EACAC,EAMJ,IAJAJ,EAAOR,EAAEQ,KACTC,EAAMT,EAAEa,UAAW,GAEnBH,EAAM,GACAE,EAAI,EAAGA,EAAIJ,EAAKM,OAAQF,IAC7BD,EAAIF,EAAKD,EAAMI,GACVX,EAAUc,KAAMb,EAASS,EAAGC,EAAGJ,IACnCE,EAAIM,KAAML,GAGZ,OAAOD,CACR,CA8BSG,CAAWV,EAAKF,EAAWC,GArFpC,SAAmBF,EAAGC,EAAWC,GAChC,IAAIQ,EACAC,EACAC,EAGJ,IADAF,EAAM,GACAE,EAAI,EAAGA,EAAIZ,EAAEc,OAAQF,IAC1BD,EAAIX,EAAGY,GACFX,EAAUc,KAAMb,EAASS,EAAGC,EAAGZ,IACnCU,EAAIM,KAAML,GAGZ,OAAOD,CACR,CA0EQO,CAAUjB,EAAGC,EAAWC,EAChC"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index d4d08f0..0000000 --- a/stats.html +++ /dev/null @@ -1,4842 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From a9c87d3229d7340ec147b1415d2fa03aaff91606 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Wed, 17 Jul 2024 10:21:02 +0000 Subject: [PATCH 29/40] Auto-generated commit --- .editorconfig | 181 - .eslintrc.js | 1 - .gitattributes | 66 - .github/PULL_REQUEST_TEMPLATE.md | 7 - .github/workflows/benchmark.yml | 64 - .github/workflows/cancel.yml | 57 - .github/workflows/close_pull_requests.yml | 54 - .github/workflows/examples.yml | 64 - .github/workflows/npm_downloads.yml | 112 - .github/workflows/productionize.yml | 794 ---- .github/workflows/publish.yml | 252 -- .github/workflows/test.yml | 99 - .github/workflows/test_bundles.yml | 186 - .github/workflows/test_coverage.yml | 133 - .github/workflows/test_install.yml | 85 - .gitignore | 188 - .npmignore | 229 - .npmrc | 31 - CHANGELOG.md | 85 - CITATION.cff | 30 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 --- README.md | 41 +- SECURITY.md | 5 - benchmark/benchmark.length.js | 97 - branches.md | 56 - dist/index.d.ts | 3 - dist/index.js | 5 - dist/index.js.map | 7 - docs/repl.txt | 46 - docs/types/test.ts | 101 - examples/index.js | 35 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/index.js | 46 - lib/main.js | 160 - package.json | 65 +- stats.html | 4842 +++++++++++++++++++++ test/dist/test.js | 33 - test/test.js | 251 -- 42 files changed, 4867 insertions(+), 4191 deletions(-) delete mode 100644 .editorconfig delete mode 100644 .eslintrc.js delete mode 100644 .gitattributes delete mode 100644 .github/PULL_REQUEST_TEMPLATE.md delete mode 100644 .github/workflows/benchmark.yml delete mode 100644 .github/workflows/cancel.yml delete mode 100644 .github/workflows/close_pull_requests.yml delete mode 100644 .github/workflows/examples.yml delete mode 100644 .github/workflows/npm_downloads.yml delete mode 100644 .github/workflows/productionize.yml delete mode 100644 .github/workflows/publish.yml delete mode 100644 .github/workflows/test.yml delete mode 100644 .github/workflows/test_bundles.yml delete mode 100644 .github/workflows/test_coverage.yml delete mode 100644 .github/workflows/test_install.yml delete mode 100644 .gitignore delete mode 100644 .npmignore delete mode 100644 .npmrc delete mode 100644 CHANGELOG.md delete mode 100644 CITATION.cff delete mode 100644 CODE_OF_CONDUCT.md delete mode 100644 CONTRIBUTING.md delete mode 100644 Makefile delete mode 100644 SECURITY.md delete mode 100644 benchmark/benchmark.length.js delete mode 100644 branches.md delete mode 100644 dist/index.d.ts delete mode 100644 dist/index.js delete mode 100644 dist/index.js.map delete mode 100644 docs/repl.txt delete mode 100644 docs/types/test.ts delete mode 100644 examples/index.js rename docs/types/index.d.ts => index.d.ts (99%) create mode 100644 index.mjs create mode 100644 index.mjs.map delete mode 100644 lib/index.js delete mode 100644 lib/main.js create mode 100644 stats.html delete mode 100644 test/dist/test.js delete mode 100644 test/test.js diff --git a/.editorconfig b/.editorconfig deleted file mode 100644 index 60d743f..0000000 --- a/.editorconfig +++ /dev/null @@ -1,181 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 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. -#/ - -# EditorConfig configuration file (see ). - -# Indicate that this file is a root-level configuration file: -root = true - -# Set properties for all files: -[*] -end_of_line = lf -charset = utf-8 -trim_trailing_whitespace = true -insert_final_newline = true - -# Set properties for JavaScript files: -[*.{js,js.txt}] -indent_style = tab - -# Set properties for JavaScript ES module files: -[*.{mjs,mjs.txt}] -indent_style = tab - -# Set properties for JavaScript CommonJS files: -[*.{cjs,cjs.txt}] -indent_style = tab - -# Set properties for JSON files: -[*.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `cli_opts.json` files: -[cli_opts.json] -indent_style = tab - -# Set properties for TypeScript files: -[*.ts] -indent_style = tab - -# Set properties for Python files: -[*.{py,py.txt}] -indent_style = space -indent_size = 4 - -# Set properties for Julia files: -[*.{jl,jl.txt}] -indent_style = tab - -# Set properties for R files: -[*.{R,R.txt}] -indent_style = tab - -# Set properties for C files: -[*.{c,c.txt}] -indent_style = tab - -# Set properties for C header files: -[*.{h,h.txt}] -indent_style = tab - -# Set properties for C++ files: -[*.{cpp,cpp.txt}] -indent_style = tab - -# Set properties for C++ header files: -[*.{hpp,hpp.txt}] -indent_style = tab - -# Set properties for Fortran files: -[*.{f,f.txt}] -indent_style = space -indent_size = 2 -insert_final_newline = false - -# Set properties for shell files: -[*.{sh,sh.txt}] -indent_style = tab - -# Set properties for AWK files: -[*.{awk,awk.txt}] -indent_style = tab - -# Set properties for HTML files: -[*.{html,html.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for XML files: -[*.{xml,xml.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for CSS files: -[*.{css,css.txt}] -indent_style = tab - -# Set properties for Makefiles: -[Makefile] -indent_style = tab - -[*.{mk,mk.txt}] -indent_style = tab - -# Set properties for Markdown files: -[*.{md,md.txt}] -indent_style = space -indent_size = 4 -trim_trailing_whitespace = false - -# Set properties for `usage.txt` files: -[usage.txt] -indent_style = space -indent_size = 2 - -# Set properties for `repl.txt` files: -[repl.txt] -indent_style = space -indent_size = 4 - -# Set properties for `package.json` files: -[package.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `datapackage.json` files: -[datapackage.json] -indent_style = space -indent_size = 2 - -# Set properties for `manifest.json` files: -[manifest.json] -indent_style = space -indent_size = 2 - -# Set properties for `tsconfig.json` files: -[tsconfig.json] -indent_style = space -indent_size = 2 - -# Set properties for LaTeX files: -[*.{tex,tex.txt}] -indent_style = tab - -# Set properties for LaTeX Bibliography files: -[*.{bib,bib.txt}] -indent_style = tab - -# Set properties for YAML files: -[*.{yml,yml.txt}] -indent_style = space -indent_size = 2 - -# Set properties for GYP files: -[binding.gyp] -indent_style = space -indent_size = 2 - -[*.gypi] -indent_style = space -indent_size = 2 - -# Set properties for citation files: -[*.{cff,cff.txt}] -indent_style = space -indent_size = 2 diff --git a/.eslintrc.js b/.eslintrc.js deleted file mode 100644 index 5f30286..0000000 --- a/.eslintrc.js +++ /dev/null @@ -1 +0,0 @@ -/* For the `eslint` rules of this project, consult the main repository at https://github.com/stdlib-js/stdlib */ diff --git a/.gitattributes b/.gitattributes deleted file mode 100644 index 1c88e69..0000000 --- a/.gitattributes +++ /dev/null @@ -1,66 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 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. -#/ - -# Configuration file which assigns attributes to pathnames. -# -# [1]: https://git-scm.com/docs/gitattributes - -# Automatically normalize the line endings of any committed text files: -* text=auto - -# Override line endings for certain files on checkout: -*.crlf.csv text eol=crlf - -# Denote that certain files are binary and should not be modified: -*.png binary -*.jpg binary -*.jpeg binary -*.gif binary -*.ico binary -*.gz binary -*.zip binary -*.7z binary -*.mp3 binary -*.mp4 binary -*.mov binary - -# Override what is considered "vendored" by GitHub's linguist: -/lib/node_modules/** -linguist-vendored -linguist-generated - -# Configure directories which should *not* be included in GitHub language statistics: -/deps/** linguist-vendored -/dist/** linguist-generated -/workshops/** linguist-vendored - -benchmark/** linguist-vendored -docs/* linguist-documentation -etc/** linguist-vendored -examples/** linguist-documentation -scripts/** linguist-vendored -test/** linguist-vendored -tools/** linguist-vendored - -# Configure files which should *not* be included in GitHub language statistics: -Makefile linguist-vendored -*.mk linguist-vendored -*.jl linguist-vendored -*.py linguist-vendored -*.R linguist-vendored - -# Configure files which should be included in GitHub language statistics: -docs/types/*.d.ts -linguist-documentation diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index 6559bc7..0000000 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ /dev/null @@ -1,7 +0,0 @@ - - -We are excited about your pull request, but unfortunately we are not accepting pull requests against this repository, as all development happens on the [main project repository](https://github.com/stdlib-js/stdlib). We kindly request that you submit this pull request against the [respective directory](https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/filter) of the main repository where we’ll review and provide feedback. - -If this is your first stdlib contribution, be sure to read the [contributing guide](https://github.com/stdlib-js/stdlib/blob/develop/CONTRIBUTING.md) which provides guidelines and instructions for submitting contributions. You may also consult the [development guide](https://github.com/stdlib-js/stdlib/blob/develop/docs/development.md) for help on developing stdlib. - -We look forward to receiving your contribution! :smiley: \ No newline at end of file diff --git a/.github/workflows/benchmark.yml b/.github/workflows/benchmark.yml deleted file mode 100644 index e4f10fe..0000000 --- a/.github/workflows/benchmark.yml +++ /dev/null @@ -1,64 +0,0 @@ -#/ -# @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. -#/ - -# Workflow name: -name: benchmark - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to run benchmarks: - benchmark: - - # Define a display name: - name: 'Run benchmarks' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Run benchmarks: - - name: 'Run benchmarks' - run: | - npm run benchmark diff --git a/.github/workflows/cancel.yml b/.github/workflows/cancel.yml deleted file mode 100644 index b5291db..0000000 --- a/.github/workflows/cancel.yml +++ /dev/null @@ -1,57 +0,0 @@ -#/ -# @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. -#/ - -# Workflow name: -name: cancel - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to cancel existing workflow runs: - cancel: - - # Define a display name: - name: 'Cancel workflow runs' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Time limit: - timeout-minutes: 3 - - # Define the sequence of job steps... - steps: - - # Cancel existing workflow runs: - - name: 'Cancel existing workflow runs' - # Pin action to full length commit SHA - uses: styfle/cancel-workflow-action@85880fa0301c86cca9da44039ee3bb12d3bedbfa # v0.12.1 - with: - workflow_id: >- - benchmark.yml, - examples.yml, - test.yml, - test_coverage.yml, - test_install.yml, - publish.yml - access_token: ${{ github.token }} diff --git a/.github/workflows/close_pull_requests.yml b/.github/workflows/close_pull_requests.yml deleted file mode 100644 index 2060eba..0000000 --- a/.github/workflows/close_pull_requests.yml +++ /dev/null @@ -1,54 +0,0 @@ -#/ -# @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. -#/ - -# Workflow name: -name: close_pull_requests - -# Workflow triggers: -on: - pull_request_target: - types: [opened] - -# Workflow jobs: -jobs: - - # Define job to close all pull requests: - run: - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - - # Close pull request - - name: 'Close pull request' - # Pin action to full length commit SHA corresponding to v3.1.2 - uses: superbrothers/close-pull-request@9c18513d320d7b2c7185fb93396d0c664d5d8448 - with: - comment: | - Thank you for submitting a pull request. :raised_hands: - - We greatly appreciate your willingness to submit a contribution. However, we are not accepting pull requests against this repository, as all development happens on the [main project repository](https://github.com/stdlib-js/stdlib). - - We kindly request that you submit this pull request against the [respective directory](https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/filter) of the main repository where we’ll review and provide feedback. If this is your first stdlib contribution, be sure to read the [contributing guide](https://github.com/stdlib-js/stdlib/blob/develop/CONTRIBUTING.md) which provides guidelines and instructions for submitting contributions. - - Thank you again, and we look forward to receiving your contribution! :smiley: - - Best, - The stdlib team \ No newline at end of file diff --git a/.github/workflows/examples.yml b/.github/workflows/examples.yml deleted file mode 100644 index 2984901..0000000 --- a/.github/workflows/examples.yml +++ /dev/null @@ -1,64 +0,0 @@ -#/ -# @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. -#/ - -# Workflow name: -name: examples - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to run the package examples... - examples: - - # Define display name: - name: 'Run examples' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - - # Checkout repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Run examples: - - name: 'Run examples' - run: | - npm run examples diff --git a/.github/workflows/npm_downloads.yml b/.github/workflows/npm_downloads.yml deleted file mode 100644 index c2326d6..0000000 --- a/.github/workflows/npm_downloads.yml +++ /dev/null @@ -1,112 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2022 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. -#/ - -# Workflow name: -name: npm_downloads - -# Workflow triggers: -on: - # Run this workflow weekly: - schedule: - # cron: ' ' - - cron: '48 12 * * 3' - - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job for retrieving npm download counts... - npm_downloads: - - # Define display name: - name: 'Retrieve npm download counts' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - timeout-minutes: 10 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Resolve package name: - - name: 'Resolve package name' - id: package_name - run: | - name=`node -e 'console.log(require("./package.json").name)' | tr -d '\n'` - echo "package_name=$name" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Fetch download data: - - name: 'Fetch data' - id: download_data - run: | - url="https://api.npmjs.org/downloads/range/$(date --date='1 year ago' '+%Y-%m-%d'):$(date '+%Y-%m-%d')/${{ steps.package_name.outputs.package_name }}" - echo "$url" - data=$(curl "$url") - mkdir ./tmp - echo "$data" > ./tmp/npm_downloads.json - echo "data=$data" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Print summary of download data: - - name: 'Print summary' - run: | - echo "| Date | Downloads |" >> $GITHUB_STEP_SUMMARY - echo "|------|------------|" >> $GITHUB_STEP_SUMMARY - cat ./tmp/npm_downloads.json | jq -r ".downloads | .[-14:] | to_entries | map(\"| \(.value.day) | \(.value.downloads) |\") |.[]" >> $GITHUB_STEP_SUMMARY - - # Upload the download data: - - name: 'Upload data' - # Pin action to full length commit SHA - uses: actions/upload-artifact@5d5d22a31266ced268874388b861e4b58bb5c2f3 # v4.3.1 - with: - # Define a name for the uploaded artifact (ensuring a unique name for each job): - name: npm_downloads - - # Specify the path to the file to upload: - path: ./tmp/npm_downloads.json - - # Specify the number of days to retain the artifact (default is 90 days): - retention-days: 90 - timeout-minutes: 10 - if: success() - - # Send data to events server: - - name: 'Post data' - # Pin action to full length commit SHA - uses: distributhor/workflow-webhook@48a40b380ce4593b6a6676528cd005986ae56629 # v3.0.3 - env: - webhook_url: ${{ secrets.STDLIB_NPM_DOWNLOADS_URL }} - webhook_secret: ${{ secrets.STDLIB_WEBHOOK_SECRET }} - data: '{ "downloads": ${{ steps.download_data.outputs.data }} }' - timeout-minutes: 5 - if: success() diff --git a/.github/workflows/productionize.yml b/.github/workflows/productionize.yml deleted file mode 100644 index f92a6c5..0000000 --- a/.github/workflows/productionize.yml +++ /dev/null @@ -1,794 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2022 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. -#/ - -# Workflow name: -name: productionize - -# Workflow triggers: -on: - # Run workflow when a new commit is pushed to the main branch: - push: - branches: - - main - - # Allow the workflow to be manually run: - workflow_dispatch: - inputs: - require-passing-tests: - description: 'Require passing tests for creating bundles' - type: boolean - default: true - - # Run workflow upon completion of `publish` workflow run: - workflow_run: - workflows: ["publish"] - types: [completed] - - -# Concurrency group to prevent multiple concurrent executions: -concurrency: - group: productionize - cancel-in-progress: true - -# Workflow jobs: -jobs: - - # Define a job to create a production build... - productionize: - - # Define display name: - name: 'Productionize' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Define the sequence of job steps... - steps: - # Checkout main branch of repository: - - name: 'Checkout main branch' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - with: - ref: main - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Create production branch: - - name: 'Create production branch' - run: | - git checkout -b production - - # Transform error messages: - - name: 'Transform error messages' - id: transform-error-messages - uses: stdlib-js/transform-errors-action@main - - # 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: | - PKG_VERSION=$(npm view @stdlib/error-tools-fmtprodmsg version) - if grep -q '"@stdlib/string-format"' package.json; then - sed -i "s/\"@stdlib\/string-format\": \"^.*\"/\"@stdlib\/error-tools-fmtprodmsg\": \"^$PKG_VERSION\"/g" package.json - else - node -e "var pkg = require( './package.json' ); pkg.dependencies[ '@stdlib/error-tools-fmtprodmsg' ] = '^$PKG_VERSION'; require( 'fs' ).writeFileSync( 'package.json', JSON.stringify( pkg, null, 2 ) );" - fi - - # Configure git: - - name: 'Configure git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Transform error messages" - - # Push changes: - - name: 'Push changes' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" production --force - - # Define a job for running tests of the productionized code... - test: - - # Define a display name: - name: 'Run Tests' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Indicate that this job depends on the prior job finishing: - needs: productionize - - # Run this job regardless of the outcome of the prior job: - if: always() - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout repository' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - with: - # Use the `production` branch: - ref: production - - # Install Node.js: - - name: 'Install Node.js' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Build native add-on if present: - - name: 'Build native add-on (if present)' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - run: | - if [ -f "binding.gyp" ]; then - npm install node-gyp --no-save && ./node_modules/.bin/node-gyp rebuild - fi - - # Run tests: - - name: 'Run tests' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: tests - run: | - npm test || npm test || npm test - - # Define job to create a bundle for use in Deno... - deno: - - # Define display name: - name: 'Create Deno bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Configure git: - - name: 'Configure git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `deno` branch exists: - - name: 'Check if remote `deno` branch exists' - id: deno-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin deno - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `deno` exists, delete everything in branch and merge `production` into it - - name: 'If `deno` exists, delete everything in branch and merge `production` into it' - if: steps.deno-branch-exists.outputs.remote-exists - run: | - git checkout -b deno origin/deno - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `deno` does not exist, create `deno` branch: - - name: 'If `deno` does not exist, create `deno` branch' - if: ${{ steps.deno-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b deno - - # Copy files to deno directory: - - name: 'Copy files to deno directory' - run: | - mkdir -p deno - cp README.md LICENSE CONTRIBUTORS NOTICE ./deno - - # Copy TypeScript definitions to deno directory: - if [ -d index.d.ts ]; then - cp index.d.ts ./deno/index.d.ts - fi - if [ -e ./docs/types/index.d.ts ]; then - cp ./docs/types/index.d.ts ./deno/mod.d.ts - fi - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: Install production and development dependencies - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Bundle package for use in Deno: - - name: 'Bundle package for Deno' - id: deno-bundle - uses: stdlib-js/bundle-action@main - with: - target: 'deno' - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - # Replace links to other packages with links to the deno branch: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/deno/"; - - # Replace reference to `@stdlib/types` with CDN link: - find ./deno -type f -name '*.ts' -print0 | xargs -0 -r sed -Ei "s/\/\/\/ /\/\/\/ /g" - - # Change wording of project description to avoid reference to JavaScript and Node.js: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "s/a standard library for JavaScript and Node.js, /a standard library /g" - - # Rewrite all `require()`s to use jsDelivr links: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/require\( '@stdlib\// { - s/(var|let|const)\s+([a-z0-9_]+)\s+=\s*require\( '([^']+)' \);/import \2 from \'\3\';/i - s/@stdlib/https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js/ - s/';/@deno\/mod.js';/ - }" - - # Rewrite first `import` to show importing of named exports if available: - exports=$(cat lib/index.js | \ - grep -E 'setReadOnly\(.*,.*,.*\)' | \ - sed -E 's/setReadOnly\((.*),(.*),(.*)\);/\2/' | \ - sed -E "s/'//g" | \ - sort) - if [ -n "$exports" ]; then - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\nimport\s+([a-zA-Z0-9_]+)\s+from\s*'([^']+)';\n\`\`\`/\`\`\`javascript\nimport \1 from '\2';\n\`\`\`\n\nYou can also import the following named exports from the package:\n\n\`\`\`javascript\nimport { $(echo $exports | sed -E 's/ /, /g') } from '\2';\n\`\`\`/" - fi - - # Remove `installation`, `cli`, and `c` sections: - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Create package.json file for deno branch: - jq --indent 2 '{"name": .name, "version": .version, "description": .description, "license": .license, "type": "module", "main": "./mod.js", "homepage": .homepage, "repository": .repository, "bugs": .bugs, "keywords": .keywords, "funding": .funding}' package.json > ./deno/package.json - - # Delete everything in current directory aside from deno folder: - - name: 'Delete everything in current directory aside from deno folder' - run: | - find . -type 'f' | grep -v -e "deno" -e ".git/" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e "deno" -e ".git" | xargs -r rm -rf - - # Move deno directory to root: - - name: 'Move deno directory to root' - run: | - mv ./deno/* . - rmdir ./deno - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Auto-generated commit" - - # Push changes to `deno` branch: - - name: 'Push changes to `deno` branch' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" deno - - # Send status to Slack channel if job fails: - - name: 'Send status to Slack channel in case of failure' - # Pin action to full length commit SHA - uses: 8398a7/action-slack@28ba43ae48961b90635b50953d216767a6bea486 # v3.16.2 - with: - status: ${{ job.status }} - channel: '#npm-ci' - if: failure() - - # Define job to create a UMD bundle... - umd: - - # Define display name: - name: 'Create UMD bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Configure git: - - name: 'Configure git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `umd` branch exists: - - name: 'Check if remote `umd` branch exists' - id: umd-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin umd - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `umd` exists, delete everything in branch and merge `production` into it - - name: 'If `umd` exists, delete everything in branch and merge `production` into it' - if: steps.umd-branch-exists.outputs.remote-exists - run: | - git checkout -b umd origin/umd - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `umd` does not exist, create `umd` branch: - - name: 'If `umd` does not exist, create `umd` branch' - if: ${{ steps.umd-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b umd - - # Copy files to umd directory: - - name: 'Copy files to umd directory' - run: | - mkdir -p umd - cp README.md LICENSE CONTRIBUTORS NOTICE ./umd - - # Install Node.js - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Extract alias: - - name: 'Extract alias' - id: extract-alias - run: | - alias=$(grep -E 'require\(' README.md | head -n 1 | sed -E 's/^var ([a-zA-Z0-9_]+) = .+/\1/') - echo "alias=${alias}" >> $GITHUB_OUTPUT - - # Create Universal Module Definition (UMD) Node.js bundle: - - name: 'Create Universal Module Definition (UMD) Node.js bundle' - id: umd-bundle-node - uses: stdlib-js/bundle-action@main - with: - target: 'umd-node' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Create Universal Module Definition (UMD) browser bundle: - - name: 'Create Universal Module Definition (UMD) browser bundle' - id: umd-bundle-browser - uses: stdlib-js/bundle-action@main - with: - target: 'umd-browser' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - - # Replace links to other packages with links to the umd branch: - find ./umd -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/umd/"; - - # Remove `installation`, `cli`, and `c` sections: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Rewrite first `require()` to show consumption of the UMD bundle in Observable and via a `script` tag: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\n(var|let|const)\s+([a-zA-Z0-9_]+)\s+=\s*require\( '\@stdlib\/([^']+)' \);\n\`\`\`/To use in Observable,\n\n\`\`\`javascript\n\2 = require\( 'https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js\/\3\@umd\/browser.js' \)\n\`\`\`\n\nTo vendor stdlib functionality and avoid installing dependency trees for Node.js, you can use the UMD server build:\n\n\`\`\`javascript\nvar \2 = require\( 'path\/to\/vendor\/umd\/\3\/index.js' \)\n\`\`\`\n\nTo include the bundle in a webpage,\n\n\`\`\`html\n + + ```
@@ -189,7 +180,7 @@ var out = filter( x, naryFunction( isPositiveInteger, 1 ) ); ## 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. +This package is part of [stdlib][stdlib], a standard library 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]. diff --git a/SECURITY.md b/SECURITY.md deleted file mode 100644 index 9702d4c..0000000 --- a/SECURITY.md +++ /dev/null @@ -1,5 +0,0 @@ -# Security - -> Policy for reporting security vulnerabilities. - -See the security policy [in the main project repository](https://github.com/stdlib-js/stdlib/security). diff --git a/benchmark/benchmark.length.js b/benchmark/benchmark.length.js deleted file mode 100644 index bc79e33..0000000 --- a/benchmark/benchmark.length.js +++ /dev/null @@ -1,97 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 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 bench = require( '@stdlib/bench-harness' ); -var pow = require( '@stdlib/math-base-special-pow' ); -var isArray = require( '@stdlib/assert-is-array' ); -var isNonNegativeInteger = require( '@stdlib/assert-is-nonnegative-integer' ).isPrimitive; -var zeroTo = require( '@stdlib/array-base-zero-to' ); -var pkg = require( './../package.json' ).name; -var filter = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveInteger} len - array length -* @returns {Function} benchmark function -*/ -function createBenchmark( len ) { - var x = zeroTo( len ); - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var out; - var i; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - out = filter( x, isNonNegativeInteger ); - if ( typeof out !== 'object' ) { - b.fail( 'should return an array' ); - } - } - b.toc(); - if ( !isArray( out ) ) { - b.fail( 'should return an array' ); - } - b.pass( 'benchmark finished' ); - b.end(); - } -} - - -// MAIN // - -/** -* Main execution sequence. -* -* @private -*/ -function main() { - var len; - var min; - var max; - var f; - var i; - - min = 1; // 10^min - max = 6; // 10^max - - for ( i = min; i <= max; i++ ) { - len = pow( 10, i ); - - f = createBenchmark( len ); - bench( pkg+':dtype=generic,len='+len, f ); - } -} - -main(); diff --git a/branches.md b/branches.md deleted file mode 100644 index 9858901..0000000 --- a/branches.md +++ /dev/null @@ -1,56 +0,0 @@ - - -# Branches - -This repository has the following branches: - -- **main**: default branch generated from the [stdlib project][stdlib-url], where all development takes place. -- **production**: [production build][production-url] of the package (e.g., reformatted error messages to reduce bundle sizes and thus the number of bytes transmitted over a network). -- **esm**: [ES Module][esm-url] branch for use via a `script` tag without the need for installation and bundlers (see [README][esm-readme]). -- **deno**: [Deno][deno-url] branch for use in Deno (see [README][deno-readme]). -- **umd**: [UMD][umd-url] branch for use in Observable, or in dual browser/Node.js environments (see [README][umd-readme]). - -The following diagram illustrates the relationships among the above branches: - -```mermaid -graph TD; -A[stdlib]-->|generate standalone package|B; -B[main] -->|productionize| C[production]; -C -->|bundle| D[esm]; -C -->|bundle| E[deno]; -C -->|bundle| F[umd]; - -%% click A href "https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/filter" -%% click B href "https://github.com/stdlib-js/array-base-filter/tree/main" -%% click C href "https://github.com/stdlib-js/array-base-filter/tree/production" -%% click D href "https://github.com/stdlib-js/array-base-filter/tree/esm" -%% click E href "https://github.com/stdlib-js/array-base-filter/tree/deno" -%% click F href "https://github.com/stdlib-js/array-base-filter/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/filter -[production-url]: https://github.com/stdlib-js/array-base-filter/tree/production -[deno-url]: https://github.com/stdlib-js/array-base-filter/tree/deno -[deno-readme]: https://github.com/stdlib-js/array-base-filter/blob/deno/README.md -[umd-url]: https://github.com/stdlib-js/array-base-filter/tree/umd -[umd-readme]: https://github.com/stdlib-js/array-base-filter/blob/umd/README.md -[esm-url]: https://github.com/stdlib-js/array-base-filter/tree/esm -[esm-readme]: https://github.com/stdlib-js/array-base-filter/blob/esm/README.md \ No newline at end of file diff --git a/dist/index.d.ts b/dist/index.d.ts deleted file mode 100644 index aafb9cb..0000000 --- a/dist/index.d.ts +++ /dev/null @@ -1,3 +0,0 @@ -/// -import filter from '../docs/types/index'; -export = filter; \ No newline at end of file diff --git a/dist/index.js b/dist/index.js deleted file mode 100644 index 5c2f789..0000000 --- a/dist/index.js +++ /dev/null @@ -1,5 +0,0 @@ -"use strict";var s=function(r,t){return function(){return t||r((t={exports:{}}).exports,t),t.exports}};var f=s(function(y,c){ -var v=require('@stdlib/array-base-arraylike2object/dist');function l(r,t){return typeof r[t]=="function"}function h(r,t,n){var e,o,a;for(e=[],a=0;a 0;\n* }\n*\n* var x = [ 1, -2, -3, 4 ];\n*\n* var out = internal( x, isPositive );\n* // returns [ 1, 4 ]\n*/\nfunction internal( x, predicate, thisArg ) {\n\tvar out;\n\tvar v;\n\tvar i;\n\n\tout = [];\n\tfor ( i = 0; i < x.length; i++ ) {\n\t\tv = x[ i ];\n\t\tif ( predicate.call( thisArg, v, i, x ) ) {\n\t\t\tout.push( v );\n\t\t}\n\t}\n\treturn out;\n}\n\n/**\n* Returns a shallow copy of an array containing only those elements which pass a test implemented by a predicate function.\n*\n* @private\n* @param {Object} x - input array object\n* @param {Function} predicate - test function\n* @param {*} thisArg - execution context\n* @returns {Array} output array\n*\n* @example\n* var toAccessorArray = require( '@stdlib/array-base-to-accessor-array' );\n* var arraylike2object = require( '@stdlib/array-base-arraylike2object' );\n*\n* function isPositive( v ) {\n* return v > 0;\n* }\n*\n* var x = arraylike2object( toAccessorArray( [ 1, -2, -3, 4 ] ) );\n*\n* var out = accessors( x, isPositive );\n* // returns [ 1, 4 ]\n*/\nfunction accessors( x, predicate, thisArg ) {\n\tvar data;\n\tvar get;\n\tvar out;\n\tvar v;\n\tvar i;\n\n\tdata = x.data;\n\tget = x.accessors[ 0 ];\n\n\tout = [];\n\tfor ( i = 0; i < data.length; i++ ) {\n\t\tv = get( data, i );\n\t\tif ( predicate.call( thisArg, v, i, data ) ) {\n\t\t\tout.push( v );\n\t\t}\n\t}\n\treturn out;\n}\n\n\n// MAIN //\n\n/**\n* Returns a shallow copy of an array containing only those elements which pass a test implemented by a predicate function.\n*\n* @param {Collection} x - input array\n* @param {Function} predicate - test function\n* @param {*} [thisArg] - execution context\n* @returns {Collection} output array\n*\n* @example\n* function isPositive( v ) {\n* return v > 0;\n* }\n*\n* var x = [ 1, -2, -3, 4 ];\n*\n* var out = filter( x, isPositive );\n* // returns [ 1, 4 ]\n*/\nfunction filter( x, predicate, thisArg ) {\n\tvar obj;\n\tif ( hasMethod( x, 'filter' ) ) {\n\t\treturn x.filter( predicate, thisArg );\n\t}\n\tobj = arraylike2object( x );\n\tif ( obj.accessorProtocol ) {\n\t\treturn accessors( obj, predicate, thisArg );\n\t}\n\treturn internal( x, predicate, thisArg );\n}\n\n\n// EXPORTS //\n\nmodule.exports = filter;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2024 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* Return a shallow copy of an array containing only those elements which pass a test implemented by a predicate function.\n*\n* @module @stdlib/array-base-filter\n*\n* @example\n* var filter = require( '@stdlib/array-base-filter' );\n*\n* function isPositive( v ) {\n* return v > 0;\n* }\n*\n* var x = [ 1, -2, -3, 4 ];\n*\n* var out = filter( x, isPositive );\n* // returns [ 1, 4 ]\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,EAAmB,QAAS,qCAAsC,EAqBtE,SAASC,EAAWC,EAAKC,EAAS,CACjC,OAAS,OAAOD,EAAKC,CAAO,GAAM,UACnC,CAqBA,SAASC,EAAUC,EAAGC,EAAWC,EAAU,CAC1C,IAAIC,EACAC,EACAC,EAGJ,IADAF,EAAM,CAAC,EACDE,EAAI,EAAGA,EAAIL,EAAE,OAAQK,IAC1BD,EAAIJ,EAAGK,CAAE,EACJJ,EAAU,KAAMC,EAASE,EAAGC,EAAGL,CAAE,GACrCG,EAAI,KAAMC,CAAE,EAGd,OAAOD,CACR,CAwBA,SAASG,EAAWN,EAAGC,EAAWC,EAAU,CAC3C,IAAIK,EACAC,EACAL,EACAC,EACAC,EAMJ,IAJAE,EAAOP,EAAE,KACTQ,EAAMR,EAAE,UAAW,CAAE,EAErBG,EAAM,CAAC,EACDE,EAAI,EAAGA,EAAIE,EAAK,OAAQF,IAC7BD,EAAII,EAAKD,EAAMF,CAAE,EACZJ,EAAU,KAAMC,EAASE,EAAGC,EAAGE,CAAK,GACxCJ,EAAI,KAAMC,CAAE,EAGd,OAAOD,CACR,CAuBA,SAASM,EAAQT,EAAGC,EAAWC,EAAU,CACxC,IAAIL,EACJ,OAAKD,EAAWI,EAAG,QAAS,EACpBA,EAAE,OAAQC,EAAWC,CAAQ,GAErCL,EAAMF,EAAkBK,CAAE,EACrBH,EAAI,iBACDS,EAAWT,EAAKI,EAAWC,CAAQ,EAEpCH,EAAUC,EAAGC,EAAWC,CAAQ,EACxC,CAKAR,EAAO,QAAUe,ICvHjB,IAAIC,EAAO,IAKX,OAAO,QAAUA", - "names": ["require_main", "__commonJSMin", "exports", "module", "arraylike2object", "hasMethod", "obj", "method", "internal", "x", "predicate", "thisArg", "out", "v", "i", "accessors", "data", "get", "filter", "main"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index bb2b17a..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,46 +0,0 @@ - -{{alias}}( x, predicate[, thisArg] ) - Returns a shallow copy of an array containing only those elements which pass - a test implemented by a predicate function. - - The predicate function is provided three arguments: - - - value: current array element. - - index: current array element index. - - arr: the input array. - - If provided an array-like object having a `filter` method , the function - defers execution to that method and assumes that the method has the - following signature: - - x.filter( predicate, thisArg ) - - If provided an array-like object without a `filter` method, the function - performs a linear scan and always returns a generic array. - - Parameters - ---------- - x: Array|TypedArray|Object - Input array. - - predicate: Function - Predicate function. - - thisArg: any (optional) - Execution context. - - Returns - ------- - out: Array|TypedArray|Object - Output array. - - Examples - -------- - > function f( v ) { return ( v > 0 ); }; - > var x = [ 1, -2, -3, 4 ]; - > var out = {{alias}}( x, f ) - [ 1, 4 ] - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index db0c38d..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,101 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2024 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. -*/ - -import toAccessorArray = require( '@stdlib/array-base-to-accessor-array' ); -import filter = require( './index' ); - -/** -* Tests whether a value is positive. -* -* @param value - input value -* @returns boolean indicating whether an element is positive -*/ -function isPositive( value: number ): boolean { - return ( value > 0 ); -} - - -// TESTS // - -// The function returns a collection... -{ - filter( [ 1, 2, 3 ], isPositive ); // $ExpectType number[] - filter( new Float64Array( [ 1, 2, 3 ] ), isPositive ); // $ExpectType Float64Array - filter( new Float32Array( [ 1, 2, 3 ] ), isPositive ); // $ExpectType Float32Array - filter( new Int32Array( [ 1, 2, 3 ] ), isPositive ); // $ExpectType Int32Array - filter( new Int16Array( [ 1, 2, 3 ] ), isPositive ); // $ExpectType Int16Array - filter( new Int8Array( [ 1, 2, 3 ] ), isPositive ); // $ExpectType Int8Array - filter( new Uint32Array( [ 1, 2, 3 ] ), isPositive ); // $ExpectType Uint32Array - filter( new Uint16Array( [ 1, 2, 3 ] ), isPositive ); // $ExpectType Uint16Array - filter( new Uint8Array( [ 1, 2, 3 ] ), isPositive ); // $ExpectType Uint8Array - filter( new Uint8ClampedArray( [ 1, 2, 3 ] ), isPositive ); // $ExpectType Uint8ClampedArray - filter( toAccessorArray( [ 1, 2, 3 ] ), isPositive ); // $ExpectType number[] - - filter( [ 1, 2, 3 ], isPositive, {} ); // $ExpectType number[] - filter( new Float64Array( [ 1, 2, 3 ] ), isPositive, {} ); // $ExpectType Float64Array - filter( new Float32Array( [ 1, 2, 3 ] ), isPositive, {} ); // $ExpectType Float32Array - filter( new Int32Array( [ 1, 2, 3 ] ), isPositive, {} ); // $ExpectType Int32Array - filter( new Int16Array( [ 1, 2, 3 ] ), isPositive, {} ); // $ExpectType Int16Array - filter( new Int8Array( [ 1, 2, 3 ] ), isPositive, {} ); // $ExpectType Int8Array - filter( new Uint32Array( [ 1, 2, 3 ] ), isPositive, {} ); // $ExpectType Uint32Array - filter( new Uint16Array( [ 1, 2, 3 ] ), isPositive, {} ); // $ExpectType Uint16Array - filter( new Uint8Array( [ 1, 2, 3 ] ), isPositive, {} ); // $ExpectType Uint8Array - filter( new Uint8ClampedArray( [ 1, 2, 3 ] ), isPositive, {} ); // $ExpectType Uint8ClampedArray - filter( toAccessorArray( [ 1, 2, 3 ] ), isPositive, {} ); // $ExpectType number[] -} - -// The compiler throws an error if the function is provided a first argument which is not a collection... -{ - filter( 2, isPositive ); // $ExpectError - filter( false, isPositive ); // $ExpectError - filter( true, isPositive ); // $ExpectError - filter( {}, isPositive ); // $ExpectError - - filter( 2, isPositive, {} ); // $ExpectError - filter( false, isPositive, {} ); // $ExpectError - filter( true, isPositive, {} ); // $ExpectError - filter( {}, isPositive, {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided a second argument which is not a function... -{ - filter( [ 1, 2, 3 ], 'abc' ); // $ExpectError - filter( [ 1, 2, 3 ], 2 ); // $ExpectError - filter( [ 1, 2, 3 ], false ); // $ExpectError - filter( [ 1, 2, 3 ], true ); // $ExpectError - filter( [ 1, 2, 3 ], null ); // $ExpectError - filter( [ 1, 2, 3 ], void 0 ); // $ExpectError - filter( [ 1, 2, 3 ], {} ); // $ExpectError - filter( [ 1, 2, 3 ], [] ); // $ExpectError - - filter( [ 1, 2, 3 ], 'abc', {} ); // $ExpectError - filter( [ 1, 2, 3 ], 2, {} ); // $ExpectError - filter( [ 1, 2, 3 ], false, {} ); // $ExpectError - filter( [ 1, 2, 3 ], true, {} ); // $ExpectError - filter( [ 1, 2, 3 ], null, {} ); // $ExpectError - filter( [ 1, 2, 3 ], void 0, {} ); // $ExpectError - filter( [ 1, 2, 3 ], {}, {} ); // $ExpectError - filter( [ 1, 2, 3 ], [], {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided an unsupported number of arguments... -{ - filter(); // $ExpectError - filter( [ 1, 2, 3 ] ); // $ExpectError - filter( [ 1, 2, 3 ], isPositive, {}, 3 ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index cdfb9a7..0000000 --- a/examples/index.js +++ /dev/null @@ -1,35 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 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'; - -var discreteUniform = require( '@stdlib/random-array-discrete-uniform' ); -var isPositiveInteger = require( '@stdlib/assert-is-positive-integer' ).isPrimitive; -var naryFunction = require( '@stdlib/utils-nary-function' ); -var filter = require( './../lib' ); - -var x = discreteUniform( 10, -5, 5, { - 'dtype': 'int32' -}); -// returns - -var out = filter( x, naryFunction( isPositiveInteger, 1 ) ); -// returns - -console.log( x ); -console.log( out ); diff --git a/docs/types/index.d.ts b/index.d.ts similarity index 99% rename from docs/types/index.d.ts rename to index.d.ts index 730dc98..c5c8ca7 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 4.1 -/// +/// import { Collection, AccessorArrayLike, Complex128Array, Complex64Array } from '@stdlib/types/array'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..a10870c --- /dev/null +++ b/index.mjs @@ -0,0 +1,4 @@ +// Copyright (c) 2024 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 +/// +import r from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-arraylike2object@v0.2.1-esm/index.mjs";function t(t,e,n){var o;return function(r,t){return"function"==typeof r[t]}(t,"filter")?t.filter(e,n):(o=r(t)).accessorProtocol?function(r,t,e){var n,o,a,s,c;for(n=r.data,o=r.accessors[0],a=[],c=0;c 0;\n* }\n*\n* var x = [ 1, -2, -3, 4 ];\n*\n* var out = internal( x, isPositive );\n* // returns [ 1, 4 ]\n*/\nfunction internal( x, predicate, thisArg ) {\n\tvar out;\n\tvar v;\n\tvar i;\n\n\tout = [];\n\tfor ( i = 0; i < x.length; i++ ) {\n\t\tv = x[ i ];\n\t\tif ( predicate.call( thisArg, v, i, x ) ) {\n\t\t\tout.push( v );\n\t\t}\n\t}\n\treturn out;\n}\n\n/**\n* Returns a shallow copy of an array containing only those elements which pass a test implemented by a predicate function.\n*\n* @private\n* @param {Object} x - input array object\n* @param {Function} predicate - test function\n* @param {*} thisArg - execution context\n* @returns {Array} output array\n*\n* @example\n* import toAccessorArray from '@stdlib/array-base-to-accessor-array';\n* import arraylike2object from '@stdlib/array-base-arraylike2object';\n*\n* function isPositive( v ) {\n* return v > 0;\n* }\n*\n* var x = arraylike2object( toAccessorArray( [ 1, -2, -3, 4 ] ) );\n*\n* var out = accessors( x, isPositive );\n* // returns [ 1, 4 ]\n*/\nfunction accessors( x, predicate, thisArg ) {\n\tvar data;\n\tvar get;\n\tvar out;\n\tvar v;\n\tvar i;\n\n\tdata = x.data;\n\tget = x.accessors[ 0 ];\n\n\tout = [];\n\tfor ( i = 0; i < data.length; i++ ) {\n\t\tv = get( data, i );\n\t\tif ( predicate.call( thisArg, v, i, data ) ) {\n\t\t\tout.push( v );\n\t\t}\n\t}\n\treturn out;\n}\n\n\n// MAIN //\n\n/**\n* Returns a shallow copy of an array containing only those elements which pass a test implemented by a predicate function.\n*\n* @param {Collection} x - input array\n* @param {Function} predicate - test function\n* @param {*} [thisArg] - execution context\n* @returns {Collection} output array\n*\n* @example\n* function isPositive( v ) {\n* return v > 0;\n* }\n*\n* var x = [ 1, -2, -3, 4 ];\n*\n* var out = filter( x, isPositive );\n* // returns [ 1, 4 ]\n*/\nfunction filter( x, predicate, thisArg ) {\n\tvar obj;\n\tif ( hasMethod( x, 'filter' ) ) {\n\t\treturn x.filter( predicate, thisArg );\n\t}\n\tobj = arraylike2object( x );\n\tif ( obj.accessorProtocol ) {\n\t\treturn accessors( obj, predicate, thisArg );\n\t}\n\treturn internal( x, predicate, thisArg );\n}\n\n\n// EXPORTS //\n\nexport default filter;\n"],"names":["filter","x","predicate","thisArg","obj","method","hasMethod","arraylike2object","accessorProtocol","data","get","out","v","i","accessors","length","call","push","internal"],"mappings":";;sGAgJA,SAASA,EAAQC,EAAGC,EAAWC,GAC9B,IAAIC,EACJ,OAvGD,SAAoBA,EAAKC,GACxB,MAAkC,mBAAlBD,EAAKC,EACtB,CAqGMC,CAAWL,EAAG,UACXA,EAAED,OAAQE,EAAWC,IAE7BC,EAAMG,EAAkBN,IACfO,iBA/CV,SAAoBP,EAAGC,EAAWC,GACjC,IAAIM,EACAC,EACAC,EACAC,EACAC,EAMJ,IAJAJ,EAAOR,EAAEQ,KACTC,EAAMT,EAAEa,UAAW,GAEnBH,EAAM,GACAE,EAAI,EAAGA,EAAIJ,EAAKM,OAAQF,IAC7BD,EAAIF,EAAKD,EAAMI,GACVX,EAAUc,KAAMb,EAASS,EAAGC,EAAGJ,IACnCE,EAAIM,KAAML,GAGZ,OAAOD,CACR,CA8BSG,CAAWV,EAAKF,EAAWC,GArFpC,SAAmBF,EAAGC,EAAWC,GAChC,IAAIQ,EACAC,EACAC,EAGJ,IADAF,EAAM,GACAE,EAAI,EAAGA,EAAIZ,EAAEc,OAAQF,IAC1BD,EAAIX,EAAGY,GACFX,EAAUc,KAAMb,EAASS,EAAGC,EAAGZ,IACnCU,EAAIM,KAAML,GAGZ,OAAOD,CACR,CA0EQO,CAAUjB,EAAGC,EAAWC,EAChC"} \ No newline at end of file diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index 56236cd..0000000 --- a/lib/index.js +++ /dev/null @@ -1,46 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 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'; - -/** -* Return a shallow copy of an array containing only those elements which pass a test implemented by a predicate function. -* -* @module @stdlib/array-base-filter -* -* @example -* var filter = require( '@stdlib/array-base-filter' ); -* -* function isPositive( v ) { -* return v > 0; -* } -* -* var x = [ 1, -2, -3, 4 ]; -* -* var out = filter( x, isPositive ); -* // returns [ 1, 4 ] -*/ - -// MODULES // - -var main = require( './main.js' ); - - -// EXPORTS // - -module.exports = main; diff --git a/lib/main.js b/lib/main.js deleted file mode 100644 index 9b0c3db..0000000 --- a/lib/main.js +++ /dev/null @@ -1,160 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 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 arraylike2object = require( '@stdlib/array-base-arraylike2object' ); - - -// FUNCTIONS // - -/** -* Tests whether an object has a specified method. -* -* @private -* @param {Object} obj - input object -* @param {string} method - method name -* @returns {boolean} boolean indicating whether an object has a specified method -* -* @example -* var bool = hasMethod( [], 'filter' ); -* // returns true -* -* @example -* var bool = hasMethod( [], 'beep' ); -* // returns false -*/ -function hasMethod( obj, method ) { - return ( typeof obj[ method ] === 'function' ); -} - -/** -* Returns a shallow copy of an array containing only those elements which pass a test implemented by a predicate function. -* -* @private -* @param {Collection} x - input array -* @param {Function} predicate - test function -* @param {*} thisArg - execution context -* @returns {Array} output array -* -* @example -* function isPositive( v ) { -* return v > 0; -* } -* -* var x = [ 1, -2, -3, 4 ]; -* -* var out = internal( x, isPositive ); -* // returns [ 1, 4 ] -*/ -function internal( x, predicate, thisArg ) { - var out; - var v; - var i; - - out = []; - for ( i = 0; i < x.length; i++ ) { - v = x[ i ]; - if ( predicate.call( thisArg, v, i, x ) ) { - out.push( v ); - } - } - return out; -} - -/** -* Returns a shallow copy of an array containing only those elements which pass a test implemented by a predicate function. -* -* @private -* @param {Object} x - input array object -* @param {Function} predicate - test function -* @param {*} thisArg - execution context -* @returns {Array} output array -* -* @example -* var toAccessorArray = require( '@stdlib/array-base-to-accessor-array' ); -* var arraylike2object = require( '@stdlib/array-base-arraylike2object' ); -* -* function isPositive( v ) { -* return v > 0; -* } -* -* var x = arraylike2object( toAccessorArray( [ 1, -2, -3, 4 ] ) ); -* -* var out = accessors( x, isPositive ); -* // returns [ 1, 4 ] -*/ -function accessors( x, predicate, thisArg ) { - var data; - var get; - var out; - var v; - var i; - - data = x.data; - get = x.accessors[ 0 ]; - - out = []; - for ( i = 0; i < data.length; i++ ) { - v = get( data, i ); - if ( predicate.call( thisArg, v, i, data ) ) { - out.push( v ); - } - } - return out; -} - - -// MAIN // - -/** -* Returns a shallow copy of an array containing only those elements which pass a test implemented by a predicate function. -* -* @param {Collection} x - input array -* @param {Function} predicate - test function -* @param {*} [thisArg] - execution context -* @returns {Collection} output array -* -* @example -* function isPositive( v ) { -* return v > 0; -* } -* -* var x = [ 1, -2, -3, 4 ]; -* -* var out = filter( x, isPositive ); -* // returns [ 1, 4 ] -*/ -function filter( x, predicate, thisArg ) { - var obj; - if ( hasMethod( x, 'filter' ) ) { - return x.filter( predicate, thisArg ); - } - obj = arraylike2object( x ); - if ( obj.accessorProtocol ) { - return accessors( obj, predicate, thisArg ); - } - return internal( x, predicate, thisArg ); -} - - -// EXPORTS // - -module.exports = filter; diff --git a/package.json b/package.json index d836e77..222dce3 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.2.1", "description": "Return a shallow copy of an array containing only those elements which pass a test implemented by a predicate function.", "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", - "directories": { - "benchmark": "./benchmark", - "doc": "./docs", - "example": "./examples", - "lib": "./lib", - "test": "./test" - }, - "types": "./docs/types", - "scripts": { - "test": "make test", - "test-cov": "make test-cov", - "examples": "make examples", - "benchmark": "make benchmark" - }, + "type": "module", + "main": "./index.mjs", "homepage": "https://stdlib.io", "repository": { "type": "git", @@ -36,42 +13,6 @@ "bugs": { "url": "https://github.com/stdlib-js/stdlib/issues" }, - "dependencies": { - "@stdlib/array-base-arraylike2object": "^0.2.1", - "@stdlib/types": "^0.3.2", - "@stdlib/error-tools-fmtprodmsg": "^0.2.1" - }, - "devDependencies": { - "@stdlib/array-base-accessor": "^0.2.1", - "@stdlib/array-base-zero-to": "^0.2.1", - "@stdlib/array-float64": "^0.2.1", - "@stdlib/assert-instance-of": "^0.2.1", - "@stdlib/assert-is-array": "^0.2.1", - "@stdlib/assert-is-nonnegative-integer": "^0.2.1", - "@stdlib/assert-is-positive-integer": "^0.2.1", - "@stdlib/math-base-special-pow": "^0.2.1", - "@stdlib/random-array-discrete-uniform": "^0.2.1", - "@stdlib/utils-nary-function": "^0.2.1", - "tape": "git+https://github.com/kgryte/tape.git#fix/globby", - "istanbul": "^0.4.1", - "tap-min": "git+https://github.com/Planeshifter/tap-min.git", - "@stdlib/bench-harness": "^0.2.1" - }, - "engines": { - "node": ">=0.10.0", - "npm": ">2.7.0" - }, - "os": [ - "aix", - "darwin", - "freebsd", - "linux", - "macos", - "openbsd", - "sunos", - "win32", - "windows" - ], "keywords": [ "stdlib", "stdtypes", @@ -91,4 +32,4 @@ "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} \ No newline at end of file +} diff --git a/stats.html b/stats.html new file mode 100644 index 0000000..d4d08f0 --- /dev/null +++ b/stats.html @@ -0,0 +1,4842 @@ + + + + + + + + Rollup Visualizer + + + +
+ + + + + diff --git a/test/dist/test.js b/test/dist/test.js deleted file mode 100644 index a8a9c60..0000000 --- a/test/dist/test.js +++ /dev/null @@ -1,33 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 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 tape = require( 'tape' ); -var main = require( './../../dist' ); - - -// TESTS // - -tape( 'main export is defined', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( main !== void 0, true, 'main export is defined' ); - t.end(); -}); diff --git a/test/test.js b/test/test.js deleted file mode 100644 index d4e7373..0000000 --- a/test/test.js +++ /dev/null @@ -1,251 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 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 tape = require( 'tape' ); -var AccessorArray = require( '@stdlib/array-base-accessor' ); -var Float64Array = require( '@stdlib/array-float64' ); -var instanceOf = require( '@stdlib/assert-instance-of' ); -var filter = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Tests whether a value is positive. -* -* @private -* @param {number} value - input value -* @returns {boolean} boolean indicating if a value is positive -*/ -function isPositive( value ) { - return ( value > 0 ); -} - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof filter, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'if provided an empty collection, the function returns an empty collection (generic)', function test( t ) { - var expected; - var actual; - var arr; - - arr = []; - expected = []; - actual = filter( arr, foo ); - - t.strictEqual( instanceOf( actual, Array ), true, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - t.end(); - - function foo() { - t.fail( 'should not be invoked' ); - } -}); - -tape( 'if provided an empty collection, the function returns an empty collection (typed array)', function test( t ) { - var expected; - var actual; - var arr; - - arr = new Float64Array( [] ); - expected = new Float64Array( [] ); - actual = filter( arr, foo ); - - t.strictEqual( instanceOf( actual, Float64Array ), true, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - t.end(); - - function foo() { - t.fail( 'should not be invoked' ); - } -}); - -tape( 'if provided an empty collection, the function returns an empty collection (accessor)', function test( t ) { - var expected; - var actual; - var arr; - - arr = new AccessorArray( [] ); - expected = []; - actual = filter( arr, foo ); - - t.strictEqual( instanceOf( actual, Array ), true, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - t.end(); - - function foo() { - t.fail( 'should not be invoked' ); - } -}); - -tape( 'the function filters a provided collection (generic)', function test( t ) { - var expected; - var actual; - var arr; - - arr = [ 1, -2, 3 ]; - expected = [ 1, 3 ]; - actual = filter( arr, isPositive ); - - t.strictEqual( instanceOf( actual, Array ), true, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - t.end(); -}); - -tape( 'the function filters a provided collection (typed array)', function test( t ) { - var expected; - var actual; - var arr; - - arr = new Float64Array( [ -1.0, 2.0, 3.0 ] ); - expected = new Float64Array( [ 2.0, 3.0 ] ); - actual = filter( arr, isPositive ); - - t.strictEqual( instanceOf( actual, Float64Array ), true, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - t.end(); -}); - -tape( 'the function filters a provided collection (accessor)', function test( t ) { - var expected; - var actual; - var arr; - - arr = new AccessorArray( [ 1, -2, -3 ] ); - expected = [ 1 ]; - actual = filter( arr, isPositive ); - - t.strictEqual( instanceOf( actual, Array ), true, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - t.end(); -}); - -tape( 'the function filters a provided collection (array-like object)', function test( t ) { - var expected; - var actual; - var arr; - - arr = { - 'length': 3, - '0': -1, - '1': -2, - '2': 3 - }; - expected = [ 3 ]; - actual = filter( arr, isPositive ); - - t.strictEqual( instanceOf( actual, Array ), true, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - t.end(); -}); - -tape( 'the function an empty collection if all elements fail a test (generic)', function test( t ) { - var expected; - var actual; - var arr; - - arr = [ -1, -2, -3 ]; - expected = []; - actual = filter( arr, isPositive ); - - t.strictEqual( instanceOf( actual, Array ), true, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - t.end(); -}); - -tape( 'the function an empty collection if all elements fail a test (typed array)', function test( t ) { - var expected; - var actual; - var arr; - - arr = new Float64Array( [ -1.0, -2.0, -3.0 ] ); - expected = new Float64Array( [] ); - actual = filter( arr, isPositive ); - - t.strictEqual( instanceOf( actual, Float64Array ), true, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - t.end(); -}); - -tape( 'the function an empty collection if all elements fail a test (accessor)', function test( t ) { - var expected; - var actual; - var arr; - - arr = new AccessorArray( [ -1, -2, -3 ] ); - expected = []; - actual = filter( arr, isPositive ); - - t.strictEqual( instanceOf( actual, Array ), true, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - t.end(); -}); - -tape( 'the function an empty collection if all elements fail a test (array-like object)', function test( t ) { - var expected; - var actual; - var arr; - - arr = { - 'length': 3, - '0': -1, - '1': -2, - '2': -3 - }; - expected = []; - actual = filter( arr, isPositive ); - - t.strictEqual( instanceOf( actual, Array ), true, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - t.end(); -}); - -tape( 'the function supports providing an execution context', function test( t ) { - var expected; - var actual; - var ctx; - var arr; - - ctx = { - 'count': 0 - }; - arr = [ 1, 2, 3 ]; - expected = [ 1, 2, 3 ]; - actual = filter( arr, predicate, ctx ); - - t.strictEqual( instanceOf( actual, Array ), true, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - t.strictEqual( ctx.count, arr.length, 'returns expected value' ); - - t.end(); - - function predicate( value ) { - this.count += 1; // eslint-disable-line no-invalid-this - return ( value > 0 ); - } -}); From a26f6b9be4b23d0329f93bbcca9330ec5604d784 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 29 Jul 2024 11:59:26 +0000 Subject: [PATCH 30/40] Transform error messages --- package.json | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/package.json b/package.json index 3376b6f..327779d 100644 --- a/package.json +++ b/package.json @@ -38,7 +38,8 @@ }, "dependencies": { "@stdlib/array-base-arraylike2object": "^0.2.1", - "@stdlib/types": "^0.3.2" + "@stdlib/types": "^0.3.2", + "@stdlib/error-tools-fmtprodmsg": "^0.2.2" }, "devDependencies": { "@stdlib/array-base-accessor": "^0.2.1", @@ -90,4 +91,4 @@ "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} +} \ No newline at end of file From 0abca9764aa76aec96aaa06ac671e610ff834496 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 29 Jul 2024 12:02:48 +0000 Subject: [PATCH 31/40] Remove files --- index.d.ts | 343 ---- index.mjs | 4 - index.mjs.map | 1 - stats.html | 4842 ------------------------------------------------- 4 files changed, 5190 deletions(-) delete mode 100644 index.d.ts delete mode 100644 index.mjs delete mode 100644 index.mjs.map delete mode 100644 stats.html diff --git a/index.d.ts b/index.d.ts deleted file mode 100644 index c5c8ca7..0000000 --- a/index.d.ts +++ /dev/null @@ -1,343 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2024 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 - -/// - -import { Collection, AccessorArrayLike, Complex128Array, Complex64Array } from '@stdlib/types/array'; - -/** -* Returns a boolean indicating whether an element passes a test. -* -* @returns boolean indicating whether an element passes a test -*/ -type Nullary = ( this: U ) => boolean; - -/** -* Returns a boolean indicating whether an element passes a test. -* -* @param value - current array element -* @returns boolean indicating whether an element passes a test -*/ -type Unary = ( this: U, value: T ) => boolean; - -/** -* Returns a boolean indicating whether an element passes a test. -* -* @param value - current array element -* @param index - current array element index -* @returns boolean indicating whether an element passes a test -*/ -type Binary = ( this: U, value: T, index: number ) => boolean; - -/** -* Returns a boolean indicating whether an element passes a test. -* -* @param value - current array element -* @param index - current array element index -* @param arr - input array -* @returns boolean indicating whether an element passes a test -*/ -type Ternary = ( this: U, value: T, index: number, arr: V ) => boolean; - -/** -* Returns a boolean indicating whether an element passes a test. -* -* @param value - current array element -* @param index - current array element index -* @param arr - input array -* @returns boolean indicating whether an element passes a test -*/ -type Predicate = Nullary | Unary | Binary | Ternary; - -/** -* Returns a shallow copy of an array containing only those elements which pass a test implemented by a predicate function. -* -* @param x - input array -* @param predicate - predicate function -* @param thisArg - predicate function execution context -* @returns output array -* -* @example -* var isPositiveNumber = require( '@stdlib/assert-is-positive-number' ).isPrimitive; -* var Float64Array = require( '@stdlib/array-float64' ); -* -* var x = new Float64Array( [ 1.0, -2.0, -3.0, 4.0 ] ); -* -* var out = filter( x, isPositiveNumber ); -* // returns [ 1.0, 4.0 ] -*/ -declare function filter( x: Float64Array, predicate: Predicate, thisArg?: ThisParameterType> ): Float64Array; - -/** -* Returns a shallow copy of an array containing only those elements which pass a test implemented by a predicate function. -* -* @param x - input array -* @param predicate - predicate function -* @param thisArg - predicate function execution context -* @returns output array -* -* @example -* var isPositiveNumber = require( '@stdlib/assert-is-positive-number' ).isPrimitive; -* var Float32Array = require( '@stdlib/array-float32' ); -* -* var x = new Float32Array( [ 1.0, -2.0, -3.0, 4.0 ] ); -* -* var out = filter( x, isPositiveNumber ); -* // returns [ 1.0, 4.0 ] -*/ -declare function filter( x: Float32Array, predicate: Predicate, thisArg?: ThisParameterType> ): Float32Array; - -/** -* Returns a shallow copy of an array containing only those elements which pass a test implemented by a predicate function. -* -* @param x - input array -* @param predicate - predicate function -* @param thisArg - predicate function execution context -* @returns output array -* -* @example -* var isPositiveNumber = require( '@stdlib/assert-is-positive-number' ).isPrimitive; -* var Int32Array = require( '@stdlib/array-int32' ); -* -* var x = new Int32Array( [ 1, -2, -3, 4 ] ); -* -* var out = filter( x, isPositiveNumber ); -* // returns [ 1, 4 ] -*/ -declare function filter( x: Int32Array, predicate: Predicate, thisArg?: ThisParameterType> ): Int32Array; - -/** -* Returns a shallow copy of an array containing only those elements which pass a test implemented by a predicate function. -* -* @param x - input array -* @param predicate - predicate function -* @param thisArg - predicate function execution context -* @returns output array -* -* @example -* var isPositiveNumber = require( '@stdlib/assert-is-positive-number' ).isPrimitive; -* var Int16Array = require( '@stdlib/array-int16' ); -* -* var x = new Int16Array( [ 1, -2, -3, 4 ] ); -* -* var out = filter( x, isPositiveNumber ); -* // returns [ 1, 4 ] -*/ -declare function filter( x: Int16Array, predicate: Predicate, thisArg?: ThisParameterType> ): Int16Array; - -/** -* Returns a shallow copy of an array containing only those elements which pass a test implemented by a predicate function. -* -* @param x - input array -* @param predicate - predicate function -* @param thisArg - predicate function execution context -* @returns output array -* -* @example -* var isPositiveNumber = require( '@stdlib/assert-is-positive-number' ).isPrimitive; -* var Int8Array = require( '@stdlib/array-int8' ); -* -* var x = new Int8Array( [ 1, -2, -3, 4 ] ); -* -* var out = filter( x, isPositiveNumber ); -* // returns [ 1, 4 ] -*/ -declare function filter( x: Int8Array, predicate: Predicate, thisArg?: ThisParameterType> ): Int8Array; - -/** -* Returns a shallow copy of an array containing only those elements which pass a test implemented by a predicate function. -* -* @param x - input array -* @param predicate - predicate function -* @param thisArg - predicate function execution context -* @returns output array -* -* @example -* var isPositiveNumber = require( '@stdlib/assert-is-positive-number' ).isPrimitive; -* var Uint32Array = require( '@stdlib/array-uint32' ); -* -* var x = new Uint32Array( [ 1, 2, 3, 4 ] ); -* -* var out = filter( x, isPositiveNumber ); -* // returns [ 1, 2, 3, 4 ] -*/ -declare function filter( x: Uint32Array, predicate: Predicate, thisArg?: ThisParameterType> ): Uint32Array; - -/** -* Returns a shallow copy of an array containing only those elements which pass a test implemented by a predicate function. -* -* @param x - input array -* @param predicate - predicate function -* @param thisArg - predicate function execution context -* @returns output array -* -* @example -* var isPositiveNumber = require( '@stdlib/assert-is-positive-number' ).isPrimitive; -* var Uint16Array = require( '@stdlib/array-uint16' ); -* -* var x = new Uint16Array( [ 1, 2, 3, 4 ] ); -* -* var out = filter( x, isPositiveNumber ); -* // returns [ 1, 2, 3, 4 ] -*/ -declare function filter( x: Uint16Array, predicate: Predicate, thisArg?: ThisParameterType> ): Uint16Array; - -/** -* Returns a shallow copy of an array containing only those elements which pass a test implemented by a predicate function. -* -* @param x - input array -* @param predicate - predicate function -* @param thisArg - predicate function execution context -* @returns output array -* -* @example -* var isPositiveNumber = require( '@stdlib/assert-is-positive-number' ).isPrimitive; -* var Uint8Array = require( '@stdlib/array-uint8' ); -* -* var x = new Uint8Array( [ 1, 2, 3, 4 ] ); -* -* var out = filter( x, isPositiveNumber ); -* // returns [ 1, 2, 3, 4 ] -*/ -declare function filter( x: Uint8Array, predicate: Predicate, thisArg?: ThisParameterType> ): Uint8Array; - -/** -* Returns a shallow copy of an array containing only those elements which pass a test implemented by a predicate function. -* -* @param x - input array -* @param predicate - predicate function -* @param thisArg - predicate function execution context -* @returns output array -* -* @example -* var isPositiveNumber = require( '@stdlib/assert-is-positive-number' ).isPrimitive; -* var Uint8ClampedArray = require( '@stdlib/array-uint8c' ); -* -* var x = new Uint8ClampedArray( [ 1, 2, 3, 4 ] ); -* -* var out = filter( x, isPositiveNumber ); -* // returns [ 1, 2, 3, 4 ] -*/ -declare function filter( x: Uint8ClampedArray, predicate: Predicate, thisArg?: ThisParameterType> ): Uint8ClampedArray; - -/** -* Returns a shallow copy of an array containing only those elements which pass a test implemented by a predicate function. -* -* @param x - input array -* @param predicate - predicate function -* @param thisArg - predicate function execution context -* @returns output array -* -* @example -* var isPositiveNumber = require( '@stdlib/assert-is-positive-number' ).isPrimitive; -* var real = require( '@stdlib/complex-float64-real' ); -* var imag = require( '@stdlib/complex-float64-imag' ); -* var Complex128Array = require( '@stdlib/array-complex128' ); -* -* function predicate( v ) { -* return ( isPositiveNumber( real( v ) ) && isPositiveNumber( imag( v ) ) ); -* } -* -* var x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0 ] ); -* -* var out = filter( x, predicate ); -* // returns -*/ -declare function filter( x: Complex128Array, predicate: Predicate, thisArg?: ThisParameterType> ): Complex128Array; - -/** -* Returns a shallow copy of an array containing only those elements which pass a test implemented by a predicate function. -* -* @param x - input array -* @param predicate - predicate function -* @param thisArg - predicate function execution context -* @returns output array -* -* @example -* var isPositiveNumber = require( '@stdlib/assert-is-positive-number' ).isPrimitive; -* var realf = require( '@stdlib/complex-float32-real' ); -* var imagf = require( '@stdlib/complex-float32-imag' ); -* var Complex64Array = require( '@stdlib/array-complex64' ); -* -* function predicate( v ) { -* return ( isPositiveNumber( realf( v ) ) && isPositiveNumber( imagf( v ) ) ); -* } -* -* var x = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); -* -* var out = filter( x, predicate ); -* // returns -*/ -declare function filter( x: Complex64Array, predicate: Predicate, thisArg?: ThisParameterType> ): Complex64Array; - -/** -* Returns a shallow copy of an array containing only those elements which pass a test implemented by a predicate function. -* -* @param x - input array -* @param predicate - predicate function -* @param thisArg - predicate function execution context -* @returns output array -* -* @example -* var x = [ 1, -2, -3, 4 ]; -* -* var out = filter( x, isPositiveNumber ); -* // returns [ 1, 4 ] -*/ -declare function filter( x: Array, predicate: Predicate>, thisArg?: ThisParameterType>> ): Array; - -/** -* Returns a shallow copy of an array containing only those elements which pass a test implemented by a predicate function. -* -* @param x - input array -* @param predicate - predicate function -* @param thisArg - predicate function execution context -* @returns output array -* -* @example -* var toAccessorArray = require( '@stdlib/array-base-to-accessor-array' ); -* -* var x = toAccessorArray( [ 1, -2, -3, 4 ] ); -* -* var out = filter( x, isPositiveNumber ); -* // returns [ 1, 4 ] -*/ -declare function filter( x: AccessorArrayLike, predicate: Predicate>, thisArg?: ThisParameterType>> ): Array; - -/** -* Returns a shallow copy of an array containing only those elements which pass a test implemented by a predicate function. -* -* @param x - input array -* @param predicate - predicate function -* @param thisArg - predicate function execution context -* @returns output array -* -* @example -* var x = [ 1, -2, -3, 4 ]; -* -* var out = filter( x, isPositiveNumber ); -* // returns [ 1, 4 ] -*/ -declare function filter( x: Collection, predicate: Predicate>, thisArg?: ThisParameterType>> ): Array; - - -// EXPORTS // - -export = filter; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index a10870c..0000000 --- a/index.mjs +++ /dev/null @@ -1,4 +0,0 @@ -// Copyright (c) 2024 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 -/// -import r from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-arraylike2object@v0.2.1-esm/index.mjs";function t(t,e,n){var o;return function(r,t){return"function"==typeof r[t]}(t,"filter")?t.filter(e,n):(o=r(t)).accessorProtocol?function(r,t,e){var n,o,a,s,c;for(n=r.data,o=r.accessors[0],a=[],c=0;c 0;\n* }\n*\n* var x = [ 1, -2, -3, 4 ];\n*\n* var out = internal( x, isPositive );\n* // returns [ 1, 4 ]\n*/\nfunction internal( x, predicate, thisArg ) {\n\tvar out;\n\tvar v;\n\tvar i;\n\n\tout = [];\n\tfor ( i = 0; i < x.length; i++ ) {\n\t\tv = x[ i ];\n\t\tif ( predicate.call( thisArg, v, i, x ) ) {\n\t\t\tout.push( v );\n\t\t}\n\t}\n\treturn out;\n}\n\n/**\n* Returns a shallow copy of an array containing only those elements which pass a test implemented by a predicate function.\n*\n* @private\n* @param {Object} x - input array object\n* @param {Function} predicate - test function\n* @param {*} thisArg - execution context\n* @returns {Array} output array\n*\n* @example\n* import toAccessorArray from '@stdlib/array-base-to-accessor-array';\n* import arraylike2object from '@stdlib/array-base-arraylike2object';\n*\n* function isPositive( v ) {\n* return v > 0;\n* }\n*\n* var x = arraylike2object( toAccessorArray( [ 1, -2, -3, 4 ] ) );\n*\n* var out = accessors( x, isPositive );\n* // returns [ 1, 4 ]\n*/\nfunction accessors( x, predicate, thisArg ) {\n\tvar data;\n\tvar get;\n\tvar out;\n\tvar v;\n\tvar i;\n\n\tdata = x.data;\n\tget = x.accessors[ 0 ];\n\n\tout = [];\n\tfor ( i = 0; i < data.length; i++ ) {\n\t\tv = get( data, i );\n\t\tif ( predicate.call( thisArg, v, i, data ) ) {\n\t\t\tout.push( v );\n\t\t}\n\t}\n\treturn out;\n}\n\n\n// MAIN //\n\n/**\n* Returns a shallow copy of an array containing only those elements which pass a test implemented by a predicate function.\n*\n* @param {Collection} x - input array\n* @param {Function} predicate - test function\n* @param {*} [thisArg] - execution context\n* @returns {Collection} output array\n*\n* @example\n* function isPositive( v ) {\n* return v > 0;\n* }\n*\n* var x = [ 1, -2, -3, 4 ];\n*\n* var out = filter( x, isPositive );\n* // returns [ 1, 4 ]\n*/\nfunction filter( x, predicate, thisArg ) {\n\tvar obj;\n\tif ( hasMethod( x, 'filter' ) ) {\n\t\treturn x.filter( predicate, thisArg );\n\t}\n\tobj = arraylike2object( x );\n\tif ( obj.accessorProtocol ) {\n\t\treturn accessors( obj, predicate, thisArg );\n\t}\n\treturn internal( x, predicate, thisArg );\n}\n\n\n// EXPORTS //\n\nexport default filter;\n"],"names":["filter","x","predicate","thisArg","obj","method","hasMethod","arraylike2object","accessorProtocol","data","get","out","v","i","accessors","length","call","push","internal"],"mappings":";;sGAgJA,SAASA,EAAQC,EAAGC,EAAWC,GAC9B,IAAIC,EACJ,OAvGD,SAAoBA,EAAKC,GACxB,MAAkC,mBAAlBD,EAAKC,EACtB,CAqGMC,CAAWL,EAAG,UACXA,EAAED,OAAQE,EAAWC,IAE7BC,EAAMG,EAAkBN,IACfO,iBA/CV,SAAoBP,EAAGC,EAAWC,GACjC,IAAIM,EACAC,EACAC,EACAC,EACAC,EAMJ,IAJAJ,EAAOR,EAAEQ,KACTC,EAAMT,EAAEa,UAAW,GAEnBH,EAAM,GACAE,EAAI,EAAGA,EAAIJ,EAAKM,OAAQF,IAC7BD,EAAIF,EAAKD,EAAMI,GACVX,EAAUc,KAAMb,EAASS,EAAGC,EAAGJ,IACnCE,EAAIM,KAAML,GAGZ,OAAOD,CACR,CA8BSG,CAAWV,EAAKF,EAAWC,GArFpC,SAAmBF,EAAGC,EAAWC,GAChC,IAAIQ,EACAC,EACAC,EAGJ,IADAF,EAAM,GACAE,EAAI,EAAGA,EAAIZ,EAAEc,OAAQF,IAC1BD,EAAIX,EAAGY,GACFX,EAAUc,KAAMb,EAASS,EAAGC,EAAGZ,IACnCU,EAAIM,KAAML,GAGZ,OAAOD,CACR,CA0EQO,CAAUjB,EAAGC,EAAWC,EAChC"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index d4d08f0..0000000 --- a/stats.html +++ /dev/null @@ -1,4842 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From 221e18b625b065835f80f075b1c8b77d82f6f67a Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 29 Jul 2024 12:03:02 +0000 Subject: [PATCH 32/40] Auto-generated commit --- .editorconfig | 181 - .eslintrc.js | 1 - .gitattributes | 66 - .github/PULL_REQUEST_TEMPLATE.md | 7 - .github/workflows/benchmark.yml | 64 - .github/workflows/cancel.yml | 57 - .github/workflows/close_pull_requests.yml | 54 - .github/workflows/examples.yml | 64 - .github/workflows/npm_downloads.yml | 112 - .github/workflows/productionize.yml | 794 ---- .github/workflows/publish.yml | 252 -- .github/workflows/test.yml | 99 - .github/workflows/test_bundles.yml | 186 - .github/workflows/test_coverage.yml | 133 - .github/workflows/test_install.yml | 85 - .gitignore | 190 - .npmignore | 229 - .npmrc | 31 - CHANGELOG.md | 105 - CITATION.cff | 30 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 --- README.md | 41 +- SECURITY.md | 5 - benchmark/benchmark.length.js | 97 - branches.md | 56 - dist/index.d.ts | 3 - dist/index.js | 5 - dist/index.js.map | 7 - docs/repl.txt | 46 - docs/types/test.ts | 101 - examples/index.js | 35 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/index.js | 46 - lib/main.js | 160 - package.json | 65 +- stats.html | 4842 +++++++++++++++++++++ test/dist/test.js | 33 - test/test.js | 251 -- 42 files changed, 4867 insertions(+), 4213 deletions(-) delete mode 100644 .editorconfig delete mode 100644 .eslintrc.js delete mode 100644 .gitattributes delete mode 100644 .github/PULL_REQUEST_TEMPLATE.md delete mode 100644 .github/workflows/benchmark.yml delete mode 100644 .github/workflows/cancel.yml delete mode 100644 .github/workflows/close_pull_requests.yml delete mode 100644 .github/workflows/examples.yml delete mode 100644 .github/workflows/npm_downloads.yml delete mode 100644 .github/workflows/productionize.yml delete mode 100644 .github/workflows/publish.yml delete mode 100644 .github/workflows/test.yml delete mode 100644 .github/workflows/test_bundles.yml delete mode 100644 .github/workflows/test_coverage.yml delete mode 100644 .github/workflows/test_install.yml delete mode 100644 .gitignore delete mode 100644 .npmignore delete mode 100644 .npmrc delete mode 100644 CHANGELOG.md delete mode 100644 CITATION.cff delete mode 100644 CODE_OF_CONDUCT.md delete mode 100644 CONTRIBUTING.md delete mode 100644 Makefile delete mode 100644 SECURITY.md delete mode 100644 benchmark/benchmark.length.js delete mode 100644 branches.md delete mode 100644 dist/index.d.ts delete mode 100644 dist/index.js delete mode 100644 dist/index.js.map delete mode 100644 docs/repl.txt delete mode 100644 docs/types/test.ts delete mode 100644 examples/index.js rename docs/types/index.d.ts => index.d.ts (99%) create mode 100644 index.mjs create mode 100644 index.mjs.map delete mode 100644 lib/index.js delete mode 100644 lib/main.js create mode 100644 stats.html delete mode 100644 test/dist/test.js delete mode 100644 test/test.js diff --git a/.editorconfig b/.editorconfig deleted file mode 100644 index 60d743f..0000000 --- a/.editorconfig +++ /dev/null @@ -1,181 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 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. -#/ - -# EditorConfig configuration file (see ). - -# Indicate that this file is a root-level configuration file: -root = true - -# Set properties for all files: -[*] -end_of_line = lf -charset = utf-8 -trim_trailing_whitespace = true -insert_final_newline = true - -# Set properties for JavaScript files: -[*.{js,js.txt}] -indent_style = tab - -# Set properties for JavaScript ES module files: -[*.{mjs,mjs.txt}] -indent_style = tab - -# Set properties for JavaScript CommonJS files: -[*.{cjs,cjs.txt}] -indent_style = tab - -# Set properties for JSON files: -[*.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `cli_opts.json` files: -[cli_opts.json] -indent_style = tab - -# Set properties for TypeScript files: -[*.ts] -indent_style = tab - -# Set properties for Python files: -[*.{py,py.txt}] -indent_style = space -indent_size = 4 - -# Set properties for Julia files: -[*.{jl,jl.txt}] -indent_style = tab - -# Set properties for R files: -[*.{R,R.txt}] -indent_style = tab - -# Set properties for C files: -[*.{c,c.txt}] -indent_style = tab - -# Set properties for C header files: -[*.{h,h.txt}] -indent_style = tab - -# Set properties for C++ files: -[*.{cpp,cpp.txt}] -indent_style = tab - -# Set properties for C++ header files: -[*.{hpp,hpp.txt}] -indent_style = tab - -# Set properties for Fortran files: -[*.{f,f.txt}] -indent_style = space -indent_size = 2 -insert_final_newline = false - -# Set properties for shell files: -[*.{sh,sh.txt}] -indent_style = tab - -# Set properties for AWK files: -[*.{awk,awk.txt}] -indent_style = tab - -# Set properties for HTML files: -[*.{html,html.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for XML files: -[*.{xml,xml.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for CSS files: -[*.{css,css.txt}] -indent_style = tab - -# Set properties for Makefiles: -[Makefile] -indent_style = tab - -[*.{mk,mk.txt}] -indent_style = tab - -# Set properties for Markdown files: -[*.{md,md.txt}] -indent_style = space -indent_size = 4 -trim_trailing_whitespace = false - -# Set properties for `usage.txt` files: -[usage.txt] -indent_style = space -indent_size = 2 - -# Set properties for `repl.txt` files: -[repl.txt] -indent_style = space -indent_size = 4 - -# Set properties for `package.json` files: -[package.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `datapackage.json` files: -[datapackage.json] -indent_style = space -indent_size = 2 - -# Set properties for `manifest.json` files: -[manifest.json] -indent_style = space -indent_size = 2 - -# Set properties for `tsconfig.json` files: -[tsconfig.json] -indent_style = space -indent_size = 2 - -# Set properties for LaTeX files: -[*.{tex,tex.txt}] -indent_style = tab - -# Set properties for LaTeX Bibliography files: -[*.{bib,bib.txt}] -indent_style = tab - -# Set properties for YAML files: -[*.{yml,yml.txt}] -indent_style = space -indent_size = 2 - -# Set properties for GYP files: -[binding.gyp] -indent_style = space -indent_size = 2 - -[*.gypi] -indent_style = space -indent_size = 2 - -# Set properties for citation files: -[*.{cff,cff.txt}] -indent_style = space -indent_size = 2 diff --git a/.eslintrc.js b/.eslintrc.js deleted file mode 100644 index 5f30286..0000000 --- a/.eslintrc.js +++ /dev/null @@ -1 +0,0 @@ -/* For the `eslint` rules of this project, consult the main repository at https://github.com/stdlib-js/stdlib */ diff --git a/.gitattributes b/.gitattributes deleted file mode 100644 index 1c88e69..0000000 --- a/.gitattributes +++ /dev/null @@ -1,66 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 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. -#/ - -# Configuration file which assigns attributes to pathnames. -# -# [1]: https://git-scm.com/docs/gitattributes - -# Automatically normalize the line endings of any committed text files: -* text=auto - -# Override line endings for certain files on checkout: -*.crlf.csv text eol=crlf - -# Denote that certain files are binary and should not be modified: -*.png binary -*.jpg binary -*.jpeg binary -*.gif binary -*.ico binary -*.gz binary -*.zip binary -*.7z binary -*.mp3 binary -*.mp4 binary -*.mov binary - -# Override what is considered "vendored" by GitHub's linguist: -/lib/node_modules/** -linguist-vendored -linguist-generated - -# Configure directories which should *not* be included in GitHub language statistics: -/deps/** linguist-vendored -/dist/** linguist-generated -/workshops/** linguist-vendored - -benchmark/** linguist-vendored -docs/* linguist-documentation -etc/** linguist-vendored -examples/** linguist-documentation -scripts/** linguist-vendored -test/** linguist-vendored -tools/** linguist-vendored - -# Configure files which should *not* be included in GitHub language statistics: -Makefile linguist-vendored -*.mk linguist-vendored -*.jl linguist-vendored -*.py linguist-vendored -*.R linguist-vendored - -# Configure files which should be included in GitHub language statistics: -docs/types/*.d.ts -linguist-documentation diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index 6559bc7..0000000 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ /dev/null @@ -1,7 +0,0 @@ - - -We are excited about your pull request, but unfortunately we are not accepting pull requests against this repository, as all development happens on the [main project repository](https://github.com/stdlib-js/stdlib). We kindly request that you submit this pull request against the [respective directory](https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/filter) of the main repository where we’ll review and provide feedback. - -If this is your first stdlib contribution, be sure to read the [contributing guide](https://github.com/stdlib-js/stdlib/blob/develop/CONTRIBUTING.md) which provides guidelines and instructions for submitting contributions. You may also consult the [development guide](https://github.com/stdlib-js/stdlib/blob/develop/docs/development.md) for help on developing stdlib. - -We look forward to receiving your contribution! :smiley: \ No newline at end of file diff --git a/.github/workflows/benchmark.yml b/.github/workflows/benchmark.yml deleted file mode 100644 index e4f10fe..0000000 --- a/.github/workflows/benchmark.yml +++ /dev/null @@ -1,64 +0,0 @@ -#/ -# @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. -#/ - -# Workflow name: -name: benchmark - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to run benchmarks: - benchmark: - - # Define a display name: - name: 'Run benchmarks' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Run benchmarks: - - name: 'Run benchmarks' - run: | - npm run benchmark diff --git a/.github/workflows/cancel.yml b/.github/workflows/cancel.yml deleted file mode 100644 index b5291db..0000000 --- a/.github/workflows/cancel.yml +++ /dev/null @@ -1,57 +0,0 @@ -#/ -# @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. -#/ - -# Workflow name: -name: cancel - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to cancel existing workflow runs: - cancel: - - # Define a display name: - name: 'Cancel workflow runs' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Time limit: - timeout-minutes: 3 - - # Define the sequence of job steps... - steps: - - # Cancel existing workflow runs: - - name: 'Cancel existing workflow runs' - # Pin action to full length commit SHA - uses: styfle/cancel-workflow-action@85880fa0301c86cca9da44039ee3bb12d3bedbfa # v0.12.1 - with: - workflow_id: >- - benchmark.yml, - examples.yml, - test.yml, - test_coverage.yml, - test_install.yml, - publish.yml - access_token: ${{ github.token }} diff --git a/.github/workflows/close_pull_requests.yml b/.github/workflows/close_pull_requests.yml deleted file mode 100644 index 2060eba..0000000 --- a/.github/workflows/close_pull_requests.yml +++ /dev/null @@ -1,54 +0,0 @@ -#/ -# @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. -#/ - -# Workflow name: -name: close_pull_requests - -# Workflow triggers: -on: - pull_request_target: - types: [opened] - -# Workflow jobs: -jobs: - - # Define job to close all pull requests: - run: - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - - # Close pull request - - name: 'Close pull request' - # Pin action to full length commit SHA corresponding to v3.1.2 - uses: superbrothers/close-pull-request@9c18513d320d7b2c7185fb93396d0c664d5d8448 - with: - comment: | - Thank you for submitting a pull request. :raised_hands: - - We greatly appreciate your willingness to submit a contribution. However, we are not accepting pull requests against this repository, as all development happens on the [main project repository](https://github.com/stdlib-js/stdlib). - - We kindly request that you submit this pull request against the [respective directory](https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/filter) of the main repository where we’ll review and provide feedback. If this is your first stdlib contribution, be sure to read the [contributing guide](https://github.com/stdlib-js/stdlib/blob/develop/CONTRIBUTING.md) which provides guidelines and instructions for submitting contributions. - - Thank you again, and we look forward to receiving your contribution! :smiley: - - Best, - The stdlib team \ No newline at end of file diff --git a/.github/workflows/examples.yml b/.github/workflows/examples.yml deleted file mode 100644 index 2984901..0000000 --- a/.github/workflows/examples.yml +++ /dev/null @@ -1,64 +0,0 @@ -#/ -# @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. -#/ - -# Workflow name: -name: examples - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to run the package examples... - examples: - - # Define display name: - name: 'Run examples' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - - # Checkout repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Run examples: - - name: 'Run examples' - run: | - npm run examples diff --git a/.github/workflows/npm_downloads.yml b/.github/workflows/npm_downloads.yml deleted file mode 100644 index c2326d6..0000000 --- a/.github/workflows/npm_downloads.yml +++ /dev/null @@ -1,112 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2022 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. -#/ - -# Workflow name: -name: npm_downloads - -# Workflow triggers: -on: - # Run this workflow weekly: - schedule: - # cron: ' ' - - cron: '48 12 * * 3' - - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job for retrieving npm download counts... - npm_downloads: - - # Define display name: - name: 'Retrieve npm download counts' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - timeout-minutes: 10 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Resolve package name: - - name: 'Resolve package name' - id: package_name - run: | - name=`node -e 'console.log(require("./package.json").name)' | tr -d '\n'` - echo "package_name=$name" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Fetch download data: - - name: 'Fetch data' - id: download_data - run: | - url="https://api.npmjs.org/downloads/range/$(date --date='1 year ago' '+%Y-%m-%d'):$(date '+%Y-%m-%d')/${{ steps.package_name.outputs.package_name }}" - echo "$url" - data=$(curl "$url") - mkdir ./tmp - echo "$data" > ./tmp/npm_downloads.json - echo "data=$data" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Print summary of download data: - - name: 'Print summary' - run: | - echo "| Date | Downloads |" >> $GITHUB_STEP_SUMMARY - echo "|------|------------|" >> $GITHUB_STEP_SUMMARY - cat ./tmp/npm_downloads.json | jq -r ".downloads | .[-14:] | to_entries | map(\"| \(.value.day) | \(.value.downloads) |\") |.[]" >> $GITHUB_STEP_SUMMARY - - # Upload the download data: - - name: 'Upload data' - # Pin action to full length commit SHA - uses: actions/upload-artifact@5d5d22a31266ced268874388b861e4b58bb5c2f3 # v4.3.1 - with: - # Define a name for the uploaded artifact (ensuring a unique name for each job): - name: npm_downloads - - # Specify the path to the file to upload: - path: ./tmp/npm_downloads.json - - # Specify the number of days to retain the artifact (default is 90 days): - retention-days: 90 - timeout-minutes: 10 - if: success() - - # Send data to events server: - - name: 'Post data' - # Pin action to full length commit SHA - uses: distributhor/workflow-webhook@48a40b380ce4593b6a6676528cd005986ae56629 # v3.0.3 - env: - webhook_url: ${{ secrets.STDLIB_NPM_DOWNLOADS_URL }} - webhook_secret: ${{ secrets.STDLIB_WEBHOOK_SECRET }} - data: '{ "downloads": ${{ steps.download_data.outputs.data }} }' - timeout-minutes: 5 - if: success() diff --git a/.github/workflows/productionize.yml b/.github/workflows/productionize.yml deleted file mode 100644 index f4575e9..0000000 --- a/.github/workflows/productionize.yml +++ /dev/null @@ -1,794 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2022 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. -#/ - -# Workflow name: -name: productionize - -# Workflow triggers: -on: - # Run workflow when a new commit is pushed to the main branch: - push: - branches: - - main - - # Allow the workflow to be manually run: - workflow_dispatch: - inputs: - require-passing-tests: - description: 'Require passing tests for creating bundles' - type: boolean - default: true - - # Run workflow upon completion of `publish` workflow run: - workflow_run: - workflows: ["publish"] - types: [completed] - - -# Concurrency group to prevent multiple concurrent executions: -concurrency: - group: productionize - cancel-in-progress: true - -# Workflow jobs: -jobs: - - # Define a job to create a production build... - productionize: - - # Define display name: - name: 'Productionize' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Define the sequence of job steps... - steps: - # Checkout main branch of repository: - - name: 'Checkout main branch' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - with: - ref: main - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Create production branch: - - name: 'Create production branch' - run: | - git checkout -b production - - # Transform error messages: - - name: 'Transform error messages' - id: transform-error-messages - uses: stdlib-js/transform-errors-action@main - - # 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: | - PKG_VERSION=$(npm view @stdlib/error-tools-fmtprodmsg version) - if grep -q '"@stdlib/string-format"' package.json; then - sed -i "s/\"@stdlib\/string-format\": \"^.*\"/\"@stdlib\/error-tools-fmtprodmsg\": \"^$PKG_VERSION\"/g" package.json - else - node -e "var pkg = require( './package.json' ); pkg.dependencies[ '@stdlib/error-tools-fmtprodmsg' ] = '^$PKG_VERSION'; require( 'fs' ).writeFileSync( 'package.json', JSON.stringify( pkg, null, 2 ) );" - fi - - # Configure Git: - - name: 'Configure Git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Transform error messages" - - # Push changes: - - name: 'Push changes' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" production --force - - # Define a job for running tests of the productionized code... - test: - - # Define a display name: - name: 'Run Tests' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Indicate that this job depends on the prior job finishing: - needs: productionize - - # Run this job regardless of the outcome of the prior job: - if: always() - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout repository' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - with: - # Use the `production` branch: - ref: production - - # Install Node.js: - - name: 'Install Node.js' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Build native add-on if present: - - name: 'Build native add-on (if present)' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - run: | - if [ -f "binding.gyp" ]; then - npm install node-gyp --no-save && ./node_modules/.bin/node-gyp rebuild - fi - - # Run tests: - - name: 'Run tests' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: tests - run: | - npm test || npm test || npm test - - # Define job to create a bundle for use in Deno... - deno: - - # Define display name: - name: 'Create Deno bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Configure Git: - - name: 'Configure Git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `deno` branch exists: - - name: 'Check if remote `deno` branch exists' - id: deno-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin deno - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `deno` exists, delete everything in branch and merge `production` into it - - name: 'If `deno` exists, delete everything in branch and merge `production` into it' - if: steps.deno-branch-exists.outputs.remote-exists - run: | - git checkout -b deno origin/deno - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `deno` does not exist, create `deno` branch: - - name: 'If `deno` does not exist, create `deno` branch' - if: ${{ steps.deno-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b deno - - # Copy files to deno directory: - - name: 'Copy files to deno directory' - run: | - mkdir -p deno - cp README.md LICENSE CONTRIBUTORS NOTICE ./deno - - # Copy TypeScript definitions to deno directory: - if [ -d index.d.ts ]; then - cp index.d.ts ./deno/index.d.ts - fi - if [ -e ./docs/types/index.d.ts ]; then - cp ./docs/types/index.d.ts ./deno/mod.d.ts - fi - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: Install production and development dependencies - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Bundle package for use in Deno: - - name: 'Bundle package for Deno' - id: deno-bundle - uses: stdlib-js/bundle-action@main - with: - target: 'deno' - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - # Replace links to other packages with links to the deno branch: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/deno/"; - - # Replace reference to `@stdlib/types` with CDN link: - find ./deno -type f -name '*.ts' -print0 | xargs -0 -r sed -Ei "s/\/\/\/ /\/\/\/ /g" - - # Change wording of project description to avoid reference to JavaScript and Node.js: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "s/a standard library for JavaScript and Node.js, /a standard library /g" - - # Rewrite all `require()`s to use jsDelivr links: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/require\( '@stdlib\// { - s/(var|let|const)\s+([a-z0-9_]+)\s+=\s*require\( '([^']+)' \);/import \2 from \'\3\';/i - s/@stdlib/https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js/ - s/';/@deno\/mod.js';/ - }" - - # Rewrite first `import` to show importing of named exports if available: - exports=$(cat lib/index.js | \ - grep -E 'setReadOnly\(.*,.*,.*\)' | \ - sed -E 's/setReadOnly\((.*),(.*),(.*)\);/\2/' | \ - sed -E "s/'//g" | \ - sort) - if [ -n "$exports" ]; then - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\nimport\s+([a-zA-Z0-9_]+)\s+from\s*'([^']+)';\n\`\`\`/\`\`\`javascript\nimport \1 from '\2';\n\`\`\`\n\nYou can also import the following named exports from the package:\n\n\`\`\`javascript\nimport { $(echo $exports | sed -E 's/ /, /g') } from '\2';\n\`\`\`/" - fi - - # Remove `installation`, `cli`, and `c` sections: - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Create package.json file for deno branch: - jq --indent 2 '{"name": .name, "version": .version, "description": .description, "license": .license, "type": "module", "main": "./mod.js", "homepage": .homepage, "repository": .repository, "bugs": .bugs, "keywords": .keywords, "funding": .funding}' package.json > ./deno/package.json - - # Delete everything in current directory aside from deno folder: - - name: 'Delete everything in current directory aside from deno folder' - run: | - find . -type 'f' | grep -v -e "deno" -e ".git/" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e "deno" -e ".git" | xargs -r rm -rf - - # Move deno directory to root: - - name: 'Move deno directory to root' - run: | - mv ./deno/* . - rmdir ./deno - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Auto-generated commit" - - # Push changes to `deno` branch: - - name: 'Push changes to `deno` branch' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" deno - - # Send status to Slack channel if job fails: - - name: 'Send status to Slack channel in case of failure' - # Pin action to full length commit SHA - uses: 8398a7/action-slack@28ba43ae48961b90635b50953d216767a6bea486 # v3.16.2 - with: - status: ${{ job.status }} - channel: '#npm-ci' - if: failure() - - # Define job to create a UMD bundle... - umd: - - # Define display name: - name: 'Create UMD bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Configure Git: - - name: 'Configure Git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `umd` branch exists: - - name: 'Check if remote `umd` branch exists' - id: umd-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin umd - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `umd` exists, delete everything in branch and merge `production` into it - - name: 'If `umd` exists, delete everything in branch and merge `production` into it' - if: steps.umd-branch-exists.outputs.remote-exists - run: | - git checkout -b umd origin/umd - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `umd` does not exist, create `umd` branch: - - name: 'If `umd` does not exist, create `umd` branch' - if: ${{ steps.umd-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b umd - - # Copy files to umd directory: - - name: 'Copy files to umd directory' - run: | - mkdir -p umd - cp README.md LICENSE CONTRIBUTORS NOTICE ./umd - - # Install Node.js - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Extract alias: - - name: 'Extract alias' - id: extract-alias - run: | - alias=$(grep -E 'require\(' README.md | head -n 1 | sed -E 's/^var ([a-zA-Z0-9_]+) = .+/\1/') - echo "alias=${alias}" >> $GITHUB_OUTPUT - - # Create Universal Module Definition (UMD) Node.js bundle: - - name: 'Create Universal Module Definition (UMD) Node.js bundle' - id: umd-bundle-node - uses: stdlib-js/bundle-action@main - with: - target: 'umd-node' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Create Universal Module Definition (UMD) browser bundle: - - name: 'Create Universal Module Definition (UMD) browser bundle' - id: umd-bundle-browser - uses: stdlib-js/bundle-action@main - with: - target: 'umd-browser' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - - # Replace links to other packages with links to the umd branch: - find ./umd -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/umd/"; - - # Remove `installation`, `cli`, and `c` sections: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Rewrite first `require()` to show consumption of the UMD bundle in Observable and via a `script` tag: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\n(var|let|const)\s+([a-zA-Z0-9_]+)\s+=\s*require\( '\@stdlib\/([^']+)' \);\n\`\`\`/To use in Observable,\n\n\`\`\`javascript\n\2 = require\( 'https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js\/\3\@umd\/browser.js' \)\n\`\`\`\n\nTo vendor stdlib functionality and avoid installing dependency trees for Node.js, you can use the UMD server build:\n\n\`\`\`javascript\nvar \2 = require\( 'path\/to\/vendor\/umd\/\3\/index.js' \)\n\`\`\`\n\nTo include the bundle in a webpage,\n\n\`\`\`html\n + + ```
@@ -189,7 +180,7 @@ var out = filter( x, naryFunction( isPositiveInteger, 1 ) ); ## 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. +This package is part of [stdlib][stdlib], a standard library 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]. diff --git a/SECURITY.md b/SECURITY.md deleted file mode 100644 index 9702d4c..0000000 --- a/SECURITY.md +++ /dev/null @@ -1,5 +0,0 @@ -# Security - -> Policy for reporting security vulnerabilities. - -See the security policy [in the main project repository](https://github.com/stdlib-js/stdlib/security). diff --git a/benchmark/benchmark.length.js b/benchmark/benchmark.length.js deleted file mode 100644 index bc79e33..0000000 --- a/benchmark/benchmark.length.js +++ /dev/null @@ -1,97 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 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 bench = require( '@stdlib/bench-harness' ); -var pow = require( '@stdlib/math-base-special-pow' ); -var isArray = require( '@stdlib/assert-is-array' ); -var isNonNegativeInteger = require( '@stdlib/assert-is-nonnegative-integer' ).isPrimitive; -var zeroTo = require( '@stdlib/array-base-zero-to' ); -var pkg = require( './../package.json' ).name; -var filter = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveInteger} len - array length -* @returns {Function} benchmark function -*/ -function createBenchmark( len ) { - var x = zeroTo( len ); - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var out; - var i; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - out = filter( x, isNonNegativeInteger ); - if ( typeof out !== 'object' ) { - b.fail( 'should return an array' ); - } - } - b.toc(); - if ( !isArray( out ) ) { - b.fail( 'should return an array' ); - } - b.pass( 'benchmark finished' ); - b.end(); - } -} - - -// MAIN // - -/** -* Main execution sequence. -* -* @private -*/ -function main() { - var len; - var min; - var max; - var f; - var i; - - min = 1; // 10^min - max = 6; // 10^max - - for ( i = min; i <= max; i++ ) { - len = pow( 10, i ); - - f = createBenchmark( len ); - bench( pkg+':dtype=generic,len='+len, f ); - } -} - -main(); diff --git a/branches.md b/branches.md deleted file mode 100644 index 9858901..0000000 --- a/branches.md +++ /dev/null @@ -1,56 +0,0 @@ - - -# Branches - -This repository has the following branches: - -- **main**: default branch generated from the [stdlib project][stdlib-url], where all development takes place. -- **production**: [production build][production-url] of the package (e.g., reformatted error messages to reduce bundle sizes and thus the number of bytes transmitted over a network). -- **esm**: [ES Module][esm-url] branch for use via a `script` tag without the need for installation and bundlers (see [README][esm-readme]). -- **deno**: [Deno][deno-url] branch for use in Deno (see [README][deno-readme]). -- **umd**: [UMD][umd-url] branch for use in Observable, or in dual browser/Node.js environments (see [README][umd-readme]). - -The following diagram illustrates the relationships among the above branches: - -```mermaid -graph TD; -A[stdlib]-->|generate standalone package|B; -B[main] -->|productionize| C[production]; -C -->|bundle| D[esm]; -C -->|bundle| E[deno]; -C -->|bundle| F[umd]; - -%% click A href "https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/filter" -%% click B href "https://github.com/stdlib-js/array-base-filter/tree/main" -%% click C href "https://github.com/stdlib-js/array-base-filter/tree/production" -%% click D href "https://github.com/stdlib-js/array-base-filter/tree/esm" -%% click E href "https://github.com/stdlib-js/array-base-filter/tree/deno" -%% click F href "https://github.com/stdlib-js/array-base-filter/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/filter -[production-url]: https://github.com/stdlib-js/array-base-filter/tree/production -[deno-url]: https://github.com/stdlib-js/array-base-filter/tree/deno -[deno-readme]: https://github.com/stdlib-js/array-base-filter/blob/deno/README.md -[umd-url]: https://github.com/stdlib-js/array-base-filter/tree/umd -[umd-readme]: https://github.com/stdlib-js/array-base-filter/blob/umd/README.md -[esm-url]: https://github.com/stdlib-js/array-base-filter/tree/esm -[esm-readme]: https://github.com/stdlib-js/array-base-filter/blob/esm/README.md \ No newline at end of file diff --git a/dist/index.d.ts b/dist/index.d.ts deleted file mode 100644 index aafb9cb..0000000 --- a/dist/index.d.ts +++ /dev/null @@ -1,3 +0,0 @@ -/// -import filter from '../docs/types/index'; -export = filter; \ No newline at end of file diff --git a/dist/index.js b/dist/index.js deleted file mode 100644 index 5c2f789..0000000 --- a/dist/index.js +++ /dev/null @@ -1,5 +0,0 @@ -"use strict";var s=function(r,t){return function(){return t||r((t={exports:{}}).exports,t),t.exports}};var f=s(function(y,c){ -var v=require('@stdlib/array-base-arraylike2object/dist');function l(r,t){return typeof r[t]=="function"}function h(r,t,n){var e,o,a;for(e=[],a=0;a 0;\n* }\n*\n* var x = [ 1, -2, -3, 4 ];\n*\n* var out = internal( x, isPositive );\n* // returns [ 1, 4 ]\n*/\nfunction internal( x, predicate, thisArg ) {\n\tvar out;\n\tvar v;\n\tvar i;\n\n\tout = [];\n\tfor ( i = 0; i < x.length; i++ ) {\n\t\tv = x[ i ];\n\t\tif ( predicate.call( thisArg, v, i, x ) ) {\n\t\t\tout.push( v );\n\t\t}\n\t}\n\treturn out;\n}\n\n/**\n* Returns a shallow copy of an array containing only those elements which pass a test implemented by a predicate function.\n*\n* @private\n* @param {Object} x - input array object\n* @param {Function} predicate - test function\n* @param {*} thisArg - execution context\n* @returns {Array} output array\n*\n* @example\n* var toAccessorArray = require( '@stdlib/array-base-to-accessor-array' );\n* var arraylike2object = require( '@stdlib/array-base-arraylike2object' );\n*\n* function isPositive( v ) {\n* return v > 0;\n* }\n*\n* var x = arraylike2object( toAccessorArray( [ 1, -2, -3, 4 ] ) );\n*\n* var out = accessors( x, isPositive );\n* // returns [ 1, 4 ]\n*/\nfunction accessors( x, predicate, thisArg ) {\n\tvar data;\n\tvar get;\n\tvar out;\n\tvar v;\n\tvar i;\n\n\tdata = x.data;\n\tget = x.accessors[ 0 ];\n\n\tout = [];\n\tfor ( i = 0; i < data.length; i++ ) {\n\t\tv = get( data, i );\n\t\tif ( predicate.call( thisArg, v, i, data ) ) {\n\t\t\tout.push( v );\n\t\t}\n\t}\n\treturn out;\n}\n\n\n// MAIN //\n\n/**\n* Returns a shallow copy of an array containing only those elements which pass a test implemented by a predicate function.\n*\n* @param {Collection} x - input array\n* @param {Function} predicate - test function\n* @param {*} [thisArg] - execution context\n* @returns {Collection} output array\n*\n* @example\n* function isPositive( v ) {\n* return v > 0;\n* }\n*\n* var x = [ 1, -2, -3, 4 ];\n*\n* var out = filter( x, isPositive );\n* // returns [ 1, 4 ]\n*/\nfunction filter( x, predicate, thisArg ) {\n\tvar obj;\n\tif ( hasMethod( x, 'filter' ) ) {\n\t\treturn x.filter( predicate, thisArg );\n\t}\n\tobj = arraylike2object( x );\n\tif ( obj.accessorProtocol ) {\n\t\treturn accessors( obj, predicate, thisArg );\n\t}\n\treturn internal( x, predicate, thisArg );\n}\n\n\n// EXPORTS //\n\nmodule.exports = filter;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2024 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* Return a shallow copy of an array containing only those elements which pass a test implemented by a predicate function.\n*\n* @module @stdlib/array-base-filter\n*\n* @example\n* var filter = require( '@stdlib/array-base-filter' );\n*\n* function isPositive( v ) {\n* return v > 0;\n* }\n*\n* var x = [ 1, -2, -3, 4 ];\n*\n* var out = filter( x, isPositive );\n* // returns [ 1, 4 ]\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,EAAmB,QAAS,qCAAsC,EAqBtE,SAASC,EAAWC,EAAKC,EAAS,CACjC,OAAS,OAAOD,EAAKC,CAAO,GAAM,UACnC,CAqBA,SAASC,EAAUC,EAAGC,EAAWC,EAAU,CAC1C,IAAIC,EACAC,EACAC,EAGJ,IADAF,EAAM,CAAC,EACDE,EAAI,EAAGA,EAAIL,EAAE,OAAQK,IAC1BD,EAAIJ,EAAGK,CAAE,EACJJ,EAAU,KAAMC,EAASE,EAAGC,EAAGL,CAAE,GACrCG,EAAI,KAAMC,CAAE,EAGd,OAAOD,CACR,CAwBA,SAASG,EAAWN,EAAGC,EAAWC,EAAU,CAC3C,IAAIK,EACAC,EACAL,EACAC,EACAC,EAMJ,IAJAE,EAAOP,EAAE,KACTQ,EAAMR,EAAE,UAAW,CAAE,EAErBG,EAAM,CAAC,EACDE,EAAI,EAAGA,EAAIE,EAAK,OAAQF,IAC7BD,EAAII,EAAKD,EAAMF,CAAE,EACZJ,EAAU,KAAMC,EAASE,EAAGC,EAAGE,CAAK,GACxCJ,EAAI,KAAMC,CAAE,EAGd,OAAOD,CACR,CAuBA,SAASM,EAAQT,EAAGC,EAAWC,EAAU,CACxC,IAAIL,EACJ,OAAKD,EAAWI,EAAG,QAAS,EACpBA,EAAE,OAAQC,EAAWC,CAAQ,GAErCL,EAAMF,EAAkBK,CAAE,EACrBH,EAAI,iBACDS,EAAWT,EAAKI,EAAWC,CAAQ,EAEpCH,EAAUC,EAAGC,EAAWC,CAAQ,EACxC,CAKAR,EAAO,QAAUe,ICvHjB,IAAIC,EAAO,IAKX,OAAO,QAAUA", - "names": ["require_main", "__commonJSMin", "exports", "module", "arraylike2object", "hasMethod", "obj", "method", "internal", "x", "predicate", "thisArg", "out", "v", "i", "accessors", "data", "get", "filter", "main"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index bb2b17a..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,46 +0,0 @@ - -{{alias}}( x, predicate[, thisArg] ) - Returns a shallow copy of an array containing only those elements which pass - a test implemented by a predicate function. - - The predicate function is provided three arguments: - - - value: current array element. - - index: current array element index. - - arr: the input array. - - If provided an array-like object having a `filter` method , the function - defers execution to that method and assumes that the method has the - following signature: - - x.filter( predicate, thisArg ) - - If provided an array-like object without a `filter` method, the function - performs a linear scan and always returns a generic array. - - Parameters - ---------- - x: Array|TypedArray|Object - Input array. - - predicate: Function - Predicate function. - - thisArg: any (optional) - Execution context. - - Returns - ------- - out: Array|TypedArray|Object - Output array. - - Examples - -------- - > function f( v ) { return ( v > 0 ); }; - > var x = [ 1, -2, -3, 4 ]; - > var out = {{alias}}( x, f ) - [ 1, 4 ] - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index db0c38d..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,101 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2024 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. -*/ - -import toAccessorArray = require( '@stdlib/array-base-to-accessor-array' ); -import filter = require( './index' ); - -/** -* Tests whether a value is positive. -* -* @param value - input value -* @returns boolean indicating whether an element is positive -*/ -function isPositive( value: number ): boolean { - return ( value > 0 ); -} - - -// TESTS // - -// The function returns a collection... -{ - filter( [ 1, 2, 3 ], isPositive ); // $ExpectType number[] - filter( new Float64Array( [ 1, 2, 3 ] ), isPositive ); // $ExpectType Float64Array - filter( new Float32Array( [ 1, 2, 3 ] ), isPositive ); // $ExpectType Float32Array - filter( new Int32Array( [ 1, 2, 3 ] ), isPositive ); // $ExpectType Int32Array - filter( new Int16Array( [ 1, 2, 3 ] ), isPositive ); // $ExpectType Int16Array - filter( new Int8Array( [ 1, 2, 3 ] ), isPositive ); // $ExpectType Int8Array - filter( new Uint32Array( [ 1, 2, 3 ] ), isPositive ); // $ExpectType Uint32Array - filter( new Uint16Array( [ 1, 2, 3 ] ), isPositive ); // $ExpectType Uint16Array - filter( new Uint8Array( [ 1, 2, 3 ] ), isPositive ); // $ExpectType Uint8Array - filter( new Uint8ClampedArray( [ 1, 2, 3 ] ), isPositive ); // $ExpectType Uint8ClampedArray - filter( toAccessorArray( [ 1, 2, 3 ] ), isPositive ); // $ExpectType number[] - - filter( [ 1, 2, 3 ], isPositive, {} ); // $ExpectType number[] - filter( new Float64Array( [ 1, 2, 3 ] ), isPositive, {} ); // $ExpectType Float64Array - filter( new Float32Array( [ 1, 2, 3 ] ), isPositive, {} ); // $ExpectType Float32Array - filter( new Int32Array( [ 1, 2, 3 ] ), isPositive, {} ); // $ExpectType Int32Array - filter( new Int16Array( [ 1, 2, 3 ] ), isPositive, {} ); // $ExpectType Int16Array - filter( new Int8Array( [ 1, 2, 3 ] ), isPositive, {} ); // $ExpectType Int8Array - filter( new Uint32Array( [ 1, 2, 3 ] ), isPositive, {} ); // $ExpectType Uint32Array - filter( new Uint16Array( [ 1, 2, 3 ] ), isPositive, {} ); // $ExpectType Uint16Array - filter( new Uint8Array( [ 1, 2, 3 ] ), isPositive, {} ); // $ExpectType Uint8Array - filter( new Uint8ClampedArray( [ 1, 2, 3 ] ), isPositive, {} ); // $ExpectType Uint8ClampedArray - filter( toAccessorArray( [ 1, 2, 3 ] ), isPositive, {} ); // $ExpectType number[] -} - -// The compiler throws an error if the function is provided a first argument which is not a collection... -{ - filter( 2, isPositive ); // $ExpectError - filter( false, isPositive ); // $ExpectError - filter( true, isPositive ); // $ExpectError - filter( {}, isPositive ); // $ExpectError - - filter( 2, isPositive, {} ); // $ExpectError - filter( false, isPositive, {} ); // $ExpectError - filter( true, isPositive, {} ); // $ExpectError - filter( {}, isPositive, {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided a second argument which is not a function... -{ - filter( [ 1, 2, 3 ], 'abc' ); // $ExpectError - filter( [ 1, 2, 3 ], 2 ); // $ExpectError - filter( [ 1, 2, 3 ], false ); // $ExpectError - filter( [ 1, 2, 3 ], true ); // $ExpectError - filter( [ 1, 2, 3 ], null ); // $ExpectError - filter( [ 1, 2, 3 ], void 0 ); // $ExpectError - filter( [ 1, 2, 3 ], {} ); // $ExpectError - filter( [ 1, 2, 3 ], [] ); // $ExpectError - - filter( [ 1, 2, 3 ], 'abc', {} ); // $ExpectError - filter( [ 1, 2, 3 ], 2, {} ); // $ExpectError - filter( [ 1, 2, 3 ], false, {} ); // $ExpectError - filter( [ 1, 2, 3 ], true, {} ); // $ExpectError - filter( [ 1, 2, 3 ], null, {} ); // $ExpectError - filter( [ 1, 2, 3 ], void 0, {} ); // $ExpectError - filter( [ 1, 2, 3 ], {}, {} ); // $ExpectError - filter( [ 1, 2, 3 ], [], {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided an unsupported number of arguments... -{ - filter(); // $ExpectError - filter( [ 1, 2, 3 ] ); // $ExpectError - filter( [ 1, 2, 3 ], isPositive, {}, 3 ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index cdfb9a7..0000000 --- a/examples/index.js +++ /dev/null @@ -1,35 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 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'; - -var discreteUniform = require( '@stdlib/random-array-discrete-uniform' ); -var isPositiveInteger = require( '@stdlib/assert-is-positive-integer' ).isPrimitive; -var naryFunction = require( '@stdlib/utils-nary-function' ); -var filter = require( './../lib' ); - -var x = discreteUniform( 10, -5, 5, { - 'dtype': 'int32' -}); -// returns - -var out = filter( x, naryFunction( isPositiveInteger, 1 ) ); -// returns - -console.log( x ); -console.log( out ); diff --git a/docs/types/index.d.ts b/index.d.ts similarity index 99% rename from docs/types/index.d.ts rename to index.d.ts index 730dc98..c5c8ca7 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 4.1 -/// +/// import { Collection, AccessorArrayLike, Complex128Array, Complex64Array } from '@stdlib/types/array'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..a10870c --- /dev/null +++ b/index.mjs @@ -0,0 +1,4 @@ +// Copyright (c) 2024 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 +/// +import r from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-arraylike2object@v0.2.1-esm/index.mjs";function t(t,e,n){var o;return function(r,t){return"function"==typeof r[t]}(t,"filter")?t.filter(e,n):(o=r(t)).accessorProtocol?function(r,t,e){var n,o,a,s,c;for(n=r.data,o=r.accessors[0],a=[],c=0;c 0;\n* }\n*\n* var x = [ 1, -2, -3, 4 ];\n*\n* var out = internal( x, isPositive );\n* // returns [ 1, 4 ]\n*/\nfunction internal( x, predicate, thisArg ) {\n\tvar out;\n\tvar v;\n\tvar i;\n\n\tout = [];\n\tfor ( i = 0; i < x.length; i++ ) {\n\t\tv = x[ i ];\n\t\tif ( predicate.call( thisArg, v, i, x ) ) {\n\t\t\tout.push( v );\n\t\t}\n\t}\n\treturn out;\n}\n\n/**\n* Returns a shallow copy of an array containing only those elements which pass a test implemented by a predicate function.\n*\n* @private\n* @param {Object} x - input array object\n* @param {Function} predicate - test function\n* @param {*} thisArg - execution context\n* @returns {Array} output array\n*\n* @example\n* import toAccessorArray from '@stdlib/array-base-to-accessor-array';\n* import arraylike2object from '@stdlib/array-base-arraylike2object';\n*\n* function isPositive( v ) {\n* return v > 0;\n* }\n*\n* var x = arraylike2object( toAccessorArray( [ 1, -2, -3, 4 ] ) );\n*\n* var out = accessors( x, isPositive );\n* // returns [ 1, 4 ]\n*/\nfunction accessors( x, predicate, thisArg ) {\n\tvar data;\n\tvar get;\n\tvar out;\n\tvar v;\n\tvar i;\n\n\tdata = x.data;\n\tget = x.accessors[ 0 ];\n\n\tout = [];\n\tfor ( i = 0; i < data.length; i++ ) {\n\t\tv = get( data, i );\n\t\tif ( predicate.call( thisArg, v, i, data ) ) {\n\t\t\tout.push( v );\n\t\t}\n\t}\n\treturn out;\n}\n\n\n// MAIN //\n\n/**\n* Returns a shallow copy of an array containing only those elements which pass a test implemented by a predicate function.\n*\n* @param {Collection} x - input array\n* @param {Function} predicate - test function\n* @param {*} [thisArg] - execution context\n* @returns {Collection} output array\n*\n* @example\n* function isPositive( v ) {\n* return v > 0;\n* }\n*\n* var x = [ 1, -2, -3, 4 ];\n*\n* var out = filter( x, isPositive );\n* // returns [ 1, 4 ]\n*/\nfunction filter( x, predicate, thisArg ) {\n\tvar obj;\n\tif ( hasMethod( x, 'filter' ) ) {\n\t\treturn x.filter( predicate, thisArg );\n\t}\n\tobj = arraylike2object( x );\n\tif ( obj.accessorProtocol ) {\n\t\treturn accessors( obj, predicate, thisArg );\n\t}\n\treturn internal( x, predicate, thisArg );\n}\n\n\n// EXPORTS //\n\nexport default filter;\n"],"names":["filter","x","predicate","thisArg","obj","method","hasMethod","arraylike2object","accessorProtocol","data","get","out","v","i","accessors","length","call","push","internal"],"mappings":";;sGAgJA,SAASA,EAAQC,EAAGC,EAAWC,GAC9B,IAAIC,EACJ,OAvGD,SAAoBA,EAAKC,GACxB,MAAkC,mBAAlBD,EAAKC,EACtB,CAqGMC,CAAWL,EAAG,UACXA,EAAED,OAAQE,EAAWC,IAE7BC,EAAMG,EAAkBN,IACfO,iBA/CV,SAAoBP,EAAGC,EAAWC,GACjC,IAAIM,EACAC,EACAC,EACAC,EACAC,EAMJ,IAJAJ,EAAOR,EAAEQ,KACTC,EAAMT,EAAEa,UAAW,GAEnBH,EAAM,GACAE,EAAI,EAAGA,EAAIJ,EAAKM,OAAQF,IAC7BD,EAAIF,EAAKD,EAAMI,GACVX,EAAUc,KAAMb,EAASS,EAAGC,EAAGJ,IACnCE,EAAIM,KAAML,GAGZ,OAAOD,CACR,CA8BSG,CAAWV,EAAKF,EAAWC,GArFpC,SAAmBF,EAAGC,EAAWC,GAChC,IAAIQ,EACAC,EACAC,EAGJ,IADAF,EAAM,GACAE,EAAI,EAAGA,EAAIZ,EAAEc,OAAQF,IAC1BD,EAAIX,EAAGY,GACFX,EAAUc,KAAMb,EAASS,EAAGC,EAAGZ,IACnCU,EAAIM,KAAML,GAGZ,OAAOD,CACR,CA0EQO,CAAUjB,EAAGC,EAAWC,EAChC"} \ No newline at end of file diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index 56236cd..0000000 --- a/lib/index.js +++ /dev/null @@ -1,46 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 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'; - -/** -* Return a shallow copy of an array containing only those elements which pass a test implemented by a predicate function. -* -* @module @stdlib/array-base-filter -* -* @example -* var filter = require( '@stdlib/array-base-filter' ); -* -* function isPositive( v ) { -* return v > 0; -* } -* -* var x = [ 1, -2, -3, 4 ]; -* -* var out = filter( x, isPositive ); -* // returns [ 1, 4 ] -*/ - -// MODULES // - -var main = require( './main.js' ); - - -// EXPORTS // - -module.exports = main; diff --git a/lib/main.js b/lib/main.js deleted file mode 100644 index 9b0c3db..0000000 --- a/lib/main.js +++ /dev/null @@ -1,160 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 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 arraylike2object = require( '@stdlib/array-base-arraylike2object' ); - - -// FUNCTIONS // - -/** -* Tests whether an object has a specified method. -* -* @private -* @param {Object} obj - input object -* @param {string} method - method name -* @returns {boolean} boolean indicating whether an object has a specified method -* -* @example -* var bool = hasMethod( [], 'filter' ); -* // returns true -* -* @example -* var bool = hasMethod( [], 'beep' ); -* // returns false -*/ -function hasMethod( obj, method ) { - return ( typeof obj[ method ] === 'function' ); -} - -/** -* Returns a shallow copy of an array containing only those elements which pass a test implemented by a predicate function. -* -* @private -* @param {Collection} x - input array -* @param {Function} predicate - test function -* @param {*} thisArg - execution context -* @returns {Array} output array -* -* @example -* function isPositive( v ) { -* return v > 0; -* } -* -* var x = [ 1, -2, -3, 4 ]; -* -* var out = internal( x, isPositive ); -* // returns [ 1, 4 ] -*/ -function internal( x, predicate, thisArg ) { - var out; - var v; - var i; - - out = []; - for ( i = 0; i < x.length; i++ ) { - v = x[ i ]; - if ( predicate.call( thisArg, v, i, x ) ) { - out.push( v ); - } - } - return out; -} - -/** -* Returns a shallow copy of an array containing only those elements which pass a test implemented by a predicate function. -* -* @private -* @param {Object} x - input array object -* @param {Function} predicate - test function -* @param {*} thisArg - execution context -* @returns {Array} output array -* -* @example -* var toAccessorArray = require( '@stdlib/array-base-to-accessor-array' ); -* var arraylike2object = require( '@stdlib/array-base-arraylike2object' ); -* -* function isPositive( v ) { -* return v > 0; -* } -* -* var x = arraylike2object( toAccessorArray( [ 1, -2, -3, 4 ] ) ); -* -* var out = accessors( x, isPositive ); -* // returns [ 1, 4 ] -*/ -function accessors( x, predicate, thisArg ) { - var data; - var get; - var out; - var v; - var i; - - data = x.data; - get = x.accessors[ 0 ]; - - out = []; - for ( i = 0; i < data.length; i++ ) { - v = get( data, i ); - if ( predicate.call( thisArg, v, i, data ) ) { - out.push( v ); - } - } - return out; -} - - -// MAIN // - -/** -* Returns a shallow copy of an array containing only those elements which pass a test implemented by a predicate function. -* -* @param {Collection} x - input array -* @param {Function} predicate - test function -* @param {*} [thisArg] - execution context -* @returns {Collection} output array -* -* @example -* function isPositive( v ) { -* return v > 0; -* } -* -* var x = [ 1, -2, -3, 4 ]; -* -* var out = filter( x, isPositive ); -* // returns [ 1, 4 ] -*/ -function filter( x, predicate, thisArg ) { - var obj; - if ( hasMethod( x, 'filter' ) ) { - return x.filter( predicate, thisArg ); - } - obj = arraylike2object( x ); - if ( obj.accessorProtocol ) { - return accessors( obj, predicate, thisArg ); - } - return internal( x, predicate, thisArg ); -} - - -// EXPORTS // - -module.exports = filter; diff --git a/package.json b/package.json index 327779d..20cda5b 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.2.2", "description": "Return a shallow copy of an array containing only those elements which pass a test implemented by a predicate function.", "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", - "directories": { - "benchmark": "./benchmark", - "doc": "./docs", - "example": "./examples", - "lib": "./lib", - "test": "./test" - }, - "types": "./docs/types", - "scripts": { - "test": "make test", - "test-cov": "make test-cov", - "examples": "make examples", - "benchmark": "make benchmark" - }, + "type": "module", + "main": "./index.mjs", "homepage": "https://stdlib.io", "repository": { "type": "git", @@ -36,42 +13,6 @@ "bugs": { "url": "https://github.com/stdlib-js/stdlib/issues" }, - "dependencies": { - "@stdlib/array-base-arraylike2object": "^0.2.1", - "@stdlib/types": "^0.3.2", - "@stdlib/error-tools-fmtprodmsg": "^0.2.2" - }, - "devDependencies": { - "@stdlib/array-base-accessor": "^0.2.1", - "@stdlib/array-base-zero-to": "^0.2.1", - "@stdlib/array-float64": "^0.2.2", - "@stdlib/assert-instance-of": "^0.2.2", - "@stdlib/assert-is-array": "^0.2.2", - "@stdlib/assert-is-nonnegative-integer": "^0.2.2", - "@stdlib/assert-is-positive-integer": "^0.2.2", - "@stdlib/math-base-special-pow": "^0.3.0", - "@stdlib/random-array-discrete-uniform": "^0.2.1", - "@stdlib/utils-nary-function": "^0.2.2", - "tape": "git+https://github.com/kgryte/tape.git#fix/globby", - "istanbul": "^0.4.1", - "tap-min": "git+https://github.com/Planeshifter/tap-min.git", - "@stdlib/bench-harness": "^0.2.2" - }, - "engines": { - "node": ">=0.10.0", - "npm": ">2.7.0" - }, - "os": [ - "aix", - "darwin", - "freebsd", - "linux", - "macos", - "openbsd", - "sunos", - "win32", - "windows" - ], "keywords": [ "stdlib", "stdtypes", @@ -91,4 +32,4 @@ "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} \ No newline at end of file +} diff --git a/stats.html b/stats.html new file mode 100644 index 0000000..d4d08f0 --- /dev/null +++ b/stats.html @@ -0,0 +1,4842 @@ + + + + + + + + Rollup Visualizer + + + +
+ + + + + diff --git a/test/dist/test.js b/test/dist/test.js deleted file mode 100644 index a8a9c60..0000000 --- a/test/dist/test.js +++ /dev/null @@ -1,33 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 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 tape = require( 'tape' ); -var main = require( './../../dist' ); - - -// TESTS // - -tape( 'main export is defined', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( main !== void 0, true, 'main export is defined' ); - t.end(); -}); diff --git a/test/test.js b/test/test.js deleted file mode 100644 index d4e7373..0000000 --- a/test/test.js +++ /dev/null @@ -1,251 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 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 tape = require( 'tape' ); -var AccessorArray = require( '@stdlib/array-base-accessor' ); -var Float64Array = require( '@stdlib/array-float64' ); -var instanceOf = require( '@stdlib/assert-instance-of' ); -var filter = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Tests whether a value is positive. -* -* @private -* @param {number} value - input value -* @returns {boolean} boolean indicating if a value is positive -*/ -function isPositive( value ) { - return ( value > 0 ); -} - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof filter, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'if provided an empty collection, the function returns an empty collection (generic)', function test( t ) { - var expected; - var actual; - var arr; - - arr = []; - expected = []; - actual = filter( arr, foo ); - - t.strictEqual( instanceOf( actual, Array ), true, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - t.end(); - - function foo() { - t.fail( 'should not be invoked' ); - } -}); - -tape( 'if provided an empty collection, the function returns an empty collection (typed array)', function test( t ) { - var expected; - var actual; - var arr; - - arr = new Float64Array( [] ); - expected = new Float64Array( [] ); - actual = filter( arr, foo ); - - t.strictEqual( instanceOf( actual, Float64Array ), true, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - t.end(); - - function foo() { - t.fail( 'should not be invoked' ); - } -}); - -tape( 'if provided an empty collection, the function returns an empty collection (accessor)', function test( t ) { - var expected; - var actual; - var arr; - - arr = new AccessorArray( [] ); - expected = []; - actual = filter( arr, foo ); - - t.strictEqual( instanceOf( actual, Array ), true, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - t.end(); - - function foo() { - t.fail( 'should not be invoked' ); - } -}); - -tape( 'the function filters a provided collection (generic)', function test( t ) { - var expected; - var actual; - var arr; - - arr = [ 1, -2, 3 ]; - expected = [ 1, 3 ]; - actual = filter( arr, isPositive ); - - t.strictEqual( instanceOf( actual, Array ), true, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - t.end(); -}); - -tape( 'the function filters a provided collection (typed array)', function test( t ) { - var expected; - var actual; - var arr; - - arr = new Float64Array( [ -1.0, 2.0, 3.0 ] ); - expected = new Float64Array( [ 2.0, 3.0 ] ); - actual = filter( arr, isPositive ); - - t.strictEqual( instanceOf( actual, Float64Array ), true, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - t.end(); -}); - -tape( 'the function filters a provided collection (accessor)', function test( t ) { - var expected; - var actual; - var arr; - - arr = new AccessorArray( [ 1, -2, -3 ] ); - expected = [ 1 ]; - actual = filter( arr, isPositive ); - - t.strictEqual( instanceOf( actual, Array ), true, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - t.end(); -}); - -tape( 'the function filters a provided collection (array-like object)', function test( t ) { - var expected; - var actual; - var arr; - - arr = { - 'length': 3, - '0': -1, - '1': -2, - '2': 3 - }; - expected = [ 3 ]; - actual = filter( arr, isPositive ); - - t.strictEqual( instanceOf( actual, Array ), true, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - t.end(); -}); - -tape( 'the function an empty collection if all elements fail a test (generic)', function test( t ) { - var expected; - var actual; - var arr; - - arr = [ -1, -2, -3 ]; - expected = []; - actual = filter( arr, isPositive ); - - t.strictEqual( instanceOf( actual, Array ), true, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - t.end(); -}); - -tape( 'the function an empty collection if all elements fail a test (typed array)', function test( t ) { - var expected; - var actual; - var arr; - - arr = new Float64Array( [ -1.0, -2.0, -3.0 ] ); - expected = new Float64Array( [] ); - actual = filter( arr, isPositive ); - - t.strictEqual( instanceOf( actual, Float64Array ), true, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - t.end(); -}); - -tape( 'the function an empty collection if all elements fail a test (accessor)', function test( t ) { - var expected; - var actual; - var arr; - - arr = new AccessorArray( [ -1, -2, -3 ] ); - expected = []; - actual = filter( arr, isPositive ); - - t.strictEqual( instanceOf( actual, Array ), true, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - t.end(); -}); - -tape( 'the function an empty collection if all elements fail a test (array-like object)', function test( t ) { - var expected; - var actual; - var arr; - - arr = { - 'length': 3, - '0': -1, - '1': -2, - '2': -3 - }; - expected = []; - actual = filter( arr, isPositive ); - - t.strictEqual( instanceOf( actual, Array ), true, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - t.end(); -}); - -tape( 'the function supports providing an execution context', function test( t ) { - var expected; - var actual; - var ctx; - var arr; - - ctx = { - 'count': 0 - }; - arr = [ 1, 2, 3 ]; - expected = [ 1, 2, 3 ]; - actual = filter( arr, predicate, ctx ); - - t.strictEqual( instanceOf( actual, Array ), true, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - t.strictEqual( ctx.count, arr.length, 'returns expected value' ); - - t.end(); - - function predicate( value ) { - this.count += 1; // eslint-disable-line no-invalid-this - return ( value > 0 ); - } -}); From 0111102d0c36b20f562360e4fcedff7e23a62ecb Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 29 Jul 2024 12:05:02 +0000 Subject: [PATCH 33/40] Update README.md for ESM bundle v0.2.2 --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index e3192d3..c26c920 100644 --- a/README.md +++ b/README.md @@ -52,7 +52,7 @@ limitations under the License. ## Usage ```javascript -import filter from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-filter@esm/index.mjs'; +import filter from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-filter@v0.2.2-esm/index.mjs'; ``` #### filter( x, predicate\[, thisArg] ) @@ -136,7 +136,7 @@ var cnt = context.count; import discreteUniform from 'https://cdn.jsdelivr.net/gh/stdlib-js/random-array-discrete-uniform@esm/index.mjs'; var isPositiveInteger = require( 'https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-positive-integer' ).isPrimitive; import naryFunction from 'https://cdn.jsdelivr.net/gh/stdlib-js/utils-nary-function@esm/index.mjs'; -import filter from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-filter@esm/index.mjs'; +import filter from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-filter@v0.2.2-esm/index.mjs'; var x = discreteUniform( 10, -5, 5, { 'dtype': 'int32' From 295ba4147a3eadfd8d1cca5198af4bbdb89a9272 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 29 Jul 2024 12:05:03 +0000 Subject: [PATCH 34/40] Auto-generated commit --- README.md | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index c26c920..8327d4d 100644 --- a/README.md +++ b/README.md @@ -51,6 +51,11 @@ limitations under the License. ## Usage +```javascript +import filter from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-filter@esm/index.mjs'; +``` +The previous example will load the latest bundled code from the esm branch. Alternatively, you may load a specific version by loading the file from one of the [tagged bundles](https://github.com/stdlib-js/array-base-filter/tags). For example, + ```javascript import filter from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-filter@v0.2.2-esm/index.mjs'; ``` @@ -136,7 +141,7 @@ var cnt = context.count; import discreteUniform from 'https://cdn.jsdelivr.net/gh/stdlib-js/random-array-discrete-uniform@esm/index.mjs'; var isPositiveInteger = require( 'https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-positive-integer' ).isPrimitive; import naryFunction from 'https://cdn.jsdelivr.net/gh/stdlib-js/utils-nary-function@esm/index.mjs'; -import filter from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-filter@v0.2.2-esm/index.mjs'; +import filter from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-filter@esm/index.mjs'; var x = discreteUniform( 10, -5, 5, { 'dtype': 'int32' From 2ab817c75c3eeeba35ffd7cdc2d18d2842e1e72d Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 2 Jun 2025 00:59:18 +0000 Subject: [PATCH 35/40] Transform error messages --- package.json | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/package.json b/package.json index 4c62951..317e1f2 100644 --- a/package.json +++ b/package.json @@ -38,7 +38,8 @@ }, "dependencies": { "@stdlib/array-base-arraylike2object": "^0.2.1", - "@stdlib/types": "^0.4.3" + "@stdlib/types": "^0.4.3", + "@stdlib/error-tools-fmtprodmsg": "^0.2.2" }, "devDependencies": { "@stdlib/array-base-accessor": "^0.2.2", @@ -90,4 +91,4 @@ "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} +} \ No newline at end of file From a36e9177ec56c786a2a874488a8571c1fd5753fc Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 2 Jun 2025 01:24:58 +0000 Subject: [PATCH 36/40] Remove files --- index.d.ts | 343 ---- index.mjs | 4 - index.mjs.map | 1 - stats.html | 4842 ------------------------------------------------- 4 files changed, 5190 deletions(-) delete mode 100644 index.d.ts delete mode 100644 index.mjs delete mode 100644 index.mjs.map delete mode 100644 stats.html diff --git a/index.d.ts b/index.d.ts deleted file mode 100644 index c5c8ca7..0000000 --- a/index.d.ts +++ /dev/null @@ -1,343 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2024 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 - -/// - -import { Collection, AccessorArrayLike, Complex128Array, Complex64Array } from '@stdlib/types/array'; - -/** -* Returns a boolean indicating whether an element passes a test. -* -* @returns boolean indicating whether an element passes a test -*/ -type Nullary = ( this: U ) => boolean; - -/** -* Returns a boolean indicating whether an element passes a test. -* -* @param value - current array element -* @returns boolean indicating whether an element passes a test -*/ -type Unary = ( this: U, value: T ) => boolean; - -/** -* Returns a boolean indicating whether an element passes a test. -* -* @param value - current array element -* @param index - current array element index -* @returns boolean indicating whether an element passes a test -*/ -type Binary = ( this: U, value: T, index: number ) => boolean; - -/** -* Returns a boolean indicating whether an element passes a test. -* -* @param value - current array element -* @param index - current array element index -* @param arr - input array -* @returns boolean indicating whether an element passes a test -*/ -type Ternary = ( this: U, value: T, index: number, arr: V ) => boolean; - -/** -* Returns a boolean indicating whether an element passes a test. -* -* @param value - current array element -* @param index - current array element index -* @param arr - input array -* @returns boolean indicating whether an element passes a test -*/ -type Predicate = Nullary | Unary | Binary | Ternary; - -/** -* Returns a shallow copy of an array containing only those elements which pass a test implemented by a predicate function. -* -* @param x - input array -* @param predicate - predicate function -* @param thisArg - predicate function execution context -* @returns output array -* -* @example -* var isPositiveNumber = require( '@stdlib/assert-is-positive-number' ).isPrimitive; -* var Float64Array = require( '@stdlib/array-float64' ); -* -* var x = new Float64Array( [ 1.0, -2.0, -3.0, 4.0 ] ); -* -* var out = filter( x, isPositiveNumber ); -* // returns [ 1.0, 4.0 ] -*/ -declare function filter( x: Float64Array, predicate: Predicate, thisArg?: ThisParameterType> ): Float64Array; - -/** -* Returns a shallow copy of an array containing only those elements which pass a test implemented by a predicate function. -* -* @param x - input array -* @param predicate - predicate function -* @param thisArg - predicate function execution context -* @returns output array -* -* @example -* var isPositiveNumber = require( '@stdlib/assert-is-positive-number' ).isPrimitive; -* var Float32Array = require( '@stdlib/array-float32' ); -* -* var x = new Float32Array( [ 1.0, -2.0, -3.0, 4.0 ] ); -* -* var out = filter( x, isPositiveNumber ); -* // returns [ 1.0, 4.0 ] -*/ -declare function filter( x: Float32Array, predicate: Predicate, thisArg?: ThisParameterType> ): Float32Array; - -/** -* Returns a shallow copy of an array containing only those elements which pass a test implemented by a predicate function. -* -* @param x - input array -* @param predicate - predicate function -* @param thisArg - predicate function execution context -* @returns output array -* -* @example -* var isPositiveNumber = require( '@stdlib/assert-is-positive-number' ).isPrimitive; -* var Int32Array = require( '@stdlib/array-int32' ); -* -* var x = new Int32Array( [ 1, -2, -3, 4 ] ); -* -* var out = filter( x, isPositiveNumber ); -* // returns [ 1, 4 ] -*/ -declare function filter( x: Int32Array, predicate: Predicate, thisArg?: ThisParameterType> ): Int32Array; - -/** -* Returns a shallow copy of an array containing only those elements which pass a test implemented by a predicate function. -* -* @param x - input array -* @param predicate - predicate function -* @param thisArg - predicate function execution context -* @returns output array -* -* @example -* var isPositiveNumber = require( '@stdlib/assert-is-positive-number' ).isPrimitive; -* var Int16Array = require( '@stdlib/array-int16' ); -* -* var x = new Int16Array( [ 1, -2, -3, 4 ] ); -* -* var out = filter( x, isPositiveNumber ); -* // returns [ 1, 4 ] -*/ -declare function filter( x: Int16Array, predicate: Predicate, thisArg?: ThisParameterType> ): Int16Array; - -/** -* Returns a shallow copy of an array containing only those elements which pass a test implemented by a predicate function. -* -* @param x - input array -* @param predicate - predicate function -* @param thisArg - predicate function execution context -* @returns output array -* -* @example -* var isPositiveNumber = require( '@stdlib/assert-is-positive-number' ).isPrimitive; -* var Int8Array = require( '@stdlib/array-int8' ); -* -* var x = new Int8Array( [ 1, -2, -3, 4 ] ); -* -* var out = filter( x, isPositiveNumber ); -* // returns [ 1, 4 ] -*/ -declare function filter( x: Int8Array, predicate: Predicate, thisArg?: ThisParameterType> ): Int8Array; - -/** -* Returns a shallow copy of an array containing only those elements which pass a test implemented by a predicate function. -* -* @param x - input array -* @param predicate - predicate function -* @param thisArg - predicate function execution context -* @returns output array -* -* @example -* var isPositiveNumber = require( '@stdlib/assert-is-positive-number' ).isPrimitive; -* var Uint32Array = require( '@stdlib/array-uint32' ); -* -* var x = new Uint32Array( [ 1, 2, 3, 4 ] ); -* -* var out = filter( x, isPositiveNumber ); -* // returns [ 1, 2, 3, 4 ] -*/ -declare function filter( x: Uint32Array, predicate: Predicate, thisArg?: ThisParameterType> ): Uint32Array; - -/** -* Returns a shallow copy of an array containing only those elements which pass a test implemented by a predicate function. -* -* @param x - input array -* @param predicate - predicate function -* @param thisArg - predicate function execution context -* @returns output array -* -* @example -* var isPositiveNumber = require( '@stdlib/assert-is-positive-number' ).isPrimitive; -* var Uint16Array = require( '@stdlib/array-uint16' ); -* -* var x = new Uint16Array( [ 1, 2, 3, 4 ] ); -* -* var out = filter( x, isPositiveNumber ); -* // returns [ 1, 2, 3, 4 ] -*/ -declare function filter( x: Uint16Array, predicate: Predicate, thisArg?: ThisParameterType> ): Uint16Array; - -/** -* Returns a shallow copy of an array containing only those elements which pass a test implemented by a predicate function. -* -* @param x - input array -* @param predicate - predicate function -* @param thisArg - predicate function execution context -* @returns output array -* -* @example -* var isPositiveNumber = require( '@stdlib/assert-is-positive-number' ).isPrimitive; -* var Uint8Array = require( '@stdlib/array-uint8' ); -* -* var x = new Uint8Array( [ 1, 2, 3, 4 ] ); -* -* var out = filter( x, isPositiveNumber ); -* // returns [ 1, 2, 3, 4 ] -*/ -declare function filter( x: Uint8Array, predicate: Predicate, thisArg?: ThisParameterType> ): Uint8Array; - -/** -* Returns a shallow copy of an array containing only those elements which pass a test implemented by a predicate function. -* -* @param x - input array -* @param predicate - predicate function -* @param thisArg - predicate function execution context -* @returns output array -* -* @example -* var isPositiveNumber = require( '@stdlib/assert-is-positive-number' ).isPrimitive; -* var Uint8ClampedArray = require( '@stdlib/array-uint8c' ); -* -* var x = new Uint8ClampedArray( [ 1, 2, 3, 4 ] ); -* -* var out = filter( x, isPositiveNumber ); -* // returns [ 1, 2, 3, 4 ] -*/ -declare function filter( x: Uint8ClampedArray, predicate: Predicate, thisArg?: ThisParameterType> ): Uint8ClampedArray; - -/** -* Returns a shallow copy of an array containing only those elements which pass a test implemented by a predicate function. -* -* @param x - input array -* @param predicate - predicate function -* @param thisArg - predicate function execution context -* @returns output array -* -* @example -* var isPositiveNumber = require( '@stdlib/assert-is-positive-number' ).isPrimitive; -* var real = require( '@stdlib/complex-float64-real' ); -* var imag = require( '@stdlib/complex-float64-imag' ); -* var Complex128Array = require( '@stdlib/array-complex128' ); -* -* function predicate( v ) { -* return ( isPositiveNumber( real( v ) ) && isPositiveNumber( imag( v ) ) ); -* } -* -* var x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0 ] ); -* -* var out = filter( x, predicate ); -* // returns -*/ -declare function filter( x: Complex128Array, predicate: Predicate, thisArg?: ThisParameterType> ): Complex128Array; - -/** -* Returns a shallow copy of an array containing only those elements which pass a test implemented by a predicate function. -* -* @param x - input array -* @param predicate - predicate function -* @param thisArg - predicate function execution context -* @returns output array -* -* @example -* var isPositiveNumber = require( '@stdlib/assert-is-positive-number' ).isPrimitive; -* var realf = require( '@stdlib/complex-float32-real' ); -* var imagf = require( '@stdlib/complex-float32-imag' ); -* var Complex64Array = require( '@stdlib/array-complex64' ); -* -* function predicate( v ) { -* return ( isPositiveNumber( realf( v ) ) && isPositiveNumber( imagf( v ) ) ); -* } -* -* var x = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); -* -* var out = filter( x, predicate ); -* // returns -*/ -declare function filter( x: Complex64Array, predicate: Predicate, thisArg?: ThisParameterType> ): Complex64Array; - -/** -* Returns a shallow copy of an array containing only those elements which pass a test implemented by a predicate function. -* -* @param x - input array -* @param predicate - predicate function -* @param thisArg - predicate function execution context -* @returns output array -* -* @example -* var x = [ 1, -2, -3, 4 ]; -* -* var out = filter( x, isPositiveNumber ); -* // returns [ 1, 4 ] -*/ -declare function filter( x: Array, predicate: Predicate>, thisArg?: ThisParameterType>> ): Array; - -/** -* Returns a shallow copy of an array containing only those elements which pass a test implemented by a predicate function. -* -* @param x - input array -* @param predicate - predicate function -* @param thisArg - predicate function execution context -* @returns output array -* -* @example -* var toAccessorArray = require( '@stdlib/array-base-to-accessor-array' ); -* -* var x = toAccessorArray( [ 1, -2, -3, 4 ] ); -* -* var out = filter( x, isPositiveNumber ); -* // returns [ 1, 4 ] -*/ -declare function filter( x: AccessorArrayLike, predicate: Predicate>, thisArg?: ThisParameterType>> ): Array; - -/** -* Returns a shallow copy of an array containing only those elements which pass a test implemented by a predicate function. -* -* @param x - input array -* @param predicate - predicate function -* @param thisArg - predicate function execution context -* @returns output array -* -* @example -* var x = [ 1, -2, -3, 4 ]; -* -* var out = filter( x, isPositiveNumber ); -* // returns [ 1, 4 ] -*/ -declare function filter( x: Collection, predicate: Predicate>, thisArg?: ThisParameterType>> ): Array; - - -// EXPORTS // - -export = filter; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index a10870c..0000000 --- a/index.mjs +++ /dev/null @@ -1,4 +0,0 @@ -// Copyright (c) 2024 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 -/// -import r from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-arraylike2object@v0.2.1-esm/index.mjs";function t(t,e,n){var o;return function(r,t){return"function"==typeof r[t]}(t,"filter")?t.filter(e,n):(o=r(t)).accessorProtocol?function(r,t,e){var n,o,a,s,c;for(n=r.data,o=r.accessors[0],a=[],c=0;c 0;\n* }\n*\n* var x = [ 1, -2, -3, 4 ];\n*\n* var out = internal( x, isPositive );\n* // returns [ 1, 4 ]\n*/\nfunction internal( x, predicate, thisArg ) {\n\tvar out;\n\tvar v;\n\tvar i;\n\n\tout = [];\n\tfor ( i = 0; i < x.length; i++ ) {\n\t\tv = x[ i ];\n\t\tif ( predicate.call( thisArg, v, i, x ) ) {\n\t\t\tout.push( v );\n\t\t}\n\t}\n\treturn out;\n}\n\n/**\n* Returns a shallow copy of an array containing only those elements which pass a test implemented by a predicate function.\n*\n* @private\n* @param {Object} x - input array object\n* @param {Function} predicate - test function\n* @param {*} thisArg - execution context\n* @returns {Array} output array\n*\n* @example\n* import toAccessorArray from '@stdlib/array-base-to-accessor-array';\n* import arraylike2object from '@stdlib/array-base-arraylike2object';\n*\n* function isPositive( v ) {\n* return v > 0;\n* }\n*\n* var x = arraylike2object( toAccessorArray( [ 1, -2, -3, 4 ] ) );\n*\n* var out = accessors( x, isPositive );\n* // returns [ 1, 4 ]\n*/\nfunction accessors( x, predicate, thisArg ) {\n\tvar data;\n\tvar get;\n\tvar out;\n\tvar v;\n\tvar i;\n\n\tdata = x.data;\n\tget = x.accessors[ 0 ];\n\n\tout = [];\n\tfor ( i = 0; i < data.length; i++ ) {\n\t\tv = get( data, i );\n\t\tif ( predicate.call( thisArg, v, i, data ) ) {\n\t\t\tout.push( v );\n\t\t}\n\t}\n\treturn out;\n}\n\n\n// MAIN //\n\n/**\n* Returns a shallow copy of an array containing only those elements which pass a test implemented by a predicate function.\n*\n* @param {Collection} x - input array\n* @param {Function} predicate - test function\n* @param {*} [thisArg] - execution context\n* @returns {Collection} output array\n*\n* @example\n* function isPositive( v ) {\n* return v > 0;\n* }\n*\n* var x = [ 1, -2, -3, 4 ];\n*\n* var out = filter( x, isPositive );\n* // returns [ 1, 4 ]\n*/\nfunction filter( x, predicate, thisArg ) {\n\tvar obj;\n\tif ( hasMethod( x, 'filter' ) ) {\n\t\treturn x.filter( predicate, thisArg );\n\t}\n\tobj = arraylike2object( x );\n\tif ( obj.accessorProtocol ) {\n\t\treturn accessors( obj, predicate, thisArg );\n\t}\n\treturn internal( x, predicate, thisArg );\n}\n\n\n// EXPORTS //\n\nexport default filter;\n"],"names":["filter","x","predicate","thisArg","obj","method","hasMethod","arraylike2object","accessorProtocol","data","get","out","v","i","accessors","length","call","push","internal"],"mappings":";;sGAgJA,SAASA,EAAQC,EAAGC,EAAWC,GAC9B,IAAIC,EACJ,OAvGD,SAAoBA,EAAKC,GACxB,MAAkC,mBAAlBD,EAAKC,EACtB,CAqGMC,CAAWL,EAAG,UACXA,EAAED,OAAQE,EAAWC,IAE7BC,EAAMG,EAAkBN,IACfO,iBA/CV,SAAoBP,EAAGC,EAAWC,GACjC,IAAIM,EACAC,EACAC,EACAC,EACAC,EAMJ,IAJAJ,EAAOR,EAAEQ,KACTC,EAAMT,EAAEa,UAAW,GAEnBH,EAAM,GACAE,EAAI,EAAGA,EAAIJ,EAAKM,OAAQF,IAC7BD,EAAIF,EAAKD,EAAMI,GACVX,EAAUc,KAAMb,EAASS,EAAGC,EAAGJ,IACnCE,EAAIM,KAAML,GAGZ,OAAOD,CACR,CA8BSG,CAAWV,EAAKF,EAAWC,GArFpC,SAAmBF,EAAGC,EAAWC,GAChC,IAAIQ,EACAC,EACAC,EAGJ,IADAF,EAAM,GACAE,EAAI,EAAGA,EAAIZ,EAAEc,OAAQF,IAC1BD,EAAIX,EAAGY,GACFX,EAAUc,KAAMb,EAASS,EAAGC,EAAGZ,IACnCU,EAAIM,KAAML,GAGZ,OAAOD,CACR,CA0EQO,CAAUjB,EAAGC,EAAWC,EAChC"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index d4d08f0..0000000 --- a/stats.html +++ /dev/null @@ -1,4842 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From 2e0769c2e4e988f64ce4332562cebed0f5d1488b Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 2 Jun 2025 01:25:23 +0000 Subject: [PATCH 37/40] Auto-generated commit --- .editorconfig | 180 - .eslintrc.js | 1 - .gitattributes | 66 - .github/.keepalive | 1 - .github/PULL_REQUEST_TEMPLATE.md | 7 - .github/workflows/benchmark.yml | 64 - .github/workflows/cancel.yml | 57 - .github/workflows/close_pull_requests.yml | 54 - .github/workflows/examples.yml | 64 - .github/workflows/npm_downloads.yml | 112 - .github/workflows/productionize.yml | 794 --- .github/workflows/publish.yml | 252 - .github/workflows/test.yml | 99 - .github/workflows/test_bundles.yml | 186 - .github/workflows/test_coverage.yml | 133 - .github/workflows/test_install.yml | 85 - .github/workflows/test_published_package.yml | 105 - .gitignore | 194 - .npmignore | 229 - .npmrc | 31 - CHANGELOG.md | 105 - CITATION.cff | 30 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 -- README.md | 41 +- SECURITY.md | 5 - benchmark/benchmark.length.js | 97 - branches.md | 56 - dist/index.d.ts | 3 - dist/index.js | 5 - dist/index.js.map | 7 - docs/repl.txt | 46 - docs/types/test.ts | 101 - examples/index.js | 35 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/index.js | 46 - lib/main.js | 160 - package.json | 65 +- stats.html | 4842 ++++++++++++++++++ test/dist/test.js | 33 - test/test.js | 251 - 44 files changed, 4867 insertions(+), 4322 deletions(-) delete mode 100644 .editorconfig delete mode 100644 .eslintrc.js delete mode 100644 .gitattributes delete mode 100644 .github/.keepalive delete mode 100644 .github/PULL_REQUEST_TEMPLATE.md delete mode 100644 .github/workflows/benchmark.yml delete mode 100644 .github/workflows/cancel.yml delete mode 100644 .github/workflows/close_pull_requests.yml delete mode 100644 .github/workflows/examples.yml delete mode 100644 .github/workflows/npm_downloads.yml delete mode 100644 .github/workflows/productionize.yml delete mode 100644 .github/workflows/publish.yml delete mode 100644 .github/workflows/test.yml delete mode 100644 .github/workflows/test_bundles.yml delete mode 100644 .github/workflows/test_coverage.yml delete mode 100644 .github/workflows/test_install.yml delete mode 100644 .github/workflows/test_published_package.yml delete mode 100644 .gitignore delete mode 100644 .npmignore delete mode 100644 .npmrc delete mode 100644 CHANGELOG.md delete mode 100644 CITATION.cff delete mode 100644 CODE_OF_CONDUCT.md delete mode 100644 CONTRIBUTING.md delete mode 100644 Makefile delete mode 100644 SECURITY.md delete mode 100644 benchmark/benchmark.length.js delete mode 100644 branches.md delete mode 100644 dist/index.d.ts delete mode 100644 dist/index.js delete mode 100644 dist/index.js.map delete mode 100644 docs/repl.txt delete mode 100644 docs/types/test.ts delete mode 100644 examples/index.js rename docs/types/index.d.ts => index.d.ts (99%) create mode 100644 index.mjs create mode 100644 index.mjs.map delete mode 100644 lib/index.js delete mode 100644 lib/main.js create mode 100644 stats.html delete mode 100644 test/dist/test.js delete mode 100644 test/test.js diff --git a/.editorconfig b/.editorconfig deleted file mode 100644 index dab5d2a..0000000 --- a/.editorconfig +++ /dev/null @@ -1,180 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 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. -#/ - -# EditorConfig configuration file (see ). - -# Indicate that this file is a root-level configuration file: -root = true - -# Set properties for all files: -[*] -end_of_line = lf -charset = utf-8 -trim_trailing_whitespace = true -insert_final_newline = true - -# Set properties for JavaScript files: -[*.{js,js.txt}] -indent_style = tab - -# Set properties for JavaScript ES module files: -[*.{mjs,mjs.txt}] -indent_style = tab - -# Set properties for JavaScript CommonJS files: -[*.{cjs,cjs.txt}] -indent_style = tab - -# Set properties for JSON files: -[*.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `cli_opts.json` files: -[cli_opts.json] -indent_style = tab - -# Set properties for TypeScript files: -[*.ts] -indent_style = tab - -# Set properties for Python files: -[*.{py,py.txt}] -indent_style = space -indent_size = 4 - -# Set properties for Julia files: -[*.{jl,jl.txt}] -indent_style = tab - -# Set properties for R files: -[*.{R,R.txt}] -indent_style = tab - -# Set properties for C files: -[*.{c,c.txt}] -indent_style = tab - -# Set properties for C header files: -[*.{h,h.txt}] -indent_style = tab - -# Set properties for C++ files: -[*.{cpp,cpp.txt}] -indent_style = tab - -# Set properties for C++ header files: -[*.{hpp,hpp.txt}] -indent_style = tab - -# Set properties for Fortran files: -[*.{f,f.txt}] -indent_style = space -indent_size = 2 - -# Set properties for shell files: -[*.{sh,sh.txt}] -indent_style = tab - -# Set properties for AWK files: -[*.{awk,awk.txt}] -indent_style = tab - -# Set properties for HTML files: -[*.{html,html.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for XML files: -[*.{xml,xml.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for CSS files: -[*.{css,css.txt}] -indent_style = tab - -# Set properties for Makefiles: -[Makefile] -indent_style = tab - -[*.{mk,mk.txt}] -indent_style = tab - -# Set properties for Markdown files: -[*.{md,md.txt}] -indent_style = space -indent_size = 4 -trim_trailing_whitespace = true # Note: this disables using two spaces to force a hard line break, which is permitted in Markdown. As we don't typically follow that practice (TMK), we should be safe to automatically trim. - -# Set properties for `usage.txt` files: -[usage.txt] -indent_style = space -indent_size = 2 - -# Set properties for `repl.txt` files: -[repl.txt] -indent_style = space -indent_size = 4 - -# Set properties for `package.json` files: -[package.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `datapackage.json` files: -[datapackage.json] -indent_style = space -indent_size = 2 - -# Set properties for `manifest.json` files: -[manifest.json] -indent_style = space -indent_size = 2 - -# Set properties for `tsconfig.json` files: -[tsconfig.json] -indent_style = space -indent_size = 2 - -# Set properties for LaTeX files: -[*.{tex,tex.txt}] -indent_style = tab - -# Set properties for LaTeX Bibliography files: -[*.{bib,bib.txt}] -indent_style = tab - -# Set properties for YAML files: -[*.{yml,yml.txt}] -indent_style = space -indent_size = 2 - -# Set properties for GYP files: -[binding.gyp] -indent_style = space -indent_size = 2 - -[*.gypi] -indent_style = space -indent_size = 2 - -# Set properties for citation files: -[*.{cff,cff.txt}] -indent_style = space -indent_size = 2 diff --git a/.eslintrc.js b/.eslintrc.js deleted file mode 100644 index 5f30286..0000000 --- a/.eslintrc.js +++ /dev/null @@ -1 +0,0 @@ -/* For the `eslint` rules of this project, consult the main repository at https://github.com/stdlib-js/stdlib */ diff --git a/.gitattributes b/.gitattributes deleted file mode 100644 index 1c88e69..0000000 --- a/.gitattributes +++ /dev/null @@ -1,66 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 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. -#/ - -# Configuration file which assigns attributes to pathnames. -# -# [1]: https://git-scm.com/docs/gitattributes - -# Automatically normalize the line endings of any committed text files: -* text=auto - -# Override line endings for certain files on checkout: -*.crlf.csv text eol=crlf - -# Denote that certain files are binary and should not be modified: -*.png binary -*.jpg binary -*.jpeg binary -*.gif binary -*.ico binary -*.gz binary -*.zip binary -*.7z binary -*.mp3 binary -*.mp4 binary -*.mov binary - -# Override what is considered "vendored" by GitHub's linguist: -/lib/node_modules/** -linguist-vendored -linguist-generated - -# Configure directories which should *not* be included in GitHub language statistics: -/deps/** linguist-vendored -/dist/** linguist-generated -/workshops/** linguist-vendored - -benchmark/** linguist-vendored -docs/* linguist-documentation -etc/** linguist-vendored -examples/** linguist-documentation -scripts/** linguist-vendored -test/** linguist-vendored -tools/** linguist-vendored - -# Configure files which should *not* be included in GitHub language statistics: -Makefile linguist-vendored -*.mk linguist-vendored -*.jl linguist-vendored -*.py linguist-vendored -*.R linguist-vendored - -# Configure files which should be included in GitHub language statistics: -docs/types/*.d.ts -linguist-documentation diff --git a/.github/.keepalive b/.github/.keepalive deleted file mode 100644 index c96dbcc..0000000 --- a/.github/.keepalive +++ /dev/null @@ -1 +0,0 @@ -2025-06-02T00:58:10.572Z diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index 7753f5a..0000000 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ /dev/null @@ -1,7 +0,0 @@ - - -We are excited about your pull request, but unfortunately we are not accepting pull requests against this repository, as all development happens on the [main project repository](https://github.com/stdlib-js/stdlib). We kindly request that you submit this pull request against the [respective directory](https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/filter) of the main repository where we’ll review and provide feedback. - -If this is your first stdlib contribution, be sure to read the [contributing guide](https://github.com/stdlib-js/stdlib/blob/develop/CONTRIBUTING.md) which provides guidelines and instructions for submitting contributions. You may also consult the [development guide](https://github.com/stdlib-js/stdlib/blob/develop/docs/contributing/development.md) for help on developing stdlib. - -We look forward to receiving your contribution! :smiley: \ No newline at end of file diff --git a/.github/workflows/benchmark.yml b/.github/workflows/benchmark.yml deleted file mode 100644 index e4f10fe..0000000 --- a/.github/workflows/benchmark.yml +++ /dev/null @@ -1,64 +0,0 @@ -#/ -# @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. -#/ - -# Workflow name: -name: benchmark - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to run benchmarks: - benchmark: - - # Define a display name: - name: 'Run benchmarks' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Run benchmarks: - - name: 'Run benchmarks' - run: | - npm run benchmark diff --git a/.github/workflows/cancel.yml b/.github/workflows/cancel.yml deleted file mode 100644 index b5291db..0000000 --- a/.github/workflows/cancel.yml +++ /dev/null @@ -1,57 +0,0 @@ -#/ -# @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. -#/ - -# Workflow name: -name: cancel - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to cancel existing workflow runs: - cancel: - - # Define a display name: - name: 'Cancel workflow runs' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Time limit: - timeout-minutes: 3 - - # Define the sequence of job steps... - steps: - - # Cancel existing workflow runs: - - name: 'Cancel existing workflow runs' - # Pin action to full length commit SHA - uses: styfle/cancel-workflow-action@85880fa0301c86cca9da44039ee3bb12d3bedbfa # v0.12.1 - with: - workflow_id: >- - benchmark.yml, - examples.yml, - test.yml, - test_coverage.yml, - test_install.yml, - publish.yml - access_token: ${{ github.token }} diff --git a/.github/workflows/close_pull_requests.yml b/.github/workflows/close_pull_requests.yml deleted file mode 100644 index 2060eba..0000000 --- a/.github/workflows/close_pull_requests.yml +++ /dev/null @@ -1,54 +0,0 @@ -#/ -# @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. -#/ - -# Workflow name: -name: close_pull_requests - -# Workflow triggers: -on: - pull_request_target: - types: [opened] - -# Workflow jobs: -jobs: - - # Define job to close all pull requests: - run: - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - - # Close pull request - - name: 'Close pull request' - # Pin action to full length commit SHA corresponding to v3.1.2 - uses: superbrothers/close-pull-request@9c18513d320d7b2c7185fb93396d0c664d5d8448 - with: - comment: | - Thank you for submitting a pull request. :raised_hands: - - We greatly appreciate your willingness to submit a contribution. However, we are not accepting pull requests against this repository, as all development happens on the [main project repository](https://github.com/stdlib-js/stdlib). - - We kindly request that you submit this pull request against the [respective directory](https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/filter) of the main repository where we’ll review and provide feedback. If this is your first stdlib contribution, be sure to read the [contributing guide](https://github.com/stdlib-js/stdlib/blob/develop/CONTRIBUTING.md) which provides guidelines and instructions for submitting contributions. - - Thank you again, and we look forward to receiving your contribution! :smiley: - - Best, - The stdlib team \ No newline at end of file diff --git a/.github/workflows/examples.yml b/.github/workflows/examples.yml deleted file mode 100644 index 2984901..0000000 --- a/.github/workflows/examples.yml +++ /dev/null @@ -1,64 +0,0 @@ -#/ -# @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. -#/ - -# Workflow name: -name: examples - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to run the package examples... - examples: - - # Define display name: - name: 'Run examples' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - - # Checkout repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Run examples: - - name: 'Run examples' - run: | - npm run examples diff --git a/.github/workflows/npm_downloads.yml b/.github/workflows/npm_downloads.yml deleted file mode 100644 index c2326d6..0000000 --- a/.github/workflows/npm_downloads.yml +++ /dev/null @@ -1,112 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2022 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. -#/ - -# Workflow name: -name: npm_downloads - -# Workflow triggers: -on: - # Run this workflow weekly: - schedule: - # cron: ' ' - - cron: '48 12 * * 3' - - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job for retrieving npm download counts... - npm_downloads: - - # Define display name: - name: 'Retrieve npm download counts' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - timeout-minutes: 10 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Resolve package name: - - name: 'Resolve package name' - id: package_name - run: | - name=`node -e 'console.log(require("./package.json").name)' | tr -d '\n'` - echo "package_name=$name" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Fetch download data: - - name: 'Fetch data' - id: download_data - run: | - url="https://api.npmjs.org/downloads/range/$(date --date='1 year ago' '+%Y-%m-%d'):$(date '+%Y-%m-%d')/${{ steps.package_name.outputs.package_name }}" - echo "$url" - data=$(curl "$url") - mkdir ./tmp - echo "$data" > ./tmp/npm_downloads.json - echo "data=$data" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Print summary of download data: - - name: 'Print summary' - run: | - echo "| Date | Downloads |" >> $GITHUB_STEP_SUMMARY - echo "|------|------------|" >> $GITHUB_STEP_SUMMARY - cat ./tmp/npm_downloads.json | jq -r ".downloads | .[-14:] | to_entries | map(\"| \(.value.day) | \(.value.downloads) |\") |.[]" >> $GITHUB_STEP_SUMMARY - - # Upload the download data: - - name: 'Upload data' - # Pin action to full length commit SHA - uses: actions/upload-artifact@5d5d22a31266ced268874388b861e4b58bb5c2f3 # v4.3.1 - with: - # Define a name for the uploaded artifact (ensuring a unique name for each job): - name: npm_downloads - - # Specify the path to the file to upload: - path: ./tmp/npm_downloads.json - - # Specify the number of days to retain the artifact (default is 90 days): - retention-days: 90 - timeout-minutes: 10 - if: success() - - # Send data to events server: - - name: 'Post data' - # Pin action to full length commit SHA - uses: distributhor/workflow-webhook@48a40b380ce4593b6a6676528cd005986ae56629 # v3.0.3 - env: - webhook_url: ${{ secrets.STDLIB_NPM_DOWNLOADS_URL }} - webhook_secret: ${{ secrets.STDLIB_WEBHOOK_SECRET }} - data: '{ "downloads": ${{ steps.download_data.outputs.data }} }' - timeout-minutes: 5 - if: success() diff --git a/.github/workflows/productionize.yml b/.github/workflows/productionize.yml deleted file mode 100644 index f4575e9..0000000 --- a/.github/workflows/productionize.yml +++ /dev/null @@ -1,794 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2022 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. -#/ - -# Workflow name: -name: productionize - -# Workflow triggers: -on: - # Run workflow when a new commit is pushed to the main branch: - push: - branches: - - main - - # Allow the workflow to be manually run: - workflow_dispatch: - inputs: - require-passing-tests: - description: 'Require passing tests for creating bundles' - type: boolean - default: true - - # Run workflow upon completion of `publish` workflow run: - workflow_run: - workflows: ["publish"] - types: [completed] - - -# Concurrency group to prevent multiple concurrent executions: -concurrency: - group: productionize - cancel-in-progress: true - -# Workflow jobs: -jobs: - - # Define a job to create a production build... - productionize: - - # Define display name: - name: 'Productionize' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Define the sequence of job steps... - steps: - # Checkout main branch of repository: - - name: 'Checkout main branch' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - with: - ref: main - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Create production branch: - - name: 'Create production branch' - run: | - git checkout -b production - - # Transform error messages: - - name: 'Transform error messages' - id: transform-error-messages - uses: stdlib-js/transform-errors-action@main - - # 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: | - PKG_VERSION=$(npm view @stdlib/error-tools-fmtprodmsg version) - if grep -q '"@stdlib/string-format"' package.json; then - sed -i "s/\"@stdlib\/string-format\": \"^.*\"/\"@stdlib\/error-tools-fmtprodmsg\": \"^$PKG_VERSION\"/g" package.json - else - node -e "var pkg = require( './package.json' ); pkg.dependencies[ '@stdlib/error-tools-fmtprodmsg' ] = '^$PKG_VERSION'; require( 'fs' ).writeFileSync( 'package.json', JSON.stringify( pkg, null, 2 ) );" - fi - - # Configure Git: - - name: 'Configure Git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Transform error messages" - - # Push changes: - - name: 'Push changes' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" production --force - - # Define a job for running tests of the productionized code... - test: - - # Define a display name: - name: 'Run Tests' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Indicate that this job depends on the prior job finishing: - needs: productionize - - # Run this job regardless of the outcome of the prior job: - if: always() - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout repository' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - with: - # Use the `production` branch: - ref: production - - # Install Node.js: - - name: 'Install Node.js' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Build native add-on if present: - - name: 'Build native add-on (if present)' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - run: | - if [ -f "binding.gyp" ]; then - npm install node-gyp --no-save && ./node_modules/.bin/node-gyp rebuild - fi - - # Run tests: - - name: 'Run tests' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: tests - run: | - npm test || npm test || npm test - - # Define job to create a bundle for use in Deno... - deno: - - # Define display name: - name: 'Create Deno bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Configure Git: - - name: 'Configure Git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `deno` branch exists: - - name: 'Check if remote `deno` branch exists' - id: deno-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin deno - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `deno` exists, delete everything in branch and merge `production` into it - - name: 'If `deno` exists, delete everything in branch and merge `production` into it' - if: steps.deno-branch-exists.outputs.remote-exists - run: | - git checkout -b deno origin/deno - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `deno` does not exist, create `deno` branch: - - name: 'If `deno` does not exist, create `deno` branch' - if: ${{ steps.deno-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b deno - - # Copy files to deno directory: - - name: 'Copy files to deno directory' - run: | - mkdir -p deno - cp README.md LICENSE CONTRIBUTORS NOTICE ./deno - - # Copy TypeScript definitions to deno directory: - if [ -d index.d.ts ]; then - cp index.d.ts ./deno/index.d.ts - fi - if [ -e ./docs/types/index.d.ts ]; then - cp ./docs/types/index.d.ts ./deno/mod.d.ts - fi - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: Install production and development dependencies - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Bundle package for use in Deno: - - name: 'Bundle package for Deno' - id: deno-bundle - uses: stdlib-js/bundle-action@main - with: - target: 'deno' - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - # Replace links to other packages with links to the deno branch: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/deno/"; - - # Replace reference to `@stdlib/types` with CDN link: - find ./deno -type f -name '*.ts' -print0 | xargs -0 -r sed -Ei "s/\/\/\/ /\/\/\/ /g" - - # Change wording of project description to avoid reference to JavaScript and Node.js: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "s/a standard library for JavaScript and Node.js, /a standard library /g" - - # Rewrite all `require()`s to use jsDelivr links: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/require\( '@stdlib\// { - s/(var|let|const)\s+([a-z0-9_]+)\s+=\s*require\( '([^']+)' \);/import \2 from \'\3\';/i - s/@stdlib/https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js/ - s/';/@deno\/mod.js';/ - }" - - # Rewrite first `import` to show importing of named exports if available: - exports=$(cat lib/index.js | \ - grep -E 'setReadOnly\(.*,.*,.*\)' | \ - sed -E 's/setReadOnly\((.*),(.*),(.*)\);/\2/' | \ - sed -E "s/'//g" | \ - sort) - if [ -n "$exports" ]; then - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\nimport\s+([a-zA-Z0-9_]+)\s+from\s*'([^']+)';\n\`\`\`/\`\`\`javascript\nimport \1 from '\2';\n\`\`\`\n\nYou can also import the following named exports from the package:\n\n\`\`\`javascript\nimport { $(echo $exports | sed -E 's/ /, /g') } from '\2';\n\`\`\`/" - fi - - # Remove `installation`, `cli`, and `c` sections: - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Create package.json file for deno branch: - jq --indent 2 '{"name": .name, "version": .version, "description": .description, "license": .license, "type": "module", "main": "./mod.js", "homepage": .homepage, "repository": .repository, "bugs": .bugs, "keywords": .keywords, "funding": .funding}' package.json > ./deno/package.json - - # Delete everything in current directory aside from deno folder: - - name: 'Delete everything in current directory aside from deno folder' - run: | - find . -type 'f' | grep -v -e "deno" -e ".git/" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e "deno" -e ".git" | xargs -r rm -rf - - # Move deno directory to root: - - name: 'Move deno directory to root' - run: | - mv ./deno/* . - rmdir ./deno - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Auto-generated commit" - - # Push changes to `deno` branch: - - name: 'Push changes to `deno` branch' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" deno - - # Send status to Slack channel if job fails: - - name: 'Send status to Slack channel in case of failure' - # Pin action to full length commit SHA - uses: 8398a7/action-slack@28ba43ae48961b90635b50953d216767a6bea486 # v3.16.2 - with: - status: ${{ job.status }} - channel: '#npm-ci' - if: failure() - - # Define job to create a UMD bundle... - umd: - - # Define display name: - name: 'Create UMD bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Configure Git: - - name: 'Configure Git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `umd` branch exists: - - name: 'Check if remote `umd` branch exists' - id: umd-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin umd - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `umd` exists, delete everything in branch and merge `production` into it - - name: 'If `umd` exists, delete everything in branch and merge `production` into it' - if: steps.umd-branch-exists.outputs.remote-exists - run: | - git checkout -b umd origin/umd - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `umd` does not exist, create `umd` branch: - - name: 'If `umd` does not exist, create `umd` branch' - if: ${{ steps.umd-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b umd - - # Copy files to umd directory: - - name: 'Copy files to umd directory' - run: | - mkdir -p umd - cp README.md LICENSE CONTRIBUTORS NOTICE ./umd - - # Install Node.js - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Extract alias: - - name: 'Extract alias' - id: extract-alias - run: | - alias=$(grep -E 'require\(' README.md | head -n 1 | sed -E 's/^var ([a-zA-Z0-9_]+) = .+/\1/') - echo "alias=${alias}" >> $GITHUB_OUTPUT - - # Create Universal Module Definition (UMD) Node.js bundle: - - name: 'Create Universal Module Definition (UMD) Node.js bundle' - id: umd-bundle-node - uses: stdlib-js/bundle-action@main - with: - target: 'umd-node' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Create Universal Module Definition (UMD) browser bundle: - - name: 'Create Universal Module Definition (UMD) browser bundle' - id: umd-bundle-browser - uses: stdlib-js/bundle-action@main - with: - target: 'umd-browser' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - - # Replace links to other packages with links to the umd branch: - find ./umd -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/umd/"; - - # Remove `installation`, `cli`, and `c` sections: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Rewrite first `require()` to show consumption of the UMD bundle in Observable and via a `script` tag: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\n(var|let|const)\s+([a-zA-Z0-9_]+)\s+=\s*require\( '\@stdlib\/([^']+)' \);\n\`\`\`/To use in Observable,\n\n\`\`\`javascript\n\2 = require\( 'https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js\/\3\@umd\/browser.js' \)\n\`\`\`\n\nTo vendor stdlib functionality and avoid installing dependency trees for Node.js, you can use the UMD server build:\n\n\`\`\`javascript\nvar \2 = require\( 'path\/to\/vendor\/umd\/\3\/index.js' \)\n\`\`\`\n\nTo include the bundle in a webpage,\n\n\`\`\`html\n + + ```
@@ -189,7 +180,7 @@ var out = filter( x, naryFunction( isPositiveInteger, 1 ) ); ## 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. +This package is part of [stdlib][stdlib], a standard library 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]. diff --git a/SECURITY.md b/SECURITY.md deleted file mode 100644 index 9702d4c..0000000 --- a/SECURITY.md +++ /dev/null @@ -1,5 +0,0 @@ -# Security - -> Policy for reporting security vulnerabilities. - -See the security policy [in the main project repository](https://github.com/stdlib-js/stdlib/security). diff --git a/benchmark/benchmark.length.js b/benchmark/benchmark.length.js deleted file mode 100644 index bc79e33..0000000 --- a/benchmark/benchmark.length.js +++ /dev/null @@ -1,97 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 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 bench = require( '@stdlib/bench-harness' ); -var pow = require( '@stdlib/math-base-special-pow' ); -var isArray = require( '@stdlib/assert-is-array' ); -var isNonNegativeInteger = require( '@stdlib/assert-is-nonnegative-integer' ).isPrimitive; -var zeroTo = require( '@stdlib/array-base-zero-to' ); -var pkg = require( './../package.json' ).name; -var filter = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveInteger} len - array length -* @returns {Function} benchmark function -*/ -function createBenchmark( len ) { - var x = zeroTo( len ); - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var out; - var i; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - out = filter( x, isNonNegativeInteger ); - if ( typeof out !== 'object' ) { - b.fail( 'should return an array' ); - } - } - b.toc(); - if ( !isArray( out ) ) { - b.fail( 'should return an array' ); - } - b.pass( 'benchmark finished' ); - b.end(); - } -} - - -// MAIN // - -/** -* Main execution sequence. -* -* @private -*/ -function main() { - var len; - var min; - var max; - var f; - var i; - - min = 1; // 10^min - max = 6; // 10^max - - for ( i = min; i <= max; i++ ) { - len = pow( 10, i ); - - f = createBenchmark( len ); - bench( pkg+':dtype=generic,len='+len, f ); - } -} - -main(); diff --git a/branches.md b/branches.md deleted file mode 100644 index 9858901..0000000 --- a/branches.md +++ /dev/null @@ -1,56 +0,0 @@ - - -# Branches - -This repository has the following branches: - -- **main**: default branch generated from the [stdlib project][stdlib-url], where all development takes place. -- **production**: [production build][production-url] of the package (e.g., reformatted error messages to reduce bundle sizes and thus the number of bytes transmitted over a network). -- **esm**: [ES Module][esm-url] branch for use via a `script` tag without the need for installation and bundlers (see [README][esm-readme]). -- **deno**: [Deno][deno-url] branch for use in Deno (see [README][deno-readme]). -- **umd**: [UMD][umd-url] branch for use in Observable, or in dual browser/Node.js environments (see [README][umd-readme]). - -The following diagram illustrates the relationships among the above branches: - -```mermaid -graph TD; -A[stdlib]-->|generate standalone package|B; -B[main] -->|productionize| C[production]; -C -->|bundle| D[esm]; -C -->|bundle| E[deno]; -C -->|bundle| F[umd]; - -%% click A href "https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/filter" -%% click B href "https://github.com/stdlib-js/array-base-filter/tree/main" -%% click C href "https://github.com/stdlib-js/array-base-filter/tree/production" -%% click D href "https://github.com/stdlib-js/array-base-filter/tree/esm" -%% click E href "https://github.com/stdlib-js/array-base-filter/tree/deno" -%% click F href "https://github.com/stdlib-js/array-base-filter/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/filter -[production-url]: https://github.com/stdlib-js/array-base-filter/tree/production -[deno-url]: https://github.com/stdlib-js/array-base-filter/tree/deno -[deno-readme]: https://github.com/stdlib-js/array-base-filter/blob/deno/README.md -[umd-url]: https://github.com/stdlib-js/array-base-filter/tree/umd -[umd-readme]: https://github.com/stdlib-js/array-base-filter/blob/umd/README.md -[esm-url]: https://github.com/stdlib-js/array-base-filter/tree/esm -[esm-readme]: https://github.com/stdlib-js/array-base-filter/blob/esm/README.md \ No newline at end of file diff --git a/dist/index.d.ts b/dist/index.d.ts deleted file mode 100644 index aafb9cb..0000000 --- a/dist/index.d.ts +++ /dev/null @@ -1,3 +0,0 @@ -/// -import filter from '../docs/types/index'; -export = filter; \ No newline at end of file diff --git a/dist/index.js b/dist/index.js deleted file mode 100644 index 5c2f789..0000000 --- a/dist/index.js +++ /dev/null @@ -1,5 +0,0 @@ -"use strict";var s=function(r,t){return function(){return t||r((t={exports:{}}).exports,t),t.exports}};var f=s(function(y,c){ -var v=require('@stdlib/array-base-arraylike2object/dist');function l(r,t){return typeof r[t]=="function"}function h(r,t,n){var e,o,a;for(e=[],a=0;a 0;\n* }\n*\n* var x = [ 1, -2, -3, 4 ];\n*\n* var out = internal( x, isPositive );\n* // returns [ 1, 4 ]\n*/\nfunction internal( x, predicate, thisArg ) {\n\tvar out;\n\tvar v;\n\tvar i;\n\n\tout = [];\n\tfor ( i = 0; i < x.length; i++ ) {\n\t\tv = x[ i ];\n\t\tif ( predicate.call( thisArg, v, i, x ) ) {\n\t\t\tout.push( v );\n\t\t}\n\t}\n\treturn out;\n}\n\n/**\n* Returns a shallow copy of an array containing only those elements which pass a test implemented by a predicate function.\n*\n* @private\n* @param {Object} x - input array object\n* @param {Function} predicate - test function\n* @param {*} thisArg - execution context\n* @returns {Array} output array\n*\n* @example\n* var toAccessorArray = require( '@stdlib/array-base-to-accessor-array' );\n* var arraylike2object = require( '@stdlib/array-base-arraylike2object' );\n*\n* function isPositive( v ) {\n* return v > 0;\n* }\n*\n* var x = arraylike2object( toAccessorArray( [ 1, -2, -3, 4 ] ) );\n*\n* var out = accessors( x, isPositive );\n* // returns [ 1, 4 ]\n*/\nfunction accessors( x, predicate, thisArg ) {\n\tvar data;\n\tvar get;\n\tvar out;\n\tvar v;\n\tvar i;\n\n\tdata = x.data;\n\tget = x.accessors[ 0 ];\n\n\tout = [];\n\tfor ( i = 0; i < data.length; i++ ) {\n\t\tv = get( data, i );\n\t\tif ( predicate.call( thisArg, v, i, data ) ) {\n\t\t\tout.push( v );\n\t\t}\n\t}\n\treturn out;\n}\n\n\n// MAIN //\n\n/**\n* Returns a shallow copy of an array containing only those elements which pass a test implemented by a predicate function.\n*\n* @param {Collection} x - input array\n* @param {Function} predicate - test function\n* @param {*} [thisArg] - execution context\n* @returns {Collection} output array\n*\n* @example\n* function isPositive( v ) {\n* return v > 0;\n* }\n*\n* var x = [ 1, -2, -3, 4 ];\n*\n* var out = filter( x, isPositive );\n* // returns [ 1, 4 ]\n*/\nfunction filter( x, predicate, thisArg ) {\n\tvar obj;\n\tif ( hasMethod( x, 'filter' ) ) {\n\t\treturn x.filter( predicate, thisArg );\n\t}\n\tobj = arraylike2object( x );\n\tif ( obj.accessorProtocol ) {\n\t\treturn accessors( obj, predicate, thisArg );\n\t}\n\treturn internal( x, predicate, thisArg );\n}\n\n\n// EXPORTS //\n\nmodule.exports = filter;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2024 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* Return a shallow copy of an array containing only those elements which pass a test implemented by a predicate function.\n*\n* @module @stdlib/array-base-filter\n*\n* @example\n* var filter = require( '@stdlib/array-base-filter' );\n*\n* function isPositive( v ) {\n* return v > 0;\n* }\n*\n* var x = [ 1, -2, -3, 4 ];\n*\n* var out = filter( x, isPositive );\n* // returns [ 1, 4 ]\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,EAAmB,QAAS,qCAAsC,EAqBtE,SAASC,EAAWC,EAAKC,EAAS,CACjC,OAAS,OAAOD,EAAKC,CAAO,GAAM,UACnC,CAqBA,SAASC,EAAUC,EAAGC,EAAWC,EAAU,CAC1C,IAAIC,EACAC,EACAC,EAGJ,IADAF,EAAM,CAAC,EACDE,EAAI,EAAGA,EAAIL,EAAE,OAAQK,IAC1BD,EAAIJ,EAAGK,CAAE,EACJJ,EAAU,KAAMC,EAASE,EAAGC,EAAGL,CAAE,GACrCG,EAAI,KAAMC,CAAE,EAGd,OAAOD,CACR,CAwBA,SAASG,EAAWN,EAAGC,EAAWC,EAAU,CAC3C,IAAIK,EACAC,EACAL,EACAC,EACAC,EAMJ,IAJAE,EAAOP,EAAE,KACTQ,EAAMR,EAAE,UAAW,CAAE,EAErBG,EAAM,CAAC,EACDE,EAAI,EAAGA,EAAIE,EAAK,OAAQF,IAC7BD,EAAII,EAAKD,EAAMF,CAAE,EACZJ,EAAU,KAAMC,EAASE,EAAGC,EAAGE,CAAK,GACxCJ,EAAI,KAAMC,CAAE,EAGd,OAAOD,CACR,CAuBA,SAASM,EAAQT,EAAGC,EAAWC,EAAU,CACxC,IAAIL,EACJ,OAAKD,EAAWI,EAAG,QAAS,EACpBA,EAAE,OAAQC,EAAWC,CAAQ,GAErCL,EAAMF,EAAkBK,CAAE,EACrBH,EAAI,iBACDS,EAAWT,EAAKI,EAAWC,CAAQ,EAEpCH,EAAUC,EAAGC,EAAWC,CAAQ,EACxC,CAKAR,EAAO,QAAUe,ICvHjB,IAAIC,EAAO,IAKX,OAAO,QAAUA", - "names": ["require_main", "__commonJSMin", "exports", "module", "arraylike2object", "hasMethod", "obj", "method", "internal", "x", "predicate", "thisArg", "out", "v", "i", "accessors", "data", "get", "filter", "main"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index bb2b17a..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,46 +0,0 @@ - -{{alias}}( x, predicate[, thisArg] ) - Returns a shallow copy of an array containing only those elements which pass - a test implemented by a predicate function. - - The predicate function is provided three arguments: - - - value: current array element. - - index: current array element index. - - arr: the input array. - - If provided an array-like object having a `filter` method , the function - defers execution to that method and assumes that the method has the - following signature: - - x.filter( predicate, thisArg ) - - If provided an array-like object without a `filter` method, the function - performs a linear scan and always returns a generic array. - - Parameters - ---------- - x: Array|TypedArray|Object - Input array. - - predicate: Function - Predicate function. - - thisArg: any (optional) - Execution context. - - Returns - ------- - out: Array|TypedArray|Object - Output array. - - Examples - -------- - > function f( v ) { return ( v > 0 ); }; - > var x = [ 1, -2, -3, 4 ]; - > var out = {{alias}}( x, f ) - [ 1, 4 ] - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index db0c38d..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,101 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2024 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. -*/ - -import toAccessorArray = require( '@stdlib/array-base-to-accessor-array' ); -import filter = require( './index' ); - -/** -* Tests whether a value is positive. -* -* @param value - input value -* @returns boolean indicating whether an element is positive -*/ -function isPositive( value: number ): boolean { - return ( value > 0 ); -} - - -// TESTS // - -// The function returns a collection... -{ - filter( [ 1, 2, 3 ], isPositive ); // $ExpectType number[] - filter( new Float64Array( [ 1, 2, 3 ] ), isPositive ); // $ExpectType Float64Array - filter( new Float32Array( [ 1, 2, 3 ] ), isPositive ); // $ExpectType Float32Array - filter( new Int32Array( [ 1, 2, 3 ] ), isPositive ); // $ExpectType Int32Array - filter( new Int16Array( [ 1, 2, 3 ] ), isPositive ); // $ExpectType Int16Array - filter( new Int8Array( [ 1, 2, 3 ] ), isPositive ); // $ExpectType Int8Array - filter( new Uint32Array( [ 1, 2, 3 ] ), isPositive ); // $ExpectType Uint32Array - filter( new Uint16Array( [ 1, 2, 3 ] ), isPositive ); // $ExpectType Uint16Array - filter( new Uint8Array( [ 1, 2, 3 ] ), isPositive ); // $ExpectType Uint8Array - filter( new Uint8ClampedArray( [ 1, 2, 3 ] ), isPositive ); // $ExpectType Uint8ClampedArray - filter( toAccessorArray( [ 1, 2, 3 ] ), isPositive ); // $ExpectType number[] - - filter( [ 1, 2, 3 ], isPositive, {} ); // $ExpectType number[] - filter( new Float64Array( [ 1, 2, 3 ] ), isPositive, {} ); // $ExpectType Float64Array - filter( new Float32Array( [ 1, 2, 3 ] ), isPositive, {} ); // $ExpectType Float32Array - filter( new Int32Array( [ 1, 2, 3 ] ), isPositive, {} ); // $ExpectType Int32Array - filter( new Int16Array( [ 1, 2, 3 ] ), isPositive, {} ); // $ExpectType Int16Array - filter( new Int8Array( [ 1, 2, 3 ] ), isPositive, {} ); // $ExpectType Int8Array - filter( new Uint32Array( [ 1, 2, 3 ] ), isPositive, {} ); // $ExpectType Uint32Array - filter( new Uint16Array( [ 1, 2, 3 ] ), isPositive, {} ); // $ExpectType Uint16Array - filter( new Uint8Array( [ 1, 2, 3 ] ), isPositive, {} ); // $ExpectType Uint8Array - filter( new Uint8ClampedArray( [ 1, 2, 3 ] ), isPositive, {} ); // $ExpectType Uint8ClampedArray - filter( toAccessorArray( [ 1, 2, 3 ] ), isPositive, {} ); // $ExpectType number[] -} - -// The compiler throws an error if the function is provided a first argument which is not a collection... -{ - filter( 2, isPositive ); // $ExpectError - filter( false, isPositive ); // $ExpectError - filter( true, isPositive ); // $ExpectError - filter( {}, isPositive ); // $ExpectError - - filter( 2, isPositive, {} ); // $ExpectError - filter( false, isPositive, {} ); // $ExpectError - filter( true, isPositive, {} ); // $ExpectError - filter( {}, isPositive, {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided a second argument which is not a function... -{ - filter( [ 1, 2, 3 ], 'abc' ); // $ExpectError - filter( [ 1, 2, 3 ], 2 ); // $ExpectError - filter( [ 1, 2, 3 ], false ); // $ExpectError - filter( [ 1, 2, 3 ], true ); // $ExpectError - filter( [ 1, 2, 3 ], null ); // $ExpectError - filter( [ 1, 2, 3 ], void 0 ); // $ExpectError - filter( [ 1, 2, 3 ], {} ); // $ExpectError - filter( [ 1, 2, 3 ], [] ); // $ExpectError - - filter( [ 1, 2, 3 ], 'abc', {} ); // $ExpectError - filter( [ 1, 2, 3 ], 2, {} ); // $ExpectError - filter( [ 1, 2, 3 ], false, {} ); // $ExpectError - filter( [ 1, 2, 3 ], true, {} ); // $ExpectError - filter( [ 1, 2, 3 ], null, {} ); // $ExpectError - filter( [ 1, 2, 3 ], void 0, {} ); // $ExpectError - filter( [ 1, 2, 3 ], {}, {} ); // $ExpectError - filter( [ 1, 2, 3 ], [], {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided an unsupported number of arguments... -{ - filter(); // $ExpectError - filter( [ 1, 2, 3 ] ); // $ExpectError - filter( [ 1, 2, 3 ], isPositive, {}, 3 ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index cdfb9a7..0000000 --- a/examples/index.js +++ /dev/null @@ -1,35 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 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'; - -var discreteUniform = require( '@stdlib/random-array-discrete-uniform' ); -var isPositiveInteger = require( '@stdlib/assert-is-positive-integer' ).isPrimitive; -var naryFunction = require( '@stdlib/utils-nary-function' ); -var filter = require( './../lib' ); - -var x = discreteUniform( 10, -5, 5, { - 'dtype': 'int32' -}); -// returns - -var out = filter( x, naryFunction( isPositiveInteger, 1 ) ); -// returns - -console.log( x ); -console.log( out ); diff --git a/docs/types/index.d.ts b/index.d.ts similarity index 99% rename from docs/types/index.d.ts rename to index.d.ts index 730dc98..c5c8ca7 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 4.1 -/// +/// import { Collection, AccessorArrayLike, Complex128Array, Complex64Array } from '@stdlib/types/array'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..9c58a52 --- /dev/null +++ b/index.mjs @@ -0,0 +1,4 @@ +// Copyright (c) 2025 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 +/// +import r from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-arraylike2object@v0.2.1-esm/index.mjs";function t(t,e,n){var o;return function(r,t){return"function"==typeof r[t]}(t,"filter")?t.filter(e,n):(o=r(t)).accessorProtocol?function(r,t,e){var n,o,a,s,c;for(n=r.data,o=r.accessors[0],a=[],c=0;c 0;\n* }\n*\n* var x = [ 1, -2, -3, 4 ];\n*\n* var out = internal( x, isPositive );\n* // returns [ 1, 4 ]\n*/\nfunction internal( x, predicate, thisArg ) {\n\tvar out;\n\tvar v;\n\tvar i;\n\n\tout = [];\n\tfor ( i = 0; i < x.length; i++ ) {\n\t\tv = x[ i ];\n\t\tif ( predicate.call( thisArg, v, i, x ) ) {\n\t\t\tout.push( v );\n\t\t}\n\t}\n\treturn out;\n}\n\n/**\n* Returns a shallow copy of an array containing only those elements which pass a test implemented by a predicate function.\n*\n* @private\n* @param {Object} x - input array object\n* @param {Function} predicate - test function\n* @param {*} thisArg - execution context\n* @returns {Array} output array\n*\n* @example\n* import toAccessorArray from '@stdlib/array-base-to-accessor-array';\n* import arraylike2object from '@stdlib/array-base-arraylike2object';\n*\n* function isPositive( v ) {\n* return v > 0;\n* }\n*\n* var x = arraylike2object( toAccessorArray( [ 1, -2, -3, 4 ] ) );\n*\n* var out = accessors( x, isPositive );\n* // returns [ 1, 4 ]\n*/\nfunction accessors( x, predicate, thisArg ) {\n\tvar data;\n\tvar get;\n\tvar out;\n\tvar v;\n\tvar i;\n\n\tdata = x.data;\n\tget = x.accessors[ 0 ];\n\n\tout = [];\n\tfor ( i = 0; i < data.length; i++ ) {\n\t\tv = get( data, i );\n\t\tif ( predicate.call( thisArg, v, i, data ) ) {\n\t\t\tout.push( v );\n\t\t}\n\t}\n\treturn out;\n}\n\n\n// MAIN //\n\n/**\n* Returns a shallow copy of an array containing only those elements which pass a test implemented by a predicate function.\n*\n* @param {Collection} x - input array\n* @param {Function} predicate - test function\n* @param {*} [thisArg] - execution context\n* @returns {Collection} output array\n*\n* @example\n* function isPositive( v ) {\n* return v > 0;\n* }\n*\n* var x = [ 1, -2, -3, 4 ];\n*\n* var out = filter( x, isPositive );\n* // returns [ 1, 4 ]\n*/\nfunction filter( x, predicate, thisArg ) {\n\tvar obj;\n\tif ( hasMethod( x, 'filter' ) ) {\n\t\treturn x.filter( predicate, thisArg );\n\t}\n\tobj = arraylike2object( x );\n\tif ( obj.accessorProtocol ) {\n\t\treturn accessors( obj, predicate, thisArg );\n\t}\n\treturn internal( x, predicate, thisArg );\n}\n\n\n// EXPORTS //\n\nexport default filter;\n"],"names":["filter","x","predicate","thisArg","obj","method","hasMethod","arraylike2object","accessorProtocol","data","get","out","v","i","accessors","length","call","push","internal"],"mappings":";;sGAgJA,SAASA,EAAQC,EAAGC,EAAWC,GAC9B,IAAIC,EACJ,OAvGD,SAAoBA,EAAKC,GACxB,MAAkC,mBAAlBD,EAAKC,EACtB,CAqGMC,CAAWL,EAAG,UACXA,EAAED,OAAQE,EAAWC,IAE7BC,EAAMG,EAAkBN,IACfO,iBA/CV,SAAoBP,EAAGC,EAAWC,GACjC,IAAIM,EACAC,EACAC,EACAC,EACAC,EAMJ,IAJAJ,EAAOR,EAAEQ,KACTC,EAAMT,EAAEa,UAAW,GAEnBH,EAAM,GACAE,EAAI,EAAGA,EAAIJ,EAAKM,OAAQF,IAC7BD,EAAIF,EAAKD,EAAMI,GACVX,EAAUc,KAAMb,EAASS,EAAGC,EAAGJ,IACnCE,EAAIM,KAAML,GAGZ,OAAOD,CACR,CA8BSG,CAAWV,EAAKF,EAAWC,GArFpC,SAAmBF,EAAGC,EAAWC,GAChC,IAAIQ,EACAC,EACAC,EAGJ,IADAF,EAAM,GACAE,EAAI,EAAGA,EAAIZ,EAAEc,OAAQF,IAC1BD,EAAIX,EAAGY,GACFX,EAAUc,KAAMb,EAASS,EAAGC,EAAGZ,IACnCU,EAAIM,KAAML,GAGZ,OAAOD,CACR,CA0EQO,CAAUjB,EAAGC,EAAWC,EAChC"} \ No newline at end of file diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index 56236cd..0000000 --- a/lib/index.js +++ /dev/null @@ -1,46 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 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'; - -/** -* Return a shallow copy of an array containing only those elements which pass a test implemented by a predicate function. -* -* @module @stdlib/array-base-filter -* -* @example -* var filter = require( '@stdlib/array-base-filter' ); -* -* function isPositive( v ) { -* return v > 0; -* } -* -* var x = [ 1, -2, -3, 4 ]; -* -* var out = filter( x, isPositive ); -* // returns [ 1, 4 ] -*/ - -// MODULES // - -var main = require( './main.js' ); - - -// EXPORTS // - -module.exports = main; diff --git a/lib/main.js b/lib/main.js deleted file mode 100644 index 9b0c3db..0000000 --- a/lib/main.js +++ /dev/null @@ -1,160 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 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 arraylike2object = require( '@stdlib/array-base-arraylike2object' ); - - -// FUNCTIONS // - -/** -* Tests whether an object has a specified method. -* -* @private -* @param {Object} obj - input object -* @param {string} method - method name -* @returns {boolean} boolean indicating whether an object has a specified method -* -* @example -* var bool = hasMethod( [], 'filter' ); -* // returns true -* -* @example -* var bool = hasMethod( [], 'beep' ); -* // returns false -*/ -function hasMethod( obj, method ) { - return ( typeof obj[ method ] === 'function' ); -} - -/** -* Returns a shallow copy of an array containing only those elements which pass a test implemented by a predicate function. -* -* @private -* @param {Collection} x - input array -* @param {Function} predicate - test function -* @param {*} thisArg - execution context -* @returns {Array} output array -* -* @example -* function isPositive( v ) { -* return v > 0; -* } -* -* var x = [ 1, -2, -3, 4 ]; -* -* var out = internal( x, isPositive ); -* // returns [ 1, 4 ] -*/ -function internal( x, predicate, thisArg ) { - var out; - var v; - var i; - - out = []; - for ( i = 0; i < x.length; i++ ) { - v = x[ i ]; - if ( predicate.call( thisArg, v, i, x ) ) { - out.push( v ); - } - } - return out; -} - -/** -* Returns a shallow copy of an array containing only those elements which pass a test implemented by a predicate function. -* -* @private -* @param {Object} x - input array object -* @param {Function} predicate - test function -* @param {*} thisArg - execution context -* @returns {Array} output array -* -* @example -* var toAccessorArray = require( '@stdlib/array-base-to-accessor-array' ); -* var arraylike2object = require( '@stdlib/array-base-arraylike2object' ); -* -* function isPositive( v ) { -* return v > 0; -* } -* -* var x = arraylike2object( toAccessorArray( [ 1, -2, -3, 4 ] ) ); -* -* var out = accessors( x, isPositive ); -* // returns [ 1, 4 ] -*/ -function accessors( x, predicate, thisArg ) { - var data; - var get; - var out; - var v; - var i; - - data = x.data; - get = x.accessors[ 0 ]; - - out = []; - for ( i = 0; i < data.length; i++ ) { - v = get( data, i ); - if ( predicate.call( thisArg, v, i, data ) ) { - out.push( v ); - } - } - return out; -} - - -// MAIN // - -/** -* Returns a shallow copy of an array containing only those elements which pass a test implemented by a predicate function. -* -* @param {Collection} x - input array -* @param {Function} predicate - test function -* @param {*} [thisArg] - execution context -* @returns {Collection} output array -* -* @example -* function isPositive( v ) { -* return v > 0; -* } -* -* var x = [ 1, -2, -3, 4 ]; -* -* var out = filter( x, isPositive ); -* // returns [ 1, 4 ] -*/ -function filter( x, predicate, thisArg ) { - var obj; - if ( hasMethod( x, 'filter' ) ) { - return x.filter( predicate, thisArg ); - } - obj = arraylike2object( x ); - if ( obj.accessorProtocol ) { - return accessors( obj, predicate, thisArg ); - } - return internal( x, predicate, thisArg ); -} - - -// EXPORTS // - -module.exports = filter; diff --git a/package.json b/package.json index 317e1f2..20cda5b 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.2.2", "description": "Return a shallow copy of an array containing only those elements which pass a test implemented by a predicate function.", "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", - "directories": { - "benchmark": "./benchmark", - "doc": "./docs", - "example": "./examples", - "lib": "./lib", - "test": "./test" - }, - "types": "./docs/types", - "scripts": { - "test": "make test", - "test-cov": "make test-cov", - "examples": "make examples", - "benchmark": "make benchmark" - }, + "type": "module", + "main": "./index.mjs", "homepage": "https://stdlib.io", "repository": { "type": "git", @@ -36,42 +13,6 @@ "bugs": { "url": "https://github.com/stdlib-js/stdlib/issues" }, - "dependencies": { - "@stdlib/array-base-arraylike2object": "^0.2.1", - "@stdlib/types": "^0.4.3", - "@stdlib/error-tools-fmtprodmsg": "^0.2.2" - }, - "devDependencies": { - "@stdlib/array-base-accessor": "^0.2.2", - "@stdlib/array-base-zero-to": "^0.2.1", - "@stdlib/array-float64": "^0.2.2", - "@stdlib/assert-instance-of": "^0.2.2", - "@stdlib/assert-is-array": "^0.2.2", - "@stdlib/assert-is-nonnegative-integer": "^0.2.2", - "@stdlib/assert-is-positive-integer": "^0.2.2", - "@stdlib/math-base-special-pow": "^0.3.0", - "@stdlib/random-array-discrete-uniform": "^0.2.1", - "@stdlib/utils-nary-function": "^0.2.2", - "tape": "git+https://github.com/kgryte/tape.git#fix/globby", - "istanbul": "^0.4.1", - "tap-min": "git+https://github.com/Planeshifter/tap-min.git", - "@stdlib/bench-harness": "^0.2.2" - }, - "engines": { - "node": ">=0.10.0", - "npm": ">2.7.0" - }, - "os": [ - "aix", - "darwin", - "freebsd", - "linux", - "macos", - "openbsd", - "sunos", - "win32", - "windows" - ], "keywords": [ "stdlib", "stdtypes", @@ -91,4 +32,4 @@ "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} \ No newline at end of file +} diff --git a/stats.html b/stats.html new file mode 100644 index 0000000..d4d08f0 --- /dev/null +++ b/stats.html @@ -0,0 +1,4842 @@ + + + + + + + + Rollup Visualizer + + + +
+ + + + + diff --git a/test/dist/test.js b/test/dist/test.js deleted file mode 100644 index a8a9c60..0000000 --- a/test/dist/test.js +++ /dev/null @@ -1,33 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 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 tape = require( 'tape' ); -var main = require( './../../dist' ); - - -// TESTS // - -tape( 'main export is defined', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( main !== void 0, true, 'main export is defined' ); - t.end(); -}); diff --git a/test/test.js b/test/test.js deleted file mode 100644 index d4e7373..0000000 --- a/test/test.js +++ /dev/null @@ -1,251 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 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 tape = require( 'tape' ); -var AccessorArray = require( '@stdlib/array-base-accessor' ); -var Float64Array = require( '@stdlib/array-float64' ); -var instanceOf = require( '@stdlib/assert-instance-of' ); -var filter = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Tests whether a value is positive. -* -* @private -* @param {number} value - input value -* @returns {boolean} boolean indicating if a value is positive -*/ -function isPositive( value ) { - return ( value > 0 ); -} - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof filter, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'if provided an empty collection, the function returns an empty collection (generic)', function test( t ) { - var expected; - var actual; - var arr; - - arr = []; - expected = []; - actual = filter( arr, foo ); - - t.strictEqual( instanceOf( actual, Array ), true, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - t.end(); - - function foo() { - t.fail( 'should not be invoked' ); - } -}); - -tape( 'if provided an empty collection, the function returns an empty collection (typed array)', function test( t ) { - var expected; - var actual; - var arr; - - arr = new Float64Array( [] ); - expected = new Float64Array( [] ); - actual = filter( arr, foo ); - - t.strictEqual( instanceOf( actual, Float64Array ), true, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - t.end(); - - function foo() { - t.fail( 'should not be invoked' ); - } -}); - -tape( 'if provided an empty collection, the function returns an empty collection (accessor)', function test( t ) { - var expected; - var actual; - var arr; - - arr = new AccessorArray( [] ); - expected = []; - actual = filter( arr, foo ); - - t.strictEqual( instanceOf( actual, Array ), true, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - t.end(); - - function foo() { - t.fail( 'should not be invoked' ); - } -}); - -tape( 'the function filters a provided collection (generic)', function test( t ) { - var expected; - var actual; - var arr; - - arr = [ 1, -2, 3 ]; - expected = [ 1, 3 ]; - actual = filter( arr, isPositive ); - - t.strictEqual( instanceOf( actual, Array ), true, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - t.end(); -}); - -tape( 'the function filters a provided collection (typed array)', function test( t ) { - var expected; - var actual; - var arr; - - arr = new Float64Array( [ -1.0, 2.0, 3.0 ] ); - expected = new Float64Array( [ 2.0, 3.0 ] ); - actual = filter( arr, isPositive ); - - t.strictEqual( instanceOf( actual, Float64Array ), true, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - t.end(); -}); - -tape( 'the function filters a provided collection (accessor)', function test( t ) { - var expected; - var actual; - var arr; - - arr = new AccessorArray( [ 1, -2, -3 ] ); - expected = [ 1 ]; - actual = filter( arr, isPositive ); - - t.strictEqual( instanceOf( actual, Array ), true, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - t.end(); -}); - -tape( 'the function filters a provided collection (array-like object)', function test( t ) { - var expected; - var actual; - var arr; - - arr = { - 'length': 3, - '0': -1, - '1': -2, - '2': 3 - }; - expected = [ 3 ]; - actual = filter( arr, isPositive ); - - t.strictEqual( instanceOf( actual, Array ), true, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - t.end(); -}); - -tape( 'the function an empty collection if all elements fail a test (generic)', function test( t ) { - var expected; - var actual; - var arr; - - arr = [ -1, -2, -3 ]; - expected = []; - actual = filter( arr, isPositive ); - - t.strictEqual( instanceOf( actual, Array ), true, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - t.end(); -}); - -tape( 'the function an empty collection if all elements fail a test (typed array)', function test( t ) { - var expected; - var actual; - var arr; - - arr = new Float64Array( [ -1.0, -2.0, -3.0 ] ); - expected = new Float64Array( [] ); - actual = filter( arr, isPositive ); - - t.strictEqual( instanceOf( actual, Float64Array ), true, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - t.end(); -}); - -tape( 'the function an empty collection if all elements fail a test (accessor)', function test( t ) { - var expected; - var actual; - var arr; - - arr = new AccessorArray( [ -1, -2, -3 ] ); - expected = []; - actual = filter( arr, isPositive ); - - t.strictEqual( instanceOf( actual, Array ), true, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - t.end(); -}); - -tape( 'the function an empty collection if all elements fail a test (array-like object)', function test( t ) { - var expected; - var actual; - var arr; - - arr = { - 'length': 3, - '0': -1, - '1': -2, - '2': -3 - }; - expected = []; - actual = filter( arr, isPositive ); - - t.strictEqual( instanceOf( actual, Array ), true, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - t.end(); -}); - -tape( 'the function supports providing an execution context', function test( t ) { - var expected; - var actual; - var ctx; - var arr; - - ctx = { - 'count': 0 - }; - arr = [ 1, 2, 3 ]; - expected = [ 1, 2, 3 ]; - actual = filter( arr, predicate, ctx ); - - t.strictEqual( instanceOf( actual, Array ), true, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - t.strictEqual( ctx.count, arr.length, 'returns expected value' ); - - t.end(); - - function predicate( value ) { - this.count += 1; // eslint-disable-line no-invalid-this - return ( value > 0 ); - } -}); From 4a9aab08fd446381d191c4be252399be69a71ce0 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Tue, 24 Jun 2025 15:43:24 +0000 Subject: [PATCH 38/40] Transform error messages --- package.json | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/package.json b/package.json index 4c62951..317e1f2 100644 --- a/package.json +++ b/package.json @@ -38,7 +38,8 @@ }, "dependencies": { "@stdlib/array-base-arraylike2object": "^0.2.1", - "@stdlib/types": "^0.4.3" + "@stdlib/types": "^0.4.3", + "@stdlib/error-tools-fmtprodmsg": "^0.2.2" }, "devDependencies": { "@stdlib/array-base-accessor": "^0.2.2", @@ -90,4 +91,4 @@ "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} +} \ No newline at end of file From e155c67e41a8f2306b74e5e5f5a1cfa459cd0383 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Tue, 24 Jun 2025 15:44:54 +0000 Subject: [PATCH 39/40] Remove files --- index.d.ts | 343 ---- index.mjs | 4 - index.mjs.map | 1 - stats.html | 4842 ------------------------------------------------- 4 files changed, 5190 deletions(-) delete mode 100644 index.d.ts delete mode 100644 index.mjs delete mode 100644 index.mjs.map delete mode 100644 stats.html diff --git a/index.d.ts b/index.d.ts deleted file mode 100644 index c5c8ca7..0000000 --- a/index.d.ts +++ /dev/null @@ -1,343 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2024 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 - -/// - -import { Collection, AccessorArrayLike, Complex128Array, Complex64Array } from '@stdlib/types/array'; - -/** -* Returns a boolean indicating whether an element passes a test. -* -* @returns boolean indicating whether an element passes a test -*/ -type Nullary = ( this: U ) => boolean; - -/** -* Returns a boolean indicating whether an element passes a test. -* -* @param value - current array element -* @returns boolean indicating whether an element passes a test -*/ -type Unary = ( this: U, value: T ) => boolean; - -/** -* Returns a boolean indicating whether an element passes a test. -* -* @param value - current array element -* @param index - current array element index -* @returns boolean indicating whether an element passes a test -*/ -type Binary = ( this: U, value: T, index: number ) => boolean; - -/** -* Returns a boolean indicating whether an element passes a test. -* -* @param value - current array element -* @param index - current array element index -* @param arr - input array -* @returns boolean indicating whether an element passes a test -*/ -type Ternary = ( this: U, value: T, index: number, arr: V ) => boolean; - -/** -* Returns a boolean indicating whether an element passes a test. -* -* @param value - current array element -* @param index - current array element index -* @param arr - input array -* @returns boolean indicating whether an element passes a test -*/ -type Predicate = Nullary | Unary | Binary | Ternary; - -/** -* Returns a shallow copy of an array containing only those elements which pass a test implemented by a predicate function. -* -* @param x - input array -* @param predicate - predicate function -* @param thisArg - predicate function execution context -* @returns output array -* -* @example -* var isPositiveNumber = require( '@stdlib/assert-is-positive-number' ).isPrimitive; -* var Float64Array = require( '@stdlib/array-float64' ); -* -* var x = new Float64Array( [ 1.0, -2.0, -3.0, 4.0 ] ); -* -* var out = filter( x, isPositiveNumber ); -* // returns [ 1.0, 4.0 ] -*/ -declare function filter( x: Float64Array, predicate: Predicate, thisArg?: ThisParameterType> ): Float64Array; - -/** -* Returns a shallow copy of an array containing only those elements which pass a test implemented by a predicate function. -* -* @param x - input array -* @param predicate - predicate function -* @param thisArg - predicate function execution context -* @returns output array -* -* @example -* var isPositiveNumber = require( '@stdlib/assert-is-positive-number' ).isPrimitive; -* var Float32Array = require( '@stdlib/array-float32' ); -* -* var x = new Float32Array( [ 1.0, -2.0, -3.0, 4.0 ] ); -* -* var out = filter( x, isPositiveNumber ); -* // returns [ 1.0, 4.0 ] -*/ -declare function filter( x: Float32Array, predicate: Predicate, thisArg?: ThisParameterType> ): Float32Array; - -/** -* Returns a shallow copy of an array containing only those elements which pass a test implemented by a predicate function. -* -* @param x - input array -* @param predicate - predicate function -* @param thisArg - predicate function execution context -* @returns output array -* -* @example -* var isPositiveNumber = require( '@stdlib/assert-is-positive-number' ).isPrimitive; -* var Int32Array = require( '@stdlib/array-int32' ); -* -* var x = new Int32Array( [ 1, -2, -3, 4 ] ); -* -* var out = filter( x, isPositiveNumber ); -* // returns [ 1, 4 ] -*/ -declare function filter( x: Int32Array, predicate: Predicate, thisArg?: ThisParameterType> ): Int32Array; - -/** -* Returns a shallow copy of an array containing only those elements which pass a test implemented by a predicate function. -* -* @param x - input array -* @param predicate - predicate function -* @param thisArg - predicate function execution context -* @returns output array -* -* @example -* var isPositiveNumber = require( '@stdlib/assert-is-positive-number' ).isPrimitive; -* var Int16Array = require( '@stdlib/array-int16' ); -* -* var x = new Int16Array( [ 1, -2, -3, 4 ] ); -* -* var out = filter( x, isPositiveNumber ); -* // returns [ 1, 4 ] -*/ -declare function filter( x: Int16Array, predicate: Predicate, thisArg?: ThisParameterType> ): Int16Array; - -/** -* Returns a shallow copy of an array containing only those elements which pass a test implemented by a predicate function. -* -* @param x - input array -* @param predicate - predicate function -* @param thisArg - predicate function execution context -* @returns output array -* -* @example -* var isPositiveNumber = require( '@stdlib/assert-is-positive-number' ).isPrimitive; -* var Int8Array = require( '@stdlib/array-int8' ); -* -* var x = new Int8Array( [ 1, -2, -3, 4 ] ); -* -* var out = filter( x, isPositiveNumber ); -* // returns [ 1, 4 ] -*/ -declare function filter( x: Int8Array, predicate: Predicate, thisArg?: ThisParameterType> ): Int8Array; - -/** -* Returns a shallow copy of an array containing only those elements which pass a test implemented by a predicate function. -* -* @param x - input array -* @param predicate - predicate function -* @param thisArg - predicate function execution context -* @returns output array -* -* @example -* var isPositiveNumber = require( '@stdlib/assert-is-positive-number' ).isPrimitive; -* var Uint32Array = require( '@stdlib/array-uint32' ); -* -* var x = new Uint32Array( [ 1, 2, 3, 4 ] ); -* -* var out = filter( x, isPositiveNumber ); -* // returns [ 1, 2, 3, 4 ] -*/ -declare function filter( x: Uint32Array, predicate: Predicate, thisArg?: ThisParameterType> ): Uint32Array; - -/** -* Returns a shallow copy of an array containing only those elements which pass a test implemented by a predicate function. -* -* @param x - input array -* @param predicate - predicate function -* @param thisArg - predicate function execution context -* @returns output array -* -* @example -* var isPositiveNumber = require( '@stdlib/assert-is-positive-number' ).isPrimitive; -* var Uint16Array = require( '@stdlib/array-uint16' ); -* -* var x = new Uint16Array( [ 1, 2, 3, 4 ] ); -* -* var out = filter( x, isPositiveNumber ); -* // returns [ 1, 2, 3, 4 ] -*/ -declare function filter( x: Uint16Array, predicate: Predicate, thisArg?: ThisParameterType> ): Uint16Array; - -/** -* Returns a shallow copy of an array containing only those elements which pass a test implemented by a predicate function. -* -* @param x - input array -* @param predicate - predicate function -* @param thisArg - predicate function execution context -* @returns output array -* -* @example -* var isPositiveNumber = require( '@stdlib/assert-is-positive-number' ).isPrimitive; -* var Uint8Array = require( '@stdlib/array-uint8' ); -* -* var x = new Uint8Array( [ 1, 2, 3, 4 ] ); -* -* var out = filter( x, isPositiveNumber ); -* // returns [ 1, 2, 3, 4 ] -*/ -declare function filter( x: Uint8Array, predicate: Predicate, thisArg?: ThisParameterType> ): Uint8Array; - -/** -* Returns a shallow copy of an array containing only those elements which pass a test implemented by a predicate function. -* -* @param x - input array -* @param predicate - predicate function -* @param thisArg - predicate function execution context -* @returns output array -* -* @example -* var isPositiveNumber = require( '@stdlib/assert-is-positive-number' ).isPrimitive; -* var Uint8ClampedArray = require( '@stdlib/array-uint8c' ); -* -* var x = new Uint8ClampedArray( [ 1, 2, 3, 4 ] ); -* -* var out = filter( x, isPositiveNumber ); -* // returns [ 1, 2, 3, 4 ] -*/ -declare function filter( x: Uint8ClampedArray, predicate: Predicate, thisArg?: ThisParameterType> ): Uint8ClampedArray; - -/** -* Returns a shallow copy of an array containing only those elements which pass a test implemented by a predicate function. -* -* @param x - input array -* @param predicate - predicate function -* @param thisArg - predicate function execution context -* @returns output array -* -* @example -* var isPositiveNumber = require( '@stdlib/assert-is-positive-number' ).isPrimitive; -* var real = require( '@stdlib/complex-float64-real' ); -* var imag = require( '@stdlib/complex-float64-imag' ); -* var Complex128Array = require( '@stdlib/array-complex128' ); -* -* function predicate( v ) { -* return ( isPositiveNumber( real( v ) ) && isPositiveNumber( imag( v ) ) ); -* } -* -* var x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0 ] ); -* -* var out = filter( x, predicate ); -* // returns -*/ -declare function filter( x: Complex128Array, predicate: Predicate, thisArg?: ThisParameterType> ): Complex128Array; - -/** -* Returns a shallow copy of an array containing only those elements which pass a test implemented by a predicate function. -* -* @param x - input array -* @param predicate - predicate function -* @param thisArg - predicate function execution context -* @returns output array -* -* @example -* var isPositiveNumber = require( '@stdlib/assert-is-positive-number' ).isPrimitive; -* var realf = require( '@stdlib/complex-float32-real' ); -* var imagf = require( '@stdlib/complex-float32-imag' ); -* var Complex64Array = require( '@stdlib/array-complex64' ); -* -* function predicate( v ) { -* return ( isPositiveNumber( realf( v ) ) && isPositiveNumber( imagf( v ) ) ); -* } -* -* var x = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); -* -* var out = filter( x, predicate ); -* // returns -*/ -declare function filter( x: Complex64Array, predicate: Predicate, thisArg?: ThisParameterType> ): Complex64Array; - -/** -* Returns a shallow copy of an array containing only those elements which pass a test implemented by a predicate function. -* -* @param x - input array -* @param predicate - predicate function -* @param thisArg - predicate function execution context -* @returns output array -* -* @example -* var x = [ 1, -2, -3, 4 ]; -* -* var out = filter( x, isPositiveNumber ); -* // returns [ 1, 4 ] -*/ -declare function filter( x: Array, predicate: Predicate>, thisArg?: ThisParameterType>> ): Array; - -/** -* Returns a shallow copy of an array containing only those elements which pass a test implemented by a predicate function. -* -* @param x - input array -* @param predicate - predicate function -* @param thisArg - predicate function execution context -* @returns output array -* -* @example -* var toAccessorArray = require( '@stdlib/array-base-to-accessor-array' ); -* -* var x = toAccessorArray( [ 1, -2, -3, 4 ] ); -* -* var out = filter( x, isPositiveNumber ); -* // returns [ 1, 4 ] -*/ -declare function filter( x: AccessorArrayLike, predicate: Predicate>, thisArg?: ThisParameterType>> ): Array; - -/** -* Returns a shallow copy of an array containing only those elements which pass a test implemented by a predicate function. -* -* @param x - input array -* @param predicate - predicate function -* @param thisArg - predicate function execution context -* @returns output array -* -* @example -* var x = [ 1, -2, -3, 4 ]; -* -* var out = filter( x, isPositiveNumber ); -* // returns [ 1, 4 ] -*/ -declare function filter( x: Collection, predicate: Predicate>, thisArg?: ThisParameterType>> ): Array; - - -// EXPORTS // - -export = filter; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index 9c58a52..0000000 --- a/index.mjs +++ /dev/null @@ -1,4 +0,0 @@ -// Copyright (c) 2025 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 -/// -import r from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-arraylike2object@v0.2.1-esm/index.mjs";function t(t,e,n){var o;return function(r,t){return"function"==typeof r[t]}(t,"filter")?t.filter(e,n):(o=r(t)).accessorProtocol?function(r,t,e){var n,o,a,s,c;for(n=r.data,o=r.accessors[0],a=[],c=0;c 0;\n* }\n*\n* var x = [ 1, -2, -3, 4 ];\n*\n* var out = internal( x, isPositive );\n* // returns [ 1, 4 ]\n*/\nfunction internal( x, predicate, thisArg ) {\n\tvar out;\n\tvar v;\n\tvar i;\n\n\tout = [];\n\tfor ( i = 0; i < x.length; i++ ) {\n\t\tv = x[ i ];\n\t\tif ( predicate.call( thisArg, v, i, x ) ) {\n\t\t\tout.push( v );\n\t\t}\n\t}\n\treturn out;\n}\n\n/**\n* Returns a shallow copy of an array containing only those elements which pass a test implemented by a predicate function.\n*\n* @private\n* @param {Object} x - input array object\n* @param {Function} predicate - test function\n* @param {*} thisArg - execution context\n* @returns {Array} output array\n*\n* @example\n* import toAccessorArray from '@stdlib/array-base-to-accessor-array';\n* import arraylike2object from '@stdlib/array-base-arraylike2object';\n*\n* function isPositive( v ) {\n* return v > 0;\n* }\n*\n* var x = arraylike2object( toAccessorArray( [ 1, -2, -3, 4 ] ) );\n*\n* var out = accessors( x, isPositive );\n* // returns [ 1, 4 ]\n*/\nfunction accessors( x, predicate, thisArg ) {\n\tvar data;\n\tvar get;\n\tvar out;\n\tvar v;\n\tvar i;\n\n\tdata = x.data;\n\tget = x.accessors[ 0 ];\n\n\tout = [];\n\tfor ( i = 0; i < data.length; i++ ) {\n\t\tv = get( data, i );\n\t\tif ( predicate.call( thisArg, v, i, data ) ) {\n\t\t\tout.push( v );\n\t\t}\n\t}\n\treturn out;\n}\n\n\n// MAIN //\n\n/**\n* Returns a shallow copy of an array containing only those elements which pass a test implemented by a predicate function.\n*\n* @param {Collection} x - input array\n* @param {Function} predicate - test function\n* @param {*} [thisArg] - execution context\n* @returns {Collection} output array\n*\n* @example\n* function isPositive( v ) {\n* return v > 0;\n* }\n*\n* var x = [ 1, -2, -3, 4 ];\n*\n* var out = filter( x, isPositive );\n* // returns [ 1, 4 ]\n*/\nfunction filter( x, predicate, thisArg ) {\n\tvar obj;\n\tif ( hasMethod( x, 'filter' ) ) {\n\t\treturn x.filter( predicate, thisArg );\n\t}\n\tobj = arraylike2object( x );\n\tif ( obj.accessorProtocol ) {\n\t\treturn accessors( obj, predicate, thisArg );\n\t}\n\treturn internal( x, predicate, thisArg );\n}\n\n\n// EXPORTS //\n\nexport default filter;\n"],"names":["filter","x","predicate","thisArg","obj","method","hasMethod","arraylike2object","accessorProtocol","data","get","out","v","i","accessors","length","call","push","internal"],"mappings":";;sGAgJA,SAASA,EAAQC,EAAGC,EAAWC,GAC9B,IAAIC,EACJ,OAvGD,SAAoBA,EAAKC,GACxB,MAAkC,mBAAlBD,EAAKC,EACtB,CAqGMC,CAAWL,EAAG,UACXA,EAAED,OAAQE,EAAWC,IAE7BC,EAAMG,EAAkBN,IACfO,iBA/CV,SAAoBP,EAAGC,EAAWC,GACjC,IAAIM,EACAC,EACAC,EACAC,EACAC,EAMJ,IAJAJ,EAAOR,EAAEQ,KACTC,EAAMT,EAAEa,UAAW,GAEnBH,EAAM,GACAE,EAAI,EAAGA,EAAIJ,EAAKM,OAAQF,IAC7BD,EAAIF,EAAKD,EAAMI,GACVX,EAAUc,KAAMb,EAASS,EAAGC,EAAGJ,IACnCE,EAAIM,KAAML,GAGZ,OAAOD,CACR,CA8BSG,CAAWV,EAAKF,EAAWC,GArFpC,SAAmBF,EAAGC,EAAWC,GAChC,IAAIQ,EACAC,EACAC,EAGJ,IADAF,EAAM,GACAE,EAAI,EAAGA,EAAIZ,EAAEc,OAAQF,IAC1BD,EAAIX,EAAGY,GACFX,EAAUc,KAAMb,EAASS,EAAGC,EAAGZ,IACnCU,EAAIM,KAAML,GAGZ,OAAOD,CACR,CA0EQO,CAAUjB,EAAGC,EAAWC,EAChC"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index d4d08f0..0000000 --- a/stats.html +++ /dev/null @@ -1,4842 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From f8f72c95aec762df392bc9b77d8ca4e89c725041 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Tue, 24 Jun 2025 15:45:25 +0000 Subject: [PATCH 40/40] Auto-generated commit --- .editorconfig | 180 - .eslintrc.js | 1 - .gitattributes | 66 - .github/PULL_REQUEST_TEMPLATE.md | 7 - .github/workflows/benchmark.yml | 64 - .github/workflows/cancel.yml | 57 - .github/workflows/close_pull_requests.yml | 54 - .github/workflows/examples.yml | 64 - .github/workflows/npm_downloads.yml | 112 - .github/workflows/productionize.yml | 794 --- .github/workflows/publish.yml | 252 - .github/workflows/test.yml | 99 - .github/workflows/test_bundles.yml | 186 - .github/workflows/test_coverage.yml | 133 - .github/workflows/test_install.yml | 85 - .github/workflows/test_published_package.yml | 105 - .gitignore | 194 - .npmignore | 229 - .npmrc | 31 - CHANGELOG.md | 139 - CITATION.cff | 30 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 -- README.md | 41 +- SECURITY.md | 5 - benchmark/benchmark.length.js | 97 - branches.md | 56 - dist/index.d.ts | 3 - dist/index.js | 5 - dist/index.js.map | 7 - docs/repl.txt | 46 - docs/types/test.ts | 101 - examples/index.js | 35 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/index.js | 46 - lib/main.js | 160 - package.json | 65 +- stats.html | 4842 ++++++++++++++++++ test/dist/test.js | 33 - test/test.js | 251 - 43 files changed, 4867 insertions(+), 4355 deletions(-) delete mode 100644 .editorconfig delete mode 100644 .eslintrc.js delete mode 100644 .gitattributes delete mode 100644 .github/PULL_REQUEST_TEMPLATE.md delete mode 100644 .github/workflows/benchmark.yml delete mode 100644 .github/workflows/cancel.yml delete mode 100644 .github/workflows/close_pull_requests.yml delete mode 100644 .github/workflows/examples.yml delete mode 100644 .github/workflows/npm_downloads.yml delete mode 100644 .github/workflows/productionize.yml delete mode 100644 .github/workflows/publish.yml delete mode 100644 .github/workflows/test.yml delete mode 100644 .github/workflows/test_bundles.yml delete mode 100644 .github/workflows/test_coverage.yml delete mode 100644 .github/workflows/test_install.yml delete mode 100644 .github/workflows/test_published_package.yml delete mode 100644 .gitignore delete mode 100644 .npmignore delete mode 100644 .npmrc delete mode 100644 CHANGELOG.md delete mode 100644 CITATION.cff delete mode 100644 CODE_OF_CONDUCT.md delete mode 100644 CONTRIBUTING.md delete mode 100644 Makefile delete mode 100644 SECURITY.md delete mode 100644 benchmark/benchmark.length.js delete mode 100644 branches.md delete mode 100644 dist/index.d.ts delete mode 100644 dist/index.js delete mode 100644 dist/index.js.map delete mode 100644 docs/repl.txt delete mode 100644 docs/types/test.ts delete mode 100644 examples/index.js rename docs/types/index.d.ts => index.d.ts (99%) create mode 100644 index.mjs create mode 100644 index.mjs.map delete mode 100644 lib/index.js delete mode 100644 lib/main.js create mode 100644 stats.html delete mode 100644 test/dist/test.js delete mode 100644 test/test.js diff --git a/.editorconfig b/.editorconfig deleted file mode 100644 index dab5d2a..0000000 --- a/.editorconfig +++ /dev/null @@ -1,180 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 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. -#/ - -# EditorConfig configuration file (see ). - -# Indicate that this file is a root-level configuration file: -root = true - -# Set properties for all files: -[*] -end_of_line = lf -charset = utf-8 -trim_trailing_whitespace = true -insert_final_newline = true - -# Set properties for JavaScript files: -[*.{js,js.txt}] -indent_style = tab - -# Set properties for JavaScript ES module files: -[*.{mjs,mjs.txt}] -indent_style = tab - -# Set properties for JavaScript CommonJS files: -[*.{cjs,cjs.txt}] -indent_style = tab - -# Set properties for JSON files: -[*.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `cli_opts.json` files: -[cli_opts.json] -indent_style = tab - -# Set properties for TypeScript files: -[*.ts] -indent_style = tab - -# Set properties for Python files: -[*.{py,py.txt}] -indent_style = space -indent_size = 4 - -# Set properties for Julia files: -[*.{jl,jl.txt}] -indent_style = tab - -# Set properties for R files: -[*.{R,R.txt}] -indent_style = tab - -# Set properties for C files: -[*.{c,c.txt}] -indent_style = tab - -# Set properties for C header files: -[*.{h,h.txt}] -indent_style = tab - -# Set properties for C++ files: -[*.{cpp,cpp.txt}] -indent_style = tab - -# Set properties for C++ header files: -[*.{hpp,hpp.txt}] -indent_style = tab - -# Set properties for Fortran files: -[*.{f,f.txt}] -indent_style = space -indent_size = 2 - -# Set properties for shell files: -[*.{sh,sh.txt}] -indent_style = tab - -# Set properties for AWK files: -[*.{awk,awk.txt}] -indent_style = tab - -# Set properties for HTML files: -[*.{html,html.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for XML files: -[*.{xml,xml.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for CSS files: -[*.{css,css.txt}] -indent_style = tab - -# Set properties for Makefiles: -[Makefile] -indent_style = tab - -[*.{mk,mk.txt}] -indent_style = tab - -# Set properties for Markdown files: -[*.{md,md.txt}] -indent_style = space -indent_size = 4 -trim_trailing_whitespace = true # Note: this disables using two spaces to force a hard line break, which is permitted in Markdown. As we don't typically follow that practice (TMK), we should be safe to automatically trim. - -# Set properties for `usage.txt` files: -[usage.txt] -indent_style = space -indent_size = 2 - -# Set properties for `repl.txt` files: -[repl.txt] -indent_style = space -indent_size = 4 - -# Set properties for `package.json` files: -[package.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `datapackage.json` files: -[datapackage.json] -indent_style = space -indent_size = 2 - -# Set properties for `manifest.json` files: -[manifest.json] -indent_style = space -indent_size = 2 - -# Set properties for `tsconfig.json` files: -[tsconfig.json] -indent_style = space -indent_size = 2 - -# Set properties for LaTeX files: -[*.{tex,tex.txt}] -indent_style = tab - -# Set properties for LaTeX Bibliography files: -[*.{bib,bib.txt}] -indent_style = tab - -# Set properties for YAML files: -[*.{yml,yml.txt}] -indent_style = space -indent_size = 2 - -# Set properties for GYP files: -[binding.gyp] -indent_style = space -indent_size = 2 - -[*.gypi] -indent_style = space -indent_size = 2 - -# Set properties for citation files: -[*.{cff,cff.txt}] -indent_style = space -indent_size = 2 diff --git a/.eslintrc.js b/.eslintrc.js deleted file mode 100644 index 5f30286..0000000 --- a/.eslintrc.js +++ /dev/null @@ -1 +0,0 @@ -/* For the `eslint` rules of this project, consult the main repository at https://github.com/stdlib-js/stdlib */ diff --git a/.gitattributes b/.gitattributes deleted file mode 100644 index 1c88e69..0000000 --- a/.gitattributes +++ /dev/null @@ -1,66 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 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. -#/ - -# Configuration file which assigns attributes to pathnames. -# -# [1]: https://git-scm.com/docs/gitattributes - -# Automatically normalize the line endings of any committed text files: -* text=auto - -# Override line endings for certain files on checkout: -*.crlf.csv text eol=crlf - -# Denote that certain files are binary and should not be modified: -*.png binary -*.jpg binary -*.jpeg binary -*.gif binary -*.ico binary -*.gz binary -*.zip binary -*.7z binary -*.mp3 binary -*.mp4 binary -*.mov binary - -# Override what is considered "vendored" by GitHub's linguist: -/lib/node_modules/** -linguist-vendored -linguist-generated - -# Configure directories which should *not* be included in GitHub language statistics: -/deps/** linguist-vendored -/dist/** linguist-generated -/workshops/** linguist-vendored - -benchmark/** linguist-vendored -docs/* linguist-documentation -etc/** linguist-vendored -examples/** linguist-documentation -scripts/** linguist-vendored -test/** linguist-vendored -tools/** linguist-vendored - -# Configure files which should *not* be included in GitHub language statistics: -Makefile linguist-vendored -*.mk linguist-vendored -*.jl linguist-vendored -*.py linguist-vendored -*.R linguist-vendored - -# Configure files which should be included in GitHub language statistics: -docs/types/*.d.ts -linguist-documentation diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index 7753f5a..0000000 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ /dev/null @@ -1,7 +0,0 @@ - - -We are excited about your pull request, but unfortunately we are not accepting pull requests against this repository, as all development happens on the [main project repository](https://github.com/stdlib-js/stdlib). We kindly request that you submit this pull request against the [respective directory](https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/filter) of the main repository where we’ll review and provide feedback. - -If this is your first stdlib contribution, be sure to read the [contributing guide](https://github.com/stdlib-js/stdlib/blob/develop/CONTRIBUTING.md) which provides guidelines and instructions for submitting contributions. You may also consult the [development guide](https://github.com/stdlib-js/stdlib/blob/develop/docs/contributing/development.md) for help on developing stdlib. - -We look forward to receiving your contribution! :smiley: \ No newline at end of file diff --git a/.github/workflows/benchmark.yml b/.github/workflows/benchmark.yml deleted file mode 100644 index e4f10fe..0000000 --- a/.github/workflows/benchmark.yml +++ /dev/null @@ -1,64 +0,0 @@ -#/ -# @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. -#/ - -# Workflow name: -name: benchmark - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to run benchmarks: - benchmark: - - # Define a display name: - name: 'Run benchmarks' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Run benchmarks: - - name: 'Run benchmarks' - run: | - npm run benchmark diff --git a/.github/workflows/cancel.yml b/.github/workflows/cancel.yml deleted file mode 100644 index b5291db..0000000 --- a/.github/workflows/cancel.yml +++ /dev/null @@ -1,57 +0,0 @@ -#/ -# @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. -#/ - -# Workflow name: -name: cancel - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to cancel existing workflow runs: - cancel: - - # Define a display name: - name: 'Cancel workflow runs' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Time limit: - timeout-minutes: 3 - - # Define the sequence of job steps... - steps: - - # Cancel existing workflow runs: - - name: 'Cancel existing workflow runs' - # Pin action to full length commit SHA - uses: styfle/cancel-workflow-action@85880fa0301c86cca9da44039ee3bb12d3bedbfa # v0.12.1 - with: - workflow_id: >- - benchmark.yml, - examples.yml, - test.yml, - test_coverage.yml, - test_install.yml, - publish.yml - access_token: ${{ github.token }} diff --git a/.github/workflows/close_pull_requests.yml b/.github/workflows/close_pull_requests.yml deleted file mode 100644 index 2060eba..0000000 --- a/.github/workflows/close_pull_requests.yml +++ /dev/null @@ -1,54 +0,0 @@ -#/ -# @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. -#/ - -# Workflow name: -name: close_pull_requests - -# Workflow triggers: -on: - pull_request_target: - types: [opened] - -# Workflow jobs: -jobs: - - # Define job to close all pull requests: - run: - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - - # Close pull request - - name: 'Close pull request' - # Pin action to full length commit SHA corresponding to v3.1.2 - uses: superbrothers/close-pull-request@9c18513d320d7b2c7185fb93396d0c664d5d8448 - with: - comment: | - Thank you for submitting a pull request. :raised_hands: - - We greatly appreciate your willingness to submit a contribution. However, we are not accepting pull requests against this repository, as all development happens on the [main project repository](https://github.com/stdlib-js/stdlib). - - We kindly request that you submit this pull request against the [respective directory](https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/filter) of the main repository where we’ll review and provide feedback. If this is your first stdlib contribution, be sure to read the [contributing guide](https://github.com/stdlib-js/stdlib/blob/develop/CONTRIBUTING.md) which provides guidelines and instructions for submitting contributions. - - Thank you again, and we look forward to receiving your contribution! :smiley: - - Best, - The stdlib team \ No newline at end of file diff --git a/.github/workflows/examples.yml b/.github/workflows/examples.yml deleted file mode 100644 index 2984901..0000000 --- a/.github/workflows/examples.yml +++ /dev/null @@ -1,64 +0,0 @@ -#/ -# @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. -#/ - -# Workflow name: -name: examples - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to run the package examples... - examples: - - # Define display name: - name: 'Run examples' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - - # Checkout repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Run examples: - - name: 'Run examples' - run: | - npm run examples diff --git a/.github/workflows/npm_downloads.yml b/.github/workflows/npm_downloads.yml deleted file mode 100644 index c2326d6..0000000 --- a/.github/workflows/npm_downloads.yml +++ /dev/null @@ -1,112 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2022 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. -#/ - -# Workflow name: -name: npm_downloads - -# Workflow triggers: -on: - # Run this workflow weekly: - schedule: - # cron: ' ' - - cron: '48 12 * * 3' - - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job for retrieving npm download counts... - npm_downloads: - - # Define display name: - name: 'Retrieve npm download counts' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - timeout-minutes: 10 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Resolve package name: - - name: 'Resolve package name' - id: package_name - run: | - name=`node -e 'console.log(require("./package.json").name)' | tr -d '\n'` - echo "package_name=$name" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Fetch download data: - - name: 'Fetch data' - id: download_data - run: | - url="https://api.npmjs.org/downloads/range/$(date --date='1 year ago' '+%Y-%m-%d'):$(date '+%Y-%m-%d')/${{ steps.package_name.outputs.package_name }}" - echo "$url" - data=$(curl "$url") - mkdir ./tmp - echo "$data" > ./tmp/npm_downloads.json - echo "data=$data" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Print summary of download data: - - name: 'Print summary' - run: | - echo "| Date | Downloads |" >> $GITHUB_STEP_SUMMARY - echo "|------|------------|" >> $GITHUB_STEP_SUMMARY - cat ./tmp/npm_downloads.json | jq -r ".downloads | .[-14:] | to_entries | map(\"| \(.value.day) | \(.value.downloads) |\") |.[]" >> $GITHUB_STEP_SUMMARY - - # Upload the download data: - - name: 'Upload data' - # Pin action to full length commit SHA - uses: actions/upload-artifact@5d5d22a31266ced268874388b861e4b58bb5c2f3 # v4.3.1 - with: - # Define a name for the uploaded artifact (ensuring a unique name for each job): - name: npm_downloads - - # Specify the path to the file to upload: - path: ./tmp/npm_downloads.json - - # Specify the number of days to retain the artifact (default is 90 days): - retention-days: 90 - timeout-minutes: 10 - if: success() - - # Send data to events server: - - name: 'Post data' - # Pin action to full length commit SHA - uses: distributhor/workflow-webhook@48a40b380ce4593b6a6676528cd005986ae56629 # v3.0.3 - env: - webhook_url: ${{ secrets.STDLIB_NPM_DOWNLOADS_URL }} - webhook_secret: ${{ secrets.STDLIB_WEBHOOK_SECRET }} - data: '{ "downloads": ${{ steps.download_data.outputs.data }} }' - timeout-minutes: 5 - if: success() diff --git a/.github/workflows/productionize.yml b/.github/workflows/productionize.yml deleted file mode 100644 index f4575e9..0000000 --- a/.github/workflows/productionize.yml +++ /dev/null @@ -1,794 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2022 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. -#/ - -# Workflow name: -name: productionize - -# Workflow triggers: -on: - # Run workflow when a new commit is pushed to the main branch: - push: - branches: - - main - - # Allow the workflow to be manually run: - workflow_dispatch: - inputs: - require-passing-tests: - description: 'Require passing tests for creating bundles' - type: boolean - default: true - - # Run workflow upon completion of `publish` workflow run: - workflow_run: - workflows: ["publish"] - types: [completed] - - -# Concurrency group to prevent multiple concurrent executions: -concurrency: - group: productionize - cancel-in-progress: true - -# Workflow jobs: -jobs: - - # Define a job to create a production build... - productionize: - - # Define display name: - name: 'Productionize' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Define the sequence of job steps... - steps: - # Checkout main branch of repository: - - name: 'Checkout main branch' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - with: - ref: main - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Create production branch: - - name: 'Create production branch' - run: | - git checkout -b production - - # Transform error messages: - - name: 'Transform error messages' - id: transform-error-messages - uses: stdlib-js/transform-errors-action@main - - # 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: | - PKG_VERSION=$(npm view @stdlib/error-tools-fmtprodmsg version) - if grep -q '"@stdlib/string-format"' package.json; then - sed -i "s/\"@stdlib\/string-format\": \"^.*\"/\"@stdlib\/error-tools-fmtprodmsg\": \"^$PKG_VERSION\"/g" package.json - else - node -e "var pkg = require( './package.json' ); pkg.dependencies[ '@stdlib/error-tools-fmtprodmsg' ] = '^$PKG_VERSION'; require( 'fs' ).writeFileSync( 'package.json', JSON.stringify( pkg, null, 2 ) );" - fi - - # Configure Git: - - name: 'Configure Git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Transform error messages" - - # Push changes: - - name: 'Push changes' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" production --force - - # Define a job for running tests of the productionized code... - test: - - # Define a display name: - name: 'Run Tests' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Indicate that this job depends on the prior job finishing: - needs: productionize - - # Run this job regardless of the outcome of the prior job: - if: always() - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout repository' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - with: - # Use the `production` branch: - ref: production - - # Install Node.js: - - name: 'Install Node.js' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Build native add-on if present: - - name: 'Build native add-on (if present)' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - run: | - if [ -f "binding.gyp" ]; then - npm install node-gyp --no-save && ./node_modules/.bin/node-gyp rebuild - fi - - # Run tests: - - name: 'Run tests' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: tests - run: | - npm test || npm test || npm test - - # Define job to create a bundle for use in Deno... - deno: - - # Define display name: - name: 'Create Deno bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Configure Git: - - name: 'Configure Git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `deno` branch exists: - - name: 'Check if remote `deno` branch exists' - id: deno-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin deno - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `deno` exists, delete everything in branch and merge `production` into it - - name: 'If `deno` exists, delete everything in branch and merge `production` into it' - if: steps.deno-branch-exists.outputs.remote-exists - run: | - git checkout -b deno origin/deno - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `deno` does not exist, create `deno` branch: - - name: 'If `deno` does not exist, create `deno` branch' - if: ${{ steps.deno-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b deno - - # Copy files to deno directory: - - name: 'Copy files to deno directory' - run: | - mkdir -p deno - cp README.md LICENSE CONTRIBUTORS NOTICE ./deno - - # Copy TypeScript definitions to deno directory: - if [ -d index.d.ts ]; then - cp index.d.ts ./deno/index.d.ts - fi - if [ -e ./docs/types/index.d.ts ]; then - cp ./docs/types/index.d.ts ./deno/mod.d.ts - fi - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: Install production and development dependencies - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Bundle package for use in Deno: - - name: 'Bundle package for Deno' - id: deno-bundle - uses: stdlib-js/bundle-action@main - with: - target: 'deno' - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - # Replace links to other packages with links to the deno branch: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/deno/"; - - # Replace reference to `@stdlib/types` with CDN link: - find ./deno -type f -name '*.ts' -print0 | xargs -0 -r sed -Ei "s/\/\/\/ /\/\/\/ /g" - - # Change wording of project description to avoid reference to JavaScript and Node.js: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "s/a standard library for JavaScript and Node.js, /a standard library /g" - - # Rewrite all `require()`s to use jsDelivr links: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/require\( '@stdlib\// { - s/(var|let|const)\s+([a-z0-9_]+)\s+=\s*require\( '([^']+)' \);/import \2 from \'\3\';/i - s/@stdlib/https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js/ - s/';/@deno\/mod.js';/ - }" - - # Rewrite first `import` to show importing of named exports if available: - exports=$(cat lib/index.js | \ - grep -E 'setReadOnly\(.*,.*,.*\)' | \ - sed -E 's/setReadOnly\((.*),(.*),(.*)\);/\2/' | \ - sed -E "s/'//g" | \ - sort) - if [ -n "$exports" ]; then - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\nimport\s+([a-zA-Z0-9_]+)\s+from\s*'([^']+)';\n\`\`\`/\`\`\`javascript\nimport \1 from '\2';\n\`\`\`\n\nYou can also import the following named exports from the package:\n\n\`\`\`javascript\nimport { $(echo $exports | sed -E 's/ /, /g') } from '\2';\n\`\`\`/" - fi - - # Remove `installation`, `cli`, and `c` sections: - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Create package.json file for deno branch: - jq --indent 2 '{"name": .name, "version": .version, "description": .description, "license": .license, "type": "module", "main": "./mod.js", "homepage": .homepage, "repository": .repository, "bugs": .bugs, "keywords": .keywords, "funding": .funding}' package.json > ./deno/package.json - - # Delete everything in current directory aside from deno folder: - - name: 'Delete everything in current directory aside from deno folder' - run: | - find . -type 'f' | grep -v -e "deno" -e ".git/" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e "deno" -e ".git" | xargs -r rm -rf - - # Move deno directory to root: - - name: 'Move deno directory to root' - run: | - mv ./deno/* . - rmdir ./deno - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Auto-generated commit" - - # Push changes to `deno` branch: - - name: 'Push changes to `deno` branch' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" deno - - # Send status to Slack channel if job fails: - - name: 'Send status to Slack channel in case of failure' - # Pin action to full length commit SHA - uses: 8398a7/action-slack@28ba43ae48961b90635b50953d216767a6bea486 # v3.16.2 - with: - status: ${{ job.status }} - channel: '#npm-ci' - if: failure() - - # Define job to create a UMD bundle... - umd: - - # Define display name: - name: 'Create UMD bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Configure Git: - - name: 'Configure Git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `umd` branch exists: - - name: 'Check if remote `umd` branch exists' - id: umd-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin umd - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `umd` exists, delete everything in branch and merge `production` into it - - name: 'If `umd` exists, delete everything in branch and merge `production` into it' - if: steps.umd-branch-exists.outputs.remote-exists - run: | - git checkout -b umd origin/umd - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `umd` does not exist, create `umd` branch: - - name: 'If `umd` does not exist, create `umd` branch' - if: ${{ steps.umd-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b umd - - # Copy files to umd directory: - - name: 'Copy files to umd directory' - run: | - mkdir -p umd - cp README.md LICENSE CONTRIBUTORS NOTICE ./umd - - # Install Node.js - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Extract alias: - - name: 'Extract alias' - id: extract-alias - run: | - alias=$(grep -E 'require\(' README.md | head -n 1 | sed -E 's/^var ([a-zA-Z0-9_]+) = .+/\1/') - echo "alias=${alias}" >> $GITHUB_OUTPUT - - # Create Universal Module Definition (UMD) Node.js bundle: - - name: 'Create Universal Module Definition (UMD) Node.js bundle' - id: umd-bundle-node - uses: stdlib-js/bundle-action@main - with: - target: 'umd-node' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Create Universal Module Definition (UMD) browser bundle: - - name: 'Create Universal Module Definition (UMD) browser bundle' - id: umd-bundle-browser - uses: stdlib-js/bundle-action@main - with: - target: 'umd-browser' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - - # Replace links to other packages with links to the umd branch: - find ./umd -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/umd/"; - - # Remove `installation`, `cli`, and `c` sections: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Rewrite first `require()` to show consumption of the UMD bundle in Observable and via a `script` tag: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\n(var|let|const)\s+([a-zA-Z0-9_]+)\s+=\s*require\( '\@stdlib\/([^']+)' \);\n\`\`\`/To use in Observable,\n\n\`\`\`javascript\n\2 = require\( 'https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js\/\3\@umd\/browser.js' \)\n\`\`\`\n\nTo vendor stdlib functionality and avoid installing dependency trees for Node.js, you can use the UMD server build:\n\n\`\`\`javascript\nvar \2 = require\( 'path\/to\/vendor\/umd\/\3\/index.js' \)\n\`\`\`\n\nTo include the bundle in a webpage,\n\n\`\`\`html\n + + ```
@@ -189,7 +180,7 @@ var out = filter( x, naryFunction( isPositiveInteger, 1 ) ); ## 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. +This package is part of [stdlib][stdlib], a standard library 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]. diff --git a/SECURITY.md b/SECURITY.md deleted file mode 100644 index 9702d4c..0000000 --- a/SECURITY.md +++ /dev/null @@ -1,5 +0,0 @@ -# Security - -> Policy for reporting security vulnerabilities. - -See the security policy [in the main project repository](https://github.com/stdlib-js/stdlib/security). diff --git a/benchmark/benchmark.length.js b/benchmark/benchmark.length.js deleted file mode 100644 index bc79e33..0000000 --- a/benchmark/benchmark.length.js +++ /dev/null @@ -1,97 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 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 bench = require( '@stdlib/bench-harness' ); -var pow = require( '@stdlib/math-base-special-pow' ); -var isArray = require( '@stdlib/assert-is-array' ); -var isNonNegativeInteger = require( '@stdlib/assert-is-nonnegative-integer' ).isPrimitive; -var zeroTo = require( '@stdlib/array-base-zero-to' ); -var pkg = require( './../package.json' ).name; -var filter = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveInteger} len - array length -* @returns {Function} benchmark function -*/ -function createBenchmark( len ) { - var x = zeroTo( len ); - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var out; - var i; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - out = filter( x, isNonNegativeInteger ); - if ( typeof out !== 'object' ) { - b.fail( 'should return an array' ); - } - } - b.toc(); - if ( !isArray( out ) ) { - b.fail( 'should return an array' ); - } - b.pass( 'benchmark finished' ); - b.end(); - } -} - - -// MAIN // - -/** -* Main execution sequence. -* -* @private -*/ -function main() { - var len; - var min; - var max; - var f; - var i; - - min = 1; // 10^min - max = 6; // 10^max - - for ( i = min; i <= max; i++ ) { - len = pow( 10, i ); - - f = createBenchmark( len ); - bench( pkg+':dtype=generic,len='+len, f ); - } -} - -main(); diff --git a/branches.md b/branches.md deleted file mode 100644 index 9858901..0000000 --- a/branches.md +++ /dev/null @@ -1,56 +0,0 @@ - - -# Branches - -This repository has the following branches: - -- **main**: default branch generated from the [stdlib project][stdlib-url], where all development takes place. -- **production**: [production build][production-url] of the package (e.g., reformatted error messages to reduce bundle sizes and thus the number of bytes transmitted over a network). -- **esm**: [ES Module][esm-url] branch for use via a `script` tag without the need for installation and bundlers (see [README][esm-readme]). -- **deno**: [Deno][deno-url] branch for use in Deno (see [README][deno-readme]). -- **umd**: [UMD][umd-url] branch for use in Observable, or in dual browser/Node.js environments (see [README][umd-readme]). - -The following diagram illustrates the relationships among the above branches: - -```mermaid -graph TD; -A[stdlib]-->|generate standalone package|B; -B[main] -->|productionize| C[production]; -C -->|bundle| D[esm]; -C -->|bundle| E[deno]; -C -->|bundle| F[umd]; - -%% click A href "https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/filter" -%% click B href "https://github.com/stdlib-js/array-base-filter/tree/main" -%% click C href "https://github.com/stdlib-js/array-base-filter/tree/production" -%% click D href "https://github.com/stdlib-js/array-base-filter/tree/esm" -%% click E href "https://github.com/stdlib-js/array-base-filter/tree/deno" -%% click F href "https://github.com/stdlib-js/array-base-filter/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/filter -[production-url]: https://github.com/stdlib-js/array-base-filter/tree/production -[deno-url]: https://github.com/stdlib-js/array-base-filter/tree/deno -[deno-readme]: https://github.com/stdlib-js/array-base-filter/blob/deno/README.md -[umd-url]: https://github.com/stdlib-js/array-base-filter/tree/umd -[umd-readme]: https://github.com/stdlib-js/array-base-filter/blob/umd/README.md -[esm-url]: https://github.com/stdlib-js/array-base-filter/tree/esm -[esm-readme]: https://github.com/stdlib-js/array-base-filter/blob/esm/README.md \ No newline at end of file diff --git a/dist/index.d.ts b/dist/index.d.ts deleted file mode 100644 index aafb9cb..0000000 --- a/dist/index.d.ts +++ /dev/null @@ -1,3 +0,0 @@ -/// -import filter from '../docs/types/index'; -export = filter; \ No newline at end of file diff --git a/dist/index.js b/dist/index.js deleted file mode 100644 index 5c2f789..0000000 --- a/dist/index.js +++ /dev/null @@ -1,5 +0,0 @@ -"use strict";var s=function(r,t){return function(){return t||r((t={exports:{}}).exports,t),t.exports}};var f=s(function(y,c){ -var v=require('@stdlib/array-base-arraylike2object/dist');function l(r,t){return typeof r[t]=="function"}function h(r,t,n){var e,o,a;for(e=[],a=0;a 0;\n* }\n*\n* var x = [ 1, -2, -3, 4 ];\n*\n* var out = internal( x, isPositive );\n* // returns [ 1, 4 ]\n*/\nfunction internal( x, predicate, thisArg ) {\n\tvar out;\n\tvar v;\n\tvar i;\n\n\tout = [];\n\tfor ( i = 0; i < x.length; i++ ) {\n\t\tv = x[ i ];\n\t\tif ( predicate.call( thisArg, v, i, x ) ) {\n\t\t\tout.push( v );\n\t\t}\n\t}\n\treturn out;\n}\n\n/**\n* Returns a shallow copy of an array containing only those elements which pass a test implemented by a predicate function.\n*\n* @private\n* @param {Object} x - input array object\n* @param {Function} predicate - test function\n* @param {*} thisArg - execution context\n* @returns {Array} output array\n*\n* @example\n* var toAccessorArray = require( '@stdlib/array-base-to-accessor-array' );\n* var arraylike2object = require( '@stdlib/array-base-arraylike2object' );\n*\n* function isPositive( v ) {\n* return v > 0;\n* }\n*\n* var x = arraylike2object( toAccessorArray( [ 1, -2, -3, 4 ] ) );\n*\n* var out = accessors( x, isPositive );\n* // returns [ 1, 4 ]\n*/\nfunction accessors( x, predicate, thisArg ) {\n\tvar data;\n\tvar get;\n\tvar out;\n\tvar v;\n\tvar i;\n\n\tdata = x.data;\n\tget = x.accessors[ 0 ];\n\n\tout = [];\n\tfor ( i = 0; i < data.length; i++ ) {\n\t\tv = get( data, i );\n\t\tif ( predicate.call( thisArg, v, i, data ) ) {\n\t\t\tout.push( v );\n\t\t}\n\t}\n\treturn out;\n}\n\n\n// MAIN //\n\n/**\n* Returns a shallow copy of an array containing only those elements which pass a test implemented by a predicate function.\n*\n* @param {Collection} x - input array\n* @param {Function} predicate - test function\n* @param {*} [thisArg] - execution context\n* @returns {Collection} output array\n*\n* @example\n* function isPositive( v ) {\n* return v > 0;\n* }\n*\n* var x = [ 1, -2, -3, 4 ];\n*\n* var out = filter( x, isPositive );\n* // returns [ 1, 4 ]\n*/\nfunction filter( x, predicate, thisArg ) {\n\tvar obj;\n\tif ( hasMethod( x, 'filter' ) ) {\n\t\treturn x.filter( predicate, thisArg );\n\t}\n\tobj = arraylike2object( x );\n\tif ( obj.accessorProtocol ) {\n\t\treturn accessors( obj, predicate, thisArg );\n\t}\n\treturn internal( x, predicate, thisArg );\n}\n\n\n// EXPORTS //\n\nmodule.exports = filter;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2024 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* Return a shallow copy of an array containing only those elements which pass a test implemented by a predicate function.\n*\n* @module @stdlib/array-base-filter\n*\n* @example\n* var filter = require( '@stdlib/array-base-filter' );\n*\n* function isPositive( v ) {\n* return v > 0;\n* }\n*\n* var x = [ 1, -2, -3, 4 ];\n*\n* var out = filter( x, isPositive );\n* // returns [ 1, 4 ]\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,EAAmB,QAAS,qCAAsC,EAqBtE,SAASC,EAAWC,EAAKC,EAAS,CACjC,OAAS,OAAOD,EAAKC,CAAO,GAAM,UACnC,CAqBA,SAASC,EAAUC,EAAGC,EAAWC,EAAU,CAC1C,IAAIC,EACAC,EACAC,EAGJ,IADAF,EAAM,CAAC,EACDE,EAAI,EAAGA,EAAIL,EAAE,OAAQK,IAC1BD,EAAIJ,EAAGK,CAAE,EACJJ,EAAU,KAAMC,EAASE,EAAGC,EAAGL,CAAE,GACrCG,EAAI,KAAMC,CAAE,EAGd,OAAOD,CACR,CAwBA,SAASG,EAAWN,EAAGC,EAAWC,EAAU,CAC3C,IAAIK,EACAC,EACAL,EACAC,EACAC,EAMJ,IAJAE,EAAOP,EAAE,KACTQ,EAAMR,EAAE,UAAW,CAAE,EAErBG,EAAM,CAAC,EACDE,EAAI,EAAGA,EAAIE,EAAK,OAAQF,IAC7BD,EAAII,EAAKD,EAAMF,CAAE,EACZJ,EAAU,KAAMC,EAASE,EAAGC,EAAGE,CAAK,GACxCJ,EAAI,KAAMC,CAAE,EAGd,OAAOD,CACR,CAuBA,SAASM,EAAQT,EAAGC,EAAWC,EAAU,CACxC,IAAIL,EACJ,OAAKD,EAAWI,EAAG,QAAS,EACpBA,EAAE,OAAQC,EAAWC,CAAQ,GAErCL,EAAMF,EAAkBK,CAAE,EACrBH,EAAI,iBACDS,EAAWT,EAAKI,EAAWC,CAAQ,EAEpCH,EAAUC,EAAGC,EAAWC,CAAQ,EACxC,CAKAR,EAAO,QAAUe,ICvHjB,IAAIC,EAAO,IAKX,OAAO,QAAUA", - "names": ["require_main", "__commonJSMin", "exports", "module", "arraylike2object", "hasMethod", "obj", "method", "internal", "x", "predicate", "thisArg", "out", "v", "i", "accessors", "data", "get", "filter", "main"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index bb2b17a..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,46 +0,0 @@ - -{{alias}}( x, predicate[, thisArg] ) - Returns a shallow copy of an array containing only those elements which pass - a test implemented by a predicate function. - - The predicate function is provided three arguments: - - - value: current array element. - - index: current array element index. - - arr: the input array. - - If provided an array-like object having a `filter` method , the function - defers execution to that method and assumes that the method has the - following signature: - - x.filter( predicate, thisArg ) - - If provided an array-like object without a `filter` method, the function - performs a linear scan and always returns a generic array. - - Parameters - ---------- - x: Array|TypedArray|Object - Input array. - - predicate: Function - Predicate function. - - thisArg: any (optional) - Execution context. - - Returns - ------- - out: Array|TypedArray|Object - Output array. - - Examples - -------- - > function f( v ) { return ( v > 0 ); }; - > var x = [ 1, -2, -3, 4 ]; - > var out = {{alias}}( x, f ) - [ 1, 4 ] - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index db0c38d..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,101 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2024 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. -*/ - -import toAccessorArray = require( '@stdlib/array-base-to-accessor-array' ); -import filter = require( './index' ); - -/** -* Tests whether a value is positive. -* -* @param value - input value -* @returns boolean indicating whether an element is positive -*/ -function isPositive( value: number ): boolean { - return ( value > 0 ); -} - - -// TESTS // - -// The function returns a collection... -{ - filter( [ 1, 2, 3 ], isPositive ); // $ExpectType number[] - filter( new Float64Array( [ 1, 2, 3 ] ), isPositive ); // $ExpectType Float64Array - filter( new Float32Array( [ 1, 2, 3 ] ), isPositive ); // $ExpectType Float32Array - filter( new Int32Array( [ 1, 2, 3 ] ), isPositive ); // $ExpectType Int32Array - filter( new Int16Array( [ 1, 2, 3 ] ), isPositive ); // $ExpectType Int16Array - filter( new Int8Array( [ 1, 2, 3 ] ), isPositive ); // $ExpectType Int8Array - filter( new Uint32Array( [ 1, 2, 3 ] ), isPositive ); // $ExpectType Uint32Array - filter( new Uint16Array( [ 1, 2, 3 ] ), isPositive ); // $ExpectType Uint16Array - filter( new Uint8Array( [ 1, 2, 3 ] ), isPositive ); // $ExpectType Uint8Array - filter( new Uint8ClampedArray( [ 1, 2, 3 ] ), isPositive ); // $ExpectType Uint8ClampedArray - filter( toAccessorArray( [ 1, 2, 3 ] ), isPositive ); // $ExpectType number[] - - filter( [ 1, 2, 3 ], isPositive, {} ); // $ExpectType number[] - filter( new Float64Array( [ 1, 2, 3 ] ), isPositive, {} ); // $ExpectType Float64Array - filter( new Float32Array( [ 1, 2, 3 ] ), isPositive, {} ); // $ExpectType Float32Array - filter( new Int32Array( [ 1, 2, 3 ] ), isPositive, {} ); // $ExpectType Int32Array - filter( new Int16Array( [ 1, 2, 3 ] ), isPositive, {} ); // $ExpectType Int16Array - filter( new Int8Array( [ 1, 2, 3 ] ), isPositive, {} ); // $ExpectType Int8Array - filter( new Uint32Array( [ 1, 2, 3 ] ), isPositive, {} ); // $ExpectType Uint32Array - filter( new Uint16Array( [ 1, 2, 3 ] ), isPositive, {} ); // $ExpectType Uint16Array - filter( new Uint8Array( [ 1, 2, 3 ] ), isPositive, {} ); // $ExpectType Uint8Array - filter( new Uint8ClampedArray( [ 1, 2, 3 ] ), isPositive, {} ); // $ExpectType Uint8ClampedArray - filter( toAccessorArray( [ 1, 2, 3 ] ), isPositive, {} ); // $ExpectType number[] -} - -// The compiler throws an error if the function is provided a first argument which is not a collection... -{ - filter( 2, isPositive ); // $ExpectError - filter( false, isPositive ); // $ExpectError - filter( true, isPositive ); // $ExpectError - filter( {}, isPositive ); // $ExpectError - - filter( 2, isPositive, {} ); // $ExpectError - filter( false, isPositive, {} ); // $ExpectError - filter( true, isPositive, {} ); // $ExpectError - filter( {}, isPositive, {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided a second argument which is not a function... -{ - filter( [ 1, 2, 3 ], 'abc' ); // $ExpectError - filter( [ 1, 2, 3 ], 2 ); // $ExpectError - filter( [ 1, 2, 3 ], false ); // $ExpectError - filter( [ 1, 2, 3 ], true ); // $ExpectError - filter( [ 1, 2, 3 ], null ); // $ExpectError - filter( [ 1, 2, 3 ], void 0 ); // $ExpectError - filter( [ 1, 2, 3 ], {} ); // $ExpectError - filter( [ 1, 2, 3 ], [] ); // $ExpectError - - filter( [ 1, 2, 3 ], 'abc', {} ); // $ExpectError - filter( [ 1, 2, 3 ], 2, {} ); // $ExpectError - filter( [ 1, 2, 3 ], false, {} ); // $ExpectError - filter( [ 1, 2, 3 ], true, {} ); // $ExpectError - filter( [ 1, 2, 3 ], null, {} ); // $ExpectError - filter( [ 1, 2, 3 ], void 0, {} ); // $ExpectError - filter( [ 1, 2, 3 ], {}, {} ); // $ExpectError - filter( [ 1, 2, 3 ], [], {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided an unsupported number of arguments... -{ - filter(); // $ExpectError - filter( [ 1, 2, 3 ] ); // $ExpectError - filter( [ 1, 2, 3 ], isPositive, {}, 3 ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index cdfb9a7..0000000 --- a/examples/index.js +++ /dev/null @@ -1,35 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 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'; - -var discreteUniform = require( '@stdlib/random-array-discrete-uniform' ); -var isPositiveInteger = require( '@stdlib/assert-is-positive-integer' ).isPrimitive; -var naryFunction = require( '@stdlib/utils-nary-function' ); -var filter = require( './../lib' ); - -var x = discreteUniform( 10, -5, 5, { - 'dtype': 'int32' -}); -// returns - -var out = filter( x, naryFunction( isPositiveInteger, 1 ) ); -// returns - -console.log( x ); -console.log( out ); diff --git a/docs/types/index.d.ts b/index.d.ts similarity index 99% rename from docs/types/index.d.ts rename to index.d.ts index c13a05b..20c1fcd 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 4.1 -/// +/// import { Collection, AccessorArrayLike, Complex128Array, Complex64Array } from '@stdlib/types/array'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..9c58a52 --- /dev/null +++ b/index.mjs @@ -0,0 +1,4 @@ +// Copyright (c) 2025 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 +/// +import r from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-arraylike2object@v0.2.1-esm/index.mjs";function t(t,e,n){var o;return function(r,t){return"function"==typeof r[t]}(t,"filter")?t.filter(e,n):(o=r(t)).accessorProtocol?function(r,t,e){var n,o,a,s,c;for(n=r.data,o=r.accessors[0],a=[],c=0;c 0;\n* }\n*\n* var x = [ 1, -2, -3, 4 ];\n*\n* var out = internal( x, isPositive );\n* // returns [ 1, 4 ]\n*/\nfunction internal( x, predicate, thisArg ) {\n\tvar out;\n\tvar v;\n\tvar i;\n\n\tout = [];\n\tfor ( i = 0; i < x.length; i++ ) {\n\t\tv = x[ i ];\n\t\tif ( predicate.call( thisArg, v, i, x ) ) {\n\t\t\tout.push( v );\n\t\t}\n\t}\n\treturn out;\n}\n\n/**\n* Returns a shallow copy of an array containing only those elements which pass a test implemented by a predicate function.\n*\n* @private\n* @param {Object} x - input array object\n* @param {Function} predicate - test function\n* @param {*} thisArg - execution context\n* @returns {Array} output array\n*\n* @example\n* import toAccessorArray from '@stdlib/array-base-to-accessor-array';\n* import arraylike2object from '@stdlib/array-base-arraylike2object';\n*\n* function isPositive( v ) {\n* return v > 0;\n* }\n*\n* var x = arraylike2object( toAccessorArray( [ 1, -2, -3, 4 ] ) );\n*\n* var out = accessors( x, isPositive );\n* // returns [ 1, 4 ]\n*/\nfunction accessors( x, predicate, thisArg ) {\n\tvar data;\n\tvar get;\n\tvar out;\n\tvar v;\n\tvar i;\n\n\tdata = x.data;\n\tget = x.accessors[ 0 ];\n\n\tout = [];\n\tfor ( i = 0; i < data.length; i++ ) {\n\t\tv = get( data, i );\n\t\tif ( predicate.call( thisArg, v, i, data ) ) {\n\t\t\tout.push( v );\n\t\t}\n\t}\n\treturn out;\n}\n\n\n// MAIN //\n\n/**\n* Returns a shallow copy of an array containing only those elements which pass a test implemented by a predicate function.\n*\n* @param {Collection} x - input array\n* @param {Function} predicate - test function\n* @param {*} [thisArg] - execution context\n* @returns {Collection} output array\n*\n* @example\n* function isPositive( v ) {\n* return v > 0;\n* }\n*\n* var x = [ 1, -2, -3, 4 ];\n*\n* var out = filter( x, isPositive );\n* // returns [ 1, 4 ]\n*/\nfunction filter( x, predicate, thisArg ) {\n\tvar obj;\n\tif ( hasMethod( x, 'filter' ) ) {\n\t\treturn x.filter( predicate, thisArg );\n\t}\n\tobj = arraylike2object( x );\n\tif ( obj.accessorProtocol ) {\n\t\treturn accessors( obj, predicate, thisArg );\n\t}\n\treturn internal( x, predicate, thisArg );\n}\n\n\n// EXPORTS //\n\nexport default filter;\n"],"names":["filter","x","predicate","thisArg","obj","method","hasMethod","arraylike2object","accessorProtocol","data","get","out","v","i","accessors","length","call","push","internal"],"mappings":";;sGAgJA,SAASA,EAAQC,EAAGC,EAAWC,GAC9B,IAAIC,EACJ,OAvGD,SAAoBA,EAAKC,GACxB,MAAkC,mBAAlBD,EAAKC,EACtB,CAqGMC,CAAWL,EAAG,UACXA,EAAED,OAAQE,EAAWC,IAE7BC,EAAMG,EAAkBN,IACfO,iBA/CV,SAAoBP,EAAGC,EAAWC,GACjC,IAAIM,EACAC,EACAC,EACAC,EACAC,EAMJ,IAJAJ,EAAOR,EAAEQ,KACTC,EAAMT,EAAEa,UAAW,GAEnBH,EAAM,GACAE,EAAI,EAAGA,EAAIJ,EAAKM,OAAQF,IAC7BD,EAAIF,EAAKD,EAAMI,GACVX,EAAUc,KAAMb,EAASS,EAAGC,EAAGJ,IACnCE,EAAIM,KAAML,GAGZ,OAAOD,CACR,CA8BSG,CAAWV,EAAKF,EAAWC,GArFpC,SAAmBF,EAAGC,EAAWC,GAChC,IAAIQ,EACAC,EACAC,EAGJ,IADAF,EAAM,GACAE,EAAI,EAAGA,EAAIZ,EAAEc,OAAQF,IAC1BD,EAAIX,EAAGY,GACFX,EAAUc,KAAMb,EAASS,EAAGC,EAAGZ,IACnCU,EAAIM,KAAML,GAGZ,OAAOD,CACR,CA0EQO,CAAUjB,EAAGC,EAAWC,EAChC"} \ No newline at end of file diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index 56236cd..0000000 --- a/lib/index.js +++ /dev/null @@ -1,46 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 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'; - -/** -* Return a shallow copy of an array containing only those elements which pass a test implemented by a predicate function. -* -* @module @stdlib/array-base-filter -* -* @example -* var filter = require( '@stdlib/array-base-filter' ); -* -* function isPositive( v ) { -* return v > 0; -* } -* -* var x = [ 1, -2, -3, 4 ]; -* -* var out = filter( x, isPositive ); -* // returns [ 1, 4 ] -*/ - -// MODULES // - -var main = require( './main.js' ); - - -// EXPORTS // - -module.exports = main; diff --git a/lib/main.js b/lib/main.js deleted file mode 100644 index 9b0c3db..0000000 --- a/lib/main.js +++ /dev/null @@ -1,160 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 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 arraylike2object = require( '@stdlib/array-base-arraylike2object' ); - - -// FUNCTIONS // - -/** -* Tests whether an object has a specified method. -* -* @private -* @param {Object} obj - input object -* @param {string} method - method name -* @returns {boolean} boolean indicating whether an object has a specified method -* -* @example -* var bool = hasMethod( [], 'filter' ); -* // returns true -* -* @example -* var bool = hasMethod( [], 'beep' ); -* // returns false -*/ -function hasMethod( obj, method ) { - return ( typeof obj[ method ] === 'function' ); -} - -/** -* Returns a shallow copy of an array containing only those elements which pass a test implemented by a predicate function. -* -* @private -* @param {Collection} x - input array -* @param {Function} predicate - test function -* @param {*} thisArg - execution context -* @returns {Array} output array -* -* @example -* function isPositive( v ) { -* return v > 0; -* } -* -* var x = [ 1, -2, -3, 4 ]; -* -* var out = internal( x, isPositive ); -* // returns [ 1, 4 ] -*/ -function internal( x, predicate, thisArg ) { - var out; - var v; - var i; - - out = []; - for ( i = 0; i < x.length; i++ ) { - v = x[ i ]; - if ( predicate.call( thisArg, v, i, x ) ) { - out.push( v ); - } - } - return out; -} - -/** -* Returns a shallow copy of an array containing only those elements which pass a test implemented by a predicate function. -* -* @private -* @param {Object} x - input array object -* @param {Function} predicate - test function -* @param {*} thisArg - execution context -* @returns {Array} output array -* -* @example -* var toAccessorArray = require( '@stdlib/array-base-to-accessor-array' ); -* var arraylike2object = require( '@stdlib/array-base-arraylike2object' ); -* -* function isPositive( v ) { -* return v > 0; -* } -* -* var x = arraylike2object( toAccessorArray( [ 1, -2, -3, 4 ] ) ); -* -* var out = accessors( x, isPositive ); -* // returns [ 1, 4 ] -*/ -function accessors( x, predicate, thisArg ) { - var data; - var get; - var out; - var v; - var i; - - data = x.data; - get = x.accessors[ 0 ]; - - out = []; - for ( i = 0; i < data.length; i++ ) { - v = get( data, i ); - if ( predicate.call( thisArg, v, i, data ) ) { - out.push( v ); - } - } - return out; -} - - -// MAIN // - -/** -* Returns a shallow copy of an array containing only those elements which pass a test implemented by a predicate function. -* -* @param {Collection} x - input array -* @param {Function} predicate - test function -* @param {*} [thisArg] - execution context -* @returns {Collection} output array -* -* @example -* function isPositive( v ) { -* return v > 0; -* } -* -* var x = [ 1, -2, -3, 4 ]; -* -* var out = filter( x, isPositive ); -* // returns [ 1, 4 ] -*/ -function filter( x, predicate, thisArg ) { - var obj; - if ( hasMethod( x, 'filter' ) ) { - return x.filter( predicate, thisArg ); - } - obj = arraylike2object( x ); - if ( obj.accessorProtocol ) { - return accessors( obj, predicate, thisArg ); - } - return internal( x, predicate, thisArg ); -} - - -// EXPORTS // - -module.exports = filter; diff --git a/package.json b/package.json index 317e1f2..20cda5b 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.2.2", "description": "Return a shallow copy of an array containing only those elements which pass a test implemented by a predicate function.", "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", - "directories": { - "benchmark": "./benchmark", - "doc": "./docs", - "example": "./examples", - "lib": "./lib", - "test": "./test" - }, - "types": "./docs/types", - "scripts": { - "test": "make test", - "test-cov": "make test-cov", - "examples": "make examples", - "benchmark": "make benchmark" - }, + "type": "module", + "main": "./index.mjs", "homepage": "https://stdlib.io", "repository": { "type": "git", @@ -36,42 +13,6 @@ "bugs": { "url": "https://github.com/stdlib-js/stdlib/issues" }, - "dependencies": { - "@stdlib/array-base-arraylike2object": "^0.2.1", - "@stdlib/types": "^0.4.3", - "@stdlib/error-tools-fmtprodmsg": "^0.2.2" - }, - "devDependencies": { - "@stdlib/array-base-accessor": "^0.2.2", - "@stdlib/array-base-zero-to": "^0.2.1", - "@stdlib/array-float64": "^0.2.2", - "@stdlib/assert-instance-of": "^0.2.2", - "@stdlib/assert-is-array": "^0.2.2", - "@stdlib/assert-is-nonnegative-integer": "^0.2.2", - "@stdlib/assert-is-positive-integer": "^0.2.2", - "@stdlib/math-base-special-pow": "^0.3.0", - "@stdlib/random-array-discrete-uniform": "^0.2.1", - "@stdlib/utils-nary-function": "^0.2.2", - "tape": "git+https://github.com/kgryte/tape.git#fix/globby", - "istanbul": "^0.4.1", - "tap-min": "git+https://github.com/Planeshifter/tap-min.git", - "@stdlib/bench-harness": "^0.2.2" - }, - "engines": { - "node": ">=0.10.0", - "npm": ">2.7.0" - }, - "os": [ - "aix", - "darwin", - "freebsd", - "linux", - "macos", - "openbsd", - "sunos", - "win32", - "windows" - ], "keywords": [ "stdlib", "stdtypes", @@ -91,4 +32,4 @@ "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} \ No newline at end of file +} diff --git a/stats.html b/stats.html new file mode 100644 index 0000000..d4d08f0 --- /dev/null +++ b/stats.html @@ -0,0 +1,4842 @@ + + + + + + + + Rollup Visualizer + + + +
+ + + + + diff --git a/test/dist/test.js b/test/dist/test.js deleted file mode 100644 index a8a9c60..0000000 --- a/test/dist/test.js +++ /dev/null @@ -1,33 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 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 tape = require( 'tape' ); -var main = require( './../../dist' ); - - -// TESTS // - -tape( 'main export is defined', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( main !== void 0, true, 'main export is defined' ); - t.end(); -}); diff --git a/test/test.js b/test/test.js deleted file mode 100644 index d4e7373..0000000 --- a/test/test.js +++ /dev/null @@ -1,251 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 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 tape = require( 'tape' ); -var AccessorArray = require( '@stdlib/array-base-accessor' ); -var Float64Array = require( '@stdlib/array-float64' ); -var instanceOf = require( '@stdlib/assert-instance-of' ); -var filter = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Tests whether a value is positive. -* -* @private -* @param {number} value - input value -* @returns {boolean} boolean indicating if a value is positive -*/ -function isPositive( value ) { - return ( value > 0 ); -} - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof filter, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'if provided an empty collection, the function returns an empty collection (generic)', function test( t ) { - var expected; - var actual; - var arr; - - arr = []; - expected = []; - actual = filter( arr, foo ); - - t.strictEqual( instanceOf( actual, Array ), true, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - t.end(); - - function foo() { - t.fail( 'should not be invoked' ); - } -}); - -tape( 'if provided an empty collection, the function returns an empty collection (typed array)', function test( t ) { - var expected; - var actual; - var arr; - - arr = new Float64Array( [] ); - expected = new Float64Array( [] ); - actual = filter( arr, foo ); - - t.strictEqual( instanceOf( actual, Float64Array ), true, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - t.end(); - - function foo() { - t.fail( 'should not be invoked' ); - } -}); - -tape( 'if provided an empty collection, the function returns an empty collection (accessor)', function test( t ) { - var expected; - var actual; - var arr; - - arr = new AccessorArray( [] ); - expected = []; - actual = filter( arr, foo ); - - t.strictEqual( instanceOf( actual, Array ), true, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - t.end(); - - function foo() { - t.fail( 'should not be invoked' ); - } -}); - -tape( 'the function filters a provided collection (generic)', function test( t ) { - var expected; - var actual; - var arr; - - arr = [ 1, -2, 3 ]; - expected = [ 1, 3 ]; - actual = filter( arr, isPositive ); - - t.strictEqual( instanceOf( actual, Array ), true, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - t.end(); -}); - -tape( 'the function filters a provided collection (typed array)', function test( t ) { - var expected; - var actual; - var arr; - - arr = new Float64Array( [ -1.0, 2.0, 3.0 ] ); - expected = new Float64Array( [ 2.0, 3.0 ] ); - actual = filter( arr, isPositive ); - - t.strictEqual( instanceOf( actual, Float64Array ), true, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - t.end(); -}); - -tape( 'the function filters a provided collection (accessor)', function test( t ) { - var expected; - var actual; - var arr; - - arr = new AccessorArray( [ 1, -2, -3 ] ); - expected = [ 1 ]; - actual = filter( arr, isPositive ); - - t.strictEqual( instanceOf( actual, Array ), true, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - t.end(); -}); - -tape( 'the function filters a provided collection (array-like object)', function test( t ) { - var expected; - var actual; - var arr; - - arr = { - 'length': 3, - '0': -1, - '1': -2, - '2': 3 - }; - expected = [ 3 ]; - actual = filter( arr, isPositive ); - - t.strictEqual( instanceOf( actual, Array ), true, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - t.end(); -}); - -tape( 'the function an empty collection if all elements fail a test (generic)', function test( t ) { - var expected; - var actual; - var arr; - - arr = [ -1, -2, -3 ]; - expected = []; - actual = filter( arr, isPositive ); - - t.strictEqual( instanceOf( actual, Array ), true, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - t.end(); -}); - -tape( 'the function an empty collection if all elements fail a test (typed array)', function test( t ) { - var expected; - var actual; - var arr; - - arr = new Float64Array( [ -1.0, -2.0, -3.0 ] ); - expected = new Float64Array( [] ); - actual = filter( arr, isPositive ); - - t.strictEqual( instanceOf( actual, Float64Array ), true, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - t.end(); -}); - -tape( 'the function an empty collection if all elements fail a test (accessor)', function test( t ) { - var expected; - var actual; - var arr; - - arr = new AccessorArray( [ -1, -2, -3 ] ); - expected = []; - actual = filter( arr, isPositive ); - - t.strictEqual( instanceOf( actual, Array ), true, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - t.end(); -}); - -tape( 'the function an empty collection if all elements fail a test (array-like object)', function test( t ) { - var expected; - var actual; - var arr; - - arr = { - 'length': 3, - '0': -1, - '1': -2, - '2': -3 - }; - expected = []; - actual = filter( arr, isPositive ); - - t.strictEqual( instanceOf( actual, Array ), true, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - t.end(); -}); - -tape( 'the function supports providing an execution context', function test( t ) { - var expected; - var actual; - var ctx; - var arr; - - ctx = { - 'count': 0 - }; - arr = [ 1, 2, 3 ]; - expected = [ 1, 2, 3 ]; - actual = filter( arr, predicate, ctx ); - - t.strictEqual( instanceOf( actual, Array ), true, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - t.strictEqual( ctx.count, arr.length, 'returns expected value' ); - - t.end(); - - function predicate( value ) { - this.count += 1; // eslint-disable-line no-invalid-this - return ( value > 0 ); - } -});