Skip to main content
Using Deno in production at your company? Earn free Deno merch.
Give us feedback
Module

std/bytes/mod.ts>indexOfNeedle

The Deno Standard Library
Latest
function indexOfNeedle
Re-export
import { indexOfNeedle } from "https://deno.land/std@0.224.0/bytes/mod.ts";

Returns the index of the first occurrence of the needle array in the source array, or -1 if it is not present.

A start index can be specified as the third argument that begins the search at that given index. The start index defaults to the start of the array.

The complexity of this function is O(source.length * needle.length).

Examples

Basic usage

import { indexOfNeedle } from "https://deno.land/std@0.224.0/bytes/index_of_needle.ts";

const source = new Uint8Array([0, 1, 2, 1, 2, 1, 2, 3]);
const needle = new Uint8Array([1, 2]);
const notNeedle = new Uint8Array([5, 0]);

indexOfNeedle(source, needle); // 1
indexOfNeedle(source, notNeedle); // -1

Start index

import { indexOfNeedle } from "https://deno.land/std@0.224.0/bytes/index_of_needle.ts";

const source = new Uint8Array([0, 1, 2, 1, 2, 1, 2, 3]);
const needle = new Uint8Array([1, 2]);

indexOfNeedle(source, needle, 2); // 3
indexOfNeedle(source, needle, 6); // -1

Defining a start index will begin the search at the specified index in the source array.

Parameters

source: Uint8Array

Source array to check.

needle: Uint8Array

Needle array to check for.

optional
start = [UNSUPPORTED]

Start index in the source array to begin the search. Defaults to 0.

Returns

number

Index of the first occurrence of the needle array in the source array, or -1 if it is not present.