npmpackage.info

Gathering detailed insights and metrics for @stdlib/utils-index-of

Other packages similar to @stdlib/utils-index-of

@stdlib/ndarray-index-modes

0.2.2

List of ndarray index modes.

@stdlib/ndarray-base-offset

0.2.2

Return the index offset specifying the underlying buffer index of the first iterated ndarray element.

@stdlib/ndarray-base-strides2offset

0.2.2

Determine the index offset which specifies the location of the first indexed value in a multidimensional array based on a stride array.

@stdlib/ndarray-base-next-cartesian-index

0.2.2

Return the next Cartesian index (i.e., set of subscripts/dimension indices).

Gathering detailed insights and metrics for @stdlib/utils-index-of

@stdlib/utils-index-of - 0.2.2 | npmpackage.info

@stdlib/utils-index-of

Return the first index at which a given element can be found.

0.2.2

Apache-2.0

JavaScript

34.22 kB

4.2

Installations

npm install @stdlib/utils-index-of

Developer Guide

BETA

Typescript

Yes

Module System

CommonJS

Min. Node Version

>=0.10.0

Node Version

16.20.2

NPM Version

8.19.4 Pull Requests

Open

0

Total

0

Closed

0

Issues

Open

0

Total

0

Closed

0

Releases

Unable to fetch releases

Languages

JavaScript

JavaScript (100%)

Developer

stdlib-js

Download Statistics

Total Downloads

Last Day

Last Week

Last Month

Last Year

GitHub Statistics

Apache-2.0 License

2 Stars

64 Commits

3 Watchers

5 Branches

14 Contributors

Updated on May 19, 2025

Sponsor this package

https://opencollective.com/stdlib

Maintainers

View All 14 Contributors

Package Meta Information

Latest Version

0.2.2

Package Id

@stdlib/utils-index-of@0.2.2

Unpacked Size

34.22 kB

Size

9.58 kB

File Count

NPM Version

8.19.4

Node Version

16.20.2

Published on

Jul 28, 2024

Total Downloads

Cumulative downloads

Total Downloads

NaN

Last Day

NaN

Compared to previous day

Last Week

NaN

Compared to previous week

Last Month

NaN

Compared to previous month

Last Year

NaN

Compared to previous year

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

@stdlib/assert-is-collection @stdlib/assert-is-integer @stdlib/assert-is-nan @stdlib/assert-is-string @stdlib/string-format @stdlib/error-tools-fmtprodmsg

About stdlib...

We believe in a future in which the web is a preferred environment for numerical computation. To help realize this future, we've built stdlib. stdlib is a standard library, with an emphasis on numerical and scientific computation, written in JavaScript (and C) for execution in browsers and in Node.js.

The library is fully decomposable, being architected in such a way that you can swap out and mix and match APIs and functionality to cater to your exact preferences and use cases.

When you use stdlib, you can be absolutely certain that you are using the most thorough, rigorous, well-written, studied, documented, tested, measured, and high-quality code out there.

To join us in bringing numerical computing to the web, get started by checking us out on GitHub, and please consider financially supporting stdlib. We greatly appreciate your continued support!

indexOf

Return the first index at which a given element can be found.

Installation

1npm install @stdlib/utils-index-of

Usage

1var indexOf = require( '@stdlib/utils-index-of' );

indexOf( arr, searchElement[, fromIndex] )

Returns the first index at which a given element can be found.

1var arr = [ 4, 3, 2, 1 ];
2
3var idx = indexOf( arr, 3 );
4// returns 1

If a searchElement is not present in an input array, the function returns -1.

1var arr = [ 4, 3, 2, 1 ];
2
3var idx = indexOf( arr, 5 );
4// returns -1

By default, the implementation searches an input array starting from the first element. To start searching from a different element, specify a fromIndex.

1var arr = [ 1, 2, 3, 4, 5, 2, 6 ];
2
3var idx = indexOf( arr, 2, 3 );
4// returns 5

