# isAllowedId()

## `CommonErrors.prototype.isAllowedId()`

Checks whether the given [identification](https://docs.angular-package.dev/error/getting-started/basic-concepts#unique-identification) number was provided in the [constructor](https://docs.angular-package.dev/error/commonerrors/constructor).

{% code title="common-errors.class.ts" %}

```typescript
protected isAllowedId<ErrorId extends Id>(id: ErrorId): boolean {
  return this.#id ? this.#id.has(id) : false;
}
```

{% endcode %}

### Generic type variables

#### <mark style="color:green;">`ErrorId`</mark>`extends`[<mark style="color:green;">`Id`</mark>](https://docs.angular-package.dev/error/generic-type-variables#commonerrors-less-than-id-greater-than)

A generic type variable `ErrorId` constrained by the generic type variable [`Id`](https://docs.angular-package.dev/error/generic-type-variables#commonerrors-less-than-id-greater-than) of the [`CommonErrors`](https://docs.angular-package.dev/error/commonerrors) object indicates the type picked from the [`Id`](https://docs.angular-package.dev/error/generic-type-variables#commonerrors-less-than-id-greater-than) and its exact type is useful in picking the specific error from the storage.

### Parameters

#### `id:`[<mark style="color:green;">`ErrorId`</mark>](#erroridextendsid)

The error identification number of generic type variable [`ErrorId`](#erroridextendsid) to test for its presence in the object.

### Return type

#### <mark style="color:green;">`this`</mark>

## Example usage

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

// Define new `TestClass` to add error to the map storage.
export class TestClass<Id extends string> extends CommonErrors<Id> {
  public get errors(): Map<Id, any> {
    return super.errors;
  }
  public set<ErrorId extends Id>(
    problem: string,
    fix: string,
    id: ErrorId
  ): this {
    // <--- Use the isAllowedId() here ----------------
    if (super.isAllowedId(id)) {
      this.errors.set(id, new Error(problem, fix, id));
    }
    // <-----------------------------------------------
    return this;
  }
}

// Initialize the `TestClass`.
const generalErrors = new TestClass('EG: 4332', 'EG: 4331', 'EG: 4330');

// Set the errors.
generalErrors
  .set(
    'Bad parameter type, detected number',
    'Provide proper type, the `string`',
    'EG: 3000' as any // <--- Wrong ID
  )
  .set(
    'Detected numbers',
    'Provide only letters',
    'EG: 4335' as any // <--- Wrong ID
  );

// Returns Map(0) {size: 0}
generalErrors.errors;

  // Returns `false`.
generalErrors.has('EG: 3000' as any);

// Returns `false`.
generalErrors.has('EG: 4335' as any);
```


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.angular-package.dev/error/commonerrors/methods/isallowedid.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
