https://github.com/3shain/multishot-generator
https://github.com/3shain/multishot-generator
Last synced: 12 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/3shain/multishot-generator
- Owner: 3Shain
- License: mit
- Created: 2023-11-24T05:50:45.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-11-26T05:19:55.000Z (over 2 years ago)
- Last Synced: 2025-08-11T02:43:53.077Z (12 months ago)
- Language: TypeScript
- Size: 19.5 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Multishot Generator
The `multishot-generator` package provides a unique implementation of multishot generators in TypeScript. This implementation allows generators to be "forked" at any yield point, creating new generators that can continue independently from that point. It is particularly useful in scenarios where you need to explore different paths of execution from a certain state in a generator function.
## Features
- **Efficient Forking**: Create new generator instances at any yield point with minimal overhead (No fork, no replay).
- **History Tracking**: Maintains a history of yielded values for accurate state replication.
- **Pure Generators**: Assumes generator functions are pure for consistent behavior across forks.
## Installation
To install the package, run the following command in your project directory:
```bash
npm install multishot-generator
```
## API Reference
### `multishot(generatorFn: () => Generator): () => MultishotGenerator`
Creates a multishot generator function.
- **`generatorFn`**: A generator function that will be used to create new generator instances.
- **Returns**: A function that, when called, initiates the multishot generator process. This function returns a `MultishotGenerator` union.
### `MultishotGenerator`
The `MultishotGenerator` type is a union of a tuple representing the state of a multishot generator at a specific point in its execution. It can be either of the following:
1. **A Tuple for Yielded Values**: When the generator yields a value, the `MultishotGenerator` is a tuple of the form `[IteratorYieldResult, NextFunction]`. This tuple consists of:
- **`IteratorYieldResult`**: An object with a `value` property containing the yielded value of type `T`, and a `done` property which is `false`.
- **`NextFunction`**: A function with the signature `(value: TNext) => MultishotGenerator`. This function is used to continue or fork the generator's execution with a new value of type `TNext`.
2. **A Tuple for Returned Values**: When the generator completes its execution, the `MultishotGenerator` is a tuple of the form `[IteratorReturnResult]`. This tuple consists of:
- **`IteratorReturnResult`**: An object with a `value` property containing the final return value of type `TReturn`, and a `done` property which is `true`.
The `MultishotGenerator` type allows users to manage the execution of a generator, providing the capability to either continue the generator with a new value or to handle its completion.
## Contributing
Contributions are welcome! Please feel free to submit a pull request or open an issue for any bugs, feature requests, or improvements.
## License
This project is licensed under the [MIT License](LICENSE).