If a fromIndex exceeds the input array length, the function returns -1.

1var arr = [ 1, 2, 3, 4, 2, 5 ];
2
3var idx = indexOf( arr, 2, 10 );
4// returns -1

If a fromIndex is less than 0, the starting index is determined relative to the last index (with the last index being equivalent to fromIndex = -1).

1var arr = [ 1, 2, 3, 4, 5, 2, 6, 2 ];
2
3var idx = indexOf( arr, 2, -4 );
4// returns 5
5
6idx = indexOf( arr, 2, -1 );
7// returns 7

If fromIndex is less than 0 and its absolute value exceeds the input array length, the function searches the entire input array.

1var arr = [ 1, 2, 3, 4, 5, 2, 6 ];
2
3var idx = indexOf( arr, 2, -10 );
4// returns 1

The first argument is not limited to arrays, but may be any array-like object.

1var str = 'bebop';
2
3var idx = indexOf( str, 'o' );
4// returns 3

Notes

Search is performed using strict equality comparison. Thus,

1var arr = [ 1, [ 1, 2, 3 ], 3 ];
2
3var idx = indexOf( arr, [ 1, 2, 3 ] );
4// returns -1

This implementation is not ECMAScript Standard compliant. Notably, the standard specifies that an array be searched by calling hasOwnProperty (thus, for most cases, incurring a performance penalty), and the standard does not accommodate a searchElement equal to NaN. In this implementation, the following is possible:

1// Locate the first element which is NaN...
2var arr = [ 1, NaN, 2, NaN ];
3
4var idx = indexOf( arr, NaN );
5// returns 1
6
7// Prototype properties may be searched as well...
8function Obj() {
9    this[ 0 ] = 'beep';
10    this[ 1 ] = 'boop';
11    this[ 2 ] = 'woot';
12    this[ 3 ] = 'bap';
13    this.length = 4;
14    return this;
15}
16Obj.prototype[ 2 ] = 'bop';
17
18var obj = new Obj();
19
20idx = indexOf( obj, 'bop' );
21// returns -1
22
23delete obj[ 2 ];
24
25idx = indexOf( obj, 'bop' );
26// returns 2

Examples

1var indexOf = require( '@stdlib/utils-index-of' );
2
3var arr;
4var obj;
5var str;
6var idx;
7var i;
8
9// Arrays...
10arr = new Array( 10 );
11for ( i = 0; i < arr.length; i++ ) {
12    arr[ i ] = i * 10;
13}
14idx = indexOf( arr, 40 );
15
16console.log( idx );
17// => 4
18
19// Array-like objects...
20obj = {
21    '0': 'beep',
22    '1': 'boop',
23    '2': 'bap',
24    '3': 'bop',
25    'length': 4
26};
27
28idx = indexOf( obj, 'bap' );
29
30console.log( idx );
31// => 2
32
33// Strings...
34str = 'beepboopbop';
35
36idx = indexOf( str, 'o' );
37
38console.log( idx );
39// => 5

Notice

This package is part of stdlib, a standard library for JavaScript and Node.js, with an emphasis on numerical and scientific computing. The library provides a collection of robust, high performance libraries for mathematics, statistics, streams, utilities, and more.

For more information on the project, filing bug reports and feature requests, and guidance on how to develop stdlib, see the main project repository.

Community

License

See LICENSE.

Copyright

No vulnerabilities found.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

10

Dangerous-Workflow

Determines if the project's GitHub Action workflows avoid dangerous patterns.

10

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

10

License

Determines if the project has defined a license.

9

Security-Policy

Determines if the project has published a security policy.

3

Pinned-Dependencies

Determines if the project has declared and pinned the dependencies of its build process.

Reason

dependency not pinned by hash detected -- score normalized to 3

Details

