# @hoast/base-source

> Base package for source packages.

Latest version **3.1.1** (published 2024-02-17) · MIT license · 0 weekly downloads

## Install

```sh
npm install @hoast/base-source
pnpm add @hoast/base-source
yarn add @hoast/base-source
bun add @hoast/base-source
```

## Health

**Score 30/100 (F)** — status: abandoned.

Positive: esm support; no vulnerabilities.

Warnings: low downloads; no types.

Negative: abandoned.

## Facts

| | |
|---|---|
| Version | 3.1.1 |
| Published | 2024-02-17 |
| First published | 2020-10-06 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Dependencies | 1 |
| Unpacked size | 8.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 3 |
| Author | Ron Dekker |
| Maintainers | redkenrok |
| Keywords | hoast, base, source |

## Links

- npm: https://www.npmjs.com/package/@hoast/base-source
- Repository: https://github.com/hoast/hoast
- Homepage: https://github.com/hoast/hoast/tree/main/packages/base-source#readme
- Issues: https://github.com/hoast/hoast/issues
- npm.io page: https://npm.io/package/@hoast/base-source

## Dependencies (1)

- [@hoast/base-package](https://npm.io/package/@hoast/base-package.md) ^3.0.0

## Alternatives

- [flatbuffers](https://npm.io/package/flatbuffers.md) — 6.0M weekly downloads
- [jwt-simple](https://npm.io/package/jwt-simple.md) — 259.5K weekly downloads
- [@exodus/patch-broken-hermes-typed-arrays](https://npm.io/package/@exodus/patch-broken-hermes-typed-arrays.md) — 28.5K weekly downloads
- [@native-to-anchor/buffer-layout](https://npm.io/package/@native-to-anchor/buffer-layout.md) — 12.2K weekly downloads
- [binary-parser-encoder](https://npm.io/package/binary-parser-encoder.md) — 5.3K weekly downloads

## Recent versions

- 3.1.1 (latest) — 2024-02-17
- 3.1.0 — 2024-02-11
- 3.0.0 — 2021-05-23
- 2.0.0 — 2020-10-06

## README

# @hoast/base-source

Provides basic functionality for source package like an initialization function, sequentially running of certain code, and a finallize function called after the source is done iterating. Meant for developers to be used as a base for a [hoast](https://hoast.js.org) source package.

## Install

```ZSH
npm install @hoast/base-source
```

## Usage

> Extends [BasePackage](https://github.com/hoast/hoast/tree/main/packages/base-package#readme).

### Constructor

- `constructor` Create package instance.
  - `@param {Object} ...Options` Options objects which can contain the following keys.
    - `{Number} logLevel = 2` Log level given to the [logger](https://github.com/hoast/hoast/tree/main/packages/utils#logger.js).

### Variables

- `{Boolean} done` Is set to true if all items are returned.
- `{Boolean} exhausted` Set `exhausted` to true if the source has ran out of items to return.

### Functions

- `async next` Will be called by hoast itself to retrieve the next item.
  - `@returns {Any}` Retrieved data.

### Abstract functions

The following functions can be implemented by the derived class and will automatically called if present. All functions are optional and don't have to be asynchronous.

- `async initialize` Called only once before sequential and concurrent.
- `async sequential` Called sequentially for each iteration call. Meaning while this method is running it won't be called until the ongoing call is finished. Useful for processes that have to happen in order. Useful for iterating over the items in the filesystem.
  - `@returns {Any}` Item.
- `async concurrent` Called concurrently for each iteration call after the sequential call. Meaning this will run after the sequential call and in contrast to the sequential function will be called before a previous call has finished. Useful for reading file contents from the filesystem.
  - `@params {Any}` Data returned by the sequential method.
  - `@returns {Any}` Item.
- `async final` Called after the source has been exhausted and is finished.

### Example

```JavaScript
// Import base modules.
import BaseSource from '@hoast/base-source'

class NewSource extends BaseSource {
  constructor(options) {
    super({
      // Default options.
    }, options)
  }

  async initialize() {
    // Initialize.
  }

  async sequential() {
    // Sequential.
    this.exhausted = true
    return {}
  }

  async concurrent(data) {
    // Concurrent.
    return data
  }

  async final() {
    // Final.
  }
}

export default NewSource
```

See the [@hoast/source-readfiles](https://github.com/hoast/hoast/tree/main/packages/source-readfiles#readme) package for another example.

---
_Source: https://npm.io/package/@hoast/base-source · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._