# some()

## `areDeterminer().some()`

Checks if some of the provided [`values`](https://type.angular-package.dev/are/aredeterminer/..#...values-any) pass the test implemented by the given [`checkFn`](https://type.angular-package.dev/are/aredeterminer/..#checkfn-function).

{% code title="are-determiner.func.ts" %}

```typescript
{
  some: <Payload extends CommonPayload>(
    callback: ResultCallback<any, Payload> = resultCallback,
    payload?: Payload
  ): boolean =>
    callback(
      isArray(values) ? values.some((value) => checkFn(value)) : false,
      values,
      payload
    ),
}
```

{% endcode %}

### Generic type variables

#### <mark style="color:green;">**`Payload`**</mark>**`extends`**<mark style="color:green;">**`CommonPayload`**</mark>

The `Payload` generic type variable constrained by generic type variable [`CommonPayload`](https://type.angular-package.dev/are/aredeterminer/..#commonpayloadextendsobject) indicates the type of the [`payload`](#payload-payload) parameter from which it gets its value.

### Parameters

#### `callback: ResultCallback<any, Payload>`

A callback `function` of [`ResultCallback`](https://type.angular-package.dev/type/resultcallback) type with parameters, the `value` that has been checked, the `result` of this check, and `payload` of generic type variable `Payload` with optional properties from the provided `payload`, to handle them before the `result` return. By default, it uses `resultCallback()` function.

#### `payload?: Payload`

An optional [`object`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object) of the generic type variable [`Payload`](#payloadextendscommonpayload) is assigned to the [`payload`](https://type.angular-package.dev/type/resultcallback#payload-payload) of the given [`callback`](#callback-resultcallback-less-than-any-payload-greater-than) function.

### Returns

The **return value** is a [`boolean`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean) indicating whether **some** of the provided [`values`](https://type.angular-package.dev/are/aredeterminer/..#...values-any) passed the test of the given [`checkFn`](https://type.angular-package.dev/are/aredeterminer/..#checkfn-function).

## Example usage

```typescript
// Example usage.
import { areDeterminer } from '@angular-package/type';

```