Automattic / Automattic/kue

Why is _state prefixed with an underscore? Is it not intended for use?

Open
#1,157 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
JavaScript
Stars
9.4k
Forks
858
PR merge metrics
No merged PRs in 30d

Description

I'm writing an application where, given a job ID, I want to check whether a job has completed or not. The obvious way would to get the job and check its state, but I noticed that the property is called `_state` which usually indicates a private property, so I'm thinking maybe I'm doing something wrong?

Contributor guide

No contributing guide indexed for this repository

Research direction

No file, test, or entry point is named. Start by locating Kue's job-state API and its documentation, then determine whether `_state` is an intended public interface or whether a supported accessor exists. Done means the supported way to check completion is clearly documented, with an example if the project’s documentation conventions allow it.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript, node.js, redis
Domain
backend, distributed-systems
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.