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

std/bytes/includes_needle.ts

The Deno Standard Library
Latest
File
// Copyright 2018-2024 the Deno authors. All rights reserved. MIT license.// This module is browser compatible.
import { indexOfNeedle } from "./index_of_needle.ts";
/** * Determines whether the source array contains the needle array. * * The complexity of this function is `O(source.length * needle.length)`. * * @param source Source array to check. * @param needle Needle array to check for. * @param start Start index in the source array to begin the search. Defaults to * 0. * @returns `true` if the source array contains the needle array, `false` * otherwise. * * @example Basic usage * ```ts * import { includesNeedle } from "https://deno.land/std@$STD_VERSION/bytes/includes_needle.ts"; * * const source = new Uint8Array([0, 1, 2, 1, 2, 1, 2, 3]); * const needle = new Uint8Array([1, 2]); * * includesNeedle(source, needle); // true * ``` * * @example Start index * ```ts * import { includesNeedle } from "https://deno.land/std@$STD_VERSION/bytes/includes_needle.ts"; * * const source = new Uint8Array([0, 1, 2, 1, 2, 1, 2, 3]); * const needle = new Uint8Array([1, 2]); * * includesNeedle(source, needle, 6); // false * ``` * The search will start at the specified index in the source array. */export function includesNeedle( source: Uint8Array, needle: Uint8Array, start = 0,): boolean { return indexOfNeedle(source, needle, start) !== -1;}