mafintosh / mafintosh/streamx

Rename internal hooks

Open
#54 0 comments 3 reactions 0 assignees View on GitHub
Dominant language
JavaScript
Stars
239
Forks
27
Avg merge
27m
Merged PRs (30d)
1

Description

After hitting a few "user errors", I think we should rename the following internal hooks for clarity (semvar major, but public api the same)

* `_destroy (cb) --> _close(cb)`
* `_predestroy() -> _destroy(err)`

`_close` to better reflect that its the opposite of `_open` and `_destroy` to indicate that this is the "intercept the statemachine and destroy as soon as you can" hook.

Contributor guide

No contributing guide indexed for this repository

Research direction

Search the repository for the `_destroy` and `_predestroy` definitions and call sites, then read the related `_open` hook to understand the naming context. Rename the internal hooks consistently while preserving the public API, and verify that no old internal references remain.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
backend
Issue type
Refactor
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.