The "goals project" is sort of like a "todo" app with a twist. Instead of making one-liner "to do" items and checking them off, you create goals in the form of recurring items. E.g., a weekly goal might be to vacuum a rug while a daily goal might be to brush your teeth.
This serves as a library with the core data types for the project. It is pretty much useless by itself and is intended to be used within a project alongside a storage service to handle storing the data.
Goals recur; for example, a weekly goal of "wash the dog" occurs every week. Completions are the individual records of a goal's completion for a time period. If "wash the dog" was completed last week as well as the week before, there will be two completion records for it.
The GoalModel has the following members:
The string title for the goal, e.g., "wash the dog".
The GoalOccurrence enum representing how the goal occurs.
The Date of the creation of the goal.
Unique id for the goal. Generally reserved for the storage service, you usually shouldn't set this manually.
The CompletionModel has the following members:
The unique id for the goal that this completion is for.
The unique id for the completion record.
The Date the completion record was created.
This library does not contain a default storage service; that is the responsibility of other projects. To enable developers writing UI/apps to have a consistent API to work against, this project contains an abstraction that other projects should inherit from.
Returns all the goals.
Returns all the goals with the given occurrence.
Gets a specific goal.
Updates an existing goal or creates a new one if it does not exist.
Deletes the goal with the given id.
Sets/unsets a goal as completed.
Checks a goal's completion based on the goal's occurrence; for example, if a
goal has a completion for yesterday, but the occurs is GoalOccurrence.Daily,
the goal is not completed for today.
If a goal is completed, this returns a tuple of true and the id of the
completion ([true, 42]). If it is not completed, a tuple of false
and -1 is returned ([false, -1]).
Returns all the completion records for a goal.
Returns all the goals as a tuple with the goal and whether that goal is
completed: [GoalModel, boolean].
FAQs
Core schema for the Goals app
The npm package goals-core receives a total of 1 weekly downloads. As such, goals-core popularity was classified as not popular.
We found that goals-core demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Research
A malicious npm package disguised as a WhatsApp client is exploiting authentication flows with a remote kill switch to exfiltrate data and destroy files.
Security News
PyPI now supports digital attestations, enhancing security and trust by allowing package maintainers to verify the authenticity of Python packages.
Security News
GitHub removed 27 malicious pull requests attempting to inject harmful code across multiple open source repositories, in another round of low-effort attacks.
