# history

**Repository Path**: mirrors_component/history

## Basic Information

- **Project Name**: history
- **Description**: Keep track of and cycle through capped history (chat messages, REPL command-lines etc)
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-08-08
- **Last Updated**: 2026-05-16

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README


# History

  Keep track of and cycle through capped history (chat messages, REPL command-lines etc).

## Installation

```
$ component install component/history
```

## API

### History(vals)

  Initialize with an array of `vals`.
  
### History#add(val)

  Add a value, for example a chat message or REPL command line.
  This method resets the history index, meaning the next call
  to `.back()` will be this latest value.

### History#prev()

  Cycle backwards through history, returning a value added by `.add()`.

### History#next()

  Cycle forwards through history, returning a value added by `.add()`.

### History#max(n)

  The maximum number of entries defaulting to `1000`.

### History#reset()

  Reset the index to the latest value.

## License

  MIT