1
0
Fork 0
js-utils/docs/api/js-utils.checklist.md

35 lines
1.2 KiB
Markdown

<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [@apextoaster/js-utils](./js-utils.md) &gt; [Checklist](./js-utils.checklist.md)
## Checklist class
Check whether items are included or not.
<b>Signature:</b>
```typescript
export declare class Checklist<T> implements ChecklistOptions<T>
```
<b>Implements:</b> [ChecklistOptions](./js-utils.checklistoptions.md)<!-- -->&lt;T&gt;
## Constructors
| Constructor | Modifiers | Description |
| --- | --- | --- |
| [(constructor)(options)](./js-utils.checklist._constructor_.md) | | Constructs a new instance of the <code>Checklist</code> class |
## Properties
| Property | Modifiers | Type | Description |
| --- | --- | --- | --- |
| [data](./js-utils.checklist.data.md) | <code>readonly</code> | Array&lt;T&gt; | TODO: switch to Set |
| [mode](./js-utils.checklist.mode.md) | <code>readonly</code> | [ChecklistMode](./js-utils.checklistmode.md) | |
## Methods
| Method | Modifiers | Description |
| --- | --- | --- |
| [check(value)](./js-utils.checklist.check.md) | | Check whether a value is included or excluded from this checklist (depending on <code>mode</code>). |