Warn: third-party GitHubAction not pinned by hash: .github/workflows/productionize.yml:449: update your workflow using https://app.stepsecurity.io/secureworkflow/stdlib-js/utils-index-of/productionize.yml/main?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/productionize.yml:457: update your workflow using https://app.stepsecurity.io/secureworkflow/stdlib-js/utils-index-of/productionize.yml/main?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/productionize.yml:623: update your workflow using https://app.stepsecurity.io/secureworkflow/stdlib-js/utils-index-of/productionize.yml/main?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/productionize.yml:85: update your workflow using https://app.stepsecurity.io/secureworkflow/stdlib-js/utils-index-of/productionize.yml/main?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/productionize.yml:275: update your workflow using https://app.stepsecurity.io/secureworkflow/stdlib-js/utils-index-of/productionize.yml/main?enable=pin
Warn: npmCommand not pinned by hash: .github/workflows/benchmark.yml:58
Warn: npmCommand not pinned by hash: .github/workflows/benchmark.yml:58
Warn: npmCommand not pinned by hash: .github/workflows/benchmark.yml:58
Warn: npmCommand not pinned by hash: .github/workflows/examples.yml:58
Warn: npmCommand not pinned by hash: .github/workflows/examples.yml:58
Warn: npmCommand not pinned by hash: .github/workflows/examples.yml:58
Warn: npmCommand not pinned by hash: .github/workflows/productionize.yml:269
Warn: npmCommand not pinned by hash: .github/workflows/productionize.yml:269
Warn: npmCommand not pinned by hash: .github/workflows/productionize.yml:269
Warn: npmCommand not pinned by hash: .github/workflows/productionize.yml:436
Warn: npmCommand not pinned by hash: .github/workflows/productionize.yml:436
Warn: npmCommand not pinned by hash: .github/workflows/productionize.yml:436
Warn: npmCommand not pinned by hash: .github/workflows/productionize.yml:617
Warn: npmCommand not pinned by hash: .github/workflows/productionize.yml:617
Warn: npmCommand not pinned by hash: .github/workflows/productionize.yml:617
Warn: npmCommand not pinned by hash: .github/workflows/productionize.yml:157
Warn: npmCommand not pinned by hash: .github/workflows/productionize.yml:157
Warn: npmCommand not pinned by hash: .github/workflows/productionize.yml:157
Warn: npmCommand not pinned by hash: .github/workflows/productionize.yml:165
Warn: npmCommand not pinned by hash: .github/workflows/test.yml:76
Warn: npmCommand not pinned by hash: .github/workflows/test.yml:76
Warn: npmCommand not pinned by hash: .github/workflows/test.yml:76
Warn: npmCommand not pinned by hash: .github/workflows/test.yml:83
Warn: npmCommand not pinned by hash: .github/workflows/test_bundles.yml:72
Warn: npmCommand not pinned by hash: .github/workflows/test_coverage.yml:67
Warn: npmCommand not pinned by hash: .github/workflows/test_coverage.yml:67
Warn: npmCommand not pinned by hash: .github/workflows/test_coverage.yml:67
Warn: npmCommand not pinned by hash: .github/workflows/test_coverage.yml:74
Warn: npmCommand not pinned by hash: .github/workflows/test_install.yml:75
Warn: npmCommand not pinned by hash: .github/workflows/test_install.yml:75
Warn: npmCommand not pinned by hash: .github/workflows/test_install.yml:75
Warn: npmCommand not pinned by hash: .github/workflows/test_published_package.yml:93
Info: 33 out of 33 GitHub-owned GitHubAction dependencies pinned
Info: 19 out of 24 third-party GitHubAction dependencies pinned
Info: 0 out of 32 npmCommand dependencies pinned

0

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

0

Maintained

Determines if the project is "actively maintained".

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

SAST

Determines if the project uses static code analysis.

0

Token-Permissions

Determines if the project's workflows follow the principle of least privilege.

0

Fuzzing

Determines if the project uses fuzzing.

0

Branch-Protection

Determines if the default and release branches are protected with GitHub's branch protection settings.

Score

4.2

/10

Last Scanned on 2025-06-30

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More